Player Class

Defined in: src\player\player.js:8

This is for Player operations. It depends to Device. Some methods are abstracted by Devices

Index

Show:

Methods

Constructor

Player
(
  • currentDevice
  • events
  • config
)

Defined in src\player\player.js:8

Parameters:

  • currentDevice Object
    • Current device object
  • events Object
    • Events class inheritance
  • config Object
    • Config object

Methods

addAdsCaption () Boolean

Defined in src\player\player.js:489

Adds ads caption to video player to end user notified about Ads This text can be edited via config

Returns:

Boolean:

addVideoSource
(
  • src
  • customData
)

Defined in src\player\player.js:97

Adds video source to element. If trying to play DRM video you have to send customData with video source It sets this customData to player info so it can be accessible. Checks content address if it includes manifest regex it will start DRM functions automatically It catches DRM providers with currentDevice You can send HLS, Live HLS and Microsoft SS (PlayReady) content TODO DRM providers can be included in another function

Parameters:

  • src String
    • Source url for video content
  • customData String
    • Custom Data

checkAdsStatus ()

Defined in src\player\player.js:430

This function is triggered with timeUpdate event of video player. It compares with Vast time with current time

createOIPFDrmAgent ()

Defined in src\player\player.js:820

Drm initiator for OIPF Devices such as Vestel and Arcelik

createVideoElement ()

Defined in src\player\player.js:25

Creates Video element. It creates a HTML5 video element with config videoPlayerId Then you can reach this video element with this.videoElement It appends this video element to body. You have to set it to a fixed position with css. Most of Tv manufacturers runs its own video player and its position fixed to (0,0) cooridnates Its important to consider your design

Returns:

null

deleteVideoElement () Boolean

Defined in src\player\player.js:81

Removes videoElement from DOM. Its recommended to call this function if you are consider to close video TODO We have to check DRM inited if yes we have to detach DRM before removing

Returns:

Boolean:

initAds
(
  • type
  • url
)

Defined in src\player\player.js:163

Initialize ads with given source and type. So type is mandatory field to operate

Parameters:

  • type String
    • Type of ads source 'VMAP' or just 'VAST'
  • url Object
    • Url of ads source VMAP or VAST Url

Returns:

:

initAudioClass ()

Defined in src\player\player.js:629

Constructor for Audio class

initAudioClass ()

Defined in src\player\player.js:642

Add Subtitle Method

initVastAd
(
  • time
)

Defined in src\player\player.js:448

It starts ads in videoPlayer. Pauses current video then starting ads After completing ads it starts old src url with initial seeking with time

Parameters:

  • time Object
    • current time of video player

pause ()

Defined in src\player\player.js:683

Pause trigger for videoElement

play ()

Defined in src\player\player.js:660

Play trigger for videoElement

playWithLoop ()

Defined in src\player\player.js:707

Play trigger for a video element with endless autoloop you can use this feature to enable silent background videos

prepareVastFromVmap
(
  • vmapObject
)

Defined in src\player\player.js:202

If ads type is VMAP and detected in initAds method it will call automatically this function

Parameters:

  • vmapObject Object
    • Vmap object its response of VMAP XML

readVastFile
(
  • vastUrl
  • options
)

Defined in src\player\player.js:238

Reads Vast file and seperates its source and options (extensions, type etc)

Parameters:

  • vastUrl String
    • URL address for Vast
  • options Object
    • It stands for this.config.vastOptions

Returns:

}

registerVideoEvents ()

Defined in src\player\player.js:723

Trigger specific events for all videoElement trigger

restart ()

Defined in src\player\player.js:881

Sets currentTime to 0 and plays automatically

seekToTime
(
  • value
)

Defined in src\player\player.js:868

Seek to given time TODO Check device performances if needed use pause method first

Parameters:

  • value Object

seekWithTimeAdd
(
  • value
)

Defined in src\player\player.js:857

Seek with given value adding

Parameters:

  • value Number

sendWebOSDrm ()

Defined in src\player\player.js:568

WebOs Drm trigger

setPlayerInfo () Object

Defined in src\player\player.js:50

Sets this.playerInfo with initial values. This values usefull for later usages For example Vast, device specific, DRM Type etc we are using this object

Returns:

Object:

this.playerInfo

setupWebOSDrm ()

Defined in src\player\player.js:534

Initialize WebOs DRM TODO This can be move to webos device with abstract

stop ()

Defined in src\player\player.js:670

Stop trigger for videoElement it removes video element from dom

togglePlay ()

Defined in src\player\player.js:693

Play/Pause toggle trigger for videoElement

unloadDrmClient ()

Defined in src\player\player.js:509

Unloads DRM client. !IMPORTANT! Some devices may be crash if you are not unloaded drm client

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index