PlayOrientedSound - Revision history

Thewreck at 16:26, 18 January 2010

2010-01-18T16:26:24Z

← Older revision		Revision as of 16:26, 18 January 2010
Line 1:		Line 1:
	{{AudioMethod		{{AudioMethod
	\|		\|
-	audio.playOrientedSound(soundFilename, gain, modulation, x, y, z, [speedX, speedY, speedZ])	+	audio.playOrientedSound(soundFilename [, gain [, modulation [, x, y, z, [speedX, speedY, speedZ])
	\|		\|
	Plays an audio file with a position in space, once. The volume and panning is then calculated based on the [[setSoundListenerPosition]].		Plays an audio file with a position in space, once. The volume and panning is then calculated based on the [[setSoundListenerPosition]].

Thewreck at 13:55, 18 January 2010

2010-01-18T13:55:43Z

← Older revision		Revision as of 13:55, 18 January 2010
Line 3:		Line 3:
	audio.playOrientedSound(soundFilename, gain, modulation, x, y, z, [speedX, speedY, speedZ])		audio.playOrientedSound(soundFilename, gain, modulation, x, y, z, [speedX, speedY, speedZ])
	\|		\|
-	Plays an audio file with a position in space. The volume and panning is then calculated based on the [[setSoundListenerPosition]].	+	Plays an audio file with a position in space, once. The volume and panning is then calculated based on the [[setSoundListenerPosition]].
	\|		\|
	{{MethodParam\|soundFilename\|A string\|The name of the audio file, relative to the source folder. The name is case sensitive on Mac OS X.}}		{{MethodParam\|soundFilename\|A string\|The name of the audio file, relative to the source folder. The name is case sensitive on Mac OS X.}}

Thewreck: /* Example */

2010-01-18T12:56:07Z

Example

← Older revision		Revision as of 12:56, 18 January 2010
Line 19:		Line 19:
	=== Example ===		=== Example ===
	<pre>		<pre>
-	audio.playOrientedSound("~~sfx/explosion~~.wav", 4, 1, bomb.x~~myGameWorldResolution~~, bomb.y~~myGameWorldResolution~~, 0)	+	local bomb = {x = 120, y = 200}
		+	local res = 1/32 -- 32 pixels is one meter.
		+	audio.playOrientedSound("boom.wav", 4, 1, bomb.xres, bomb.yres, 0)

-	audio.playOrientedSound("coin.wav", 1, 0.75+math.random()*0.5, 0, 0, 0) ~~--at center of the world, randomly pitched coins dance~~	+	--at center of the world, randomly pitched coins dance
		+	audio.playOrientedSound("coin.wav", 1, 0.75+math.random()*0.5, 0, 0, 0)
	</pre>		</pre>

Thewreck: Created page with '{{AudioMethod | audio.playOrientedSound(soundFilename, gain, modulation, x, y, z, [speedX, speedY, speedZ]) | Plays an audio file with a position in space. The volume and panning...'

2010-01-18T12:54:26Z

Created page with '{{AudioMethod | audio.playOrientedSound(soundFilename, gain, modulation, x, y, z, [speedX, speedY, speedZ]) | Plays an audio file with a position in space. The volume and panning...'

New page

{{AudioMethod
|
audio.playOrientedSound(soundFilename, gain, modulation, x, y, z, [speedX, speedY, speedZ])
|
Plays an audio file with a position in space. The volume and panning is then calculated based on the [[setSoundListenerPosition]].
|
{{MethodParam|soundFilename|A string|The name of the audio file, relative to the source folder. The name is case sensitive on Mac OS X.}}
{{MethodParam|gain|A number|The power at which the sound is emitted.}}
{{MethodParam|modulation|A number|How pitch shifted the sound should be. Original pitch is 1.}}
{{MethodParam|x|A number|Position in space, in meters.}}
{{MethodParam|y|A number|Position in space, in meters.}}
{{MethodParam|z|A number|Position in space, in meters.}}
{{MethodParam|speedX|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
{{MethodParam|speedY|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
{{MethodParam|speedZ|A number|The speed of the sound in space, for creation of doppler effects, in meters/second.}}
|
Returns nothing.
}}
=== Example ===
<pre>
audio.playOrientedSound("sfx/explosion.wav", 4, 1, bomb.x*myGameWorldResolution, bomb.y*myGameWorldResolution, 0)

audio.playOrientedSound("coin.wav", 1, 0.75+math.random()*0.5, 0, 0, 0) --at center of the world, randomly pitched coins dance
</pre>