Class Adapter

constructor

• new Adapter(player: THEOplayer): Adapter

  Parameters

  • player: THEOplayer

  Returns Adapter

player

checkReadyState

• checkReadyState(readyState: number, triggeredEvent: string): any

  Check readyState video properties

  Parameters

  • readyState: number
  • triggeredEvent: string

  Returns any

dispose

• dispose(): any

  This function disposes the currend adapter, removes player listeners and drops references.

  Returns any

fireBufferBegin

• fireBufferBegin(
      params?: object,
      convertFromSeek?: boolean,
      triggeredEvent?: string,
      triggeredByStateProperty?: boolean,
  ): any

  Emits related event and set flags if current status is valid. ie: won't sent start if isStarted is already true.

  Parameters

  • Optionalparams: object

    Object of key:value params to add to the request.

  • OptionalconvertFromSeek: boolean

    If true, will convert current seek to buffer.

  • OptionaltriggeredEvent: string
  • OptionaltriggeredByStateProperty: boolean

  Returns any

fireBufferEnd

• fireBufferEnd(params?: object, triggeredEvent?: string): any

  Emits related event and set flags if current status is valid. ie: won't sent start if isStarted is already true.

  Parameters

  • Optionalparams: object

    Object of key:value params to add to the request.

  • OptionaltriggeredEvent: string

  Returns any

fireInit

• fireInit(params?: object, triggeredEvent?: string): any

  Emits related event and set flags if current status is valid. ie: won't sent init if isStarted is already true.

  Parameters

  • Optionalparams: object

    Object of key:value params to add to the request.

  • OptionaltriggeredEvent: string

  Returns any

fireJoin

• fireJoin(params?: object, triggeredEvent?: string): any

  Emits related event and set flags if current status is valid. ie: won't sent start if isStarted is already true.

  Parameters

  • Optionalparams: object

    Object of key:value params to add to the request.

  • OptionaltriggeredEvent: string

  Returns any

firePause

• firePause(params?: object, triggeredEvent?: string): any

  Emits related event and set flags if current status is valid. ie: won't sent start if isStarted is already true.

  Parameters

  • Optionalparams: object

    Object of key:value params to add to the request.

  • OptionaltriggeredEvent: string

  Returns any

fireResume

• fireResume(params?: object, triggeredEvent?: string): any

  Emits related event and set flags if current status is valid. ie: won't sent start if isStarted is already true.

  Parameters

  • Optionalparams: object

    Object of key:value params to add to the request.

  • OptionaltriggeredEvent: string

  Returns any

fireStart

• fireStart(params?: object, triggeredEvent?: string): any

  Emits related event and set flags if current status is valid. ie: won't sent start if isStarted is already true.

  Parameters

  • Optionalparams: object

    Object of key:value params to add to the request.

  • OptionaltriggeredEvent: string

  Returns any

getBitrate

• getBitrate(): number

  Override to return current bitrate

  Returns number

getDuration

• getDuration(): number

  Override to return video duration

  Returns number

getLatency

• getLatency(): number

  Returns number

getPlayerName

• getPlayerName(): string

  Override to return player's name

  Returns string

getPlayerVersion

• getPlayerVersion(): string

  Override to return player version

  Returns string

getPlayhead

• getPlayhead(): number

  Override to return current playhead of the video

  Returns number

getResource

• getResource(): string

  Override to return resource URL.

  Returns string

getTitle

• getTitle(): string

  Override to return title

  Returns string

getTotalBytes

• getTotalBytes(): number

  Override to return total downloaded bytes

  Returns number

getVersion

• getVersion(): string

  Override to return adapter version.

  Returns string

getVideoObject

• getVideoObject(): any

  Override to return video object

  Returns any

monitorPlayhead

• monitorPlayhead(
      monitorBuffers: boolean,
      monitorSeeks: boolean,
      interval?: number,
  ): any

  Creates a new PlayheadMonitor at this.monitor.

  Parameters

  • monitorBuffers: boolean

    If true, it will monitor buffers.

  • monitorSeeks: boolean

    If true, it will monitor seeks.

  • Optionalinterval: number

    The interval time in ms.

  Returns any

monitorReadyState

• monitorReadyState(intervalMilliseconds?: number): any

  Parameters

  • OptionalintervalMilliseconds: number

  Returns any

registerListeners

• registerListeners(): any

  Override to create event binders. It's a good practice when implementing a new Adapter to create intermediate methods and call those when player events are detected instead of just calling the fire* methods. This will allow future users of the Adapter to customize its behaviour by overriding these methods.

  Returns any

  Example

  registerListeners: function () {
   this.player.addEventListener('start', this.onStart.bind(this))
  },
  
  onStart: function (e) {
   this.emit('start')
  }
  Copy

setPlayer

• setPlayer(player: THEOplayer): any

  Sets a new player, removes the old listeners if needed.

  Parameters

  • player: THEOplayer

    Player to be registered.

  Returns any

startReadyStateMonitor

• startReadyStateMonitor(): any

  Start ReadyState monitor

  Returns any

stopMonitor

• stopMonitor(): any

  Returns any

stopReadyStateMonitor

• stopReadyStateMonitor(): any

  Stop ReadyState monitor

  Returns any

unregisterListeners

• unregisterListeners(): any

  Unregister listeners to this.player.

  Returns any