Class VideoControllerInternal

constructor

• new VideoController(
      config: Partial<VideoControllerConfig>,
      videoDomController: VideoDomControllerApi,
  ): VideoController

• Parameters

  • config: Partial<VideoControllerConfig>
  • videoDomController: VideoDomControllerApi

  Returns VideoController

ReadonlyonActiveNamedEventStreamsChange$

ReadonlyonAudioContextChange$

ReadonlyonAudioLoaded$

ReadonlyonAudioPeakProcessorWorkletNodeMessage$

ReadonlyonAudioRouting$

ReadonlyonAudioSwitched$

ReadonlyonAudioWorkletNodeCreated$

ReadonlyonBuffering$

ReadonlyonEnded$

ReadonlyonFullscreenChange$

ReadonlyonHelpMenuChange$

ReadonlyonNamedEvent$

ReadonlyonPause$

ReadonlyonPlay$

ReadonlyonPlaybackRateChange$

ReadonlyonPlaybackState$

ReadonlyonSeeked$

ReadonlyonSeeking$

ReadonlyonSubtitlesCreate$

ReadonlyonSubtitlesHide$

ReadonlyonSubtitlesLoaded$

ReadonlyonSubtitlesRemove$

ReadonlyonSubtitlesShow$

ReadonlyonThumbnailVttUrlChanged$

ReadonlyonVideoError$

ReadonlyonVideoLoaded$

ReadonlyonVideoLoading$

ReadonlyonVideoSafeZoneChange$

ReadonlyonVideoTimeChange$

ReadonlyonVideoWindowPlaybackStateChange$

ReadonlyonVolumeChange$

videoElement

• get videoElement(): HTMLVideoElement

• Returns HTMLVideoElement

addSafeZone

• addSafeZone(videoSafeZone: VideoSafeZone): Observable<VideoSafeZone>

• Adds safe zone area.

  Parameters

  • videoSafeZone: VideoSafeZone

  Returns Observable<VideoSafeZone>

  safe zone id.

appendHelpMenuGroup

• appendHelpMenuGroup(helpMenuGroup: HelpMenuGroup): Observable<void>

• Appends new HelpMenuGroup to video context menu

  Parameters

  • helpMenuGroup: HelpMenuGroup

  Returns Observable<void>

attachVideoWindow

• attachVideoWindow(): Observable<void>

• Attaches back video from detached window

  Returns Observable<void>

calculateFrameToTime

• calculateFrameToTime(frameNumber: number): number

• Parameters

  • frameNumber: number

    Video frame number

  Returns number

  video timestamp in seconds

calculateTimeToFrame

• calculateTimeToFrame(time: number): number

• Parameters

  • time: number

    Video timestamp in seconds

  Returns number

  video frame number

canAttach

• canAttach(): boolean

• Returns boolean

  true if video can be attached, false if not

canDetach

• canDetach(): boolean

• Returns boolean

  true if video can be detached, false if not

clearHelpMenuGroups

• clearHelpMenuGroups(): Observable<void>

• Removes help menu groups

  Returns Observable<void>

clearSafeZones

• clearSafeZones(): Observable<void>

• Clears all added safe zones

  Returns Observable<void>

createAudioContext

• createAudioContext(contextOptions?: AudioContextOptions): Observable<void>

• Parameters

  • OptionalcontextOptions: AudioContextOptions

  Returns Observable<void>

createAudioPeakProcessorWorkletNode

• createAudioPeakProcessorWorkletNode(
      audioMeterStandard: AudioMeterStandard,
  ): Observable<void>

• Parameters

  • audioMeterStandard: AudioMeterStandard

  Returns Observable<void>

createAudioRouter

• createAudioRouter(
      inputsNumber: number,
      outputsNumber?: number,
  ): Observable<void>

• Parameters

  • inputsNumber: number
  • OptionaloutputsNumber: number

  Returns Observable<void>

createAudioRouterWithOutputsResolver

• createAudioRouterWithOutputsResolver(
      inputsNumber: number,
      outputsNumberResolver: (maxChannelCount: number) => number,
  ): Observable<void>

• Parameters

  • inputsNumber: number
  • outputsNumberResolver: (maxChannelCount: number) => number

  Returns Observable<void>

createSubtitlesVttTrack

• createSubtitlesVttTrack(
      subtitlesVttTrack: SubtitlesVttTrack,
  ): Observable<undefined | SubtitlesVttTrack>

• Parameters

  • subtitlesVttTrack: SubtitlesVttTrack

  Returns Observable<undefined | SubtitlesVttTrack>

destroy

• destroy(): void

• Returns void

destroyAudioPeakProcessorWorkletNode

• destroyAudioPeakProcessorWorkletNode(): void

• Returns void

detachVideoWindow

• detachVideoWindow(): Observable<void>

• Detaches video to new window

  Returns Observable<void>

disablePiP

• disablePiP(): Observable<void>

• Disables picture in picture mode

  Returns Observable<void>

dispatchVideoTimeChange

• dispatchVideoTimeChange(): void

• Returns void

enablePiP

• enablePiP(): Observable<void>

• Enables picture in picture mode

  Returns Observable<void>

formatToTimecode

• formatToTimecode(time: number): string

• Formats video timestamp to HH:MM:SS:FF

  Parameters

  • time: number

    Video media time in seconds

  Returns string

getActiveAudioTrack

• getActiveAudioTrack(): undefined | OmakaseAudioTrack

• Returns undefined | OmakaseAudioTrack

  current active audio track

getActiveNamedEventStreams

• getActiveNamedEventStreams(): OmpNamedEvents[]

• Returns OmpNamedEvents[]

  Event names for events streamed through onNamedEvent$

getActiveSubtitlesTrack

• getActiveSubtitlesTrack(): undefined | SubtitlesVttTrack

• Returns undefined | SubtitlesVttTrack

getAudioContext

• getAudioContext(): undefined | AudioContext

• Returns undefined | AudioContext

getAudioInputOutputNodes

• getAudioInputOutputNodes(): AudioInputOutputNode[][]

• Returns AudioInputOutputNode[][]

getAudioPeakProcessorWorkletNode

• getAudioPeakProcessorWorkletNode(): undefined | AudioWorkletNode

• Returns undefined | AudioWorkletNode

getAudioTracks

• getAudioTracks(): OmakaseAudioTrack[]

• Returns OmakaseAudioTrack[]

  available audio tracks

getBufferedTimespans

• getBufferedTimespans(): BufferedTimespan[]

• Returns BufferedTimespan[]

getConfig

• getConfig(): VideoControllerConfig

• Returns VideoControllerConfig

getCurrentFrame

• getCurrentFrame(): number

• Returns number

  current frame number

getCurrentTime

• getCurrentTime(): number

• Returns number

  video current time in seconds

getCurrentTimecode

• getCurrentTimecode(): string

• Returns string

  video current timecode

getDuration

• getDuration(): number

• return Video duration in seconds

  Returns number

getFrameRate

• getFrameRate(): number

• Returns number

  video frame rate provided in loadVideo method

getHelpMenuGroups

• getHelpMenuGroups(): HelpMenuGroup[]

• Returns HelpMenuGroup[]

  available HelpMenuGroup's

getHls

• getHls(): undefined | Hls

• Returns undefined | Hls

  Hls (hls.js) instance if video is loaded, otherwise undefined

getHTMLAudioUtilElement

• getHTMLAudioUtilElement(): HTMLAudioElement

• Returns HTMLAudioElement

getHTMLVideoElement

• getHTMLVideoElement(): HTMLVideoElement

• Returns HTMLVideoElement

  HTML

getMediaElementAudioSourceNode

• getMediaElementAudioSourceNode(): undefined | MediaElementAudioSourceNode

• Returns undefined | MediaElementAudioSourceNode

getPlaybackRate

• getPlaybackRate(): number

• Returns number

  video playback rate

getPlaybackState

• getPlaybackState(): undefined | PlaybackState

• Returns undefined | PlaybackState

getSafeZones

• getSafeZones(): VideoSafeZone[]

• Returns VideoSafeZone[]

  video safe zones

getSubtitlesTracks

• getSubtitlesTracks(): SubtitlesVttTrack[]

• Returns SubtitlesVttTrack[]

getThumbnailVttUrl

• getThumbnailVttUrl(): undefined | string

• Returns undefined | string

getTotalFrames

• getTotalFrames(): number

• Returns number

  total number of frames in video

getVideo

• getVideo(): undefined | Video

• Returns undefined | Video

  Video object that holds loaded video properties

getVideoLoadOptions

• getVideoLoadOptions(): undefined | VideoLoadOptions

• Returns undefined | VideoLoadOptions

  VideoLoadOptions object used in loadVideo method

getVideoWindowPlaybackState

• getVideoWindowPlaybackState(): VideoWindowPlaybackState

• Returns VideoWindowPlaybackState

  VideoWindowPlaybackState

getVolume

• getVolume(): number

• Returns number

  current volume level

hideSubtitlesTrack

• hideSubtitlesTrack(id: string): Observable<void>

• Parameters

  • id: string

  Returns Observable<void>

isDetachable

• isDetachable(): boolean

• Returns boolean

  true if player is detachable

isFullscreen

• isFullscreen(): boolean

• Indicates if video is in fullscreen mode

  Returns boolean

isMuted

• isMuted(): boolean

• Returns boolean

  is video muted

isPaused

• isPaused(): boolean

• Indicates if video is paused

  Returns boolean

isPlaying

• isPlaying(): boolean

• Indicates if video is playing

  Returns boolean

isSeeking

• isSeeking(): boolean

• Indicates if video is seeking

  Returns boolean

isVideoLoaded

• isVideoLoaded(): boolean

• Indicates if video is loaded or not

  Returns boolean

loadBlackVideo

• loadBlackVideo(): Observable<Video>

• Loads black MP4 video

  Returns Observable<Video>

loadThumbnailVttUrl

• loadThumbnailVttUrl(thumbnailVttUrl: string): Observable<void>

• Parameters

  • thumbnailVttUrl: string

  Returns Observable<void>

loadVideo

• loadVideo(
      sourceUrl: string,
      frameRate: string | number,
      options?: VideoLoadOptions,
  ): Observable<Video>

• Loads new video

  Parameters

  • sourceUrl: string

    Video manifest URL
  • frameRate: string | number

    Video frame rate
  • Optionaloptions: VideoLoadOptions

  Returns Observable<Video>

loadVideoInternal

• loadVideoInternal(
      sourceUrl: string,
      frameRate: string | number,
      options: undefined | VideoLoadOptions,
      optionsInternal?: VideoLoadOptionsInternal,
  ): Observable<Video>

• Parameters

  • sourceUrl: string
  • frameRate: string | number
  • options: undefined | VideoLoadOptions
  • OptionaloptionsInternal: VideoLoadOptionsInternal

  Returns Observable<Video>

mute

• mute(): Observable<void>

• Video mute

  Returns Observable<void>

parseTimecodeToFrame

• parseTimecodeToFrame(timecode: string): number

• Converts timestamp in format HH:MM:SS:FF to frame

  Parameters

  • timecode: string

  Returns number

parseTimecodeToTime

• parseTimecodeToTime(timecode: string): number

• Converts timestamp in format HH:MM:SS:FF to time in seconds

  Parameters

  • timecode: string

  Returns number

pause

• pause(): Observable<void>

• Pauses video playback

  Returns Observable<void>

play

• play(): Observable<void>

• Starts video playback

  Returns Observable<void>

  Observable when play started

prependHelpMenuGroup

• prependHelpMenuGroup(helpMenuGroup: HelpMenuGroup): Observable<void>

• Appends new HelpMenuGroup to video context menu

  Parameters

  • helpMenuGroup: HelpMenuGroup

  Returns Observable<void>

reloadVideo

• reloadVideo(): Observable<Video>

• Reloads video

  Returns Observable<Video>

removeAllSubtitlesTracks

• removeAllSubtitlesTracks(): Observable<void>

• Returns Observable<void>

removeSafeZone

• removeSafeZone(id: string): Observable<void>

• Removes safe zone area

  Parameters

  • id: string

  Returns Observable<void>

removeSubtitlesTrack

• removeSubtitlesTrack(id: string): Observable<void>

• Parameters

  • id: string

  Returns Observable<void>

routeAudioInputOutputNode

• routeAudioInputOutputNode(
      newAudioInputOutputNode: AudioInputOutputNode,
  ): Observable<void>

• Parameters

  • newAudioInputOutputNode: AudioInputOutputNode

  Returns Observable<void>

routeAudioInputOutputNodes

• routeAudioInputOutputNodes(
      newAudioInputOutputNodes: AudioInputOutputNode[],
  ): Observable<void>

• Parameters

  • newAudioInputOutputNodes: AudioInputOutputNode[]

  Returns Observable<void>

seekFromCurrentFrame

• seekFromCurrentFrame(framesCount: number): Observable<boolean>

• Seeks to video frame offsetted by provided framesCount. Video must be in non-playing mode.

  Parameters

  • framesCount: number

    Positive (seek forward) or negative (seek backward) integer

  Returns Observable<boolean>

seekFromCurrentTime

• seekFromCurrentTime(timeAmount: number): Observable<boolean>

• Seeks to video time offsetted by provided timeAmount. Video must be in non-playing mode.

  Parameters

  • timeAmount: number

    Positive (seek forward) or negative (seek backward) integer

  Returns Observable<boolean>

seekNextFrame

• seekNextFrame(): Observable<boolean>

• Seeks to next video frame

  Returns Observable<boolean>

seekPreviousFrame

• seekPreviousFrame(): Observable<boolean>

• Seeks to previous video frame

  Returns Observable<boolean>

seekToFrame

• seekToFrame(frame: number): Observable<boolean>

• Seeks to particular video frame. Video must be in non-playing mode.

  Parameters

  • frame: number

    Video frame number

  Returns Observable<boolean>

seekToPercent

• seekToPercent(percent: number): Observable<boolean>

• Seeks to timeline location

  Parameters

  • percent: number

  Returns Observable<boolean>

seekToTime

• seekToTime(time: number): Observable<boolean>

• Seeks to video timestamp

  Parameters

  • time: number

    Video timestamp in seconds

  Returns Observable<boolean>

seekToTimecode

• seekToTimecode(timecode: string): Observable<boolean>

• Seeks to video timestamp

  Parameters

  • timecode: string

    Video timestamp in HH:MM:SS:FF format

  Returns Observable<boolean>

setActiveAudioTrack

• setActiveAudioTrack(id: string): Observable<void>

• Sets active audio track

  Parameters

  • id: string

    OmakaseAudioTrack id

  Returns Observable<void>

setPlaybackRate

• setPlaybackRate(playbackRate: number): Observable<void>

• Sets video playback rate

  Parameters

  • playbackRate: number

    Decimal value between [0.1, 16]. For example, if provided value is "2", video playback rate will be 2x of normal playback rate

  Returns Observable<void>

setVolume

• setVolume(volume: number): Observable<void>

• Sets volume level

  Parameters

  • volume: number

    Decimal value between [0, 1]

  Returns Observable<void>

showSubtitlesTrack

• showSubtitlesTrack(id: string): Observable<void>

• Parameters

  • id: string

  Returns Observable<void>

toggleFullscreen

• toggleFullscreen(): Observable<void>

• Toggles video fullscreen mode

  Returns Observable<void>

toggleMuteUnmute

• toggleMuteUnmute(): Observable<void>

• Toggles mute / unmute

  Returns Observable<void>

togglePlayPause

• togglePlayPause(): Observable<void>

• Toggles video play and pause

  Returns Observable<void>

unmute

• unmute(): Observable<void>

• Video unmute

  Returns Observable<void>

updateActiveNamedEventStreams

• updateActiveNamedEventStreams(eventNames: OmpNamedEvents[]): Observable<void>

• Opens event stream for each provided event name in eventNames subscribable in onNamedEvent$. Deactivates all other event streams.

  Parameters

  • eventNames: OmpNamedEvents[]

    Event name

  Returns Observable<void>