Method Summary
Public Methods | ||
public |
canGoNext(): * |
|
public |
canGoPrevious(): * |
|
public |
getLoopStatus(): * |
|
public |
isActionPressed(button: HTMLElement): boolean |
|
public |
isButtonDisabled(button: HTMLElement): * | string |
|
public |
isControlAvailable(element: HTMLElement): boolean |
|
public |
isShuffle(): * |
|
public |
next() |
|
public |
previous() |
|
public |
setLoopStatus(status: *) |
|
public |
setRate(rate: *) |
|
public |
setShuffle(isShuffle: *) |
|
public |
setVolume(volume: *) |
Inherited Summary
From class Playback | ||
public |
The current player being shown by the MPRIS2 interface |
|
public |
A dictionary of any controls extracted from the DOM |
|
public |
Check current page for 'next' functionality |
|
public |
Check current page for 'previous' functionality |
|
public |
getIdentity(): null | string Get the identity of playback, by default it is the site's domain |
|
public |
Get the loop status of playback |
|
public |
getPosition(): null | number COMMAND Get active player's position |
|
public |
Get the rate of playback |
|
public |
One of PlaybackStatus.PLAYING or PlaybackStatus.PAUSED |
|
public |
Get the volume of playback |
|
public |
Get if the playback is shuffling between tracks |
|
public |
next() Go to next media This should be implemented per provider |
|
public |
pause() COMMAND Pause active player |
|
public |
play() COMMAND Start to play active player |
|
public |
previous() Go to previous This should be implemented per provider |
|
public |
COMMAND Seek activePlayer to offset |
|
public |
setActivePlayer(player: Player) Set the current active player |
|
public |
setLoopStatus(status: LoopStatus) By default we don't support playlist looping (LoopStatus.PLAYLIST) so we force LoopStatus.TRACK loop if any loop other than LoopStatus.NONE is specified |
|
public |
setPosition(id: string, position: number) COMMAND Set current position of active player |
|
public |
Set the rate of playback. |
|
public |
setShuffle(isShuffle: boolean) Set the shuffle between tracks of playback |
|
public |
Set the volume of playback |
|
public |
stop() COMMAND Stop active player |
|
public |
COMMAND Toggle the fullscreen state |
|
public |
COMMAND Toggle between play and pause |
Public Methods
public canGoNext(): * source
Check current page for 'next' functionality
Override:
Playback#canGoNextReturn:
* |
public canGoPrevious(): * source
Check current page for 'previous' functionality
Override:
Playback#canGoPreviousReturn:
* |
public getLoopStatus(): * source
Get the loop status of playback
Override:
Playback#getLoopStatusReturn:
* |
public isActionPressed(button: HTMLElement): boolean source
Params:
Name | Type | Attribute | Description |
button | HTMLElement |
public isButtonDisabled(button: HTMLElement): * | string source
Params:
Name | Type | Attribute | Description |
button | HTMLElement |
public isControlAvailable(element: HTMLElement): boolean source
Params:
Name | Type | Attribute | Description |
element | HTMLElement |
public isShuffle(): * source
Get if the playback is shuffling between tracks
Override:
Playback#isShuffleReturn:
* |
public next() source
Go to next media This should be implemented per provider
Override:
Playback#nextpublic previous() source
Go to previous This should be implemented per provider
Override:
Playback#previouspublic setLoopStatus(status: *) source
By default we don't support playlist looping (LoopStatus.PLAYLIST) so we force LoopStatus.TRACK loop if any loop other than LoopStatus.NONE is specified
Override:
Playback#setLoopStatusParams:
Name | Type | Attribute | Description |
status | * |
public setRate(rate: *) source
Set the rate of playback.
Override:
Playback#setRateParams:
Name | Type | Attribute | Description |
rate | * |
public setShuffle(isShuffle: *) source
Set the shuffle between tracks of playback
Override:
Playback#setShuffleParams:
Name | Type | Attribute | Description |
isShuffle | * |
public setVolume(volume: *) source
Set the volume of playback
Override:
Playback#setVolumeParams:
Name | Type | Attribute | Description |
volume | * |