Difference between revisions of "SHIP:Port:beep"

Revision as of 18:14, 1 February 2013

Beep ports are used to play sound through piezo-electric buzzer 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

@@ Line 4: / Line 4: @@
 |{{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>)
 |-
-||{{Portvar|beep|frequency}}||{{DataType|Short}}||Read/Write||The frequency the piezo-electric buzzer should emit.
+||{{Portvar|beep|frequency}}{{†}}||{{DataType|Short}}||Read/Write||The frequency the piezo-electric buzzer should emit. The buzzer's most efficient frequency is platform specific.
 |-
 ||{{Portvar|beep|playing}}||{{DataType|Boolean}}||Read/Write||Starts/stops the buzzer from producing noise.
 |}</onlyinclude>
+{{†}}see [[:SHIP:GRMs|GRM]]