Component Sound
(NOTE) Allows 3D positioning of sounds relative to SoundListeners.
| Methods | Properties | Base Classes | Derived Classes |
|---|---|---|---|
| InterpolateDecibels | Attenuator | component | |
| InterpolatePitch | Decibels | ||
| InterpolateSemitones | Directional | ||
| InterpolateVolume | EmitAngle | ||
| PlayCue | InputNode | ||
| PlayCuePaused | IsPlaying | ||
| Constructor | OutputNode | ||
| Paused | |||
| Pitch | |||
| RearVolume | |||
| Semitones | |||
| SoundNodeInput | |||
| SoundNodeOutput | |||
| Volume |
Properties
Attenuator : soundattenuator
If a SoundAttenuator resource other than DefaultNoAttenuation is selected it will be applied to SoundCues without their own SoundAttenuator resource. If a SoundCue has attenuation settings those will always be used. If neither has settings, the sound will not be attenuated.
var Attenuator : SoundAttenuator
Decibels : real
The volume adjustment, in decibels, applied to all sounds played through this SoundEmitter. A value of 0 does nothing, 6 will double the volume, -6 will halve it. The Decibels property is linked to the Volume property (changing one will change the other).
var Decibels : Real
Directional : boolean
When true, the audio output of the SoundEmitter will be limited by the EmitAngle, so that sound in front of the object will be louder than sound behind it. Within the EmitAngle the sound will be at full volume. The volume interpolates logarithmically until it reaches the RearVolume value directly behind the object.
var Directional : Boolean
EmitAngle : real
The angle of full volume sound for a directional SoundEmitter, from 1 to 360. An angle of 90, for example, will be centered at the object's front, extending 45 degrees to the left and right.
var EmitAngle : Real
InputNode : soundnode
read-only
DEPRECATED The SoundNodeInput property should be used instead.
var InputNode : SoundNode
IsPlaying : boolean
read-only
This property will be true if there are SoundInstances currently associated with this SoundEmitter, even if they are paused or otherwise not audible.
var IsPlaying : Boolean
OutputNode : soundnode
read-only
DEPRECATED The SoundNodeOutput property should be used instead.
var OutputNode : SoundNode
Paused : boolean
Setting this property to true pauses all sounds currently playing through the SoundEmitter. Setting it to false will resume playback.
var Paused : Boolean
Pitch : real
This property affects both the pitch and speed of all sounds played through this SoundEmitter. A value of 0 will do nothing, 1 will raise the pitch by an octave and speed up the sound, -1 will lower the sound by an octave and slow it down. The Pitch property is linked to the Semitones property (changing one will change the other).
var Pitch : Real
RearVolume : real
The volume of sound heard directly behind a directional SoundEmitter. It will only reach this value in a small area, since volume is interpolated from the edge of the EmitAngle. To make the volume as quiet as possible behind the object, use a small EmitAngle.
var RearVolume : Real
Semitones : real
This property, specified in semitones (or half-steps), affects both the pitch and speed of all sounds played through this SoundEmitter.. A value of 0 will do nothing, 12 will raise the pitch by an octave and speed up the sound, -12 will lower the sound by an octave and slow it down. The Semitones property is linked to the Pitch property (changing one will change the other).
var Semitones : Real
SoundNodeInput : soundnode
read-only
The SoundNode to use for attaching other nodes to the input of the SoundEmitter.
var SoundNodeInput : SoundNode
SoundNodeOutput : soundnode
read-only
The SoundNode to use for attaching other nodes to the output of the SoundEmitter.
var SoundNodeOutput : SoundNode
Volume : real
The volume adjustment applied to all sounds played through this SoundEmitter. A value of 1 does nothing, 2 will double the volume, 0.5 will halve it. The Volume property is linked to the Decibels property (changing one will change the other).
var Volume : Real
Methods
InterpolateDecibels : Void
Interpolates the Decibels property from its current value to the value passed in as the first parameter, over the number of seconds passed in as the second parameter. |Name|Type|Description| |---|---|---| |decibels|real| | |interpolationTime|real| |
function InterpolateDecibels(decibels : Real, interpolationTime : Real)
InterpolatePitch : Void
Interpolates the Pitch property from its current value to the value passed in as the first parameter, over the number of seconds passed in as the second parameter. |Name|Type|Description| |---|---|---| |pitch|real| | |interpolationTime|real| |
function InterpolatePitch(pitch : Real, interpolationTime : Real)
InterpolateSemitones : Void
Interpolates the Semitones property from its current value to the value passed in as the first parameter, over the number of seconds passed in as the second parameter. |Name|Type|Description| |---|---|---| |pitch|real| | |interpolationTime|real| |
function InterpolateSemitones(pitch : Real, interpolationTime : Real)
InterpolateVolume : Void
Interpolates the Volume property from its current value to the value passed in as the first parameter, over the number of seconds passed in as the second parameter. |Name|Type|Description| |---|---|---| |volume|real| | |interpolationTime|real| |
function InterpolateVolume(volume : Real, interpolationTime : Real)
PlayCue : soundinstance
Plays the SoundCue passed into the function and returns the resulting SoundInstance. |Name|Type|Description| |---|---|---| |cue|soundcue| |
function PlayCue(cue : SoundCue) : SoundInstance
PlayCuePaused : soundinstance
Plays the SoundCue passed into the function and returns the resulting SoundInstance, which starts off paused. |Name|Type|Description| |---|---|---| |cue|soundcue| |
function PlayCuePaused(cue : SoundCue) : SoundInstance
SoundEmitter : Void
constructor
Name Type Description function SoundEmitter()