<doc>
	<legacy_id>2510</legacy_id>
	<name>sound</name>
	<type>function</type>

	<syntax>
		<example>the sound</example>
		<example>sound()</example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Returns the name of the audio clip or sound file that is currently playing.</summary>

	<examples>
<example>the sound</example>
<example>wait until the sound is done</example>
	</examples>

	<history>
		<introduced version="1.0">Added.</introduced>
		<deprecated version=""></deprecated>
		<removed version=""></removed>
		<changed version="4.5.2">iOS support added</changed>
	</history>

	<objects>
	</objects>

	<platforms>
		<mac/>
		<windows/>
		<linux/>
		<ios/>
	  <android/>
  </platforms>

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

	<security>
	</security>


	<classification>
		<category>Images &amp; Multimedia</category>
	</classification>

	<references>
		<command tag="start">start Command</command>
		<property tag="soundChannel">soundChannel Property</property>
	</references>

	<description>
	<overview>Use the sound function to synchronize other actions with sounds.</overview>

		<parameters>
		</parameters>

	<value>The sound function returns a string.</value>
	<comments>On desktop the sound function returns 'done' if no audio clip is playing. If an audio clip is playing the name of the audio clip is returned.<p></p><p>On iOS the sound function returns 'done' if there is no sound currently playing. If a sound is currently being played its filename is returned.</p><p></p><p>Sounds played with the <command tag="beep">beep</command> command do not affect the value returned by the sound function.</p></comments>
	</description>
</doc>