Skip to main content

Privacy Player API docs

Classes#

PrivacyPlayer

this is the main class of the player

PrivacyPlayerPro

this class extends the privacy player to its pro version

PrivacyPlayerControlBar

this is the main class that is the controlbar

PrivacyPlayer#

this is the main class of the player

Kind: global class
Author: Joshua Peper

new PrivacyPlayer()#

declares the privacyPLayer and its parts

privacyPlayer.init()#

initialises the iframe including autoplay and fullscreen in applicable

Kind: instance method of PrivacyPlayer

PrivacyPlayerPro#

this class extends the privacy player to its pro version

Kind: global class
Author: Joshua Peper

privacyPlayerPro._getPlayerWidth()#

gets the players width

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro._addToOverlay()#

adds element to overlay

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro._sendMessage()#

sends message to the player

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro._setEventListner()#

listens for events

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro._iframeEventHandler()#

handles the events

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro._initOverlay()#

warnes if the player is not ready

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro._syncData()#

syncs the data between the controlbar and the player

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro.ready()#

checs if the player is ready

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro.enableStationLogo()#

enables the station logo overlay over the content

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro.disableStationLogo()#

disables the station logo

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro.addOverlay()#

adds the overlay over the content

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro.pause()#

pauses the content

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro.playPause()#

plays and pauses the content

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro.isFullscreen()#

checks if the player is in full screen mode

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro.requestFullscreen()#

makes the player request fullscreen mode

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro.exitFullscreen()#

makes the player exit fullscreen mode

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro.isInPictureInPicture()#

checks if the player is in PIP mode

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro.requestPictureInPicture()#

requestst the PIP mode

Kind: instance method of PrivacyPlayerPro

privacyPlayerPro.exitPictureInPicture()#

exits the PIP mode

Kind: instance method of PrivacyPlayerPro

PrivacyPlayerControlBar#

this is the main class that is the controlbar

Kind: global class
Author: Joshua peper

new PrivacyPlayerControlBar()#

the controlbar for the privacy player

privacyPlayerControlBar._syncSettings()#

syncs with the new settings

Kind: instance method of PrivacyPlayerControlBar

privacyPlayerControlBar.ready()#

checks if the controlbar is ready

Kind: instance method of PrivacyPlayerControlBar

privacyPlayerControlBar.controls()#

the controls itself

Kind: instance method of PrivacyPlayerControlBar

privacyPlayerControlBar.show()#

showes the controls

Kind: instance method of PrivacyPlayerControlBar

privacyPlayerControlBar.hide()#

hides the controls