SHIP:Node:audioclip

See Also

• SHIPv5 string nodes for much lighter weight string resources with (optional) translation
• Node Home
• Text Model Reference
• Language Support
• Sail String Functions

Synopsys

Node Type	Description
text	Defines a text resource or a visual text representation.

text nodes in the layout area are rendered according to the SHIP Text Model, and UTF-8 encoding is used for text node values.

In the resources area, text nodes define re-usable (and unchangeable) text resources. These text resources can have alternate translations such that when the system variable shiplanguage changes the GUI can automatically be updated.

Ancestors

text nodes within the resources area may be found within the following nodes:

Node Type	Description
group	Lightweight node that encloses other nodes for pure organizational benefit, or to create an array of nodes.
resources†	All reusable items, such as images, are held in the SHIP top-level node defined as the resources node

^†text nodes are permitted only directly underneath these nodes.

Within the layout area, text nodes may be found within the following nodes:

Node Type	Description
box†	A generic rectangular container, available as a reusable resource or layout element.
display	Contains the visual GUI layout for a specific LCD display/touch set.
group†	Lightweight node that encloses other nodes for pure organizational benefit, or to create an array of nodes.
layout	Top of the Layout Area within a SHIP GUI, which completely describes how the GUI is visually organized.
page†	Visual layout area for a specific GUI "page", or "screen"

^†text nodes are permitted directly underneath these nodes.

Descendants

The following nodes are permitted within texts:

Node Type	Description
constant†	Defines a constant value for use in SHIPTide properties or SAIL scripts.
group†	Lightweight node that encloses other nodes for pure organizational benefit, or to create an array of nodes.
listener†	Monitors one or more properties (including variable values!) for changes, and on changes invokes a script.
script	Run-time algorithms, written in SHIPSail.
timer†	Generates delays and timed alarm events.
variable†	Run-time value accessible by scripts and able to generate events on change.

^†text nodes are permitted directly underneath these nodes.

Properties

silent

Property Name	Data Type	Description
name**	String	The name used to identify this node in SHIPTide.
src	String	File name of the audio source file.
oneshot	Boolean	Determine if timer is one-shot and disables when it expires (false=default).
autoreload	Boolean	Determine if timer automatically reloads the autoreload when it expires (false=default).