ApplicationMediaCapabilities
class ApplicationMediaCapabilities : Parcelable
kotlin.Any | |
↳ | android.media.ApplicationMediaCapabilities |
ApplicationMediaCapabilities is an immutable class that encapsulates an application's capabilities for handling newer video codec format and media features.
Android 12 introduces Compatible media transcoding feature. See Compatible media transcoding. By default, Android assumes apps can support playback of all media formats. Apps that would like to request that media be transcoded into a more compatible format should declare their media capabilities in a media_capabilities.xml resource file and add it as a property tag in the AndroidManifest.xml file. Here is a example:
<code><media-capabilities xmlns:android="http://schemas.android.com/apk/res/android"> <format android:name="HEVC" supported="true"/> <format android:name="HDR10" supported="false"/> <format android:name="HDR10Plus" supported="false"/> </media-capabilities> </code>
ApplicationMediaCapabilities objects can also be built by applications at runtime for use with ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)
to provide more control over the transcoding that is built into the platform. ApplicationMediaCapabilities provided by applications at runtime like this override the default manifest capabilities for that media access.The object could be build either through createFromXml(org.xmlpull.v1.XmlPullParser)
or through the builder class ApplicationMediaCapabilities.Builder
Video Codec Support
Newer video codes include HEVC, VP9 and AV1. Application only needs to indicate their support for newer format with this class as they are assumed to support older format like h.264.
Capability of handling HDR(high dynamic range) video
There are four types of HDR video(Dolby-Vision, HDR10, HDR10+, HLG) supported by the platform, application will only need to specify individual types they supported.
Summary
Nested classes | |
---|---|
Builder class for |
Inherited constants | |
---|---|
Public methods | |
---|---|
static ApplicationMediaCapabilities |
createFromXml(xmlParser: XmlPullParser) Creates |
Int | |
MutableList<String!> |
Query all hdr types that are supported by the application. |
MutableList<String!> |
Query the video codec mime types supported by the application. |
MutableList<String!> |
Query all hdr types that are not supported by the application. |
MutableList<String!> |
Query the video codec mime types that are not supported by the application. |
Boolean |
isFormatSpecified(format: String) Query if a format is specified by the application. |
Boolean |
isHdrTypeSupported(hdrType: String) Query if a HDR type is supported by the application. |
Boolean |
isVideoMimeTypeSupported(videoMime: String) Query if a video codec format is supported by the application. |
String |
toString() |
Unit |
writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel. |
Properties | |
---|---|
static Parcelable.Creator<ApplicationMediaCapabilities!> |
Public methods
createFromXml
static fun createFromXml(xmlParser: XmlPullParser): ApplicationMediaCapabilities
Creates ApplicationMediaCapabilities
from an xml. The xml's syntax is the same as the media_capabilities.xml used by the AndroidManifest.xml.
Here is an example:
<code><media-capabilities xmlns:android="http://schemas.android.com/apk/res/android"> <format android:name="HEVC" supported="true"/> <format android:name="HDR10" supported="false"/> <format android:name="HDR10Plus" supported="false"/> </media-capabilities> </code>
Parameters | |
---|---|
xmlParser |
XmlPullParser: The underlying XmlPullParser that will read the xml. This value cannot be null . |
Return | |
---|---|
ApplicationMediaCapabilities |
An ApplicationMediaCapabilities object. This value cannot be null . |
Exceptions | |
---|---|
java.lang.UnsupportedOperationException |
if the capabilities in xml config are invalid or incompatible. |
describeContents
fun describeContents(): Int
Return | |
---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR |
getSupportedHdrTypes
fun getSupportedHdrTypes(): MutableList<String!>
Query all hdr types that are supported by the application.
Return | |
---|---|
MutableList<String!> |
List of supported hdr types. The list will be empty if there are none. This value cannot be null . |
getSupportedVideoMimeTypes
fun getSupportedVideoMimeTypes(): MutableList<String!>
Query the video codec mime types supported by the application.
Return | |
---|---|
MutableList<String!> |
List of supported video codec mime types. The list will be empty if there are none. This value cannot be null . |
getUnsupportedHdrTypes
fun getUnsupportedHdrTypes(): MutableList<String!>
Query all hdr types that are not supported by the application.
Return | |
---|---|
MutableList<String!> |
List of unsupported hdr types. The list will be empty if there are none. This value cannot be null . |
getUnsupportedVideoMimeTypes
fun getUnsupportedVideoMimeTypes(): MutableList<String!>
Query the video codec mime types that are not supported by the application.
Return | |
---|---|
MutableList<String!> |
List of unsupported video codec mime types. The list will be empty if there are none. This value cannot be null . |
isFormatSpecified
fun isFormatSpecified(format: String): Boolean
Query if a format is specified by the application.
The format could be either the video format or the hdr format.
Parameters | |
---|---|
format |
String: The name of the format. This value cannot be null . |
Return | |
---|---|
Boolean |
true if application specifies the format, false otherwise. |
isHdrTypeSupported
fun isHdrTypeSupported(hdrType: String): Boolean
Query if a HDR type is supported by the application.
If the application has not specified supporting the format or not, this will return false. Use isFormatSpecified(java.lang.String)
to query if a format is specified or not.
Parameters | |
---|---|
hdrType |
String: The type of the HDR format. This value cannot be null . Value is android.media.MediaFeature.HdrType#DOLBY_VISION , android.media.MediaFeature.HdrType#HDR10 , android.media.MediaFeature.HdrType#HDR10_PLUS , or android.media.MediaFeature.HdrType#HLG |
Return | |
---|---|
Boolean |
true if application supports the HDR format, false otherwise. |
isVideoMimeTypeSupported
fun isVideoMimeTypeSupported(videoMime: String): Boolean
Query if a video codec format is supported by the application.
If the application has not specified supporting the format or not, this will return false. Use isFormatSpecified(java.lang.String)
to query if a format is specified or not.
Parameters | |
---|---|
videoMime |
String: The mime type of the video codec format. Must be the one used in MediaFormat#KEY_MIME . This value cannot be null . |
Return | |
---|---|
Boolean |
true if application supports the video codec format, false otherwise. |
toString
fun toString(): String
Return | |
---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
Parcel: This value cannot be null . |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE . Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |