LogoLogo
  • Player API
    • Basic Usage
    • Configuration
    • Labels
    • Themes
    • Events
    • Key Bindings
    • Methods
  • Plugins
    • Call to Action
    • Branding
    • Watermark Protection
    • Playlists
    • Multi Channel Livestreams
    • Comments
    • Live Reactions
    • Quizzing
    • Peer2Peer (E-CDN)
    • Consent String
  • Release Notes
    • v5.3
    • v5.2
    • v5.1
    • v5.0
  • Tutorials
    • Switch between different livestreams
    • Use the Player with Require
    • Use Video Loop as background
  • Knowledge Base
    • Using a custom player for streaming
Powered by GitBook
On this page
  • Available Methods
  • Player controls
  • Media controls
  • Subtitles / Captions
  • AudioTracks
  • Ads
  • Sidebar
  • Playlists
  1. Player API

Methods

To call a method or to receive information from the player, just use the player instance to call them.

// Call the play method
player.play()

Available Methods

Player controls

Method
Type
Description

fullscreen

-

exitfullscreen

-

enableControls

-

disableControls

-

destroy

-

getVersion

-

load

string

Loads a new dataid

Media controls

Method
Type
Description

play

-

pause

-

unmute

-

mute

-

volume

Integer [0.1..1]

Sets the volume. E.g. for 50% volume use 0.5

seek

Integer

getVideoInfo

getCurrentTime

getDuration

getStreamType

getLiveDelayInSeconds

getProcessingStatus

Boolan

VoD only: method to check, if the video is already transcoded

Subtitles / Captions

Method
Type
Description

getSubtitles

Object

subtitle

Integer

AudioTracks

Method
Type
Description

getAudioTracks

Object

audiotrack

Integer

Ads

Method
Type
Description

requestAd

String

Triggers a midroll. Pre- and PostRolls will still be called anyway. requestAd() or requestAd(url) if specifying an ad tag url.

Sidebar

Method
Type
Description

setSideBarHTML

String

showSideBar

showSideBar

Playlists

Method
Type
Description

next

Plays the next item in the playlist

previous

Plays the previous item in the playlist

getPlaylistItems

Retrieves a list of all playlist items

PlaylistItem

Number

Sets the current active Playlist Item to given ID

PreviousKey BindingsNextCall to Action

Last updated 1 year ago