Interface VideoApi

interface VideoApi {
    onBuffering$: Observable<VideoBufferingEvent>;
    onEnded$: Observable<VideoEndedEvent>;
    onFullscreenChange$: Observable<VideoFullscreenChangeEvent>;
    onNamedEvent$: Observable<OmpNamedEvent>;
    onPause$: Observable<VideoPlayEvent>;
    onPlay$: Observable<VideoPlayEvent>;
    onPlaybackRateChange$: Observable<VideoPlaybackRateEvent>;
    onSeeked$: Observable<VideoSeekedEvent>;
    onSeeking$: Observable<VideoSeekingEvent>;
    onVideoError$: Observable<VideoErrorEvent>;
    onVideoLoaded$: Observable<undefined | VideoLoadedEvent>;
    onVideoLoading$: Observable<VideoLoadingEvent>;
    onVideoSafeZoneChange$: Observable<VideoSafeZoneChangeEvent>;
    onVideoTimeChange$: Observable<VideoTimeChangeEvent>;
    onVideoWindowPlaybackStateChange$: Observable<
        VideoWindowPlaybackStateChangeEvent,
    >;
    onVolumeChange$: Observable<VideoVolumeEvent>;
    addSafeZone(videoSafeZone: VideoSafeZone): Observable<VideoSafeZone>;
    appendHelpMenuGroup(helpMenuGroup: HelpMenuGroup): Observable<void>;
    attachVideoWindow(): Observable<void>;
    calculateFrameToTime(frameNumber: number): number;
    calculateTimeToFrame(time: number): number;
    canAttach(): boolean;
    canDetach(): boolean;
    clearHelpMenuGroups(): Observable<void>;
    clearSafeZones(): Observable<void>;
    detachVideoWindow(): Observable<void>;
    disablePiP(): Observable<void>;
    enablePiP(): Observable<void>;
    formatToTimecode(time: number): string;
    getActiveAudioTrack(): undefined | OmpAudioTrack;
    getActiveNamedEventStreams(): OmpNamedEventEventName[];
    getAudioTracks(): OmpAudioTrack[];
    getCurrentFrame(): number;
    getCurrentTime(): number;
    getCurrentTimecode(): string;
    getDuration(): number;
    getFrameRate(): number;
    getHelpMenuGroups(): HelpMenuGroup[];
    getHls(): undefined | Hls;
    getHTMLVideoElement(): HTMLVideoElement;
    getPlaybackRate(): number;
    getSafeZones(): VideoSafeZone[];
    getTotalFrames(): number;
    getVideo(): undefined | Video;
    getVideoLoadOptions(): undefined | VideoLoadOptions;
    getVideoWindowPlaybackState(): VideoWindowPlaybackState;
    getVolume(): number;
    isDetachable(): boolean;
    isFullscreen(): boolean;
    isMuted(): boolean;
    isPaused(): boolean;
    isPlaying(): boolean;
    isSeeking(): boolean;
    isVideoLoaded(): boolean;
    loadBlackVideo(): Observable<Video>;
    loadVideo(sourceUrl: string, frameRate: string | number): Observable<Video>;
    loadVideo(
        sourceUrl: string,
        frameRate: string | number,
        options?: VideoLoadOptions,
    ): Observable<Video>;
    mute(): Observable<void>;
    parseTimecodeToFrame(timecode: string): number;
    parseTimecodeToTime(timecode: string): number;
    pause(): Observable<void>;
    play(): Observable<void>;
    prependHelpMenuGroup(helpMenuGroup: HelpMenuGroup): Observable<void>;
    reloadVideo(): Observable<Video>;
    removeSafeZone(id: string): Observable<void>;
    seekFromCurrentFrame(framesCount: number): Observable<boolean>;
    seekFromCurrentTime(timeAmount: number): Observable<boolean>;
    seekNextFrame(): Observable<boolean>;
    seekPreviousFrame(): Observable<boolean>;
    seekToEnd(): Observable<boolean>;
    seekToFrame(frame: number): Observable<boolean>;
    seekToPercent(percent: number): Observable<boolean>;
    seekToTime(time: number): Observable<boolean>;
    seekToTimecode(timecode: string): Observable<boolean>;
    setActiveAudioTrack(id: string): Observable<void>;
    setPlaybackRate(playbackRate: number): Observable<void>;
    setVolume(volume: number): Observable<void>;
    toggleFullscreen(): Observable<void>;
    toggleMuteUnmute(): Observable<void>;
    togglePlayPause(): Observable<void>;
    unmute(): Observable<void>;
    updateActiveNamedEventStreams(
        eventNames: OmpNamedEventEventName[],
    ): Observable<void>;
}

Hierarchy (View Summary)

Api
- VideoApi
  - VideoControllerApi

Index

Properties

onBuffering$ onEnded$ onFullscreenChange$ onNamedEvent$ onPause$ onPlay$ onPlaybackRateChange$ onSeeked$ onSeeking$ onVideoError$ onVideoLoaded$ onVideoLoading$ onVideoSafeZoneChange$ onVideoTimeChange$ onVideoWindowPlaybackStateChange$ onVolumeChange$

Methods

addSafeZone appendHelpMenuGroup attachVideoWindow calculateFrameToTime calculateTimeToFrame canAttach canDetach clearHelpMenuGroups clearSafeZones detachVideoWindow disablePiP enablePiP formatToTimecode getActiveAudioTrack getActiveNamedEventStreams getAudioTracks getCurrentFrame getCurrentTime getCurrentTimecode getDuration getFrameRate getHelpMenuGroups getHls getHTMLVideoElement getPlaybackRate getSafeZones getTotalFrames getVideo getVideoLoadOptions getVideoWindowPlaybackState getVolume isDetachable isFullscreen isMuted isPaused isPlaying isSeeking isVideoLoaded loadBlackVideo loadVideo mute parseTimecodeToFrame parseTimecodeToTime pause play prependHelpMenuGroup reloadVideo removeSafeZone seekFromCurrentFrame seekFromCurrentTime seekNextFrame seekPreviousFrame seekToEnd seekToFrame seekToPercent seekToTime seekToTimecode setActiveAudioTrack setPlaybackRate setVolume toggleFullscreen toggleMuteUnmute togglePlayPause unmute updateActiveNamedEventStreams

Properties

`Readonly`onBuffering$

onBuffering$: Observable<VideoBufferingEvent>

Fires on video buffering

`Readonly`onEnded$

onEnded$: Observable<VideoEndedEvent>

Fires on video end

`Readonly`onFullscreenChange$

onFullscreenChange$: Observable<VideoFullscreenChangeEvent>

Fires on fullscreen change

onNamedEvent$

onNamedEvent$: Observable<OmpNamedEvent>

Fires on event which has active stream (see updateActiveNamedEventStreams

`Readonly`onPause$

onPause$: Observable<VideoPlayEvent>

Fires on video pause

`Readonly`onPlay$

onPlay$: Observable<VideoPlayEvent>

Fires on video play

`Readonly`onPlaybackRateChange$

onPlaybackRateChange$: Observable<VideoPlaybackRateEvent>

Fires on playback rate change

`Readonly`onSeeked$

onSeeked$: Observable<VideoSeekedEvent>

Fires on video seeked

`Readonly`onSeeking$

onSeeking$: Observable<VideoSeekingEvent>

Fires on video seeking

`Readonly`onVideoError$

onVideoError$: Observable<VideoErrorEvent>

Fires on if error occurs on video load

`Readonly`onVideoLoaded$

onVideoLoaded$: Observable<undefined | VideoLoadedEvent>

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

`Readonly`onVideoLoading$

onVideoLoading$: Observable<VideoLoadingEvent>

Fires on video load start.

`Readonly`onVideoSafeZoneChange$

onVideoSafeZoneChange$: Observable<VideoSafeZoneChangeEvent>

Fires on video safe zone change

`Readonly`onVideoTimeChange$

onVideoTimeChange$: Observable<VideoTimeChangeEvent>

Fires on video time change

`Readonly`onVideoWindowPlaybackStateChange$

onVideoWindowPlaybackStateChange$: Observable<
VideoWindowPlaybackStateChangeEvent,
>

Fires on video window playback state change

`Readonly`onVolumeChange$

onVolumeChange$: Observable<VideoVolumeEvent>

Fires on volume change

Methods

addSafeZone

addSafeZone(videoSafeZone: VideoSafeZone): Observable<VideoSafeZone>
Adds safe zone area.
Parameters
- videoSafeZone: VideoSafeZone
Returns Observable<VideoSafeZone>
safe zone id.
- Defined in project/src/api/video-api.ts:420

appendHelpMenuGroup

appendHelpMenuGroup(helpMenuGroup: HelpMenuGroup): Observable<void>
Appends new HelpMenuGroup to video context menu
Parameters
- helpMenuGroup: HelpMenuGroup
Returns Observable<void>
- Defined in project/src/api/video-api.ts:397

attachVideoWindow

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

Returns Observable<void>
- Defined in project/src/api/video-api.ts:467

calculateFrameToTime

calculateFrameToTime(frameNumber: number): number
Parameters
- frameNumber: number
  Video frame number
Returns number
video timestamp in seconds
- Defined in project/src/api/video-api.ts:345

calculateTimeToFrame

calculateTimeToFrame(time: number): number
Parameters
- time: number
  Video timestamp in seconds
Returns number
video frame number
- Defined in project/src/api/video-api.ts:339

canAttach

canAttach(): boolean
Returns boolean
true if video can be attached, false if not
- Defined in project/src/api/video-api.ts:457

canDetach

canDetach(): boolean
Returns boolean
true if video can be detached, false if not
- Defined in project/src/api/video-api.ts:452

clearHelpMenuGroups

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

Returns Observable<void>
- Defined in project/src/api/video-api.ts:408

clearSafeZones

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

Returns Observable<void>
- Defined in project/src/api/video-api.ts:432

detachVideoWindow

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

Returns Observable<void>
- Defined in project/src/api/video-api.ts:462

disablePiP

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

Returns Observable<void>
- Defined in project/src/api/video-api.ts:477

enablePiP

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

Returns Observable<void>
- Defined in project/src/api/video-api.ts:472

formatToTimecode

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

getActiveAudioTrack

getActiveAudioTrack(): undefined | OmpAudioTrack
Returns undefined | OmpAudioTrack
current active audio track
- Defined in project/src/api/video-api.ts:385

getActiveNamedEventStreams

getActiveNamedEventStreams(): OmpNamedEventEventName[]
Returns OmpNamedEventEventName[]
Event names for events streamed through onNamedEvent$
- Defined in project/src/api/video-api.ts:493

getAudioTracks

getAudioTracks(): OmpAudioTrack[]
Returns OmpAudioTrack[]
available audio tracks
- Defined in project/src/api/video-api.ts:380

getCurrentFrame

getCurrentFrame(): number
Returns number
current frame number
- Defined in project/src/api/video-api.ts:222

getCurrentTime

getCurrentTime(): number
Returns number
video current time in seconds
- Defined in project/src/api/video-api.ts:190

getCurrentTimecode

getCurrentTimecode(): string
Returns string
video current timecode
- Defined in project/src/api/video-api.ts:195

getDuration

getDuration(): number
Returns number
video duration. If duration is provided in loadVideo method, method returns provided value. If duration is not provided in loadVideo method, method returns HTML
- Defined in project/src/api/video-api.ts:185

getFrameRate

getFrameRate(): number
Returns number
video frame rate provided in loadVideo method
- Defined in project/src/api/video-api.ts:227

getHelpMenuGroups

getHelpMenuGroups(): HelpMenuGroup[]
Returns HelpMenuGroup[]
available HelpMenuGroup's
- Defined in project/src/api/video-api.ts:413

getHls

getHls(): undefined | Hls
Returns undefined | Hls
Hls (hls.js) instance if video is loaded, otherwise undefined
- Defined in project/src/api/video-api.ts:482

getHTMLVideoElement

getHTMLVideoElement(): HTMLVideoElement
Returns HTMLVideoElement
HTML
- Defined in project/src/api/video-api.ts:180

getPlaybackRate

getPlaybackRate(): number
Returns number
video playback rate
- Defined in project/src/api/video-api.ts:200

getSafeZones

getSafeZones(): VideoSafeZone[]
Returns VideoSafeZone[]
video safe zones
- Defined in project/src/api/video-api.ts:437

getTotalFrames

getTotalFrames(): number
Returns number
total number of frames in video
- Defined in project/src/api/video-api.ts:232

getVideo

getVideo(): undefined | Video
Returns undefined | Video
Video object that holds loaded video properties
- Defined in project/src/api/video-api.ts:170

getVideoLoadOptions

getVideoLoadOptions(): undefined | VideoLoadOptions
Returns undefined | VideoLoadOptions
VideoLoadOptions object used in loadVideo method
- Defined in project/src/api/video-api.ts:175

getVideoWindowPlaybackState

getVideoWindowPlaybackState(): VideoWindowPlaybackState
Returns VideoWindowPlaybackState
VideoWindowPlaybackState
- Defined in project/src/api/video-api.ts:442

getVolume

getVolume(): number
Returns number
current volume level
- Defined in project/src/api/video-api.ts:211

isDetachable

isDetachable(): boolean
Returns boolean
true if player is detachable
- Defined in project/src/api/video-api.ts:447

isFullscreen

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

Returns boolean
- Defined in project/src/api/video-api.ts:370

isMuted

isMuted(): boolean
Returns boolean
is video muted
- Defined in project/src/api/video-api.ts:360

isPaused

isPaused(): boolean
Indicates if video is paused

Returns boolean
- Defined in project/src/api/video-api.ts:242

isPlaying

isPlaying(): boolean
Indicates if video is playing

Returns boolean
- Defined in project/src/api/video-api.ts:237

isSeeking

isSeeking(): boolean
Indicates if video is seeking

Returns boolean
- Defined in project/src/api/video-api.ts:247

isVideoLoaded

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

Returns boolean
- Defined in project/src/api/video-api.ts:165

loadBlackVideo

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

Returns Observable<Video>
- Defined in project/src/api/video-api.ts:498

loadVideo

loadVideo(sourceUrl: string, frameRate: string | number): Observable<Video>
Loads new video
Parameters
- sourceUrl: string
  Video manifest URL
- frameRate: string | number
  Video frame rate
Returns Observable<Video>
- Defined in project/src/api/video-api.ts:146
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>
- Defined in project/src/api/video-api.ts:155

mute

mute(): Observable<void>
Video mute

Returns Observable<void>
- Defined in project/src/api/video-api.ts:350

parseTimecodeToFrame

parseTimecodeToFrame(timecode: string): number
Converts timestamp in format HH:MM:SS:FF to frame
Parameters
- timecode: string
Returns number
- Defined in project/src/api/video-api.ts:327

parseTimecodeToTime

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

pause

pause(): Observable<void>
Pauses video playback

Returns Observable<void>
- Defined in project/src/api/video-api.ts:258

play

play(): Observable<void>
Starts video playback

Returns Observable<void>
Observable when play started
- Defined in project/src/api/video-api.ts:253

prependHelpMenuGroup

prependHelpMenuGroup(helpMenuGroup: HelpMenuGroup): Observable<void>
Appends new HelpMenuGroup to video context menu
Parameters
- helpMenuGroup: HelpMenuGroup
Returns Observable<void>
- Defined in project/src/api/video-api.ts:403

reloadVideo

reloadVideo(): Observable<Video>
Reloads video

Returns Observable<Video>
- Defined in project/src/api/video-api.ts:160

removeSafeZone

removeSafeZone(id: string): Observable<void>
Removes safe zone area
Parameters
- id: string
Returns Observable<void>
- Defined in project/src/api/video-api.ts:427

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>
- Defined in project/src/api/video-api.ts:275

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>
- Defined in project/src/api/video-api.ts:281

seekNextFrame

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

Returns Observable<boolean>
- Defined in project/src/api/video-api.ts:291

seekPreviousFrame

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

Returns Observable<boolean>
- Defined in project/src/api/video-api.ts:286

seekToEnd

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

Returns Observable<boolean>
- Defined in project/src/api/video-api.ts:315

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>
- Defined in project/src/api/video-api.ts:269

seekToPercent

seekToPercent(percent: number): Observable<boolean>
Seeks to timeline location
Parameters
- percent: number
Returns Observable<boolean>
- Defined in project/src/api/video-api.ts:310

seekToTime

seekToTime(time: number): Observable<boolean>
Seeks to video timestamp
Parameters
- time: number
  Video timestamp in seconds
Returns Observable<boolean>
- Defined in project/src/api/video-api.ts:297

seekToTimecode

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

setActiveAudioTrack

setActiveAudioTrack(id: string): Observable<void>
Sets active audio track
Parameters
- id: string
  OmpAudioTrack id
Returns Observable<void>
- Defined in project/src/api/video-api.ts:391

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>
- Defined in project/src/api/video-api.ts:206

setVolume

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

toggleFullscreen

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

Returns Observable<void>
- Defined in project/src/api/video-api.ts:375

toggleMuteUnmute

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

Returns Observable<void>
- Defined in project/src/api/video-api.ts:365

togglePlayPause

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

Returns Observable<void>
- Defined in project/src/api/video-api.ts:263

unmute

unmute(): Observable<void>
Video unmute

Returns Observable<void>
- Defined in project/src/api/video-api.ts:355

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>
- Defined in project/src/api/video-api.ts:488

Interface VideoApi

Hierarchy (View Summary)

Index

Properties

Methods

Properties

ReadonlyonBuffering$

ReadonlyonEnded$

ReadonlyonFullscreenChange$

onNamedEvent$

ReadonlyonPause$

ReadonlyonPlay$

ReadonlyonPlaybackRateChange$

ReadonlyonSeeked$

ReadonlyonSeeking$

ReadonlyonVideoError$

ReadonlyonVideoLoaded$

ReadonlyonVideoLoading$

ReadonlyonVideoSafeZoneChange$

ReadonlyonVideoTimeChange$

ReadonlyonVideoWindowPlaybackStateChange$

ReadonlyonVolumeChange$

Methods

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>

detachVideoWindow

Returns Observable<void>

disablePiP

Returns Observable<void>

enablePiP

Returns Observable<void>

formatToTimecode

Parameters

Returns string

getActiveAudioTrack

Returns undefined | OmpAudioTrack

getActiveNamedEventStreams

Returns OmpNamedEventEventName[]

getAudioTracks

Returns OmpAudioTrack[]

getCurrentFrame

Returns number

getCurrentTime

Returns number

getCurrentTimecode

Returns string

getDuration

Returns number

getFrameRate

Returns number

getHelpMenuGroups

Returns HelpMenuGroup[]

getHls

Returns undefined | Hls

getHTMLVideoElement

Returns HTMLVideoElement

getPlaybackRate

Returns number

getSafeZones

Returns VideoSafeZone[]

`Readonly`onBuffering$

`Readonly`onEnded$

`Readonly`onFullscreenChange$

`Readonly`onPause$

`Readonly`onPlay$

`Readonly`onPlaybackRateChange$

`Readonly`onSeeked$

`Readonly`onSeeking$

`Readonly`onVideoError$

`Readonly`onVideoLoaded$

`Readonly`onVideoLoading$

`Readonly`onVideoSafeZoneChange$

`Readonly`onVideoTimeChange$

`Readonly`onVideoWindowPlaybackStateChange$

`Readonly`onVolumeChange$