Sound

(NOTE) The object associated with a currently playing sound.

Methods	Properties	Base Classes	Derived Classes
InterpolateDecibels	CustomEventTime	referencecountedeventobject
InterpolatePitch	Decibels
InterpolateSemitones	EndTime
InterpolateVolume	FileLength
Stop	IsPlaying
	LoopEndTime
	Looping
	LoopStartTime
	Paused
	Pitch
	Semitones
	SoundName
	SoundNode
	Time
	Volume

Properties

---

CustomEventTime : real

The time (in seconds from the beginning of the file) to get a MusicCustomTime event.

var CustomEventTime : Real

---

Decibels : real

The volume adjustment (in decibels) of the SoundInstance, initially set by the SoundCue's Decibels property. A value of 0 does nothing, 6 will double the sound's volume, -6 will halve it. The Decibels property is linked to the Volume property (changing one will change the other).

var Decibels : Real

---

EndTime : real

The time in seconds from the beginning of the file that the instance will stop.

var EndTime : Real

---

FileLength : real

read-only

The length of the entire audio file, in seconds.

var FileLength : Real

---

IsPlaying : boolean

read-only

This Property will be true while the SoundInstance is playing, then will become false when its sound has stopped.

var IsPlaying : Boolean

---

LoopEndTime : real

The time in seconds from the beginning of the file that the instance will stop and jump back when looping.

var LoopEndTime : Real

---

Looping : boolean

When this Property is true the SoundInstance will loop indefinitely. If changed to false while a SoundInstance is looping the SoundInstance will continue playing to its EndTime and then stop.

var Looping : Boolean

---

LoopStartTime : real

The time in seconds from the beginning of the file that the instance will jump back to when it loops.

var LoopStartTime : Real

---

Paused : boolean

Setting this Property to true will pause a currently playing SoundInstance. Setting it to false will resume playback.

var Paused : Boolean

---

Pitch : real

The pitch adjustment of the SoundInstance, initially set by the SoundCue's Pitch property. A value of 0 will do nothing, 1 will raise the pitch by an octave and speed up the sound,.

var Pitch : Real

---

Semitones : real

The pitch adjustment, in semitones (or half-steps), of the SoundInstance, initially set by the SoundCue's Semitones property. A value of 0 will do nothing, 12 will raise the pitch by an octave and speed up the sound, and -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

---

SoundName : string

read-only

The name of the Sound being played by this SoundInstance.

var SoundName : String

---

SoundNode : soundnode

read-only

The SoundNode associated with this SoundInstance.

var SoundNode : SoundNode

---

Time : real

This property tells you to the current playback position, in seconds from the beginning of the file, and allows you to tell the instance to change its playback position to a different time. Be aware that the time will not be precisely accurate. If the Sound resource used to play the SoundInstance has Streamed selected, you cannot set the playback position.

var Time : Real

---

Volume : real

The volume adjustment of the SoundInstance, initially set by the SoundCue's Volume property. A value of 1 does nothing, 2 will double the sound's 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 SoundInstance'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 SoundInstance'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| | |interpolationTime|real| |

function InterpolatePitch(pitch : Real, interpolationTime : Real)

---

InterpolateSemitones : Void

Interpolates the SoundInstance'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| |---|---|---| |pitchSemitones|real| | |interpolationTime|real| |

function InterpolateSemitones(pitchSemitones : Real, interpolationTime : Real)

---

InterpolateVolume : Void

Interpolates the SoundInstance'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| |---|---|---| |volume|real| | |interpolationTime|real| |

function InterpolateVolume(volume : Real, interpolationTime : Real)

---

Stop : Void

Stops the playback of this SoundInstance. It cannot be re-started. |Name|Type|Description| |---|---|---|

function Stop()

---