com.amazon.kepler.w3cmedia

​

Interfaces

• IContentProtectionInitData — Contains the content protection initialization data.
• IW3CMedia — Module : /com.amazon.kepler.w3cmedia@IW3CMedia Base Interface to access W3CMedia APIs.
• IW3CMedia2
• IW3CMedia3
• IW3CMedia4
• IW3CMedia5 — Extension to IW3CMedia4 adding factory for custom HTTP headers builder.
• IMediaEncryptedEvent — Contains MediaEncryptedEvent related information. For more details see https://www.w3.org/TR/encrypted-media/#mediaencryptedevent
• ITrackEvent — Contains TrackEvent related information. For more details see https://html.spec.whatwg.org/multipage/media.html#trackevent
• ITrackEvent2 — Extension of ITrackEvent. Contains TrackEvent related information. For more details see https://html.spec.whatwg.org/multipage/media.html#trackevent
• ISourceBufferEvent — Contains the SourceBuffer that emitted the event
• IResizeEvent — Contains width and height associated with “resize” event.
• IMediaQualityData — Payload carried by playback quality events (frame_drop, frame_freeze, audio_gap) emitted with EventSource::HTML_MEDIA_ELEMENT. Whether the event is video-side or audio-side is determined by the event name passed to onEvent.
• IPlaybackQualityEvent — Passed along with playback quality events (frame_drop, frame_freeze, audio_gap) delivered through IHtmlMediaElementEventListener::onEvent with EventSource::HTML_MEDIA_ELEMENT. The event name (frame_drop / frame_freeze / audio_gap) distinguishes video-side from audio-side events.
• IEventInfo — Stores the optional extra information about the event which is passed in onEvent callback.
• IEventInfo2 — Extension to IEventInfo adding accessor for PlaybackQualityEvent.
• IHtmlMediaElementInitStatusListener — Async Initialization callback interface to initialize HTMLMediaElement. Clients must wait for this callback before using rest of the HTMLMediaElement APIs.
• IHtmlMediaElementDeInitStatusListener — Async DeInitialization callback interface to deinitialize HTMLMediaElement. Clients must wait for this callback to ensure all resources used by HTMLMediaElement are freed.
• IHtmlMediaElementEventListener — Async Event callback interface. Asynchronously recieve events through this callback.
• IHtmlMediaElementKeysSetListener — Async setMediaKeys callback
• IMediaKeys — The MediaKeys object represents a set of keys that an associated HtmlMediaElement can use for decryption of media data during playback. It also represents a CDM instance. For more details see https://www.w3.org/TR/encrypted-media/#mediakeys-interface
• IMediaKeysPolicy — The MediaKeysPolicy object represents a set of policy requirements. Each policy requirement is an optional field.
• IMediaKeysPolicyBuilder — Interface to build IMediaKeysPolicy object instance, which will be used to query MediaKeyStatus for that instance.
• IMediaKeyStatusListener — Async callback to provide media key status.
• IMediaKeys2
• IMediaError — All media elements have an associated error status, which records the last error the element encountered since its resource selection algorithm was last invoked. The error attribute, on getting, must return the MediaError object created for this last error, or null if there has not been an error. For further details see https://html.spec.whatwg.org/multipage/media.html#mediaerror
• IAudioTrack — The AudioTrack object to represent audio track of the content. For further details see https://html.spec.whatwg.org/multipage/media.html#audiotrack
• IConfig — Configuration object used to create HTMLMediaElement object.
• IConfigBuilder — Interface to build IConfig, which will be used to create HTMLMediaElement object.
• IConfigBuilder2 — This interface extends [IConfigBuilder] interface to add config to enable codec switch without pause.
• IConfigBuilder3 — This interface extends [IConfigBuilder2] interface to add a config for enabling frame rendering before play is invoked — either at the start of playback or from the new position post seek.
• ITextTrack — The TextTrack object to represent Text track of the content. For further details see https://html.spec.whatwg.org/multipage/media.html#texttrack
• IVideoTrack — The VideoTrack object to represent Video track of the content. For further details see https://html.spec.whatwg.org/multipage/media.html#videotrack
• IHtmlMediaElement — The HtmlMediaElement object.
• IHtmlMediaElement2 — The HtmlMediaElement2 object. Extension to HtmlMediaElement adding new method to get video playback quality.
• IHtmlMediaElement3 — The HtmlMediaElement3 object. Extension to HtmlMediaElement2 adding new method to get audio effect session ID and set playback range.
• IHtmlMediaElement4 — The HtmlMediaElement4 object. Extension of HtmlMediaElement3 adds new method to set pitch multiplier of audio stream in HtmlMediaElement.
• ICustomHttpHeaders — Opaque container of custom HTTP headers, built via ICustomHttpHeadersBuilder. This interface intentionally exposes no methods — it serves as a type-safe handle passed to setSrcWithCustomHeaders. Headers can only be set through the builder; once built, the contents cannot be inspected or modified through this interface.
• ICustomHttpHeadersBuilder — Builder for constructing an ICustomHttpHeaders object.
• IHtmlMediaElement5 — Extension to IHtmlMediaElement4 adding method to set source URL with custom HTTP headers atomically.
• IHtmlMediaElement6 — The HtmlMediaElement6 object. Extension to IHtmlMediaElement5 adding methods to enable playback quality event delivery and tune PlaybackQualityMonitor detection parameters.
• VideoPlaybackQuality — The VideoPlaybackQuality object.
• ISourceBuffer — The SourceBuffer Object. For further details see https://www.w3.org/TR/2016/REC-media-source-20161117/#sourcebuffer
• ISourceBuffer2 — The SourceBuffer Object Extension. For further details see https://www.w3.org/TR/2016/REC-media-source-20161117/#sourcebuffer
• ISourceBufferConfig — SourceBufferConfig is optionally used to configure the SourceBuffers created by MediaSource. This is an extension feature, not part of W3C Specifications.
• ISourceBufferConfigBuilder — Interface to build SourceBufferConfig
• IMediaSource — MediaSource object. https://www.w3.org/TR/2016/REC-media-source-20161117/
• IMediaSource2 — Extension of MediaSource object. For further details see https://www.w3.org/TR/2016/REC-media-source-20161117/
• IMediaKeySystemMediaCapability — Representation of MediaKeySystemMediaCapability interface struct defined by EME spec. For further details see https://www.w3.org/TR/encrypted-media/#dom-mediakeysystemmediacapability
• IMediaKeySystemMediaCapability2
• IMediaKeySystemConfiguration — Representation of MediaKeySystemConfiguration interface struct defined by EME spec. For further details see https://www.w3.org/TR/encrypted-media/#dom-mediakeysystemconfiguration
• IMediaKeySystemConfiguration2
• IMediaKeySystemConfigurationBuilder — Interface to build MediaKeySystemConfiguration
• IMediaKeyStatusMap — A read-only map of key IDs to the current status of the associated key A key’s status is independent of whether the key is currently being used and of media data For further details see https://www.w3.org/TR/encrypted-media/#dom-mediakeystatusmap
• IMediaKeySession — Representation of MediaKeySession interface struct defined by EME spec. Apps should use this interface to generate license request and obtain decrypt key id, and close/remove session. For more details see https://www.w3.org/TR/encrypted-media/#mediakeysession-interface
• ILicenseRequestListener — Async callback to indicate request is generated
• IMediaKeySessionLoadStatusListener — Async callback to indicate MediaKeySession is loaded
• IMediaKeySessionUpdateStatusListener — Async callback to indicate MediaKeySession is updated
• IMediaKeySessionCloseStatusListener — Async MediaKeySession closed callback
• IMediaKeySessionExpirationListener — Async callback to indicate license has expiration info changed
• IMediaKeySessionRemoveStatusListener — Async callback to indicate that all keys associated with the MediaKeySession have been removed.
• IMediaKeysCreationListener — Async callback to indicate that MediaKeys object has been created. Clients must wait for this callback to get the created media keys
• IMediaKeyStatusChangeListener — Async callback to indiate that the media key status changed.
• IMediaKeyMessageEventListener — Async callback to notify media key message event. Upon license request being generated by CDM, this callback will be called for app to further process the request (for eg, send it to license server and fetch result)
• IServerCertificateSetListener — Async callback to indicate that the server certificate is set.
• IMediaKeySystemAccess — The interface to provide access to key system. For more details see https://www.w3.org/TR/encrypted-media/#mediakeysystemaccess-interface
• IMediaKeySystemAccessRequestListener — Media Key System Access creation callback Clients must wait for this callback to get the media key system access
• IEncryptionInfo — EncryptionInfo holds the encryption related information for an encrypted MediaSample.
• IMediaParams — Interface that encapsulates various params such as audio or video params.
• IAudioParams — AudioParams represents all audio related information required to create mediasamplesourcetrack for audio
• IVideoParams — The VideoParams stores video related information required to create mediasamplesourcetrack for video
• IVideoParams2 — The VideoParams2 stores video related information required to create mediasamplesourcetrack for video, which enables clients to set HDR related information
• IMediaSample — MediaSample holds the audio/video encoded bitstream data and all the related meta data. MediaSample contains the following information:
• IMediaSample2 — Extension of MediaSample by new method addition to support trimming duration for the Audio Frame.
• IMediaSampleSourceTrack — MediaSampleSourceTrack represents the audio/video track that will be added to MediaSampleSource. It represents a queue of A/V media samples that are pushed to the track for playback based on the presentation timestamps of the media sample. This object allows apps to create as many audio/video tracks as needed for playback. Typically one audio and one video tracks are created.
• IMediaSampleSourceTrack2
• IMediaSampleSourceQueueListener — Listener interface for IMediaSampleSourceTrack3. Apps may use addQueueListener API to add this listener and get callbacks for MediaSampleSourceTrack queue status.
• IMediaSampleSourceQueueReturn
• IMediaSampleSourceTrack3 — This interface is an extension of IMediaSampleSourceTrack2 which adds support for queueMediaSample to work in non-blocking mode. The APIs in this interface must be called after onInitialized callback is received, else exception would be thrown.
• IMediaSampleSource — MediaSampleSource extension allows clients to decode and render A/V encoded samples synchronized by presentation time.

​

Structs

• AudioContentType — Struct whose value field is used to signify the Audio Content Type The content type expresses the general category of the content.
• AudioUsage — Struct whose value field is used to signify the Audio Usage This field tells what is this sound used for. This is achieved with the “usage” information.
• Resolution — Contains width and height associated with video frame
• TimeRange — Represent a list of ranges (periods) of time.
• SubtitleInfo — Contains information about out-of-band subtitle URL
• ContentKeyId — Media Key Ids from CDM
• SubSampleInfo — Plain Old Data (POD) to store sub sample info A MediaSample’s buffer data can be divided into one or more subsamples. Each SubSample starts with 0 or more clear, unencrypted bytes followed by 0 or more encrypted bytes of data.
• EncryptionPattern — The pattern used to encrypt the sample if pattern encryption applies

​

Enumerations

• ReadyState
• ContentProtectionInitDataType
• EventSource
• MediaErrorCode
• PlayerMode
• TextTrackMode
• AppendMode
• MediaSourceReadyState
• EndOfStreamError
• MediaKeySessionType
• MediaKeyMessageType
• MediaKeysRequirement
• MediaRobustness
• MediaKeyStatus
• CryptoMode
• AudioStreamFormat
• TextTrackKind — Provides the kind of the text track as per the spec For further details see https://html.spec.whatwg.org/multipage/media.html#dom-texttrack-kind
• QueueMediaSampleStatus

​

Exceptions

• TypeError — Possible causes of this error are The parameter is empty. Invalid initialization data. Invalid response format. A persistent license was provided for a “temporary” session. For more detail see https://www.w3.org/TR/encrypted-media/#dfn-TypeError
• NotSupportedError — Possible causes of this error are The existing MediaKeys object cannot be removed. The key system is not supported. The initialization data type is not supported by the key system. The session type is not supported by the key system. The initialization data is not supported by the key system. The operation is not supported by the key system. For more detail see https://www.w3.org/TR/encrypted-media/#dfn-NotSupportedError
• InvalidInputError — Possible causes of this error are The existing input parameter is not as per the API requirement(s)
• InvalidConfigError
• InvalidStateError — Possible causes of this error are API is called in invalid state. The existing MediaKeys object cannot be removed at this time. The session has already been used. The session is not yet initialized. The session is closed. For more detail see https://www.w3.org/TR/encrypted-media/#dfn-InvalidStateError
• QuotaExceededError — Possible causes of this error are The MediaKeys object cannot be used with additional HTMLMediaElements. A non-closed session already exists for this sessionId. For more detail see https://www.w3.org/TR/encrypted-media/#dfn-QuotaExceededError
• UnsupportedPlayerModeError