Interface BitmovinV8PlayerApi

Hierarchy

  • BitmovinV8PlayerApi

Properties

ads buffer drm exports lowlatency manifest subtitles version vr

Methods

addMetadata castStop castVideo clearQueryParameters destroy getAspectRatio getAudio getAudioBufferLength getAudioQuality getAvailableAudio getAvailableAudioQualities getAvailableSegments getAvailableVideoQualities getBufferedRanges getConfig getContainer getCurrentTime getDownloadedAudioData getDownloadedVideoData getDroppedVideoFrames getDuration getManifest getMaxTimeShift getPlaybackAudioData getPlaybackSpeed getPlaybackVideoData getPlayerType getSeekableRange getSnapshot getSource getStreamType getSupportedDRM getSupportedTech getThumbnail getTimeShift getTotalStalledTime getVideoBufferLength getVideoElement getVideoQuality getViewMode getVolume hasEnded isAirplayActive isAirplayAvailable isCastAvailable isCasting isDRMSupported isLive isMuted isPaused isPlaying isStalled isViewModeAvailable load mute off on pause play preload seek setAspectRatio setAudio setAudioQuality setAuthentication setLogLevel setPlaybackSpeed setPosterImage setQueryParameters setVideoElement setVideoQuality setViewMode setVolume showAirplayTargetPicker timeShift unload unmute

Properties

Readonly ads

ads: undefined

Readonly buffer

buffer: {
    getLevel(_type, _media) => null;
    setTargetLevel(_type, _value, _media) => void;
}

Type declaration

  • getLevel:function
    • getLevel(_type, _media): null

    • Parameters

      • _type: unknown
      • _media: unknown

      Returns null

  • setTargetLevel:function
    • setTargetLevel(_type, _value, _media): void

    • Parameters

      • _type: unknown
      • _value: number
      • _media: unknown

      Returns void

Readonly drm

drm: {
    renewLicense(_drmLicenseId) => Promise<never>;
}

Type declaration

  • renewLicense:function
    • renewLicense(_drmLicenseId): Promise<never>

    • Parameters

      • _drmLicenseId: string

      Returns Promise<never>

Readonly exports

exports: {
    AdQuartile: typeof AdQuartile;
    BufferType: typeof BufferType;
    ErrorCode: typeof ErrorCode;
    HttpRequestMethod: typeof HttpRequestMethod;
    HttpRequestType: typeof HttpRequestType;
    HttpResponseType: typeof HttpResponseType;
    LogLevel: typeof LogLevel;
    MediaType: typeof MediaType;
    ModuleName: typeof ModuleName;
    PlayerAPINotAvailableError: typeof PlayerAPINotAvailableError;
    PlayerError: typeof PlayerError;
    PlayerEvent: typeof PlayerEvent;
    PlayerModuleMissingError: typeof PlayerModuleMissingError;
    PlayerType: typeof PlayerType;
    SupportedTechnologyMode: typeof SupportedTechnologyMode;
    ViewMode: typeof ViewMode;
    WarningCode: typeof WarningCode;
}

Type declaration

Readonly lowlatency

lowlatency: undefined

Readonly manifest

manifest: {
    dash: undefined;
    hls: undefined;
}

Type declaration

  • dash: undefined
  • hls: undefined

Readonly subtitles

subtitles: {
    add(_subtitle) => void;
    cueEnter(_cue) => void;
    cueExit(_cue) => void;
    disable(_id) => void;
    enable(_id, _exclusive?) => void;
    list() => never[];
    remove(_subtitleId) => void;
}

Type declaration

  • add:function
    • add(_subtitle): void

    • Parameters

      • _subtitle: unknown

      Returns void

  • cueEnter:function
    • cueEnter(_cue): void

    • Parameters

      • _cue: unknown

      Returns void

  • cueExit:function
    • cueExit(_cue): void

    • Parameters

      • _cue: unknown

      Returns void

  • disable:function
    • disable(_id): void

    • Parameters

      • _id: unknown

      Returns void

  • enable:function
    • enable(_id, _exclusive?): void

    • Parameters

      • _id: unknown
      • Optional _exclusive: boolean

      Returns void

  • list:function
    • list(): never[]

    • Returns never[]

  • remove:function
    • remove(_subtitleId): void

    • Parameters

      • _subtitleId: unknown

      Returns void

Readonly version

version: string

Readonly vr

vr: undefined

Methods

addMetadata

  • Parameters

    • metadataType: CAST
    • metadata: any

    Returns boolean

castStop

  • Returns void

castVideo

  • Returns void

clearQueryParameters

  • Returns void

destroy

  • Returns Promise<void>

getAspectRatio

  • Returns number

getAudio

  • Returns AudioTrack

getAudioBufferLength

  • Returns number

getAudioQuality

  • Returns Quality

getAvailableAudio

  • Returns AudioTrack[]

getAvailableAudioQualities

  • Returns Quality[]

getAvailableSegments

  • Returns SegmentMap

getAvailableVideoQualities

  • Returns VideoQuality[]

getBufferedRanges

  • Returns TimeRange[]

getConfig

  • Parameters

    • Optional mergedConfig: boolean

    Returns PlayerConfig

getContainer

  • Returns HTMLElement

getCurrentTime

  • Parameters

    Returns number

getDownloadedAudioData

  • Returns DownloadedData

getDownloadedVideoData

getDroppedVideoFrames

  • Returns number

getDuration

  • Returns number

getManifest

  • Returns string

getMaxTimeShift

  • Returns number

getPlaybackAudioData

  • Returns Quality

getPlaybackSpeed

  • Returns number

getPlaybackVideoData

  • Returns VideoQuality

getPlayerType

  • Returns PlayerType

getSeekableRange

  • Returns TimeRange

getSnapshot

  • Parameters

    • Optional type: string
    • Optional quality: number

    Returns Snapshot

getSource

  • Returns SourceConfig

getStreamType

  • Returns StreamType

getSupportedDRM

  • Returns Promise<string[]>

getSupportedTech

getThumbnail

  • Parameters

    • time: number

    Returns Thumbnail

getTimeShift

  • Returns number

getTotalStalledTime

  • Returns number

getVideoBufferLength

  • Returns number

getVideoElement

  • Returns HTMLVideoElement

getVideoQuality

  • Returns VideoQuality

getViewMode

  • Returns ViewMode

getVolume

  • Returns number

hasEnded

  • Returns boolean

isAirplayActive

  • Returns boolean

isAirplayAvailable

  • Returns boolean

isCastAvailable

  • Returns boolean

isCasting

  • Returns boolean

isDRMSupported

  • Parameters

    • drmSystem: string

    Returns Promise<string>

isLive

  • Returns boolean

isMuted

  • Returns boolean

isPaused

  • Returns boolean

isPlaying

  • Returns boolean

isStalled

  • Returns boolean

isViewModeAvailable

  • Parameters

    Returns boolean

load

  • Parameters

    • source: SourceConfig
    • Optional forceTechnology: string
    • Optional disableSeeking: boolean

    Returns Promise<void>

mute

  • Parameters

    • Optional issuer: string

    Returns void

off

  • Parameters

    Returns void

on

  • Parameters

    Returns void

pause

  • Parameters

    • Optional issuer: string

    Returns void

play

  • Parameters

    • Optional issuer: string

    Returns Promise<void>

preload

  • Returns void

seek

  • Parameters

    • time: number
    • Optional issuer: string

    Returns boolean

setAspectRatio

  • Parameters

    • aspectratio: string | number

    Returns void

setAudio

  • Parameters

    • trackID: string

    Returns void

setAudioQuality

  • Parameters

    • audioQualityID: string

    Returns void

setAuthentication

  • Parameters

    • customData: any

    Returns void

setLogLevel

  • Parameters

    Returns void

setPlaybackSpeed

  • Parameters

    • speed: number

    Returns void

setPosterImage

  • Parameters

    • url: string
    • keepPersistent: boolean

    Returns void

setQueryParameters

  • Parameters

    Returns void

setVideoElement

  • Parameters

    • videoElement: HTMLVideoElement

    Returns void

setVideoQuality

  • Parameters

    • videoQualityID: string

    Returns void

setViewMode

  • Parameters

    Returns void

setVolume

  • Parameters

    • volume: number
    • Optional issuer: string

    Returns void

showAirplayTargetPicker

  • Returns void

timeShift

  • Parameters

    • offset: number
    • Optional issuer: string

    Returns void

unload

  • Returns Promise<void>

unmute

  • Parameters

    • Optional issuer: string

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc