Skip to content

AudioEmitter ​

class in OpalScript

Owns one sound voice. Play, loop and stop it with volume, pitch and stereo pan.

Properties ​

MemberDescription
AudioEmitter.PlayingRead-only runtime value. Use component methods to change state.
AudioEmitter.DiagnosticRead-only runtime value. Use component methods to change state.

Methods ​

MemberDescription
AudioEmitter.PlayReplace this emitter's voice with the configured sound; playback status updates after loading.
AudioEmitter.StopCancel pending loading and stop this emitter's voice.
AudioEmitter.IsPlayingWhether the owned sound voice is playing.

Events ​

MemberDescription
AudioEmitter.startedA sound voice was admitted and started.
AudioEmitter.stoppedThe owned voice was stopped explicitly, disabled or released.
AudioEmitter.finishedThe owned voice ended naturally.

See also ​