Difference between revisions of "SHIP:Port:beep"

From Serious Documentation
Jump to: navigation, search
 
Line 1: Line 1:
−
<onlyinclude>Beep ports are used to play sound through piezo-electric buzzer and are usually referred to in the format "'''platform.BEEP'''".
+
<onlyinclude>Beep ports are used to play sound through piezo-electric buzzers or audio speakers/amplifiers and are usually referred to in the format "'''platform.BEEP'''".
  
 
{{PortvarTableStart|}}
 
{{PortvarTableStart|}}
−
|{{Portvar|beep|volume}}||{{DataType|Byte}}||Read/Write||The volume 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:beep:volume}}
 
|-
 
|-
−
||{{Portvar|beep|frequency}}{{†}}||{{DataType|Short}}||Read/Write||The frequency the piezo-electric buzzer should emit. The buzzer's most efficient frequency is platform specific.
+
|{{:SHIP:Port:beep:frequency}}
 
|-
 
|-
−
||{{Portvar|beep|playing}}||{{DataType|Boolean}}||Read/Write||Starts/stops the buzzer from producing noise.
+
|{{:SHIP:Port:beep:playing}}
 
|}</onlyinclude>
 
|}</onlyinclude>
−
 
  
 
{{†}}see [[:SHIP:GRMs|GRM]]
 
{{†}}see [[:SHIP:GRMs|GRM]]

Latest revision as of 14:09, 4 February 2013

Beep ports are used to play sound through piezo-electric buzzers or audio speakers/amplifiers and are usually referred to in the format "platform.BEEP".

Portvar Data Type Permissions Description
volume Byte Read/Write The volume between 0 (off) and 100 (max). Setting this to an out of range value sets the volume to max. (Default:100)
frequency† Short Read/Write The frequency the piezo-electric buzzer should emit. The buzzer's most efficient frequency is platform specific.
playing Boolean Read/Write Starts/stops the buzzer from producing noise.

†see GRM

Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Port:beep&oldid=2814"