SHIP:Port:audioout

From Serious Documentation
Revision as of 18:04, 1 February 2013 by NickW-Serious (talk | contribs) (Created page with "<onlyinclude>AudioOut ports are used to configure or play sound through an audio speaker/amplifier and are usually referred to in the format "'''platform.AUDIOOUT'''". {{Port...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

AudioOut ports are used to configure or play sound through an audio speaker/amplifier and are usually referred to in the format "platform.AUDIOOUT".

Portvar Data Type Permissions Description
volume Byte Read/Write The volume of the audio output between 0 (off) and 100 (max). Setting this to an out of range value sets the volume to max. (Default: 100)
clip Reference Read/Write The audioclip node reference of the last clip played (if any), otherwise the resources node. If set while another clip is playing, the sub-system will switch to the new clip immediately.
playing Boolean Read/Write Reflects whether or the not clip is being played. When clip is finished, self-sets to false and resets the clip pointer to the beginning of clip. If set to false and clip has not finished, the clip pointer is not modified so playing can be resumed. To restart an unfinished clip, reassign the same clip to clip before setting to true.