Class VideoController`Internal`

Implements

VideoControllerApi

Index

Constructors

Accessors

Methods

_exportMainAudioTrackToSidecar activateSidecarAudioTracks addSafeZone appendHelpMenuGroup attachVideoWindow calculateFrameToTime calculateTimeToFrame canAttach canDetach clearHelpMenuGroups clearSafeZones createMainAudioPeakProcessor createMainAudioRouter createMainAudioRouterWithOutputsResolver createSidecarAudioPeakProcessor createSidecarAudioRouter createSidecarAudioTrack createSidecarAudioTracks createSubtitlesVttTrack deactivateSidecarAudioTracks destroy detachVideoWindow disablePiP dispatchVideoTimeChange enablePiP exportMainAudioTracksToSidecar exportMainAudioTrackToSidecar formatToTimecode formatToTimecodeDecimal getActiveAudioTrack getActiveNamedEventStreams getActiveSidecarAudioTracks getActiveSubtitlesTrack getAudioContext getAudioTracks getBufferedTimespans getConfig getCurrentFrame getCurrentTime getCurrentTimecode getDuration getFrameRate getHelpMenuGroups getHls getHTMLVideoElement getMainAudioRouter getMainAudioSourceNode getMainAudioState getPlaybackRate getPlaybackState getSafeZones getSidecarAudio getSidecarAudios getSidecarAudioStates getSidecarAudioTracks getSubtitlesTracks getThumbnailVttUrl getTotalFrames getVideo getVideoLoadOptions getVideoWindowPlaybackState getVolume hideSubtitlesTrack isDetachable isFullscreen isMuted isPaused isPiPSupported isPlaying isSeeking isVideoLoaded loadBlackVideo loadThumbnailVttUrl loadVideo loadVideoInternal mute parseTimecodeToFrame parseTimecodeToTime parseTimecodeToTimeDecimal pause play prependHelpMenuGroup reloadVideo removeAllSidecarAudioTracks removeAllSubtitlesTracks removeSafeZone removeSidecarAudioTracks removeSubtitlesTrack routeMainAudioRouterNodes routeSidecarAudioRouterNodes seekFromCurrentFrame seekFromCurrentTime seekNextFrame seekPreviousFrame seekToEnd seekToFrame seekToPercent seekToTime seekToTimecode setActiveAudioTrack setPlaybackRate setVolume showSubtitlesTrack toggleFullscreen toggleMuteUnmute togglePlayPause unmute updateActiveNamedEventStreams

Constructors

constructor

new VideoController(
config: Partial<VideoControllerConfig>,
videoDomController: VideoDomControllerApi,
): VideoController
Parameters
- config: Partial<VideoControllerConfig>
- videoDomController: VideoDomControllerApi
Returns VideoController
- Defined in project/src/video/video-controller.ts:268

Properties

`Readonly`onActiveNamedEventStreamsChange$

onActiveNamedEventStreamsChange$: Subject<OmpNamedEventEventName[]> = ...

`Readonly`onAudioLoaded$

onAudioLoaded$: BehaviorSubject<undefined | AudioLoadedEvent> = ...

`Readonly`onAudioSwitched$

onAudioSwitched$: Subject<AudioSwitchedEvent> = ...

`Readonly`onBuffering$

onBuffering$: Subject<VideoBufferingEvent> = ...

Fires on video buffering

`Readonly`onDurationChange$

onDurationChange$: Subject<VideoDurationEvent> = ...

`Readonly`onEnded$

onEnded$: Subject<VideoEndedEvent> = ...

Fires on video end

`Readonly`onFullscreenChange$

onFullscreenChange$: Subject<VideoFullscreenChangeEvent> = ...

Fires on fullscreen change

`Readonly`onHelpMenuChange$

onHelpMenuChange$: Subject<VideoHelpMenuChangeEvent> = ...

`Readonly`onMainAudioChange$

onMainAudioChange$: BehaviorSubject<undefined | MainAudioChangeEvent> = ...

`Readonly`onMainAudioPeakProcessorMessage$

onMainAudioPeakProcessorMessage$: Subject<AudioPeakProcessorMessageEvent> = ...

`Readonly`onNamedEvent$

onNamedEvent$: Subject<OmpNamedEvent> = ...

Fires on event which has active stream (see updateActiveNamedEventStreams

`Readonly`onPause$

onPause$: Subject<VideoPlayEvent> = ...

Fires on video pause

`Readonly`onPlay$

onPlay$: Subject<VideoPlayEvent> = ...

Fires on video play

`Readonly`onPlaybackRateChange$

onPlaybackRateChange$: Subject<VideoPlaybackRateEvent> = ...

Fires on playback rate change

`Readonly`onPlaybackState$

onPlaybackState$: Subject<PlaybackState> = ...

`Readonly`onSeeked$

onSeeked$: Subject<VideoSeekedEvent> = ...

Fires on video seeked

`Readonly`onSeeking$

onSeeking$: Subject<VideoSeekingEvent> = ...

Fires on video seeking

`Readonly`onSidecarAudioChange$

onSidecarAudioChange$: Subject<SidecarAudioChangeEvent> = ...

`Readonly`onSidecarAudioCreate$

onSidecarAudioCreate$: Subject<SidecarAudioCreateEvent> = ...

`Readonly`onSidecarAudioPeakProcessorMessage$

onSidecarAudioPeakProcessorMessage$: Subject<
SidecarAudioPeakProcessorMessageEvent,
> = ...

`Readonly`onSidecarAudioRemove$

onSidecarAudioRemove$: Subject<SidecarAudioRemoveEvent> = ...

`Readonly`onSubtitlesCreate$

onSubtitlesCreate$: Subject<SubtitlesCreateEvent> = ...

`Readonly`onSubtitlesHide$

onSubtitlesHide$: Subject<SubtitlesEvent> = ...

`Readonly`onSubtitlesLoaded$

onSubtitlesLoaded$: BehaviorSubject<undefined | SubtitlesLoadedEvent> = ...

`Readonly`onSubtitlesRemove$

onSubtitlesRemove$: Subject<SubtitlesEvent> = ...

`Readonly`onSubtitlesShow$

onSubtitlesShow$: Subject<SubtitlesEvent> = ...

`Readonly`onSyncTick$

onSyncTick$: Subject<SyncTickEvent> = ...

`Readonly`onThumbnailVttUrlChanged$

onThumbnailVttUrlChanged$: Subject<ThumnbailVttUrlChangedEvent> = ...

`Readonly`onVideoError$

onVideoError$: Subject<VideoErrorEvent> = ...

Fires on if error occurs on video load

`Readonly`onVideoLoaded$

onVideoLoaded$: BehaviorSubject<undefined | VideoLoadedEvent> = ...

Fires on video load. Initial value is undefined. Always emits the current value on subscription.

`Readonly`onVideoLoading$

onVideoLoading$: Subject<VideoLoadingEvent> = ...

Fires on video load start.

`Readonly`onVideoSafeZoneChange$

onVideoSafeZoneChange$: Subject<VideoSafeZoneChangeEvent> = ...

Fires on video safe zone change

`Readonly`onVideoTimeChange$

onVideoTimeChange$: Subject<VideoTimeChangeEvent> = ...

Fires on video time change

`Readonly`onVideoWindowPlaybackStateChange$

onVideoWindowPlaybackStateChange$: Subject<VideoWindowPlaybackStateChangeEvent> = ...

Fires on video window playback state change

`Readonly`onVolumeChange$

onVolumeChange$: Subject<VideoVolumeEvent> = ...

Fires on volume change

Accessors

videoElement

get videoElement(): HTMLVideoElement
Returns HTMLVideoElement
- Defined in project/src/video/video-controller.ts:531

Methods

_exportMainAudioTrackToSidecar

_exportMainAudioTrackToSidecar(
mainAudioTrackId: string,
): Observable<OmpAudioTrack>
Parameters
- mainAudioTrackId: string
Returns Observable<OmpAudioTrack>
- Defined in project/src/video/video-controller.ts:2595

activateSidecarAudioTracks

activateSidecarAudioTracks(
ids: string[],
deactivateOthers?: boolean,
): Observable<void>
Parameters
- ids: string[]
- OptionaldeactivateOthers: boolean
Returns Observable<void>
Implementation of VideoControllerApi.activateSidecarAudioTracks
- Defined in project/src/video/video-controller.ts:2468

addSafeZone

addSafeZone(videoSafeZone: VideoSafeZone): Observable<VideoSafeZone>
Adds safe zone area.
Parameters
- videoSafeZone: VideoSafeZone
Returns Observable<VideoSafeZone>
safe zone id.
Implementation of VideoControllerApi.addSafeZone
- Defined in project/src/video/video-controller.ts:1835

appendHelpMenuGroup

appendHelpMenuGroup(helpMenuGroup: HelpMenuGroup): Observable<void>
Appends new HelpMenuGroup to video context menu
Parameters
- helpMenuGroup: HelpMenuGroup
Returns Observable<void>
Implementation of VideoControllerApi.appendHelpMenuGroup
- Defined in project/src/video/video-controller.ts:1801

attachVideoWindow

attachVideoWindow(): Observable<void>
Attaches back video from detached window

Returns Observable<void>
Implementation of VideoControllerApi.attachVideoWindow
- Defined in project/src/video/video-controller.ts:1871

calculateFrameToTime

calculateFrameToTime(frameNumber: number): number
Parameters
- frameNumber: number
  Video frame number
Returns number
video timestamp in seconds
Implementation of VideoControllerApi.calculateFrameToTime
- Defined in project/src/video/video-controller.ts:1356

calculateTimeToFrame

calculateTimeToFrame(time: number): number
Parameters
- time: number
  Video timestamp in seconds
Returns number
video frame number
Implementation of VideoControllerApi.calculateTimeToFrame
- Defined in project/src/video/video-controller.ts:1351

canAttach

canAttach(): boolean
Returns boolean
true if video can be attached, false if not
Implementation of VideoControllerApi.canAttach
- Defined in project/src/video/video-controller.ts:1859

canDetach

canDetach(): boolean
Returns boolean
true if video can be detached, false if not
Implementation of VideoControllerApi.canDetach
- Defined in project/src/video/video-controller.ts:1855

clearHelpMenuGroups

clearHelpMenuGroups(): Observable<void>
Removes help menu groups

Returns Observable<void>
Implementation of VideoControllerApi.clearHelpMenuGroups
- Defined in project/src/video/video-controller.ts:1821

clearSafeZones

clearSafeZones(): Observable<void>
Clears all added safe zones

Returns Observable<void>
Implementation of VideoControllerApi.clearSafeZones
- Defined in project/src/video/video-controller.ts:1843

createMainAudioPeakProcessor

createMainAudioPeakProcessor(
audioMeterStandard?: AudioMeterStandard,
): Observable<Observable<AudioPeakProcessorMessageEvent>>
Parameters
- OptionalaudioMeterStandard: AudioMeterStandard
Returns Observable<Observable<AudioPeakProcessorMessageEvent>>
Implementation of VideoControllerApi.createMainAudioPeakProcessor
- Defined in project/src/video/video-controller.ts:2188

createMainAudioRouter

createMainAudioRouter(
inputsNumber: number,
outputsNumber?: number,
): Observable<OmpAudioRouterState>
Parameters
- inputsNumber: number
- OptionaloutputsNumber: number
Returns Observable<OmpAudioRouterState>
Implementation of VideoControllerApi.createMainAudioRouter
- Defined in project/src/video/video-controller.ts:2122

createMainAudioRouterWithOutputsResolver

createMainAudioRouterWithOutputsResolver(
inputsNumber: number,
outputsNumberResolver: (maxChannelCount: number) => number,
): Observable<OmpAudioRouterState>
Parameters
- inputsNumber: number
- outputsNumberResolver: (maxChannelCount: number) => number
Returns Observable<OmpAudioRouterState>
Implementation of VideoControllerApi.createMainAudioRouterWithOutputsResolver
- Defined in project/src/video/video-controller.ts:2150

createSidecarAudioPeakProcessor

createSidecarAudioPeakProcessor(
sidecarAudioTrackId: string,
audioMeterStandard?: AudioMeterStandard,
): Observable<Observable<AudioPeakProcessorMessageEvent>>
Parameters
- sidecarAudioTrackId: string
- OptionalaudioMeterStandard: AudioMeterStandard
Returns Observable<Observable<AudioPeakProcessorMessageEvent>>
Implementation of VideoControllerApi.createSidecarAudioPeakProcessor
- Defined in project/src/video/video-controller.ts:2514

createSidecarAudioRouter

createSidecarAudioRouter(
    sidecarAudioTrackId: string,
    inputsNumber?: number,
    outputsNumber?: number,
): Observable<OmpAudioRouterState>
Parameters
- sidecarAudioTrackId: string
- OptionalinputsNumber: number
- OptionaloutputsNumber: number
Returns Observable<OmpAudioRouterState>
Implementation of VideoControllerApi.createSidecarAudioRouter
- Defined in project/src/video/video-controller.ts:2489

createSidecarAudioTrack

createSidecarAudioTrack(
track: Partial<OmpAudioTrack>,
): Observable<OmpAudioTrack>
Parameters
- track: Partial<OmpAudioTrack>
Returns Observable<OmpAudioTrack>
Implementation of VideoControllerApi.createSidecarAudioTrack
- Defined in project/src/video/video-controller.ts:2322

createSidecarAudioTracks

createSidecarAudioTracks(
tracks: Partial<OmpAudioTrack>[],
): Observable<OmpAudioTrack[]>
Parameters
- tracks: Partial<OmpAudioTrack>[]
Returns Observable<OmpAudioTrack[]>
Implementation of VideoControllerApi.createSidecarAudioTracks
- Defined in project/src/video/video-controller.ts:2336

createSubtitlesVttTrack

createSubtitlesVttTrack(
subtitlesVttTrack: SubtitlesVttTrack,
): Observable<undefined | SubtitlesVttTrack>
Parameters
- subtitlesVttTrack: SubtitlesVttTrack
Returns Observable<undefined | SubtitlesVttTrack>
Implementation of VideoControllerApi.createSubtitlesVttTrack
- Defined in project/src/video/video-controller.ts:1930

deactivateSidecarAudioTracks

deactivateSidecarAudioTracks(ids: string[]): Observable<void>
Parameters
- ids: string[]
Returns Observable<void>
Implementation of VideoControllerApi.deactivateSidecarAudioTracks
- Defined in project/src/video/video-controller.ts:2482

destroy

destroy(): void
Returns void
Implementation of VideoControllerApi.destroy
- Defined in project/src/video/video-controller.ts:2622

detachVideoWindow

detachVideoWindow(): Observable<void>
Detaches video to new window

Returns Observable<void>
Implementation of VideoControllerApi.detachVideoWindow
- Defined in project/src/video/video-controller.ts:1867

disablePiP

disablePiP(): Observable<void>
Disables picture in picture mode

Returns Observable<void>
Implementation of VideoControllerApi.disablePiP
- Defined in project/src/video/video-controller.ts:1894

dispatchVideoTimeChange

dispatchVideoTimeChange(): void
Returns void
- Defined in project/src/video/video-controller.ts:1319

enablePiP

enablePiP(): Observable<void>
Enables picture in picture mode

Returns Observable<void>
Implementation of VideoControllerApi.enablePiP
- Defined in project/src/video/video-controller.ts:1879

exportMainAudioTracksToSidecar

exportMainAudioTracksToSidecar(
mainAudioTrackIds: string[],
): Observable<OmpAudioTrack[]>
Parameters
- mainAudioTrackIds: string[]
Returns Observable<OmpAudioTrack[]>
Implementation of VideoControllerApi.exportMainAudioTracksToSidecar
- Defined in project/src/video/video-controller.ts:2561

exportMainAudioTrackToSidecar

exportMainAudioTrackToSidecar(
mainAudioTrackId: string,
): Observable<OmpAudioTrack>
Parameters
- mainAudioTrackId: string
Returns Observable<OmpAudioTrack>
Implementation of VideoControllerApi.exportMainAudioTrackToSidecar
- Defined in project/src/video/video-controller.ts:2581

formatToTimecode

formatToTimecode(time: number): string
Formats video timestamp to HH:MM:SS:FF
Parameters
- time: number
  Video media time in seconds
Returns string
Implementation of VideoControllerApi.formatToTimecode
- Defined in project/src/video/video-controller.ts:1664

formatToTimecodeDecimal

formatToTimecodeDecimal(time: Decimal): string
Parameters
- time: Decimal
Returns string
- Defined in project/src/video/video-controller.ts:1670

getActiveAudioTrack

getActiveAudioTrack(): undefined | OmpAudioTrack
Returns undefined | OmpAudioTrack
current active audio track
Implementation of VideoControllerApi.getActiveAudioTrack
- Defined in project/src/video/video-controller.ts:1753

getAudioContext

getAudioContext(): AudioContext
Returns AudioContext
Implementation of VideoControllerApi.getAudioContext
- Defined in project/src/video/video-controller.ts:2102

getAudioTracks

getAudioTracks(): OmpAudioTrack[]
Returns OmpAudioTrack[]
available audio tracks
Implementation of VideoControllerApi.getAudioTracks
- Defined in project/src/video/video-controller.ts:1757

getBufferedTimespans

getBufferedTimespans(): BufferedTimespan[]
Returns BufferedTimespan[]
Implementation of VideoControllerApi.getBufferedTimespans
- Defined in project/src/video/video-controller.ts:710

getConfig

getConfig(): VideoControllerConfig
Returns VideoControllerConfig
Implementation of VideoControllerApi.getConfig
- Defined in project/src/video/video-controller.ts:2280

getCurrentFrame

getCurrentFrame(): number
Returns number
current frame number
Implementation of VideoControllerApi.getCurrentFrame
- Defined in project/src/video/video-controller.ts:1537

getCurrentTime

getCurrentTime(): number
Returns number
video current time in seconds
Implementation of VideoControllerApi.getCurrentTime
- Defined in project/src/video/video-controller.ts:1451

getCurrentTimecode

getCurrentTimecode(): string
Returns string
video current timecode
Implementation of VideoControllerApi.getCurrentTimecode
- Defined in project/src/video/video-controller.ts:1455

getDuration

getDuration(): number
return Video duration in seconds

Returns number
Implementation of VideoControllerApi.getDuration
- Defined in project/src/video/video-controller.ts:1519

getFrameRate

getFrameRate(): number
Returns number
video frame rate provided in loadVideo method
Implementation of VideoControllerApi.getFrameRate
- Defined in project/src/video/video-controller.ts:1525

getHelpMenuGroups

getHelpMenuGroups(): HelpMenuGroup[]
Returns HelpMenuGroup[]
available HelpMenuGroup's
Implementation of VideoControllerApi.getHelpMenuGroups
- Defined in project/src/video/video-controller.ts:1831

getHls

getHls(): undefined | Hls
Returns undefined | Hls
Hls (hls.js) instance if video is loaded, otherwise undefined
Implementation of VideoControllerApi.getHls
- Defined in project/src/video/video-controller.ts:2284

getHTMLVideoElement

getHTMLVideoElement(): HTMLVideoElement
Returns HTMLVideoElement
HTML
Implementation of VideoControllerApi.getHTMLVideoElement
- Defined in project/src/video/video-controller.ts:1347

getMainAudioRouter

getMainAudioRouter(): undefined | OmpAudioRouter
Returns undefined | OmpAudioRouter
Implementation of VideoControllerApi.getMainAudioRouter
- Defined in project/src/video/video-controller.ts:2118

getMainAudioSourceNode

getMainAudioSourceNode(): AudioNode
Returns AudioNode
Implementation of VideoControllerApi.getMainAudioSourceNode
- Defined in project/src/video/video-controller.ts:2106

getMainAudioState

getMainAudioState(): undefined | OmpMainAudioState
Returns undefined | OmpMainAudioState
Implementation of VideoControllerApi.getMainAudioState
- Defined in project/src/video/video-controller.ts:2110

getPlaybackRate

getPlaybackRate(): number
Returns number
video playback rate
Implementation of VideoControllerApi.getPlaybackRate
- Defined in project/src/video/video-controller.ts:1459

getPlaybackState

getPlaybackState(): undefined | PlaybackState
Returns undefined | PlaybackState
Implementation of VideoControllerApi.getPlaybackState
- Defined in project/src/video/video-controller.ts:1335

getSafeZones

getSafeZones(): VideoSafeZone[]
Returns VideoSafeZone[]
video safe zones
Implementation of VideoControllerApi.getSafeZones
- Defined in project/src/video/video-controller.ts:1847

getSidecarAudio

getSidecarAudio(id: string): undefined | SidecarAudioApi
Parameters
- id: string
Returns undefined | SidecarAudioApi
Implementation of VideoControllerApi.getSidecarAudio
- Defined in project/src/video/video-controller.ts:2314

getSidecarAudios

getSidecarAudios(): SidecarAudioApi[]
Returns SidecarAudioApi[]
Implementation of VideoControllerApi.getSidecarAudios
- Defined in project/src/video/video-controller.ts:2310

getSidecarAudioStates

getSidecarAudioStates(): OmpSidecarAudioState[]
Returns OmpSidecarAudioState[]
Implementation of VideoControllerApi.getSidecarAudioStates
- Defined in project/src/video/video-controller.ts:2318

getSidecarAudioTracks

getSidecarAudioTracks(): OmpAudioTrack[]
Returns OmpAudioTrack[]
Implementation of VideoControllerApi.getSidecarAudioTracks
- Defined in project/src/video/video-controller.ts:2460

getSubtitlesTracks

getSubtitlesTracks(): SubtitlesVttTrack[]
Returns SubtitlesVttTrack[]
Implementation of VideoControllerApi.getSubtitlesTracks
- Defined in project/src/video/video-controller.ts:1969

getThumbnailVttUrl

getThumbnailVttUrl(): undefined | string
Returns undefined | string
Implementation of VideoControllerApi.getThumbnailVttUrl
- Defined in project/src/video/video-controller.ts:2267

getTotalFrames

getTotalFrames(): number
Returns number
total number of frames in video
Implementation of VideoControllerApi.getTotalFrames
- Defined in project/src/video/video-controller.ts:1531

getVideo

getVideo(): undefined | Video
Returns undefined | Video
Video object that holds loaded video properties
Implementation of VideoControllerApi.getVideo
- Defined in project/src/video/video-controller.ts:1339

getVideoLoadOptions

getVideoLoadOptions(): undefined | VideoLoadOptions
Returns undefined | VideoLoadOptions
VideoLoadOptions object used in loadVideo method
Implementation of VideoControllerApi.getVideoLoadOptions
- Defined in project/src/video/video-controller.ts:1343

getVideoWindowPlaybackState

getVideoWindowPlaybackState(): VideoWindowPlaybackState
Returns VideoWindowPlaybackState
VideoWindowPlaybackState
Implementation of VideoControllerApi.getVideoWindowPlaybackState
- Defined in project/src/video/video-controller.ts:1863

getVolume

getVolume(): number
Returns number
current volume level
Implementation of VideoControllerApi.getVolume
- Defined in project/src/video/video-controller.ts:1491

hideSubtitlesTrack

hideSubtitlesTrack(id: string): Observable<void>
Parameters
- id: string
Returns Observable<void>
Implementation of VideoControllerApi.hideSubtitlesTrack
- Defined in project/src/video/video-controller.ts:2045

isDetachable

isDetachable(): boolean
Returns boolean
true if player is detachable
Implementation of VideoControllerApi.isDetachable
- Defined in project/src/video/video-controller.ts:1851

isFullscreen

isFullscreen(): boolean
Indicates if video is in fullscreen mode

Returns boolean
Implementation of VideoControllerApi.isFullscreen
- Defined in project/src/video/video-controller.ts:1719

isMuted

isMuted(): boolean
Returns boolean
is video muted
Implementation of VideoControllerApi.isMuted
- Defined in project/src/video/video-controller.ts:1711

isPaused

isPaused(): boolean
Indicates if video is paused

Returns boolean
Implementation of VideoControllerApi.isPaused
- Defined in project/src/video/video-controller.ts:1443

isPiPSupported

isPiPSupported(): boolean
Returns boolean
Implementation of VideoControllerApi.isPiPSupported
- Defined in project/src/video/video-controller.ts:1875

isPlaying

isPlaying(): boolean
Indicates if video is playing

Returns boolean
Implementation of VideoControllerApi.isPlaying
- Defined in project/src/video/video-controller.ts:1432

isSeeking

isSeeking(): boolean
Indicates if video is seeking

Returns boolean
Implementation of VideoControllerApi.isSeeking
- Defined in project/src/video/video-controller.ts:1447

isVideoLoaded

isVideoLoaded(): boolean
Indicates if video is loaded or not

Returns boolean
Implementation of VideoControllerApi.isVideoLoaded
- Defined in project/src/video/video-controller.ts:1797

loadBlackVideo

loadBlackVideo(): Observable<Video>
Loads black MP4 video

Returns Observable<Video>
Implementation of VideoControllerApi.loadBlackVideo
- Defined in project/src/video/video-controller.ts:2304

loadThumbnailVttUrl

loadThumbnailVttUrl(thumbnailVttUrl: string): Observable<void>
Parameters
- thumbnailVttUrl: string
Returns Observable<void>
Implementation of VideoControllerApi.loadThumbnailVttUrl
- Defined in project/src/video/video-controller.ts:2271

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>
Implementation of VideoControllerApi.loadVideo
- Defined in project/src/video/video-controller.ts:521

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>
Implementation of VideoControllerApi.loadVideoInternal
- Defined in project/src/video/video-controller.ts:299

mute

mute(): Observable<void>
Video mute

Returns Observable<void>
Implementation of VideoControllerApi.mute
- Defined in project/src/video/video-controller.ts:1693

parseTimecodeToFrame

parseTimecodeToFrame(timecode: string): number
Converts timestamp in format HH:MM:SS:FF to frame
Parameters
- timecode: string
Returns number
Implementation of VideoControllerApi.parseTimecodeToFrame
- Defined in project/src/video/video-controller.ts:1675

parseTimecodeToTime

parseTimecodeToTime(timecode: string): number
Converts timestamp in format HH:MM:SS:FF to time in seconds
Parameters
- timecode: string
Returns number
Implementation of VideoControllerApi.parseTimecodeToTime
- Defined in project/src/video/video-controller.ts:1681

parseTimecodeToTimeDecimal

parseTimecodeToTimeDecimal(timecode: string): Decimal
Parameters
- timecode: string
Returns Decimal
- Defined in project/src/video/video-controller.ts:1687

pause

pause(): Observable<void>
Pauses video playback

Returns Observable<void>
Implementation of VideoControllerApi.pause
- Defined in project/src/video/video-controller.ts:1381

play

play(): Observable<void>
Starts video playback

Returns Observable<void>
Observable when play started
Implementation of VideoControllerApi.play
- Defined in project/src/video/video-controller.ts:1361

prependHelpMenuGroup

prependHelpMenuGroup(helpMenuGroup: HelpMenuGroup): Observable<void>
Appends new HelpMenuGroup to video context menu
Parameters
- helpMenuGroup: HelpMenuGroup
Returns Observable<void>
Implementation of VideoControllerApi.prependHelpMenuGroup
- Defined in project/src/video/video-controller.ts:1811

reloadVideo

reloadVideo(): Observable<Video>
Reloads video

Returns Observable<Video>
Implementation of VideoControllerApi.reloadVideo
- Defined in project/src/video/video-controller.ts:525

removeAllSidecarAudioTracks

removeAllSidecarAudioTracks(): Observable<void>
Returns Observable<void>
Implementation of VideoControllerApi.removeAllSidecarAudioTracks
- Defined in project/src/video/video-controller.ts:2425

removeAllSubtitlesTracks

removeAllSubtitlesTracks(): Observable<void>
Returns Observable<void>
Implementation of VideoControllerApi.removeAllSubtitlesTracks
- Defined in project/src/video/video-controller.ts:1973

removeSafeZone

removeSafeZone(id: string): Observable<void>
Removes safe zone area
Parameters
- id: string
Returns Observable<void>
Implementation of VideoControllerApi.removeSafeZone
- Defined in project/src/video/video-controller.ts:1839

removeSidecarAudioTracks

removeSidecarAudioTracks(ids: string[]): Observable<void>
Parameters
- ids: string[]
Returns Observable<void>
Implementation of VideoControllerApi.removeSidecarAudioTracks
- Defined in project/src/video/video-controller.ts:2418

removeSubtitlesTrack

removeSubtitlesTrack(id: string): Observable<void>
Parameters
- id: string
Returns Observable<void>
Implementation of VideoControllerApi.removeSubtitlesTrack
- Defined in project/src/video/video-controller.ts:1986

routeMainAudioRouterNodes

routeMainAudioRouterNodes(
newAudioInputOutputNodes: AudioInputOutputNode[],
): Observable<void>
Parameters
- newAudioInputOutputNodes: AudioInputOutputNode[]
Returns Observable<void>
Implementation of VideoControllerApi.routeMainAudioRouterNodes
- Defined in project/src/video/video-controller.ts:2216

routeSidecarAudioRouterNodes

routeSidecarAudioRouterNodes(
sidecarAudioTrackId: string,
newAudioInputOutputNodes: AudioInputOutputNode[],
): Observable<void>
Parameters
- sidecarAudioTrackId: string
- newAudioInputOutputNodes: AudioInputOutputNode[]
Returns Observable<void>
Implementation of VideoControllerApi.routeSidecarAudioRouterNodes
- Defined in project/src/video/video-controller.ts:2503

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>
Implementation of VideoControllerApi.seekFromCurrentFrame
- Defined in project/src/video/video-controller.ts:1562

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>
Implementation of VideoControllerApi.seekFromCurrentTime
- Defined in project/src/video/video-controller.ts:1577

seekNextFrame

seekNextFrame(): Observable<boolean>
Seeks to next video frame

Returns Observable<boolean>
Implementation of VideoControllerApi.seekNextFrame
- Defined in project/src/video/video-controller.ts:1591

seekPreviousFrame

seekPreviousFrame(): Observable<boolean>
Seeks to previous video frame

Returns Observable<boolean>
Implementation of VideoControllerApi.seekPreviousFrame
- Defined in project/src/video/video-controller.ts:1585

seekToEnd

seekToEnd(): Observable<boolean>
Seeks to end of video

Returns Observable<boolean>
Implementation of VideoControllerApi.seekToEnd
- Defined in project/src/video/video-controller.ts:1654

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>
Implementation of VideoControllerApi.seekToFrame
- Defined in project/src/video/video-controller.ts:1541

seekToPercent

seekToPercent(percent: number): Observable<boolean>
Seeks to timeline location
Parameters
- percent: number
Returns Observable<boolean>
Implementation of VideoControllerApi.seekToPercent
- Defined in project/src/video/video-controller.ts:1629

seekToTime

seekToTime(time: number): Observable<boolean>
Seeks to video timestamp
Parameters
- time: number
  Video timestamp in seconds
Returns Observable<boolean>
Implementation of VideoControllerApi.seekToTime
- Defined in project/src/video/video-controller.ts:1597

seekToTimecode

seekToTimecode(timecode: string): Observable<boolean>
Seeks to video timestamp
Parameters
- timecode: string
  Video timestamp in HH:MM:SS:FF format
Returns Observable<boolean>
Implementation of VideoControllerApi.seekToTimecode
- Defined in project/src/video/video-controller.ts:1621

setActiveAudioTrack

setActiveAudioTrack(id: string): Observable<void>
Sets active audio track
Parameters
- id: string
  OmpAudioTrack id
Returns Observable<void>
Implementation of VideoControllerApi.setActiveAudioTrack
- Defined in project/src/video/video-controller.ts:1761

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>
Implementation of VideoControllerApi.setPlaybackRate
- Defined in project/src/video/video-controller.ts:1463

setVolume

setVolume(volume: number): Observable<void>
Sets volume level
Parameters
- volume: number
  Decimal value between [0, 1]
Returns Observable<void>
Implementation of VideoControllerApi.setVolume
- Defined in project/src/video/video-controller.ts:1495

showSubtitlesTrack

showSubtitlesTrack(id: string): Observable<void>
Parameters
- id: string
Returns Observable<void>
Implementation of VideoControllerApi.showSubtitlesTrack
- Defined in project/src/video/video-controller.ts:2014

toggleFullscreen

toggleFullscreen(): Observable<void>
Toggles video fullscreen mode

Returns Observable<void>
Implementation of VideoControllerApi.toggleFullscreen
- Defined in project/src/video/video-controller.ts:1727

toggleMuteUnmute

toggleMuteUnmute(): Observable<void>
Toggles mute / unmute

Returns Observable<void>
Implementation of VideoControllerApi.toggleMuteUnmute
- Defined in project/src/video/video-controller.ts:1715

togglePlayPause

togglePlayPause(): Observable<void>
Toggles video play and pause

Returns Observable<void>
Implementation of VideoControllerApi.togglePlayPause
- Defined in project/src/video/video-controller.ts:1424

unmute

unmute(): Observable<void>
Video unmute

Returns Observable<void>
Implementation of VideoControllerApi.unmute
- Defined in project/src/video/video-controller.ts:1702

updateActiveNamedEventStreams

updateActiveNamedEventStreams(
eventNames: OmpNamedEventEventName[],
): Observable<void>
Opens event stream for each provided event name in eventNames subscribable in onNamedEvent$. Deactivates all other event streams.
Parameters
- eventNames: OmpNamedEventEventName[]
  Event name
Returns Observable<void>
Implementation of VideoControllerApi.updateActiveNamedEventStreams
- Defined in project/src/video/video-controller.ts:2292

Class VideoControllerInternal

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VideoController

Properties

ReadonlyonActiveNamedEventStreamsChange$

ReadonlyonAudioLoaded$

ReadonlyonAudioSwitched$

ReadonlyonBuffering$

ReadonlyonDurationChange$

ReadonlyonEnded$

ReadonlyonFullscreenChange$

ReadonlyonHelpMenuChange$

ReadonlyonMainAudioChange$

ReadonlyonMainAudioPeakProcessorMessage$

ReadonlyonNamedEvent$

ReadonlyonPause$

ReadonlyonPlay$

ReadonlyonPlaybackRateChange$

ReadonlyonPlaybackState$

ReadonlyonSeeked$

ReadonlyonSeeking$

ReadonlyonSidecarAudioChange$

ReadonlyonSidecarAudioCreate$

ReadonlyonSidecarAudioPeakProcessorMessage$

ReadonlyonSidecarAudioRemove$

ReadonlyonSubtitlesCreate$

ReadonlyonSubtitlesHide$

ReadonlyonSubtitlesLoaded$

ReadonlyonSubtitlesRemove$

ReadonlyonSubtitlesShow$

ReadonlyonSyncTick$

ReadonlyonThumbnailVttUrlChanged$

ReadonlyonVideoError$

ReadonlyonVideoLoaded$

ReadonlyonVideoLoading$

ReadonlyonVideoSafeZoneChange$

ReadonlyonVideoTimeChange$

ReadonlyonVideoWindowPlaybackStateChange$

ReadonlyonVolumeChange$

Accessors

videoElement

Returns HTMLVideoElement

Methods

_exportMainAudioTrackToSidecar

Parameters

Returns Observable<OmpAudioTrack>

activateSidecarAudioTracks

Parameters

Returns Observable<void>

addSafeZone

Parameters

Returns Observable<VideoSafeZone>

appendHelpMenuGroup

Parameters

Returns Observable<void>

attachVideoWindow

Returns Observable<void>

calculateFrameToTime

Parameters

Returns number

calculateTimeToFrame

Parameters

Returns number

canAttach

Returns boolean

canDetach

Returns boolean

clearHelpMenuGroups

Returns Observable<void>

clearSafeZones

Returns Observable<void>

createMainAudioPeakProcessor

Class VideoController`Internal`

`Readonly`onActiveNamedEventStreamsChange$

`Readonly`onAudioLoaded$

`Readonly`onAudioSwitched$

`Readonly`onBuffering$

`Readonly`onDurationChange$

`Readonly`onEnded$

`Readonly`onFullscreenChange$

`Readonly`onHelpMenuChange$

`Readonly`onMainAudioChange$

`Readonly`onMainAudioPeakProcessorMessage$

`Readonly`onNamedEvent$

`Readonly`onPause$

`Readonly`onPlay$

`Readonly`onPlaybackRateChange$

`Readonly`onPlaybackState$

`Readonly`onSeeked$

`Readonly`onSeeking$

`Readonly`onSidecarAudioChange$

`Readonly`onSidecarAudioCreate$

`Readonly`onSidecarAudioPeakProcessorMessage$

`Readonly`onSidecarAudioRemove$

`Readonly`onSubtitlesCreate$

`Readonly`onSubtitlesHide$

`Readonly`onSubtitlesLoaded$

`Readonly`onSubtitlesRemove$

`Readonly`onSubtitlesShow$

`Readonly`onSyncTick$

`Readonly`onThumbnailVttUrlChanged$

`Readonly`onVideoError$

`Readonly`onVideoLoaded$

`Readonly`onVideoLoading$

`Readonly`onVideoSafeZoneChange$

`Readonly`onVideoTimeChange$

`Readonly`onVideoWindowPlaybackStateChange$

`Readonly`onVolumeChange$