Class VideoController<C>`Abstract` `Internal`

Type Parameters

C extends VideoControllerConfig

Implements

VideoControllerApi

Index

Accessors

Methods

addSafeZone appendHelpMenuGroup attachVideoWindow calculateFrameToTime calculateTimeToFrame clearHelpMenuGroups clearSafeZones createAudioContext createAudioContextWithOutputsResolver createAudioPeakProcessorWorkletNode createSubtitlesVttTrack destroy destroyAudioPeakProcessorWorkletNode detachVideoWindow formatToTimecode getActiveAudioTrack getActiveSubtitlesTrack getAudioContext getAudioInputOutputNodes getAudioPeakProcessorWorkletNode getAudioTracks getBufferedTimespans getCurrentFrame getCurrentTime getCurrentTimecode getDuration getFrameRate getHelpMenuGroups getHls getHTMLVideoElement getMediaElementAudioSourceNode getPlaybackRate getPlaybackState getSafeZones getSubtitlesTracks getThumbnailVttUrl getTotalFrames getVideo getVideoLoadOptions getVideoWindowPlaybackState getVolume hideSubtitlesTrack isAttachVideoWindowEnabled isDetachVideoWindowEnabled isFullscreen isMuted isPaused isPlaying isSeeking isVideoLoaded loadThumbnailVttUrl loadVideo loadVideoInternal mute parseTimecodeToFrame parseTimecodeToTime pause play prependHelpMenuGroup reloadVideo removeAllSubtitlesTracks removeSafeZone removeSubtitlesTrack routeAudioInputOutputNode routeAudioInputOutputNodes seekFromCurrentFrame seekFromCurrentTime seekNextFrame seekPreviousFrame seekToFrame seekToPercent seekToTime seekToTimecode setActiveAudioTrack setPlaybackRate setVolume showSubtitlesTrack toggleFullscreen toggleMuteUnmute togglePlayPause unmute

Properties

`Readonly`onAudioContextChange$

onAudioContextChange$: Subject<AudioContextChangeEvent> = ...

`Readonly`onAudioLoaded$

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

`Readonly`onAudioPeakProcessorWorkletNodeMessage$

onAudioPeakProcessorWorkletNodeMessage$: Subject<AudioPeakProcessorWorkletNodeMessageEvent> = ...

`Readonly`onAudioRouting$

onAudioRouting$: Subject<AudioRoutingEvent> = ...

`Readonly`onAudioSwitched$

onAudioSwitched$: Subject<AudioSwitchedEvent> = ...

`Readonly`onAudioWorkletNodeCreated$

onAudioWorkletNodeCreated$: BehaviorSubject<undefined | AudioWorkletNodeCreatedEvent> = ...

`Readonly`onBuffering$

onBuffering$: Subject<VideoBufferingEvent> = ...

Fires on video buffering

`Readonly`onEnded$

onEnded$: Subject<VideoEndedEvent> = ...

Fires on video end

`Readonly`onFullscreenChange$

onFullscreenChange$: Subject<VideoFullscreenChangeEvent> = ...

Fires on fullscreen change

`Readonly`onHelpMenuChange$

onHelpMenuChange$: Subject<VideoHelpMenuChangeEvent> = ...

`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`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`onThumbnailVttUrlChanged$

onThumbnailVttUrlChanged$: Subject<undefined | 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.

`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:382

Methods

addSafeZone

addSafeZone(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:1559

appendHelpMenuGroup

appendHelpMenuGroup(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:1467

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:1591

calculateFrameToTime

calculateFrameToTime(frameNumber): 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:1066

calculateTimeToFrame

calculateTimeToFrame(time): 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:1061

clearHelpMenuGroups

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

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

clearSafeZones

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

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

createAudioContext

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

createAudioContextWithOutputsResolver

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

createAudioPeakProcessorWorkletNode

createAudioPeakProcessorWorkletNode(audioMeterStandard): Observable<void>
Parameters
- audioMeterStandard: AudioMeterStandard
Returns Observable<void>
Implementation of VideoControllerApi.createAudioPeakProcessorWorkletNode
- Defined in project/src/video/video-controller.ts:1940

createSubtitlesVttTrack

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

destroy

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

destroyAudioPeakProcessorWorkletNode

destroyAudioPeakProcessorWorkletNode(): void
Returns void
- Defined in project/src/video/video-controller.ts:2004

detachVideoWindow

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

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

formatToTimecode

formatToTimecode(time): 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:1380

getActiveAudioTrack

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

getActiveSubtitlesTrack

getActiveSubtitlesTrack(): undefined | SubtitlesVttTrack
Returns undefined | SubtitlesVttTrack
Implementation of VideoControllerApi.getActiveSubtitlesTrack
- Defined in project/src/video/video-controller.ts:1698

getAudioContext

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

getAudioInputOutputNodes

getAudioInputOutputNodes(): AudioInputOutputNode[][]
Returns AudioInputOutputNode[][]
Implementation of VideoControllerApi.getAudioInputOutputNodes
- Defined in project/src/video/video-controller.ts:1851

getAudioPeakProcessorWorkletNode

getAudioPeakProcessorWorkletNode(): undefined | AudioWorkletNode
Returns undefined | AudioWorkletNode
Implementation of VideoControllerApi.getAudioPeakProcessorWorkletNode
- Defined in project/src/video/video-controller.ts:1936

getAudioTracks

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

getBufferedTimespans

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

getCurrentFrame

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

getCurrentTime

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

getCurrentTimecode

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

getDuration

getDuration(): number
return Video duration in seconds

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

getFrameRate

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

getHelpMenuGroups

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

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:1463

getHTMLVideoElement

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

getMediaElementAudioSourceNode

getMediaElementAudioSourceNode(): undefined | MediaElementAudioSourceNode
Returns undefined | MediaElementAudioSourceNode
Implementation of VideoControllerApi.getMediaElementAudioSourceNode
- Defined in project/src/video/video-controller.ts:1762

getPlaybackRate

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

getPlaybackState

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

getSafeZones

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

getSubtitlesTracks

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

getThumbnailVttUrl

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

getTotalFrames

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

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:1049

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:1053

getVideoWindowPlaybackState

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

getVolume

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

hideSubtitlesTrack

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

isAttachVideoWindowEnabled

isAttachVideoWindowEnabled(): boolean
Is attach video enabled

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

isDetachVideoWindowEnabled

isDetachVideoWindowEnabled(): boolean
Is detach video window enabled

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

isFullscreen

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

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

isMuted

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

isPaused

isPaused(): boolean
Indicates if video is paused

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

isPlaying

isPlaying(): boolean
Indicates if video is playing

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

isSeeking

isSeeking(): boolean
Indicates if video is seeking

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

isVideoLoaded

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

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

loadThumbnailVttUrl

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

loadVideo

loadVideo(sourceUrl, frameRate, options?): 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:369

loadVideoInternal

loadVideoInternal(sourceUrl, frameRate, options, optionsInternal?): 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:271

mute

mute(): Observable<void>
Video mute

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

parseTimecodeToFrame

parseTimecodeToFrame(timecode): 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:1386

parseTimecodeToTime

parseTimecodeToTime(timecode): 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:1392

pause

pause(): Observable<void>
Pauses video playback

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

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:1071

prependHelpMenuGroup

prependHelpMenuGroup(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:1477

reloadVideo

reloadVideo(): Observable<Video>
Reloads video

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

removeAllSubtitlesTracks

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

removeSafeZone

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

removeSubtitlesTrack

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

routeAudioInputOutputNode

routeAudioInputOutputNode(newAudioInputOutputNode): Observable<void>
Parameters
- newAudioInputOutputNode: AudioInputOutputNode
Returns Observable<void>
Implementation of VideoControllerApi.routeAudioInputOutputNode
- Defined in project/src/video/video-controller.ts:1865

routeAudioInputOutputNodes

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

seekFromCurrentFrame

seekFromCurrentFrame(framesCount): 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:1281

seekFromCurrentTime

seekFromCurrentTime(timeAmount): 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:1297

seekNextFrame

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

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

seekPreviousFrame

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

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

seekToFrame

seekToFrame(frame): 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:1257

seekToPercent

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

seekToTime

seekToTime(time): 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:1318

seekToTimecode

seekToTimecode(timecode): 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:1347

setActiveAudioTrack

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

setPlaybackRate

setPlaybackRate(playbackRate): 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:1169

setVolume

setVolume(volume): 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:1207

showSubtitlesTrack

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

toggleFullscreen

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

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

toggleMuteUnmute

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

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

togglePlayPause

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

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

unmute

unmute(): Observable<void>
Video unmute

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

Class VideoController<C>Abstract Internal

Type Parameters

Implements

Index

Properties

Accessors

Methods

Properties

ReadonlyonAudioContextChange$

ReadonlyonAudioLoaded$

ReadonlyonAudioPeakProcessorWorkletNodeMessage$

ReadonlyonAudioRouting$

ReadonlyonAudioSwitched$

ReadonlyonAudioWorkletNodeCreated$

ReadonlyonBuffering$

ReadonlyonEnded$

ReadonlyonFullscreenChange$

ReadonlyonHelpMenuChange$

ReadonlyonPause$

ReadonlyonPlay$

ReadonlyonPlaybackRateChange$

ReadonlyonPlaybackState$

ReadonlyonSeeked$

ReadonlyonSeeking$

ReadonlyonSubtitlesCreate$

ReadonlyonSubtitlesHide$

ReadonlyonSubtitlesLoaded$

ReadonlyonSubtitlesRemove$

ReadonlyonSubtitlesShow$

ReadonlyonThumbnailVttUrlChanged$

ReadonlyonVideoError$

ReadonlyonVideoLoaded$

ReadonlyonVideoLoading$

ReadonlyonVideoSafeZoneChange$

ReadonlyonVideoTimeChange$

ReadonlyonVideoWindowPlaybackStateChange$

ReadonlyonVolumeChange$

Accessors

videoElement

Returns HTMLVideoElement

Methods

addSafeZone

Parameters

Returns Observable<VideoSafeZone>

appendHelpMenuGroup

Parameters

Returns Observable<void>

attachVideoWindow

Returns Observable<void>

calculateFrameToTime

Parameters

Returns number

calculateTimeToFrame

Parameters

Returns number

clearHelpMenuGroups

Returns Observable<void>

clearSafeZones

Returns Observable<void>

createAudioContext

Parameters

Returns Observable<void>

createAudioContextWithOutputsResolver

Parameters

Parameters

Returns number

Returns Observable<void>

createAudioPeakProcessorWorkletNode

Parameters

Returns Observable<void>

createSubtitlesVttTrack

Parameters

Returns Observable<undefined | SubtitlesVttTrack>

destroy

Returns void

destroyAudioPeakProcessorWorkletNode

Returns void

detachVideoWindow

Returns Observable<void>

formatToTimecode

Class VideoController<C>`Abstract` `Internal`

`Readonly`onAudioContextChange$

`Readonly`onAudioLoaded$

`Readonly`onAudioPeakProcessorWorkletNodeMessage$

`Readonly`onAudioRouting$

`Readonly`onAudioSwitched$

`Readonly`onAudioWorkletNodeCreated$

`Readonly`onBuffering$

`Readonly`onEnded$

`Readonly`onFullscreenChange$

`Readonly`onHelpMenuChange$

`Readonly`onPause$

`Readonly`onPlay$

`Readonly`onPlaybackRateChange$

`Readonly`onPlaybackState$

`Readonly`onSeeked$

`Readonly`onSeeking$

`Readonly`onSubtitlesCreate$

`Readonly`onSubtitlesHide$

`Readonly`onSubtitlesLoaded$

`Readonly`onSubtitlesRemove$

`Readonly`onSubtitlesShow$

`Readonly`onThumbnailVttUrlChanged$

`Readonly`onVideoError$

`Readonly`onVideoLoaded$

`Readonly`onVideoLoading$

`Readonly`onVideoSafeZoneChange$

`Readonly`onVideoTimeChange$

`Readonly`onVideoWindowPlaybackStateChange$

`Readonly`onVolumeChange$