HTMLMediaElement - Amazon Vega Docs

https://html.spec.whatwg.org/multipage/media.html#htmlmediaelement This object also emits few custom events other than standard events described in w3c specification. “playbackstarted” : event sent to the client when MediaPlayer start the playback “audiofocusgranted”: event sent to the client when MediaPlayer resumes the playback internally on obtaining the audio focus. “audiofocuspaused” : event sent to the client when MediaPlayer pauses the playback internally on loosing the audio focus temporarily. “audiofocuslost” : event sent to the client when MediaPlayer pauses the playback internally on loosing the audio focus permanantly.

Extended by

Implements

EventTarget

Constructors

new HTMLMediaElement()

new HTMLMediaElement(): HTMLMediaElement

Returns

HTMLMediaElement

Properties

src

src: string Set the URL of the media source. For additional information, see https://html.spec.whatwg.org/multipage/media.html#location-of-the-media-resource.

srcObject

srcObject: MediaProvider Set the source MediaProvider object. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-srcobject.

error

readonly error: MediaError Get the last media error encountered. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-error.

currentSrc

readonly currentSrc: string Get the source URL of the current media being played. https://html.spec.whatwg.org/multipage/media.html#dom-media-currentsrc.

networkState

readonly networkState: number https://html.spec.whatwg.org/multipage/media.html#dom-media-networkstate.

buffered

readonly buffered: TimeRanges Get the buffered time range of the content. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-buffered.

readyState

readonly readyState: number Get the ready state of the media element. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-readystate.

seeking

readonly seeking: boolean Check whehter the media element is currently seeking. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-seeking.

duration

readonly duration: number Get the duration of the content being played. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-duration.

paused

readonly paused: boolean Check whether the media playback is paused or not. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-paused.

played

readonly played: TimeRanges https://html.spec.whatwg.org/multipage/media.html#dom-media-played

seekable

readonly seekable: TimeRanges Get the seekable time range of the content. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-seekable.

ended

readonly ended: boolean Check whehter the media playback has ended. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-ended.

preload

preload: string https://html.spec.whatwg.org/multipage/media.html#attr-media-preload

currentTime

currentTime: number Get or set the current time of the playback. Setting the current time leads to a seek operation. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-currenttime.

defaultPlaybackRate

defaultPlaybackRate: number https://html.spec.whatwg.org/multipage/media.html#dom-media-defaultplaybackrate

playbackRate

playbackRate: number https://html.spec.whatwg.org/multipage/media.html#dom-media-playbackrate

autoplay

autoplay: boolean If set to true, automatically starts the playback when the URL is loaded. If set to false, the app must call play explicitly to start playback. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-autoplay.

loop

loop: boolean https://html.spec.whatwg.org/multipage/media.html#dom-media-loop

controls?

optional controls: boolean | undefined Enable or disable the UI for media controls. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-controls.

audioTracks

readonly audioTracks: AudioTrackList Gets the list of audio tracks. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-audiotracks.

videoTracks

readonly videoTracks: VideoTrackList Gets the list of video tracks. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-videotracks.

textTracks

readonly textTracks: TextTrackList Gets the list of text tracks. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-texttracks.

mediaKeys?

readonly optional mediaKeys: MediaKeys | undefined The media keys to use to decrypt DRM protected content. For additional information, see https://www.w3.org/TR/encrypted-media/#dom-htmlmediaelement-mediakeys.

nodeName

readonly nodeName: string For additional information, see https://developer.mozilla.org/en-US/docs/Web/API/Node/nodeName.

HAVE_NOTHING

static readonly HAVE_NOTHING: number = 0 For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-have_nothing.

HAVE_METADATA

static readonly HAVE_METADATA: number = 1 For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-have_metadata.

HAVE_CURRENT_DATA

static readonly HAVE_CURRENT_DATA: number = 2 For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-have_current_data.

HAVE_FUTURE_DATA

static readonly HAVE_FUTURE_DATA: number = 3 For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-have_future_data.

HAVE_ENOUGH_DATA

static readonly HAVE_ENOUGH_DATA: number = 4 For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-have_enough_data.

NETWORK_EMPTY

static readonly NETWORK_EMPTY: number = 0 https://html.spec.whatwg.org/multipage/media.html#dom-media-network_empty.

NETWORK_IDLE

static readonly NETWORK_IDLE: number = 1 https://html.spec.whatwg.org/multipage/media.html#dom-media-network_idle.

NETWORK_LOADING

static readonly NETWORK_LOADING: number = 2 https://html.spec.whatwg.org/multipage/media.html#dom-media-network_loading.

NETWORK_NO_SOURCE

static readonly NETWORK_NO_SOURCE: number = 3 https://html.spec.whatwg.org/multipage/media.html#dom-media-network_no_source.

defaultSeekIntervalInSec

defaultSeekIntervalInSec: number Configure the default seek interval in second for remote control media key press “fast-forward” or “rewind” functionality

Methods

addEventListener()

abstract addEventListener(type: string, listener: EventListener, options?: boolean | AddEventListenerOptions | undefined): void

Parameters

type

string

listener

EventListener

options?

boolean | AddEventListenerOptions | undefined

addTextTrack()

abstract addTextTrack(kind: TextTrackKind, label?: string | undefined, language?: string | undefined, uri?: string | undefined, mimeType?: string | undefined): TextTrack For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-addtexttrack.

Parameters

kind

TextTrackKind The kind parameter must return the text track kind of the text track that the TextTrack object represents.

label?

string | undefined The label parameter must return the text track label of the text track that the TextTrack object represents.

language?

string | undefined The language parameter must return the text track language of the text track that the TextTrack object represents.

uri?

string | undefined The uri parameter must return the URI of the out of band subtitle of the text track that the TextTrack object represents. This is a custom addition (not part of the w3c specification). If you specify the uri parameter, the component parses and renders subtitles.

mimeType?

string | undefined The mimeType parameter must return the mime type of the out of band subtitle of the text track that the TextTrack object represents. This is a custom addition (not part of the w3c specification).

Returns

TextTrack

canPlayType()

abstract canPlayType(type: string): CanPlayTypeResult https://html.spec.whatwg.org/multipage/media.html#dom-navigator-canplaytype

Parameters

type

string mime type

Returns

CanPlayTypeResult

fastSeek()

abstract fastSeek(time: number): void https://html.spec.whatwg.org/multipage/media.html#dom-media-fastseek

Parameters

time

number

getStartDate()

abstract getStartDate(): Date https://html.spec.whatwg.org/multipage/media.html#dom-media-getstartdate

Returns

Date

load()

abstract load(): void https://html.spec.whatwg.org/multipage/media.html#dom-media-load

pause()

abstract pause(): void Pauses the playback. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-pause.

play()

abstract play(): void Starts the playback. For additional information, see https://html.spec.whatwg.org/multipage/media.html#dom-media-play.

removeEventListener()

abstract removeEventListener(type: string, listener: EventListener, options?: boolean | EventListenerOptions | undefined): void

Parameters

type

string

listener

EventListener

options?

boolean | EventListenerOptions | undefined

setMediaKeys()

abstract setMediaKeys(mediaKeys?: MediaKeys | undefined): Promise<void> Sets the media keys used for decrypting DRM protected content. For additional information, see https://www.w3.org/TR/encrypted-media/#dom-htmlmediaelement-setmediakeys

Parameters

mediaKeys?

MediaKeys | undefined For additional information, see https://www.w3.org/TR/encrypted-media/#dom-mediakeys.

Returns

Promise<void>

​Extended by

​Implements

​Constructors

​new HTMLMediaElement()

​Returns

​Properties

​src

​srcObject

​error

​currentSrc

​networkState

​buffered

​readyState

​seeking

​duration

​paused

​played

​seekable

​ended

​preload

​currentTime

​defaultPlaybackRate

​playbackRate

​autoplay

​loop

​controls?

​volume

​muted

​defaultMuted

​audioTracks

​videoTracks

​textTracks

​mediaKeys?

​nodeName

​HAVE_NOTHING

​HAVE_METADATA

​HAVE_CURRENT_DATA

​HAVE_FUTURE_DATA

​HAVE_ENOUGH_DATA

​NETWORK_EMPTY

​NETWORK_IDLE

​NETWORK_LOADING

​NETWORK_NO_SOURCE

​defaultSeekIntervalInSec

​Methods

​addEventListener()

​Parameters

type

listener

options?

​addTextTrack()

​Parameters

kind

label?

language?

uri?

mimeType?

​Returns

​canPlayType()

​Parameters

type

​Returns

​fastSeek()

​Parameters

time

​getStartDate()

​Returns

​load()

​pause()

​play()

​removeEventListener()

​Parameters

type

listener

options?

​setMediaKeys()

​Parameters

mediaKeys?

​Returns

Extended by

Implements

Constructors

new HTMLMediaElement()

Returns

Properties

src

srcObject

error

currentSrc

networkState

buffered

readyState

seeking

duration

paused

played

seekable

ended

preload

currentTime

defaultPlaybackRate

playbackRate

autoplay

loop

controls?

volume

muted

defaultMuted

audioTracks

videoTracks

textTracks

mediaKeys?

nodeName

HAVE_NOTHING

HAVE_METADATA

HAVE_CURRENT_DATA

HAVE_FUTURE_DATA

HAVE_ENOUGH_DATA

NETWORK_EMPTY

NETWORK_IDLE

NETWORK_LOADING

NETWORK_NO_SOURCE

defaultSeekIntervalInSec

Methods

addEventListener()

Parameters

addTextTrack()

Parameters

Returns

canPlayType()

Parameters

Returns

fastSeek()

Parameters

getStartDate()

Returns

load()

pause()

play()

removeEventListener()

Parameters

setMediaKeys()

Parameters

Returns