Audio

Description:

  A record of an audio player singleton object.

soundSpeed

Type: Field.

Description:

  The speed of the sound.

Signature:

soundSpeed: number

globalVolume

Type: Field.

Description:

  The global volume.

Signature:

globalVolume: number

listener

Type: Field.

Description:

  The listener node of the 3D sound source.

Signature:

listener: Node

play

Type: Function.

Description:

  Plays a sound effect and returns a handler for the audio.

Signature:

play: function(
		self: Audio,
		filename: string,
		loop?: boolean --[[false]]
	): integer

Parameters:

Parameter	Type	Description
filename	string	The path to the sound effect file (must be a WAV file).
loop	boolean	[optional] Whether to loop the sound effect (default is false).

Returns:

Return Type	Description
integer	A handler for the audio that can be used to stop the sound effect.

stop

Type: Function.

Description:

  Stops a sound effect that is currently playing.

Signature:

stop: function(self: Audio, handler: integer)

Parameters:

Parameter	Type	Description
handler	integer	The handler for the audio that is returned by the play function.

playStream

Type: Function.

Description:

  Plays a streaming audio file.

Signature:

playStream: function(
		self: Audio,
		filename: string,
		loop?: boolean --[[false]],
		crossFadeTime?: number --[[0.0]]
	)

Parameters:

Parameter	Type	Description
filename	string	The path to the streaming audio file (can be OGG, WAV, MP3, or FLAC).
loop	boolean	[optional] Whether to loop the streaming audio (default is false).
crossFadeTime	number	[optional] The time (in seconds) to crossfade between the previous and new streaming audio (default is 0.0).

stopStream

Type: Function.

Description:

  Stops a streaming audio file that is currently playing.

Signature:

stopStream: function(
		self: Audio,
		fadeTime?: number --[[0.0]]
	)

Parameters:

Parameter	Type	Description
fadeTime	number	[optional] The time (in seconds) to fade out the streaming audio (default is 0.0).

setPauseAllCurrent

Type: Function.

Description:

  Pauses all currently playing audio.

Signature:

setPauseAllCurrent: function(self: Audio, pause: boolean)

Parameters:

Parameter	Type	Description
pause	boolean	The pause state.

setListenerAt

Type: Function.

Description:

  Sets the position of the listener.

Signature:

setListenerAt: function(self: Audio, atX: number, atY: number, atZ: number)

Parameters:

Parameter	Type	Description
atX	number	The x-axis position.
atY	number	The y-axis position.
atZ	number	The z-axis position.

setListenerUp

Type: Function.

Description:

  Sets the up direction of the listener.

Signature:

setListenerUp: function(self: Audio, upX: number, upY: number, upZ: number)

Parameters:

Parameter	Type	Description
upX	number	The x-axis up direction.
upY	number	The y-axis up direction.
upZ	number	The z-axis up direction.

setListenerVelocity

Type: Function.

Description:

  Sets the velocity of the listener.

Signature:

setListenerVelocity: function(self: Audio, velocityX: number, velocityY: number, velocityZ: number)

Parameters:

Parameter	Type	Description
velocityX	number	The x-axis velocity.
velocityY	number	The y-axis velocity.
velocityZ	number	The z-axis velocity.