SoundSource

Base class defining a sound's properties.

SoundSource is not meant to be used directly, it only serves as a common base for all audio objects that can live in the audio environment.

It defines several properties for the sound: pitch, volume, position, attenuation, etc. All of them can be changed at any time with no impact on performances.

interface SoundSource {

enum Status;

float pitch [@property setter];

float pitch [@property getter];

float volume [@property setter];

float volume [@property getter];

Vector3f position [@property setter];

Vector3f position [@property getter];

bool relativeToListener [@property setter];

bool relativeToListener [@property getter];

float minDistance [@property setter];

float minDistance [@property getter];

float attenuation [@property setter];

float attenuation [@property getter];

}

Members

Enums

Status enum Status: Enumeration of the sound source states.

Properties

attenuation float attenuation [@property setter]: The attenuation factor of the sound.
attenuation float attenuation [@property getter]: Undocumented in source.
minDistance float minDistance [@property setter]: The minimum distance of the sound.
minDistance float minDistance [@property getter]: Undocumented in source.
pitch float pitch [@property setter]: The pitch of the sound.
pitch float pitch [@property getter]: Undocumented in source.
position Vector3f position [@property setter]: The 3D position of the sound in the audio scene.
position Vector3f position [@property getter]: Undocumented in source.
relativeToListener bool relativeToListener [@property setter]: Make the sound's position relative to the listener (true) or absolute (false).
relativeToListener bool relativeToListener [@property getter]: Undocumented in source.
volume float volume [@property setter]: The volume of the sound.
volume float volume [@property getter]: Undocumented in source.

SoundSource

Members

Enums

Properties

See Also

Meta

Source

Authors