Retrieves all active players.
A promise resolving to an array of active players.
Retrieves the currently played item.
The ID of the player.
Optional
properties: string[]The properties to retrieve for the item.
A promise resolving to the currently played item.
Retrieves a list of available players.
The type of media (e.g., 'all', 'video', 'audio').
A promise resolving to an array of available players.
Retrieves the values of the given properties for a player.
The ID of the player.
The properties to retrieve.
A promise resolving to the requested properties and their values.
Gets the view mode of the video player.
A promise resolving to the view mode details.
Goes to the previous, next, or a specific position in the playlist.
The ID of the player.
The target to go to ('previous', 'next', or a specific position).
A promise resolving to a string, typically empty on success.
Moves the viewport or skips playback based on the current state.
The ID of the player.
The direction to move ('left', 'right', 'up', 'down').
A promise resolving to a string, typically empty on success.
Starts playback of a playlist, slideshow, single file, or database item.
The item to play.
Optional
options: PlayerOptionsOptional playback options.
A promise resolving to a string, typically empty on success.
Pauses or unpauses playback and returns the new state.
The ID of the player.
The toggle state ('toggle' by default).
A promise resolving to the new playback speed.
Rotates the current picture.
The ID of the player.
The direction to rotate ('clockwise' or 'counterclockwise').
A promise resolving to a string, typically empty on success.
Seeks through the playing item.
The ID of the player.
The seek value (percentage, time, step, or seconds).
A promise resolving to the new playback position.
Sets the audio delay for the current playback.
The ID of the player.
The offset value to set.
A promise resolving to the new audio delay offset.
Sets the audio stream played by the player.
The ID of the player.
The audio stream to set ('previous', 'next', or stream index).
A promise resolving to a string, typically empty on success.
Turns partymode on or off.
The ID of the player.
The toggle state ('toggle' by default).
A promise resolving to a string, typically empty on success.
Sets the repeat mode of the player.
The ID of the player.
The repeat mode ('off', 'one', 'all', or 'cycle').
A promise resolving to a string, typically empty on success.
Shuffles or unshuffles items in the player.
The ID of the player.
The toggle state ('toggle' by default).
A promise resolving to a string, typically empty on success.
Sets the speed of the current playback.
The ID of the player.
The speed value to set (-32 to 32 or increment/decrement).
A promise resolving to the new playback speed.
Sets the subtitle displayed by the player.
The ID of the player.
The subtitle to set ('previous', 'next', 'off', 'on', or subtitle index).
Whether to enable subtitles after setting (default: false).
A promise resolving to a string, typically empty on success.
Sets the tempo of the current playback.
The ID of the player.
The tempo value to set.
A promise resolving to the new tempo.
Sets the video stream played by the player.
The ID of the player.
The video stream to set ('previous', 'next', or stream index).
A promise resolving to a string, typically empty on success.
Sets the view mode of the video player.
The view mode to set (custom or predefined).
A promise resolving to a string, typically empty on success.
Adds a subtitle to the player.