MediaCodecInfo (library-core API)

java.lang.Object
- com.google.android.exoplayer2.mediacodec.MediaCodecInfo

public final class MediaCodecInfo
extends java.lang.Object

Information about a MediaCodec for a given mime type.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`adaptive` Whether the decoder supports seamless resolution switches.
`android.media.MediaCodecInfo.CodecCapabilities`	`capabilities` The capabilities of the decoder, like the profiles/levels it supports, or `null` if this is a passthrough codec.
`static int`	`MAX_SUPPORTED_INSTANCES_UNKNOWN` The value returned by `getMaxSupportedInstances()` if the upper bound on the maximum number of supported instances is unknown.
`java.lang.String`	`mimeType` The MIME type handled by the codec, or `null` if this is a passthrough codec.
`java.lang.String`	`name` The name of the decoder.
`boolean`	`passthrough` Whether this instance describes a passthrough codec.
`boolean`	`secure` Whether the decoder is secure.
`static java.lang.String`	`TAG`
`boolean`	`tunneling` Whether the decoder supports tunneling.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`android.graphics.Point`	`alignVideoSizeV21(int width, int height)` Returns the smallest video size greater than or equal to a specified size that also satisfies the `MediaCodec`'s width and height alignment requirements.
`int`	`getMaxSupportedInstances()` Returns an upper bound on the maximum number of supported instances, or `MAX_SUPPORTED_INSTANCES_UNKNOWN` if unknown.
`android.media.MediaCodecInfo.CodecProfileLevel[]`	`getProfileLevels()` The profile levels supported by the decoder.
`boolean`	`isAudioChannelCountSupportedV21(int channelCount)` Whether the decoder supports audio with a given channel count.
`boolean`	`isAudioSampleRateSupportedV21(int sampleRate)` Whether the decoder supports audio with a given sample rate.
`boolean`	`isCodecSupported(java.lang.String codec)` Whether the decoder supports the given `codec`.
`boolean`	`isFormatSupported(Format format)` Returns whether the decoder may support decoding the given `format`.
`boolean`	`isSeamlessAdaptationSupported(Format format)` Returns whether it may be possible to adapt to playing a different format when the codec is configured to play media in the specified `format`.
`boolean`	`isSeamlessAdaptationSupported(Format oldFormat, Format newFormat, boolean isNewFormatComplete)` Returns whether it is possible to adapt the decoder seamlessly from `oldFormat` to `newFormat`.
`boolean`	`isVideoSizeAndRateSupportedV21(int width, int height, double frameRate)` Whether the decoder supports video with a given width, height and frame rate.
`static MediaCodecInfo`	`newInstance(java.lang.String name, java.lang.String mimeType, android.media.MediaCodecInfo.CodecCapabilities capabilities)` Creates an instance.
`static MediaCodecInfo`	`newInstance(java.lang.String name, java.lang.String mimeType, android.media.MediaCodecInfo.CodecCapabilities capabilities, boolean forceDisableAdaptive, boolean forceSecure)` Creates an instance.
`static MediaCodecInfo`	`newPassthroughInstance(java.lang.String name)` Creates an instance representing an audio passthrough decoder.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TAG
```
public static final java.lang.String TAG
```
    See Also:
    
    Constant Field Values
  - MAX_SUPPORTED_INSTANCES_UNKNOWN
```
public static final int MAX_SUPPORTED_INSTANCES_UNKNOWN
```
    The value returned by getMaxSupportedInstances() if the upper bound on the maximum number of supported instances is unknown.
    
    See Also:
    
    Constant Field Values
  - name
```
public final java.lang.String name
```
    The name of the decoder.
    May be passed to MediaCodec.createByCodecName(String) to create an instance of the decoder.
  - mimeType
```
@Nullable
public final java.lang.String mimeType
```
    The MIME type handled by the codec, or null if this is a passthrough codec.
  - capabilities
```
@Nullable
public final android.media.MediaCodecInfo.CodecCapabilities capabilities
```
    The capabilities of the decoder, like the profiles/levels it supports, or null if this is a passthrough codec.
  - adaptive
```
public final boolean adaptive
```
    Whether the decoder supports seamless resolution switches.
    
    See Also:
    
    MediaCodecInfo.CodecCapabilities.isFeatureSupported(String), MediaCodecInfo.CodecCapabilities.FEATURE_AdaptivePlayback
  - tunneling
```
public final boolean tunneling
```
    Whether the decoder supports tunneling.
    
    See Also:
    
    MediaCodecInfo.CodecCapabilities.isFeatureSupported(String), MediaCodecInfo.CodecCapabilities.FEATURE_TunneledPlayback
  - secure
```
public final boolean secure
```
    Whether the decoder is secure.
    
    See Also:
    
    MediaCodecInfo.CodecCapabilities.isFeatureSupported(String), MediaCodecInfo.CodecCapabilities.FEATURE_SecurePlayback
  - passthrough
```
public final boolean passthrough
```
    Whether this instance describes a passthrough codec.
- Method Detail
  - newPassthroughInstance
```
public static MediaCodecInfo newPassthroughInstance(java.lang.String name)
```
    Creates an instance representing an audio passthrough decoder.
    
    Parameters:
    
    name - The name of the MediaCodec.
    
    Returns:
    
    The created instance.
  - newInstance
```
public static MediaCodecInfo newInstance(java.lang.String name,
                                         java.lang.String mimeType,
                                         android.media.MediaCodecInfo.CodecCapabilities capabilities)
```
    Creates an instance.
    
    Parameters:
    
    name - The name of the MediaCodec.
    
    mimeType - A mime type supported by the MediaCodec.
    
    capabilities - The capabilities of the MediaCodec for the specified mime type.
    
    Returns:
    
    The created instance.
  - newInstance
```
public static MediaCodecInfo newInstance(java.lang.String name,
                                         java.lang.String mimeType,
                                         android.media.MediaCodecInfo.CodecCapabilities capabilities,
                                         boolean forceDisableAdaptive,
                                         boolean forceSecure)
```
    Creates an instance.
    
    Parameters:
    
    name - The name of the MediaCodec.
    
    mimeType - A mime type supported by the MediaCodec.
    
    capabilities - The capabilities of the MediaCodec for the specified mime type.
    
    forceDisableAdaptive - Whether adaptive should be forced to false.
    
    forceSecure - Whether secure should be forced to true.
    
    Returns:
    
    The created instance.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getProfileLevels
```
public android.media.MediaCodecInfo.CodecProfileLevel[] getProfileLevels()
```
    The profile levels supported by the decoder.
    
    Returns:
    
    The profile levels supported by the decoder.
  - getMaxSupportedInstances
```
public int getMaxSupportedInstances()
```
    Returns an upper bound on the maximum number of supported instances, or MAX_SUPPORTED_INSTANCES_UNKNOWN if unknown. Applications should not expect to operate more instances than the returned maximum.
    
    See Also:
    
    MediaCodecInfo.CodecCapabilities.getMaxSupportedInstances()
  - isFormatSupported
```
public boolean isFormatSupported(Format format)
                          throws MediaCodecUtil.DecoderQueryException
```
    Returns whether the decoder may support decoding the given format.
    
    Parameters:
    
    format - The input media format.
    
    Returns:
    
    Whether the decoder may support decoding the given format.
    
    Throws:
    
    MediaCodecUtil.DecoderQueryException - Thrown if an error occurs while querying decoders.
  - isCodecSupported
```
public boolean isCodecSupported(java.lang.String codec)
```
    Whether the decoder supports the given codec. If there is insufficient information to decide, returns true.
    
    Parameters:
    
    codec - Codec string as defined in RFC 6381.
    
    Returns:
    
    True if the given codec is supported by the decoder.
  - isSeamlessAdaptationSupported
```
public boolean isSeamlessAdaptationSupported(Format format)
```
    Returns whether it may be possible to adapt to playing a different format when the codec is configured to play media in the specified format. For adaptation to succeed, the codec must also be configured with appropriate maximum values and isSeamlessAdaptationSupported(Format, Format, boolean) must return true for the old/new formats.
    
    Parameters:
    
    format - The format of media for which the decoder will be configured.
    
    Returns:
    
    Whether adaptation may be possible
  - isSeamlessAdaptationSupported
```
public boolean isSeamlessAdaptationSupported(Format oldFormat,
                                             Format newFormat,
                                             boolean isNewFormatComplete)
```
    Returns whether it is possible to adapt the decoder seamlessly from oldFormat to newFormat. If newFormat may not be completely populated, pass false for isNewFormatComplete.
    
    Parameters:
    
    oldFormat - The format being decoded.
    
    newFormat - The new format.
    
    isNewFormatComplete - Whether newFormat is populated with format-specific metadata.
    
    Returns:
    
    Whether it is possible to adapt the decoder seamlessly.
  - isVideoSizeAndRateSupportedV21
```
public boolean isVideoSizeAndRateSupportedV21(int width,
                                              int height,
                                              double frameRate)
```
    Whether the decoder supports video with a given width, height and frame rate.
    Must not be called if the device SDK version is less than 21.
    
    Parameters:
    
    width - Width in pixels.
    
    height - Height in pixels.
    
    frameRate - Optional frame rate in frames per second. Ignored if set to Format.NO_VALUE or any value less than or equal to 0.
    
    Returns:
    
    Whether the decoder supports video with the given width, height and frame rate.
  - alignVideoSizeV21
```
public android.graphics.Point alignVideoSizeV21(int width,
                                                int height)
```
    Returns the smallest video size greater than or equal to a specified size that also satisfies the MediaCodec's width and height alignment requirements.
    Must not be called if the device SDK version is less than 21.
    
    Parameters:
    
    width - Width in pixels.
    
    height - Height in pixels.
    
    Returns:
    
    The smallest video size greater than or equal to the specified size that also satisfies the MediaCodec's width and height alignment requirements, or null if not a video codec.
  - isAudioSampleRateSupportedV21
```
public boolean isAudioSampleRateSupportedV21(int sampleRate)
```
    Whether the decoder supports audio with a given sample rate.
    Must not be called if the device SDK version is less than 21.
    
    Parameters:
    
    sampleRate - The sample rate in Hz.
    
    Returns:
    
    Whether the decoder supports audio with the given sample rate.
  - isAudioChannelCountSupportedV21
```
public boolean isAudioChannelCountSupportedV21(int channelCount)
```
    Whether the decoder supports audio with a given channel count.
    Must not be called if the device SDK version is less than 21.
    
    Parameters:
    
    channelCount - The channel count.
    
    Returns:
    
    Whether the decoder supports audio with the given channel count.

Class MediaCodecInfo

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAG

MAX_SUPPORTED_INSTANCES_UNKNOWN

name

mimeType

capabilities

adaptive

tunneling

secure

passthrough

Method Detail

newPassthroughInstance

newInstance

newInstance

toString

getProfileLevels

getMaxSupportedInstances

isFormatSupported

isCodecSupported

isSeamlessAdaptationSupported

isSeamlessAdaptationSupported

isVideoSizeAndRateSupportedV21

alignVideoSizeV21

isAudioSampleRateSupportedV21

isAudioChannelCountSupportedV21