Difference between revisions of "SHIP:Port:audioout"

From Serious Documentation
Jump to: navigation, search
(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...")
 
 
Line 2: Line 2:
  
 
{{PortvarTableStart|}}
 
{{PortvarTableStart|}}
−
|{{Portvar|audioout|volume}}||{{DataType|Byte}}||Read/Write||The volume of the audio output between <code>0</code> (off) and <code>100</code> (max). Setting this to an out of range value sets the volume to max. (Default: <code>100</code>)
+
|{{:SHIP:Port:audioout:volume}}
 
|-
 
|-
−
||{{Portvar|audioout|clip}}||{{DataType|Reference}}||Read/Write||The {{Node|audioclip|audioclip}} node reference of the last clip played (if any), otherwise the {{Node|resources|resources}} node. If set while another clip is playing, the sub-system will switch to the new clip immediately.
+
|{{:SHIP:Port:audioout:clip}}
 +
|-
 +
|{{:SHIP:Port:audioout:playing}}
 
|-
 
|-
−
||{{Portvar|audioout|playing}}||{{DataType|Boolean}}||Read/Write||Reflects whether or the not {{Portvar|audioout|clip}} is being played. When {{Portvar|audioout|clip}} is finished, self-sets to {{Reserved|false}} and resets the clip pointer to the beginning of {{Portvar|audioout|clip}}. If set to {{Reserved|false}} and {{Portvar|audioout|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 {{Portvar|audioout|clip}} before setting to {{Reserved|true}}.
 
 
|}</onlyinclude>
 
|}</onlyinclude>

Latest revision as of 12:46, 4 February 2013

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:audioclip Read/Write Node reference of the last audioclip played (if any), otherwise a reference to the resources node. If set while another clip is playing, the sub-system will switch to the new audioclip immediately.
playing Boolean Read/Write Reflects whether or 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.
Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Port:audioout&oldid=2809"