Interface BitmovinV8PlayerApi

Hierarchy

BitmovinV8PlayerApi

Index

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
  - Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/apis/BufferApi.d.ts:3
setTargetLevel:function
- setTargetLevel(_type, _value, _media): void
- Parameters
  - _type: unknown
  - _value: number
  - _media: unknown
  Returns void
  - Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/apis/BufferApi.d.ts:2

`Readonly` drm

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

Type declaration

renewLicense:function
- renewLicense(_drmLicenseId): Promise<never>
- Parameters
  - _drmLicenseId: string
  Returns Promise<never>
  - Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/apis/DrmApi.d.ts:2

`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

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

`Readonly` lowlatency

lowlatency: undefined

`Readonly` manifest

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

Type declaration

dash: undefined
hls: undefined

`Readonly` subtitles

subtitles: PlayerSubtitlesAPI

`Readonly` version

version: string

`Readonly` vr

vr: undefined

Methods

addMetadata

addMetadata(metadataType, metadata): boolean
Parameters
- metadataType: CAST
- metadata: any
Returns boolean
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:159

castStop

castStop(): void
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:160

castVideo

castVideo(): void
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:161

clearQueryParameters

clearQueryParameters(): void
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:162

destroy

destroy(): Promise<void>
Returns Promise<void>
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:126

getAspectRatio

getAspectRatio(): number
Returns number
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:154

getAudio

getAudio(): AudioTrack
Returns AudioTrack
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:163

getAudioBufferLength

getAudioBufferLength(): number
Returns number
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:158

getAudioQuality

getAudioQuality(): Quality
Returns Quality
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:164

getAvailableAudio

getAvailableAudio(): AudioTrack[]
Returns AudioTrack[]
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:165

getAvailableAudioQualities

getAvailableAudioQualities(): Quality[]
Returns Quality[]
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:166

getAvailableSegments

getAvailableSegments(): SegmentMap
Returns SegmentMap
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:196

getAvailableVideoQualities

getAvailableVideoQualities(): VideoQuality[]
Returns VideoQuality[]
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:167

getBufferedRanges

getBufferedRanges(): TimeRange[]
Returns TimeRange[]
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:156

getConfig

getConfig(mergedConfig?): PlayerConfig
Parameters
- Optional mergedConfig: boolean
Returns PlayerConfig
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:127

getContainer

getContainer(): HTMLElement
Returns HTMLElement
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:128

getCurrentTime

getCurrentTime(mode?): number
Parameters
- Optional mode: TimeMode
Returns number
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:134

getDownloadedAudioData

getDownloadedAudioData(): DownloadedData
Returns DownloadedData
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:168

getDownloadedVideoData

getDownloadedVideoData(): DownloadedVideoData
Returns DownloadedVideoData
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:169

getDroppedVideoFrames

getDroppedVideoFrames(): number
Returns number
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:170

getDuration

getDuration(): number
Returns number
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:135

getManifest

getManifest(): string
Returns string
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:171

getMaxTimeShift

getMaxTimeShift(): number
Returns number
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:172

getPlaybackAudioData

getPlaybackAudioData(): Quality
Returns Quality
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:173

getPlaybackSpeed

getPlaybackSpeed(): number
Returns number
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:136

getPlaybackVideoData

getPlaybackVideoData(): VideoQuality
Returns VideoQuality
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:174

getPlayerType

getPlayerType(): PlayerType
Returns PlayerType
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:129

getSeekableRange

getSeekableRange(): TimeRange
Returns TimeRange
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:148

getSnapshot

getSnapshot(type?, quality?): Snapshot
Parameters
- Optional type: string
- Optional quality: number
Returns Snapshot
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:175

getSource

getSource(): SourceConfig
Returns SourceConfig
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:153

getStreamType

getStreamType(): StreamType
Returns StreamType
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:176

getSupportedDRM

getSupportedDRM(): Promise<string[]>
Returns Promise<string[]>
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:177

getSupportedTech

getSupportedTech(mode?): Technology[]
Parameters
- Optional mode: SupportedTechnologyMode
Returns Technology[]
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:178

getThumbnail

getThumbnail(time): Thumbnail
Parameters
- time: number
Returns Thumbnail
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:179

getTimeShift

getTimeShift(): number
Returns number
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:137

getTotalStalledTime

getTotalStalledTime(): number
Returns number
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:180

getVideoBufferLength

getVideoBufferLength(): number
Returns number
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:157

getVideoElement

getVideoElement(): HTMLVideoElement
Returns HTMLVideoElement
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:132

getVideoQuality

getVideoQuality(): VideoQuality
Returns VideoQuality
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:181

getViewMode

getViewMode(): ViewMode
Returns ViewMode
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:200

getVolume

getVolume(): number
Returns number
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:138

hasEnded

hasEnded(): boolean
Returns boolean
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:139

isAirplayActive

isAirplayActive(): boolean
Returns boolean
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:194

isAirplayAvailable

isAirplayAvailable(): boolean
Returns boolean
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:193

isCastAvailable

isCastAvailable(): boolean
Returns boolean
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:182

isCasting

isCasting(): boolean
Returns boolean
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:183

isDRMSupported

isDRMSupported(drmSystem): Promise<string>
Parameters
- drmSystem: string
Returns Promise<string>
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:184

isLive

isLive(): boolean
Returns boolean
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:140

isMuted

isMuted(): boolean
Returns boolean
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:141

isPaused

isPaused(): boolean
Returns boolean
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:142

isPlaying

isPlaying(): boolean
Returns boolean
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:143

isStalled

isStalled(): boolean
Returns boolean
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:144

isViewModeAvailable

isViewModeAvailable(viewMode): boolean
Parameters
- viewMode: ViewMode
Returns boolean
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:198

load

load(source, forceTechnology?, disableSeeking?): Promise<void>
Parameters
- source: SourceConfig
- Optional forceTechnology: string
- Optional disableSeeking: boolean
Returns Promise<void>
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:130

mute

mute(issuer?): void
Parameters
- Optional issuer: string
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:145

off

off(eventType, callback): void
Parameters
- eventType: PlayerEvent
- callback: PlayerEventCallback
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:125

on

on(eventType, callback): void
Parameters
- eventType: PlayerEvent
- callback: PlayerEventCallback
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:124

pause

pause(issuer?): void
Parameters
- Optional issuer: string
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:146

play

play(issuer?): Promise<void>
Parameters
- Optional issuer: string
Returns Promise<void>
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:147

preload

preload(): void
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:197

seek

seek(time, issuer?): boolean
Parameters
- time: number
- Optional issuer: string
Returns boolean
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:149

setAspectRatio

setAspectRatio(aspectratio): void
Parameters
- aspectratio: string | number
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:185

setAudio

setAudio(trackID): void
Parameters
- trackID: string
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:186

setAudioQuality

setAudioQuality(audioQualityID): void
Parameters
- audioQualityID: string
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:187

setAuthentication

setAuthentication(customData): void
Parameters
- customData: any
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:188

setLogLevel

setLogLevel(level): void
Parameters
- level: LogLevel
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:133

setPlaybackSpeed

setPlaybackSpeed(speed): void
Parameters
- speed: number
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:150

setPosterImage

setPosterImage(url, keepPersistent): void
Parameters
- url: string
- keepPersistent: boolean
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:189

setQueryParameters

setQueryParameters(queryParameters): void
Parameters
- queryParameters: QueryParameters
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:190

setVideoElement

setVideoElement(videoElement): void
Parameters
- videoElement: HTMLVideoElement
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:131

setVideoQuality

setVideoQuality(videoQualityID): void
Parameters
- videoQualityID: string
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:191

setViewMode

setViewMode(viewMode, options?): void
Parameters
- viewMode: ViewMode
- Optional options: ViewModeOptions
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:199

setVolume

setVolume(volume, issuer?): void
Parameters
- volume: number
- Optional issuer: string
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:155

showAirplayTargetPicker

showAirplayTargetPicker(): void
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:195

timeShift

timeShift(offset, issuer?): void
Parameters
- offset: number
- Optional issuer: string
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:192

unload

unload(): Promise<void>
Returns Promise<void>
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:151

unmute

unmute(issuer?): void
Parameters
- Optional issuer: string
Returns void
- Defined in dist/sdk/tmp-typedoc/player-types/packages/v8-compat/types/Types.d.ts:152

Interface BitmovinV8PlayerApi

Hierarchy

Index

Properties

Methods

Properties

Readonly ads

Readonly buffer

Type declaration

getLevel:function

Parameters

_type: unknown

_media: unknown

Returns null

setTargetLevel:function

Parameters

_type: unknown

_value: number

_media: unknown

Returns void

Readonly drm

Type declaration

renewLicense:function

Parameters

_drmLicenseId: string

Returns Promise<never>

Readonly exports

Type declaration

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

Readonly lowlatency

Readonly manifest

Type declaration

dash: undefined

hls: undefined

Readonly subtitles

Readonly version

Readonly vr

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

`Readonly` ads

`Readonly` buffer

`Readonly` drm

`Readonly` exports

`Readonly` lowlatency

`Readonly` manifest

`Readonly` subtitles

`Readonly` version

`Readonly` vr

`Optional` mergedConfig: boolean

`Optional` mode: TimeMode

`Optional` type: string

`Optional` quality: number

`Optional` mode: SupportedTechnologyMode