PlaybackController

The PlaybackController class enables control of audio playback.

Properties

This module exposes no properties.

Methods

MethodDescription

loop

loop(): void

Deprecated: Please use the setLooping method. Loop the playback controller, sound comes through all speakers (also known as Audio Source in the past) that reference the playback controller.

play

play(): void

Deprecated: Please use the setPlaying method. Play the playback controller, sound comes through all speakers (also known as Audio Source in the past) that reference the playback controller.

reset

reset(): void

Resets the playback controller audio to the beginning. If the playback controller is currently playing then it will immediately re-start.

setLooping

setLooping(looping: BoolValue): void

Loops the playback controller. To be used in pair with the setPlaying method. If set to true, the audio will repeat infinitely.

setPlaying

setPlaying(playing: BoolValue): void

Plays or pauses the playback controller depending on the value entered. When the audio is finished playing, use reset to play from the beginning.

stop

stop(): void Deprecated: Please use the setPlaying method to pause the audio or the reset method to return the audio to the beginning. Stop the playback controller.