ControllerStateInterface
in
Representation of the current state of a controller.
Table of Contents
Methods
- getCrossfade() : bool
- Check if crossfade is currently active.
- getPosition() : TimeInterface
- Get the position of the currently active track.
- getRepeat() : bool
- Check if repeat is currently active.
- getShuffle() : bool
- Check if shuffle is currently active.
- getSpeakers() : array<string, int>
- Each speaker's UUID and its volume.
- getState() : PlayState
- Get the playing mode of the controller.
- getStream() : Stream|null
- Get the stream this controller is using.
- getTrack() : int
- Get the number of the active track in the queue
- getTracks() : array<string|int, TrackInterface>
- Get the tracks that are in the queue.
Methods
getCrossfade()
Check if crossfade is currently active.
public
getCrossfade() : bool
Return values
boolgetPosition()
Get the position of the currently active track.
public
getPosition() : TimeInterface
Return values
TimeInterfacegetRepeat()
Check if repeat is currently active.
public
getRepeat() : bool
Return values
boolgetShuffle()
Check if shuffle is currently active.
public
getShuffle() : bool
Return values
boolgetSpeakers()
Each speaker's UUID and its volume.
public
getSpeakers() : array<string, int>
Return values
array<string, int>getState()
Get the playing mode of the controller.
public
getState() : PlayState
Return values
PlayStategetStream()
Get the stream this controller is using.
public
getStream() : Stream|null
Return values
Stream|nullgetTrack()
Get the number of the active track in the queue
public
getTrack() : int
Return values
int —The zero-based number of the track in the queue
getTracks()
Get the tracks that are in the queue.
public
getTracks() : array<string|int, TrackInterface>