<doc>
	<legacy_id>3503</legacy_id>
	<name>beepSound</name>
	<type>property</type>

	<syntax>
		<example>set the beepSound to { <i>beepType</i> }</example>
		<example>get the beepSound</example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Specifies the method used to produce sound when the beep command is used.</summary>

	<examples>
<example>set the beepSound to &quot;system&quot;</example>
<example>set the beepSound to &quot;internal&quot;</example>
<example><p>set the beepSound to &quot;vibrate&quot;</p></example>
	</examples>

	<history>
		<introduced version="2.9">Added.</introduced>
		<deprecated version=""></deprecated>
		<removed version=""></removed>
		<changed version="5.5">Additional options added</changed>
<changed version="4.5.2">iOS support added</changed>
	</history>

	<objects>
	</objects>

	<platforms>
		<windows/>
		<ios/>
	</platforms>

	<classes>
		<desktop/>
		<web/>
		<mobile/>
	</classes>

	<security>
	</security>


	<classification>
	</classification>

	<references>
		<command tag="beep">beep Command</command>
		<command tag="mobileVibrate">mobileVibrate Command</command>
	</references>

	<description>
	<overview>Use the <b>beepSound</b> property to change the sound made when the beep command is used.</overview>

		<parameters>
<parameter>
<name>beepType</name>
<description>A string containing one of the following:</description>
<options title="">
<option>
<item>system (default)</item>
<description>The system standard alert sound is played.</description>
</option>
<option>
<item>internal</item>
<description>The computer's motherboard speaker is used (if present).</description>
</option>
<option>
<item>vibrate</item>
<description>The device vibrates rather than play a sound (iOS only).</description>
</option>
</options>
</parameter>		</parameters>

	<value>The <b>beepSound</b> property is one of the following:<p>   * system - this performs beep on mobile devices</p><p>   * internal</p><p>   * vibrate</p><p>   * empty</p></value>
	<comments>When the beep command is executed, LiveCode makes a sound using the method specified by the <b>beepSound</b> property.<p></p><p></p><note>Setting the <b>beepSound</b> property only has an effect on the Windows desktop platform.  On other desktop platforms the &quot;system&quot; method is used regardless of its setting.</note><p></p><p></p><note>The iPhone does not have a default system alert sound so if a sounds is required one must be specified by using the <b>beepSound</b> property.</note><p></p><p></p><important>If you use beep with <b>beepSound</b> set to &quot;internal&quot; be sure to test your program on the machines you will be running it on.  Some Windows machines have faulty drivers for the motherboard speaker which can cause applications using it to crash.</important></comments>
	</description>
</doc>