Component Sound

(NOTE) Sound functionality associated with a Space.

Methods	Properties	Base Classes	Derived Classes
InterpolateDecibels	Decibels	component
InterpolatePitch	InputNode
InterpolateSemitones	MuteAudio
InterpolateVolume	OutputNode
PlayCue	Paused
PlayCuePaused	PauseWithTimeSpace
Constructor	Pitch
	PitchWithTimeSpace
	Semitones
	SoundNodeInput
	SoundNodeOutput
	Volume

Properties

---

Decibels : real

The volume adjustment, in decibels, applied to all sounds in the space. A value of 0 does nothing, 6 will double the sound's volume, -6 will halve it.

var Decibels : Real

---

InputNode : soundnode

read-only

DEPRECATED The SoundNodeInput property should be used instead.

var InputNode : SoundNode

---

MuteAudio : boolean

Silences all audio output from this space but processes audio normally.

var MuteAudio : Boolean

---

OutputNode : soundnode

read-only

DEPRECATED The SoundNodeOutput property should be used instead.

var OutputNode : SoundNode

---

Paused : boolean

Setting this Property to true will pause all audio in the space. Setting it to false will resume all audio.

var Paused : Boolean

---

PauseWithTimeSpace : boolean

If true, the audio of the space will pause when the space is paused.

var PauseWithTimeSpace : Boolean

---

Pitch : real

The pitch adjustment applied to all sounds in the space. 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.

var Pitch : Real

---

PitchWithTimeSpace : boolean

If true, the audio in the SoundSpace will be pitched according to the TimeScale of the Space(if time slows down the audio will slow down and lower in pitch, if it speeds up the audio will speed up and raise in pitch).

var PitchWithTimeSpace : Boolean

---

Semitones : real

The pitch adjustment, in semitones (or half-steps), applied to all sounds in the space. A value of 0 will do nothing, 12 will raise the pitch by an octave and speed up the sound,.

var Semitones : Real

---

SoundNodeInput : soundnode

read-only

The SoundNode which is the ultimate output of all sounds in this space.

var SoundNodeInput : SoundNode

---

SoundNodeOutput : soundnode

read-only

The SoundNode which can be used to attach other nodes which should process all audio in the SoundSpace.

var SoundNodeOutput : SoundNode

---

Volume : real

The volume adjustment applied to all sounds in the space. A value of 1 does nothing, 2 will double the volume, 0.5 will halve it.

var Volume : Real

---

Methods

---

InterpolateDecibels : Void

Interpolates the SoundSpace's 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 SoundSpace's 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| | |time|real| |

function InterpolatePitch(pitch : Real, time : Real)

---

InterpolateSemitones : Void

Interpolates the SoundSpace's 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| | |time|real| |

function InterpolateSemitones(pitch : Real, time : Real)

---

InterpolateVolume : Void

Interpolates the SoundSpace's 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| |---|---|---| |value|real| | |interpolationTime|real| |

function InterpolateVolume(value : Real, interpolationTime : Real)

---

PlayCue : soundinstance

Plays the passed-in SoundCue non-positionally and returns the resulting SoundInstance. |Name|Type|Description| |---|---|---| |cue|soundcue| |

function PlayCue(cue : SoundCue) : SoundInstance

---

PlayCuePaused : soundinstance

Plays the passed-in SoundCue non-positionally and returns the resulting SoundInstance, which starts off paused. |Name|Type|Description| |---|---|---| |cue|soundcue| |

function PlayCuePaused(cue : SoundCue) : SoundInstance

---

SoundSpace : Void

constructor

Name	Type	Description

function SoundSpace()

---