Properties
newMediaElementConfig
newMediaElementConfig: () => NativeMediaElementConfig
Returns
NativeMediaElementConfig
checkClientManifestForKMC
checkClientManifestForKMC: () => NativeKMCResult
Returns
NativeKMCResult
setSurface
setSurface: (mediaElement: NativeMediaElement, surface: string) => void
Parameters
mediaElement
NativeMediaElement
surface
string
clearSurface
clearSurface: (mediaElement: NativeMediaElement, surface: string) => void
Parameters
mediaElement
NativeMediaElement
surface
string
setCaptionConsumer
setCaptionConsumer: (mediaElement: NativeMediaElement, captionConsumer: string) => boolean
Parameters
mediaElement
NativeMediaElement
captionConsumer
string
Returns
boolean
clearCaptionConsumer
clearCaptionConsumer: (mediaElement: NativeMediaElement, captionConsumer: string) => boolean
Parameters
mediaElement
NativeMediaElement
captionConsumer
string
Returns
boolean
setWaitForAudioToCompleteSeek
setWaitForAudioToCompleteSeek: (mediaElementConfig: NativeMediaElementConfig, waitForAudioToCompleteSeek: boolean) => void
Parameters
mediaElementConfig
NativeMediaElementConfig
waitForAudioToCompleteSeek
boolean
setAudioConfig
setAudioConfig: (mediaElementConfig: NativeMediaElementConfig, audioType: number, audioUsage: number) => void
Parameters
mediaElementConfig
NativeMediaElementConfig
audioType
number
audioUsage
number
newMediaElement
newMediaElement: (mediaElementConfig: NativeMediaElementConfig, callback: (nativeMediaElement: NativeMediaElement) => void) => void
Parameters
mediaElementConfig
NativeMediaElementConfig
callback
(nativeMediaElement: NativeMediaElement) => void
destroy
destroy: (mediaElement: NativeMediaElement, callback: () => void) => void
Parameters
mediaElement
NativeMediaElement
callback
() => void
destroySync
destroySync: (mediaElement: NativeMediaElement, timeoutInMs: number) => MediaPlayerDeInitStatus
Parameters
mediaElement
NativeMediaElement
timeoutInMs
number
Returns
MediaPlayerDeInitStatussetEventCallback
setEventCallback: (mediaElement: NativeMediaElement, callback: (event: NativeMediaElementEvent, buffer: ArrayBuffer) => void) => void
Parameters
mediaElement
NativeMediaElement
callback
(event: NativeMediaElementEvent, buffer: ArrayBuffer) => void
setVideoOutputPosition
setVideoOutputPosition: (mediaElementConfig: NativeMediaElementConfig, x: number, y: number, width: number, height: number) => void
Parameters
mediaElementConfig
NativeMediaElementConfig
x
number
y
number
width
number
height
number
setInitPictureMode
setInitPictureMode: (mediaElementConfig: NativeMediaElementConfig, pictureMode: number) => void
Parameters
mediaElementConfig
NativeMediaElementConfig
pictureMode
number
isValid
isValid: (mediaElement: NativeMediaElement) => boolean
Parameters
mediaElement
NativeMediaElement
Returns
boolean
getError
getError: (mediaElement: NativeMediaElement) => NativeMediaError
Parameters
mediaElement
NativeMediaElement
Returns
NativeMediaError
getReadyState
getReadyState: (mediaElement: NativeMediaElement) => number
Parameters
mediaElement
NativeMediaElement
Returns
number
getBuffered
getBuffered: (mediaElement: NativeMediaElement) => Array<NativeTimeRange>
Parameters
mediaElement
NativeMediaElement
Returns
NativeTimeRange[]
getSeeking
getSeeking: (mediaElement: NativeMediaElement) => boolean
Parameters
mediaElement
NativeMediaElement
Returns
boolean
getCurrentTime
getCurrentTime: (mediaElement: NativeMediaElement) => number
Parameters
mediaElement
NativeMediaElement
Returns
number
getDuration
getDuration: (mediaElement: NativeMediaElement) => number
Parameters
mediaElement
NativeMediaElement
Returns
number
setDuration
setDuration: (mediaElement: NativeMediaElement, duration: number) => number
Parameters
mediaElement
NativeMediaElement
duration
number
Returns
number
getPaused
getPaused: (mediaElement: NativeMediaElement) => boolean
Parameters
mediaElement
NativeMediaElement
Returns
boolean
getSeekable
getSeekable: (mediaElement: NativeMediaElement) => Array<NativeTimeRange>
Parameters
mediaElement
NativeMediaElement
Returns
NativeTimeRange[]
getEnded
getEnded: (mediaElement: NativeMediaElement) => boolean
Parameters
mediaElement
NativeMediaElement
Returns
boolean
play
play: (mediaElement: NativeMediaElement) => void
Parameters
mediaElement
NativeMediaElement
pause
pause: (mediaElement: NativeMediaElement) => void
Parameters
mediaElement
NativeMediaElement
seek
seek: (mediaElement: NativeMediaElement, position: number) => void
Parameters
mediaElement
NativeMediaElement
position
number
getVolumeLevel
getVolumeLevel: (mediaElement: NativeMediaElement) => number
Parameters
mediaElement
NativeMediaElement
Returns
number
setVolumeLevel
setVolumeLevel: (mediaElement: NativeMediaElement, volumelevel: number) => void
Parameters
mediaElement
NativeMediaElement
volumelevel
number
isAudioMuted
isAudioMuted: (mediaElement: NativeMediaElement) => boolean
Parameters
mediaElement
NativeMediaElement
Returns
boolean
muteAudio
muteAudio: (mediaElement: NativeMediaElement) => void
Parameters
mediaElement
NativeMediaElement
unMuteAudio
unMuteAudio: (mediaElement: NativeMediaElement) => void
Parameters
mediaElement
NativeMediaElement
setPlaybackRate
setPlaybackRate: (mediaElement: NativeMediaElement, playbackrate: number) => void
Parameters
mediaElement
NativeMediaElement
playbackrate
number
getPlaybackRate
getPlaybackRate: (mediaElement: NativeMediaElement) => number
Parameters
mediaElement
NativeMediaElement
Returns
number
createAndAttachMediaSource
createAndAttachMediaSource: (mediaElement: NativeMediaElement) => void
Parameters
mediaElement
NativeMediaElement
detachMediaSource
detachMediaSource: (mediaElement: NativeMediaElement) => void
Parameters
mediaElement
NativeMediaElement
getEndOfStreamSignalled
getEndOfStreamSignalled: (mediaElement: NativeMediaElement) => boolean
Parameters
mediaElement
NativeMediaElement
Returns
boolean
addSourceBuffer
addSourceBuffer: (mediaElement: NativeMediaElement, appendChunkSize: number, maxWidth: number, maxHeight: number, frameRate: number, evictionThreshold: number, mimeType: string) => NativeAddSourceBufferResult
Parameters
mediaElement
NativeMediaElement
appendChunkSize
number
maxWidth
number
maxHeight
number
frameRate
number
evictionThreshold
number
mimeType
string
Returns
NativeAddSourceBufferResult
removeSourceBuffer
removeSourceBuffer: (mediaElement: NativeMediaElement, sourceBufferId: string) => number
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
Returns
number
getSourceBuffers
getSourceBuffers: (mediaElement: NativeMediaElement) => Array<string>
Parameters
mediaElement
NativeMediaElement
Returns
string[]
getActiveSourceBuffers
getActiveSourceBuffers: (mediaElement: NativeMediaElement) => Array<string>
Parameters
mediaElement
NativeMediaElement
Returns
string[]
setLiveSeekableRange
setLiveSeekableRange: (mediaElement: NativeMediaElement, start: number, end: number) => number
Parameters
mediaElement
NativeMediaElement
start
number
end
number
Returns
number
clearLiveSeekableRange
clearLiveSeekableRange: (mediaElement: NativeMediaElement) => number
Parameters
mediaElement
NativeMediaElement
Returns
number
endOfStream
endOfStream: (mediaElement: NativeMediaElement, errorMessage: string) => number
Parameters
mediaElement
NativeMediaElement
errorMessage
string
Returns
number
setMediaKeys
setMediaKeys: (mediaElement: NativeMediaElement, cdmiMediaKeys: NativeCDMiMediaKeys) => void
Parameters
mediaElement
NativeMediaElement
cdmiMediaKeys
NativeCDMiMediaKeys
clearMediaKeys
clearMediaKeys: (mediaElement: NativeMediaElement) => void
Parameters
mediaElement
NativeMediaElement
getAudioTracks
getAudioTracks: (mediaElement: NativeMediaElement) => Array<NativeAudioTrack>
Parameters
mediaElement
NativeMediaElement
Returns
NativeAudioTrack[]
getVideoTracks
getVideoTracks: (mediaElement: NativeMediaElement) => Array<NativeAudioTrack>
Parameters
mediaElement
NativeMediaElement
Returns
NativeAudioTrack[]
enableAudioTrack
enableAudioTrack: (mediaElement: NativeMediaElement, audioTrackId: string) => void
Parameters
mediaElement
NativeMediaElement
audioTrackId
string
disableAudioTrack
disableAudioTrack: (mediaElement: NativeMediaElement, audioTrackId: string) => void
Parameters
mediaElement
NativeMediaElement
audioTrackId
string
enableVideoTrack
enableVideoTrack: (mediaElement: NativeMediaElement, videoTrackId: string) => void
Parameters
mediaElement
NativeMediaElement
videoTrackId
string
disableVideoTrack
disableVideoTrack: (mediaElement: NativeMediaElement, videoTrackId: string) => void
Parameters
mediaElement
NativeMediaElement
videoTrackId
string
enableTextTrack
enableTextTrack: (mediaElement: NativeMediaElement, textTrackId: string) => void
Parameters
mediaElement
NativeMediaElement
textTrackId
string
disableTextTrack
disableTextTrack: (mediaElement: NativeMediaElement, textTrackId: string) => void
Parameters
mediaElement
NativeMediaElement
textTrackId
string
getAudioTrackById
getAudioTrackById: (mediaElement: NativeMediaElement, trackId: string) => NativeAudioTrack
Parameters
mediaElement
NativeMediaElement
trackId
string
Returns
NativeAudioTrack
getVideoTrackById
getVideoTrackById: (mediaElement: NativeMediaElement, trackId: string) => NativeVideoTrack
Parameters
mediaElement
NativeMediaElement
trackId
string
Returns
NativeVideoTrack
getTextTrackById
getTextTrackById: (mediaElement: NativeMediaElement, trackId: string) => NativeTextTrack
Parameters
mediaElement
NativeMediaElement
trackId
string
Returns
NativeTextTrack
getDiagnosticInfo
getDiagnosticInfo: (mediaElement: NativeMediaElement) => NativeMPBDiagnosticInfo
Parameters
mediaElement
NativeMediaElement
Returns
NativeMPBDiagnosticInfo
getVideoPlaybackQuality
getVideoPlaybackQuality: (mediaElement: NativeMediaElement) => NativeVideoPlaybackQualityInfo
Parameters
mediaElement
NativeMediaElement
Returns
NativeVideoPlaybackQualityInfo
canPlayType
canPlayType: (mediaElement: NativeMediaElement, type: string) => string
Parameters
mediaElement
NativeMediaElement
type
string
Returns
string
setPitchMultiplier
setPitchMultiplier: (mediaElement: NativeMediaElement, pitchMultiplier: number) => boolean
Parameters
mediaElement
NativeMediaElement
pitchMultiplier
number
Returns
boolean
getPitchMultiplier
getPitchMultiplier: (mediaElement: NativeMediaElement) => number
Parameters
mediaElement
NativeMediaElement
Returns
number
setAutoPlay
setAutoPlay: (mediaElement: NativeMediaElement, autoplay: boolean) => void
Parameters
mediaElement
NativeMediaElement
autoplay
boolean
sourceBuffer_GetId
sourceBuffer_GetId: (mediaElement: NativeMediaElement, sourceBufferId: string) => string
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
Returns
string
sourceBuffer_GetMode
sourceBuffer_GetMode: (mediaElement: NativeMediaElement, sourceBufferId: string) => number
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
Returns
number
sourceBuffer_SetMode
sourceBuffer_SetMode: (mediaElement: NativeMediaElement, sourceBufferId: string, mode: number) => number
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
mode
number
Returns
number
sourceBuffer_GetUpdating
sourceBuffer_GetUpdating: (mediaElement: NativeMediaElement, sourceBufferId: string) => boolean
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
Returns
boolean
sourceBuffer_GetBuffered
sourceBuffer_GetBuffered: (mediaElement: NativeMediaElement, sourceBufferId: string) => Array<NativeTimeRange>
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
Returns
NativeTimeRange[]
sourceBuffer_GetTimestampOffset
sourceBuffer_GetTimestampOffset: (mediaElement: NativeMediaElement, sourceBufferId: string) => number
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
Returns
number
sourceBuffer_SetTimestampOffset
sourceBuffer_SetTimestampOffset: (mediaElement: NativeMediaElement, sourceBufferId: string, timestampOffset: number) => number
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
timestampOffset
number
Returns
number
sourceBuffer_GetAppendWindowStart
sourceBuffer_GetAppendWindowStart: (mediaElement: NativeMediaElement, sourceBufferId: string) => number
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
Returns
number
sourceBuffer_SetAppendWindowStart
sourceBuffer_SetAppendWindowStart: (mediaElement: NativeMediaElement, sourceBufferId: string, appendWindowStart: number) => number
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
appendWindowStart
number
Returns
number
sourceBuffer_GetAppendWindowEnd
sourceBuffer_GetAppendWindowEnd: (mediaElement: NativeMediaElement, sourceBufferId: string) => number
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
Returns
number
sourceBuffer_SetAppendWindowEnd
sourceBuffer_SetAppendWindowEnd: (mediaElement: NativeMediaElement, sourceBufferId: string, appendWindowEnd: number) => number
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
appendWindowEnd
number
Returns
number
sourceBuffer_Append
sourceBuffer_Append: (mediaElement: NativeMediaElement, sourceBufferId: string, buffer: ArrayBuffer) => number
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
buffer
ArrayBuffer
Returns
number
sourceBuffer_Remove
sourceBuffer_Remove: (mediaElement: NativeMediaElement, sourceBufferId: string, start: number, end: number) => number
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
start
number
end
number
Returns
number
sourceBuffer_Abort
sourceBuffer_Abort: (mediaElement: NativeMediaElement, sourceBufferId: string) => number
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
Returns
number
sourceBuffer_ChangeType
sourceBuffer_ChangeType: (mediaElement: NativeMediaElement, sourceBufferId: string, type: string) => number
Parameters
mediaElement
NativeMediaElement
sourceBufferId
string
type
string
Returns
number
randomUUID
randomUUID: () => string
Returns
string
importKey
importKey: (format: KeyFormat, data: ArrayBuffer, algorithm: AlgorithmIdentifier, extractable: boolean, keyUsages: Array<KeyUsage>) => CryptoKeyObject
Parameters
format
KeyFormat
data
ArrayBuffer
algorithm
AlgorithmIdentifier
extractable
boolean
keyUsages
KeyUsage[]
Returns
CryptoKeyObject
decrypt
decrypt: (algorithm: AlgorithmIdentifier, key: CryptoKey, ivData: ArrayBuffer, data: ArrayBuffer) => ArrayBuffer
Parameters
algorithm
AlgorithmIdentifier
key
Readonly<CryptoKeyObject>
ivData
ArrayBuffer
data
ArrayBuffer
Returns
ArrayBuffer
getMediaEventSource
getMediaEventSource: () => MediaEventSource
Returns
MediaEventSource
getTrackListChangeType
getTrackListChangeType: () => TrackListChangeType
Returns
TrackListChangeType
getMediaErrorType
getMediaErrorType: () => MediaErrorType
Returns
MediaErrorType
getMediaElementReadyState
getMediaElementReadyState: () => MediaElementReadyState
Returns
MediaElementReadyState
getMSEErrorCode
getMSEErrorCode: () => MSEErrorCode
Returns
MSEErrorCode
getDemuxerAddSourceBufferResult
getDemuxerAddSourceBufferResult: () => DemuxerAddSourceBufferResult
Returns
DemuxerAddSourceBufferResult
getDRMEventType
getDRMEventType: () => DRMEventType
Returns
DRMEventType
getCDMiMessageType
getCDMiMessageType: () => CDMiMessageType
Returns
CDMiMessageType
getMpbPictureMode
getMpbPictureMode: () => MpbPictureMode
Returns
MpbPictureMode
getFrameProcessorAppendMode
getFrameProcessorAppendMode: () => FrameProcessorAppendMode
Returns
FrameProcessorAppendMode
getCdmInitDataType
getCdmInitDataType: () => CdmInitDataType
Returns
CdmInitDataType
getCdmMediaKeyRequirement
getCdmMediaKeyRequirement: () => CdmMediaKeyRequirement
Returns
CdmMediaKeyRequirement
getCdmMediaRobustness
getCdmMediaRobustness: () => CdmMediaRobustness
Returns
CdmMediaRobustness
getCdmSessionType
getCdmSessionType: () => CdmSessionType
Returns
CdmSessionType
getCdmMediaKeyStatus
getCdmMediaKeyStatus: () => CdmMediaKeyStatus
Returns
CdmMediaKeyStatus
setSrc
setSrc: (mediaElement: NativeMediaElement, url: string, autoplay: boolean) => void
Parameters
mediaElement
NativeMediaElement
url
string
autoplay
boolean
setSrcWithCustomHeaders
setSrcWithCustomHeaders: (mediaElement: NativeMediaElement, url: string, autoplay: boolean, headers: Record<string, string>) => void
Parameters
mediaElement
NativeMediaElement
url
string
autoplay
boolean
headers
Record<string, string>
addTextTrack
addTextTrack: (mediaElement: NativeMediaElement, kind: string, label: string, language: string, uri: string, mimeType: string) => NativeTextTrack
Parameters
mediaElement
NativeMediaElement
kind
string
label
string
language
string
uri
string
mimeType
string
Returns
NativeTextTrack
load
load: (mediaElement: NativeMediaElement) => void
Parameters
mediaElement
NativeMediaElement
getUrlArg
getUrlArg: () => string
Returns
string
textDecode
textDecode: (data: ArrayBuffer) => string
Parameters
data
ArrayBuffer
Returns
string
renderCaptionsV2
renderCaptionsV2: (captionViewHandle: string, cues: Array<NativeVTTCue>) => void
Parameters
captionViewHandle
string
cues
NativeVTTCue[]
renderCaptionsV2WithState
renderCaptionsV2WithState: (captionViewHandle: string, cues: Array<NativeVTTCue>, isRendererPaused: boolean) => void
Parameters
captionViewHandle
string
cues
NativeVTTCue[]
isRendererPaused
boolean
resumeCaptionRender
resumeCaptionRender: (captionViewHandle: string) => void
Parameters
captionViewHandle
string
pauseCaptionRender
pauseCaptionRender: (captionViewHandle: string) => void
Parameters
captionViewHandle
string