public
final
class
MediaFormat
extends Object
java.lang.Object | |
↳ | android.media.MediaFormat |
Encapsulates the information describing the format of media data, be it audio or video. The format of the media data is specified as string/value pairs. Keys common to all audio/video formats, all keys not marked optional are mandatory:
Name | Value Type | Description |
---|---|---|
KEY_MIME | String | The type of the format. |
KEY_MAX_INPUT_SIZE | Integer | optional, maximum size of a buffer of input data |
KEY_BIT_RATE | Integer | encoder-only, desired bitrate in bits/second |
Name | Value Type | Description |
---|---|---|
KEY_WIDTH | Integer | |
KEY_HEIGHT | Integer | |
KEY_COLOR_FORMAT | Integer | set by the user for encoders, readable in the output format of decoders |
KEY_FRAME_RATE | Integer or Float | required for encoders, optional for decoders |
KEY_CAPTURE_RATE | Integer | |
KEY_I_FRAME_INTERVAL | Integer | encoder-only |
KEY_INTRA_REFRESH_PERIOD | Integer | encoder-only, optional |
KEY_MAX_WIDTH | Integer | decoder-only, optional, max-resolution width |
KEY_MAX_HEIGHT | Integer | decoder-only, optional, max-resolution height |
KEY_REPEAT_PREVIOUS_FRAME_AFTER | Long | video encoder in surface-mode only |
KEY_PUSH_BLANK_BUFFERS_ON_STOP | Integer(1) | video decoder rendering to a surface only |
KEY_MAX_WIDTH
and KEY_MAX_HEIGHT
to enable
adaptive playback (seamless resolution change) for a video decoder that
supports it (FEATURE_AdaptivePlayback
).
The values are used as hints for the codec: they are the maximum expected
resolution to prepare for. Depending on codec support, preparing for larger
maximum resolution may require more memory even if that resolution is never
reached. These fields have no effect for codecs that do not support adaptive
playback.Name | Value Type | Description |
---|---|---|
KEY_CHANNEL_COUNT | Integer | |
KEY_SAMPLE_RATE | Integer | |
KEY_PCM_ENCODING | Integer | optional |
KEY_IS_ADTS | Integer | optional, if decoding AAC audio content, setting this key to 1 indicates that each audio frame is prefixed by the ADTS header. |
KEY_AAC_PROFILE | Integer | encoder-only, optional, if content is AAC audio, specifies the desired profile. |
KEY_AAC_SBR_MODE | Integer | encoder-only, optional, if content is AAC audio, specifies the desired SBR mode. |
KEY_AAC_DRC_TARGET_REFERENCE_LEVEL | Integer | decoder-only, optional, if content is AAC audio, specifies the target reference level. |
KEY_AAC_ENCODED_TARGET_LEVEL | Integer | decoder-only, optional, if content is AAC audio, specifies the target reference level used at encoder. |
KEY_AAC_DRC_BOOST_FACTOR | Integer | decoder-only, optional, if content is AAC audio, specifies the DRC boost factor. |
KEY_AAC_DRC_ATTENUATION_FACTOR | Integer | decoder-only, optional, if content is AAC audio, specifies the DRC attenuation factor. |
KEY_AAC_DRC_HEAVY_COMPRESSION | Integer | decoder-only, optional, if content is AAC audio, specifies whether to use heavy compression. |
KEY_AAC_MAX_OUTPUT_CHANNEL_COUNT | Integer | decoder-only, optional, if content is AAC audio, specifies the maximum number of channels the decoder outputs. |
KEY_CHANNEL_MASK | Integer | optional, a mask of audio channel assignments |
KEY_FLAC_COMPRESSION_LEVEL | Integer | encoder-only, optional, if content is FLAC audio, specifies the desired compression level. |
KEY_MIME | String | The type of the format. |
KEY_LANGUAGE | String | The language of the content. |
Constants | |
---|---|
int |
COLOR_RANGE_FULL
Full range. |
int |
COLOR_RANGE_LIMITED
Limited range. |
int |
COLOR_STANDARD_BT2020
BT.2020 color chromacity coordinates with KR = 0.2627, KB = 0.0593. |
int |
COLOR_STANDARD_BT601_NTSC
BT.601 525 color chromacity coordinates with KR = 0.299, KB = 0.114. |
int |
COLOR_STANDARD_BT601_PAL
BT.601 625 color chromacity coordinates with KR = 0.299, KB = 0.114. |
int |
COLOR_STANDARD_BT709
BT.709 color chromacity coordinates with KR = 0.2126, KB = 0.0722. |
int |
COLOR_TRANSFER_HLG
ARIB STD-B67 hybrid-log-gamma transfer function. |
int |
COLOR_TRANSFER_LINEAR
Linear transfer characteristic curve. |
int |
COLOR_TRANSFER_SDR_VIDEO
SMPTE 170M transfer characteristic curve used by BT.601/BT.709/BT.2020. |
int |
COLOR_TRANSFER_ST2084
SMPTE ST 2084 transfer function. |
String |
KEY_AAC_DRC_ATTENUATION_FACTOR
A key describing the attenuation factor allowing to adapt the dynamics of the output to the actual listening requirements. |
String |
KEY_AAC_DRC_BOOST_FACTOR
A key describing the boost factor allowing to adapt the dynamics of the output to the actual listening requirements. |
String |
KEY_AAC_DRC_HEAVY_COMPRESSION
A key describing the selection of the heavy compression profile for DRC. |
String |
KEY_AAC_DRC_TARGET_REFERENCE_LEVEL
A key describing a gain to be applied so that the output loudness matches the Target Reference Level. |
String |
KEY_AAC_ENCODED_TARGET_LEVEL
A key describing the target reference level that was assumed at the encoder for calculation of attenuation gains for clipping prevention. |
String |
KEY_AAC_MAX_OUTPUT_CHANNEL_COUNT
A key describing the maximum number of channels that can be output by the AAC decoder. |
String |
KEY_AAC_PROFILE
A key describing the AAC profile to be used (AAC audio formats only). |
String |
KEY_AAC_SBR_MODE
A key describing the AAC SBR mode to be used (AAC audio formats only). |
String |
KEY_AUDIO_SESSION_ID
A key describing the audio session ID of the AudioTrack associated to a tunneled video codec. |
String |
KEY_BITRATE_MODE
A key describing the desired bitrate mode to be used by an encoder. |
String |
KEY_BIT_RATE
A key describing the average bitrate in bits/sec. |
String |
KEY_CAPTURE_RATE
A key describing the capture rate of a video format in frames/sec. |
String |
KEY_CHANNEL_COUNT
A key describing the number of channels in an audio format. |
String |
KEY_CHANNEL_MASK
A key describing the channel composition of audio content. |
String |
KEY_COLOR_FORMAT
A key describing the color format of the content in a video format. |
String |
KEY_COLOR_RANGE
An optional key describing the range of the component values of the video content. |
String |
KEY_COLOR_STANDARD
An optional key describing the color primaries, white point and luminance factors for video content. |
String |
KEY_COLOR_TRANSFER
An optional key describing the opto-electronic transfer function used for the video content. |
String |
KEY_COMPLEXITY
A key describing the encoding complexity. |
String |
KEY_DURATION
A key describing the duration (in microseconds) of the content. |
String |
KEY_FLAC_COMPRESSION_LEVEL
A key describing the FLAC compression level to be used (FLAC audio format only). |
String |
KEY_FRAME_RATE
A key describing the frame rate of a video format in frames/sec. |
String |
KEY_HDR_STATIC_INFO
An optional key describing the static metadata of HDR (high-dynamic-range) video content. |
String |
KEY_HEIGHT
A key describing the height of the content in a video format. |
String |
KEY_INTRA_REFRESH_PERIOD
An optional key describing the period of intra refresh in frames. |
String |
KEY_IS_ADTS
A key mapping to a value of 1 if the content is AAC audio and audio frames are prefixed with an ADTS header. |
String |
KEY_IS_AUTOSELECT
A key for boolean AUTOSELECT behavior for the track. |
String |
KEY_IS_DEFAULT
A key for boolean DEFAULT behavior for the track. |
String |
KEY_IS_FORCED_SUBTITLE
A key for the FORCED field for subtitle tracks. |
String |
KEY_I_FRAME_INTERVAL
A key describing the frequency of I frames expressed in secs between I frames. |
String |
KEY_LANGUAGE
A key describing the language of the content, using either ISO 639-1 or 639-2/T codes. |
String |
KEY_LEVEL
A key describing the desired profile to be used by an encoder. |
String |
KEY_MAX_HEIGHT
A key describing the maximum expected height of the content in a video decoder format, in case there are resolution changes in the video content. |
String |
KEY_MAX_INPUT_SIZE
A key describing the maximum size in bytes of a buffer of data described by this MediaFormat. |
String |
KEY_MAX_WIDTH
A key describing the maximum expected width of the content in a video decoder format, in case there are resolution changes in the video content. |
String |
KEY_MIME
A key describing the mime type of the MediaFormat. |
String |
KEY_OPERATING_RATE
A key describing the desired operating frame rate for video or sample rate for audio that the codec will need to operate at. |
String |
KEY_PCM_ENCODING
A key describing the raw audio sample encoding/format. |
String |
KEY_PRIORITY
A key describing the desired codec priority. |
String |
KEY_PROFILE
A key describing the desired profile to be used by an encoder. |
String |
KEY_PUSH_BLANK_BUFFERS_ON_STOP
If specified when configuring a video decoder rendering to a surface, causes the decoder to output "blank", i.e. |
String |
KEY_REPEAT_PREVIOUS_FRAME_AFTER
Applies only when configuring a video encoder in "surface-input" mode. |
String |
KEY_ROTATION
A key describing the desired clockwise rotation on an output surface. |
String |
KEY_SAMPLE_RATE
A key describing the sample rate of an audio format. |
String |
KEY_SLICE_HEIGHT
A key describing the plane height of a multi-planar (YUV) video bytebuffer layout. |
String |
KEY_STRIDE
A key describing the stride of the video bytebuffer layout. |
String |
KEY_TEMPORAL_LAYERING
A key describing the temporal layering schema. |
String |
KEY_TRACK_ID
A key describing a unique ID for the content of a media track. |
String |
KEY_WIDTH
A key describing the width of the content in a video format. |
String |
MIMETYPE_AUDIO_AAC
|
String |
MIMETYPE_AUDIO_AC3
|
String |
MIMETYPE_AUDIO_AMR_NB
|
String |
MIMETYPE_AUDIO_AMR_WB
|
String |
MIMETYPE_AUDIO_EAC3
|
String |
MIMETYPE_AUDIO_FLAC
|
String |
MIMETYPE_AUDIO_G711_ALAW
|
String |
MIMETYPE_AUDIO_G711_MLAW
|
String |
MIMETYPE_AUDIO_MPEG
|
String |
MIMETYPE_AUDIO_MSGSM
|
String |
MIMETYPE_AUDIO_OPUS
|
String |
MIMETYPE_AUDIO_QCELP
|
String |
MIMETYPE_AUDIO_RAW
|
String |
MIMETYPE_AUDIO_VORBIS
|
String |
MIMETYPE_TEXT_CEA_608
MIME type for CEA-608 closed caption data. |
String |
MIMETYPE_TEXT_VTT
MIME type for WebVTT subtitle data. |
String |
MIMETYPE_VIDEO_AVC
|
String |
MIMETYPE_VIDEO_DOLBY_VISION
|
String |
MIMETYPE_VIDEO_H263
|
String |
MIMETYPE_VIDEO_HEVC
|
String |
MIMETYPE_VIDEO_MPEG2
|
String |
MIMETYPE_VIDEO_MPEG4
|
String |
MIMETYPE_VIDEO_RAW
|
String |
MIMETYPE_VIDEO_VP8
|
String |
MIMETYPE_VIDEO_VP9
|
Public constructors | |
---|---|
MediaFormat()
Creates an empty MediaFormat |
Public methods | |
---|---|
final
boolean
|
containsKey(String name)
Returns true iff a key of the given name exists in the format. |
static
final
MediaFormat
|
createAudioFormat(String mime, int sampleRate, int channelCount)
Creates a minimal audio format. |
static
final
MediaFormat
|
createSubtitleFormat(String mime, String language)
Creates a minimal subtitle format. |
static
final
MediaFormat
|
createVideoFormat(String mime, int width, int height)
Creates a minimal video format. |
final
ByteBuffer
|
getByteBuffer(String name)
Returns the value of a ByteBuffer key. |
boolean
|
getFeatureEnabled(String feature)
Returns whether a feature is to be enabled ( |
final
float
|
getFloat(String name)
Returns the value of a float key. |
final
int
|
getInteger(String name)
Returns the value of an integer key. |
final
long
|
getLong(String name)
Returns the value of a long key. |
final
String
|
getString(String name)
Returns the value of a string key. |
final
void
|
setByteBuffer(String name, ByteBuffer bytes)
Sets the value of a ByteBuffer key. |
void
|
setFeatureEnabled(String feature, boolean enabled)
Sets whether a feature is to be enabled ( |
final
void
|
setFloat(String name, float value)
Sets the value of a float key. |
final
void
|
setInteger(String name, int value)
Sets the value of an integer key. |
final
void
|
setLong(String name, long value)
Sets the value of a long key. |
final
void
|
setString(String name, String value)
Sets the value of a string key. |
String
|
toString()
Returns a string representation of the object. |
Inherited methods | |
---|---|
From
class
java.lang.Object
|
int COLOR_RANGE_FULL
Full range. Y, Cr and Cb component values range from 0 to 255 for 8-bit content.
Constant Value: 1 (0x00000001)
int COLOR_RANGE_LIMITED
Limited range. Y component values range from 16 to 235 for 8-bit content. Cr, Cy values range from 16 to 240 for 8-bit content. This is the default for video content.
Constant Value: 2 (0x00000002)
int COLOR_STANDARD_BT2020
BT.2020 color chromacity coordinates with KR = 0.2627, KB = 0.0593.
Constant Value: 6 (0x00000006)
int COLOR_STANDARD_BT601_NTSC
BT.601 525 color chromacity coordinates with KR = 0.299, KB = 0.114.
Constant Value: 4 (0x00000004)
int COLOR_STANDARD_BT601_PAL
BT.601 625 color chromacity coordinates with KR = 0.299, KB = 0.114.
Constant Value: 2 (0x00000002)
int COLOR_STANDARD_BT709
BT.709 color chromacity coordinates with KR = 0.2126, KB = 0.0722.
Constant Value: 1 (0x00000001)
int COLOR_TRANSFER_HLG
ARIB STD-B67 hybrid-log-gamma transfer function. This is used by some HDR video content.
Constant Value: 7 (0x00000007)
int COLOR_TRANSFER_LINEAR
Linear transfer characteristic curve.
Constant Value: 1 (0x00000001)
int COLOR_TRANSFER_SDR_VIDEO
SMPTE 170M transfer characteristic curve used by BT.601/BT.709/BT.2020. This is the curve used by most non-HDR video content.
Constant Value: 3 (0x00000003)
int COLOR_TRANSFER_ST2084
SMPTE ST 2084 transfer function. This is used by some HDR video content.
Constant Value: 6 (0x00000006)
String KEY_AAC_DRC_ATTENUATION_FACTOR
A key describing the attenuation factor allowing to adapt the dynamics of the output to the
actual listening requirements.
See KEY_AAC_DRC_BOOST_FACTOR
for a description of the role of this attenuation
factor and the value range.
This key is only used during decoding.
Constant Value: "aac-drc-cut-level"
String KEY_AAC_DRC_BOOST_FACTOR
A key describing the boost factor allowing to adapt the dynamics of the output to the actual listening requirements. This relies on DRC gain sequences that can be transmitted in the encoded bitstream to be able to reduce the dynamics of the output signal upon request. This factor enables the user to select how much of the gains are applied.
Positive gains (boost) and negative gains (attenuation, see
KEY_AAC_DRC_ATTENUATION_FACTOR
) can be controlled separately for a better match
to different use-cases.
Typically, attenuation gains are sent for loud signal segments, and boost gains are sent for soft signal segments. If the output is listened to in a noisy environment, for example, the boost factor is used to enable the positive gains, i.e. to amplify soft signal segments beyond the noise floor. But for listening late at night, the attenuation factor is used to enable the negative gains, to prevent loud signal from surprising the listener. In applications which generally need a low dynamic range, both the boost factor and the attenuation factor are used in order to enable all DRC gains.
In order to prevent clipping, it is also recommended to apply the attenuation factors in case of a downmix and/or loudness normalization to high target reference levels.
Both the boost and the attenuation factor parameters are given as integer values between 0 and 127, representing the range of the factor of 0 (i.e. don't apply) to 1 (i.e. fully apply boost/attenuation factors respectively).
This key is only used during decoding.
Constant Value: "aac-drc-boost-level"
String KEY_AAC_DRC_HEAVY_COMPRESSION
A key describing the selection of the heavy compression profile for DRC. Two separate DRC gain sequences can be transmitted in one bitstream: MPEG-4 DRC light compression, and DVB-specific heavy compression. When selecting the application of the heavy compression, one of the sequences is selected:
KEY_AAC_DRC_BOOST_FACTOR
and KEY_AAC_DRC_ATTENUATION_FACTOR
for the
boost and attenuation factors, and frequency-selective (multiband) DRC.
Light compression usually contains clipping prevention for stereo downmixing while heavy
compression, if additionally provided in the bitstream, is usually stronger, and contains
clipping prevention for stereo and mono downmixing.
The default is light compression.
This key is only used during decoding.
Constant Value: "aac-drc-heavy-compression"
String KEY_AAC_DRC_TARGET_REFERENCE_LEVEL
A key describing a gain to be applied so that the output loudness matches the Target Reference Level. This is typically used to normalize loudness across program items. The gain is derived as the difference between the Target Reference Level and the Program Reference Level. The latter can be given in the bitstream and indicates the actual loudness value of the program item.
The value is given as an integer value between 0 and 127, and is calculated as -0.25 * Target Reference Level in dBFS. Therefore, it represents the range of Full Scale (0 dBFS) to -31.75 dBFS.
This key is only used during decoding.
Constant Value: "aac-target-ref-level"
String KEY_AAC_ENCODED_TARGET_LEVEL
A key describing the target reference level that was assumed at the encoder for calculation of attenuation gains for clipping prevention. This information can be provided if it is known, otherwise a worst-case assumption is used.
The value is given as an integer value between 0 and 127, and is calculated as -0.25 * Target Reference Level in dBFS. Therefore, it represents the range of Full Scale (0 dBFS) to -31.75 dBFS. The default value is the worst-case assumption of 127.
The value is ignored when heavy compression is used (see
KEY_AAC_DRC_HEAVY_COMPRESSION
).
This key is only used during decoding.
Constant Value: "aac-encoded-target-level"
String KEY_AAC_MAX_OUTPUT_CHANNEL_COUNT
A key describing the maximum number of channels that can be output by the AAC decoder. By default, the decoder will output the same number of channels as present in the encoded stream, if supported. Set this value to limit the number of output channels, and use the downmix information in the stream, if available.
Values larger than the number of channels in the content to decode are ignored.
This key is only used during decoding.
Constant Value: "aac-max-output-channel_count"
String KEY_AAC_PROFILE
A key describing the AAC profile to be used (AAC audio formats only).
Constants are declared in MediaCodecInfo.CodecProfileLevel
.
Constant Value: "aac-profile"
String KEY_AAC_SBR_MODE
A key describing the AAC SBR mode to be used (AAC audio formats only). The associated value is an integer and can be set to following values:
This key is only used during encoding.
Constant Value: "aac-sbr-mode"
String KEY_AUDIO_SESSION_ID
A key describing the audio session ID of the AudioTrack associated to a tunneled video codec. The associated value is an integer.
See also:
Constant Value: "audio-session-id"
String KEY_BITRATE_MODE
A key describing the desired bitrate mode to be used by an encoder.
Constants are declared in MediaCodecInfo.CodecCapabilities
.
See also:
Constant Value: "bitrate-mode"
String KEY_BIT_RATE
A key describing the average bitrate in bits/sec. The associated value is an integer
Constant Value: "bitrate"
String KEY_CAPTURE_RATE
A key describing the capture rate of a video format in frames/sec.
When capture rate is different than the frame rate, it means that the video is acquired at a different rate than the playback, which produces slow motion or timelapse effect during playback. Application can use the value of this key to tell the relative speed ratio between capture and playback rates when the video was recorded.
The associated value is an integer or a float.
Constant Value: "capture-rate"
String KEY_CHANNEL_COUNT
A key describing the number of channels in an audio format. The associated value is an integer
Constant Value: "channel-count"
String KEY_CHANNEL_MASK
A key describing the channel composition of audio content. This mask
is composed of bits drawn from channel mask definitions in AudioFormat
.
The associated value is an integer.
Constant Value: "channel-mask"
String KEY_COLOR_FORMAT
A key describing the color format of the content in a video format.
Constants are declared in MediaCodecInfo.CodecCapabilities
.
Constant Value: "color-format"
String KEY_COLOR_RANGE
An optional key describing the range of the component values of the video content. The associated value is an integer: 0 if unspecified, or one of the COLOR_RANGE_ values.
Constant Value: "color-range"
String KEY_COLOR_STANDARD
An optional key describing the color primaries, white point and luminance factors for video content. The associated value is an integer: 0 if unspecified, or one of the COLOR_STANDARD_ values.
Constant Value: "color-standard"
String KEY_COLOR_TRANSFER
An optional key describing the opto-electronic transfer function used for the video content. The associated value is an integer: 0 if unspecified, or one of the COLOR_TRANSFER_ values.
Constant Value: "color-transfer"
String KEY_COMPLEXITY
A key describing the encoding complexity. The associated value is an integer. These values are device and codec specific, but lower values generally result in faster and/or less power-hungry encoding.
See also:
Constant Value: "complexity"
String KEY_DURATION
A key describing the duration (in microseconds) of the content. The associated value is a long.
Constant Value: "durationUs"
String KEY_FLAC_COMPRESSION_LEVEL
A key describing the FLAC compression level to be used (FLAC audio format only). The associated value is an integer ranging from 0 (fastest, least compression) to 8 (slowest, most compression).
Constant Value: "flac-compression-level"
String KEY_FRAME_RATE
A key describing the frame rate of a video format in frames/sec.
The associated value is normally an integer when the value is used by the platform,
but video codecs also accept float configuration values.
Specifically, MediaExtractor
provides an integer
value corresponding to the frame rate information of the track if specified and non-zero.
Otherwise, this key is not present. MediaCodec
accepts both
float and integer values. This represents the desired operating frame rate if the
KEY_OPERATING_RATE
is not present and KEY_PRIORITY
is 0
(realtime). For video encoders this value corresponds to the intended frame rate,
although encoders are expected
to support variable frame rate based on buffer timestamp
. This key is not used in the MediaCodec
input
/output
formats,
nor by MediaMuxer
.
Constant Value: "frame-rate"
String KEY_HDR_STATIC_INFO
An optional key describing the static metadata of HDR (high-dynamic-range) video content. The associated value is a ByteBuffer. This buffer contains the raw contents of the Static Metadata Descriptor (including the descriptor ID) of an HDMI Dynamic Range and Mastering InfoFrame as defined by CTA-861.3. This key must be provided to video decoders for HDR video content unless this information is contained in the bitstream and the video decoder supports an HDR-capable profile. This key must be provided to video encoders for HDR video content.
Constant Value: "hdr-static-info"
String KEY_HEIGHT
A key describing the height of the content in a video format. The associated value is an integer
Constant Value: "height"
String KEY_INTRA_REFRESH_PERIOD
An optional key describing the period of intra refresh in frames. This is an
optional parameter that applies only to video encoders. If encoder supports it
(FEATURE_IntraRefresh
), the whole
frame is completely refreshed after the specified period. Also for each frame,
a fix subset of macroblocks must be intra coded which leads to more constant bitrate
than inserting a key frame. This key is recommended for video streaming applications
as it provides low-delay and good error-resilience. This key is ignored if the
video encoder does not support the intra refresh feature. Use the output format to
verify that this feature was enabled.
The associated value is an integer.
Constant Value: "intra-refresh-period"
String KEY_IS_ADTS
A key mapping to a value of 1 if the content is AAC audio and audio frames are prefixed with an ADTS header. The associated value is an integer (0 or 1). This key is only supported when _decoding_ content, it cannot be used to configure an encoder to emit ADTS output.
Constant Value: "is-adts"
String KEY_IS_AUTOSELECT
A key for boolean AUTOSELECT behavior for the track. Tracks with AUTOSELECT=true are considered when automatically selecting a track without specific user choice, based on the current locale. This is currently only used for subtitle tracks, when the user selected 'Default' for the captioning locale. The associated value is an integer, where non-0 means TRUE. This is an optional field; if not specified, AUTOSELECT defaults to TRUE.
Constant Value: "is-autoselect"
String KEY_IS_DEFAULT
A key for boolean DEFAULT behavior for the track. The track with DEFAULT=true is selected in the absence of a specific user choice. This is currently only used for subtitle tracks, when the user selected 'Default' for the captioning locale. The associated value is an integer, where non-0 means TRUE. This is an optional field; if not specified, DEFAULT is considered to be FALSE.
Constant Value: "is-default"
String KEY_IS_FORCED_SUBTITLE
A key for the FORCED field for subtitle tracks. True if it is a forced subtitle track. Forced subtitle tracks are essential for the content and are shown even when the user turns off Captions. They are used for example to translate foreign/alien dialogs or signs. The associated value is an integer, where non-0 means TRUE. This is an optional field; if not specified, FORCED defaults to FALSE.
Constant Value: "is-forced-subtitle"
String KEY_I_FRAME_INTERVAL
A key describing the frequency of I frames expressed in secs between I frames. The associated value is an integer.
Constant Value: "i-frame-interval"
String KEY_LANGUAGE
A key describing the language of the content, using either ISO 639-1 or 639-2/T codes. The associated value is a string.
Constant Value: "language"
String KEY_LEVEL
A key describing the desired profile to be used by an encoder.
The associated value is an integer.
Constants are declared in MediaCodecInfo.CodecProfileLevel
.
This key is used as a further hint when specifying a desired profile,
and is only supported for codecs that specify a level.
This key is ignored if the profile
is not specified.
See also:
Constant Value: "level"
String KEY_MAX_HEIGHT
A key describing the maximum expected height of the content in a video decoder format, in case there are resolution changes in the video content. The associated value is an integer
Constant Value: "max-height"
String KEY_MAX_INPUT_SIZE
A key describing the maximum size in bytes of a buffer of data described by this MediaFormat. The associated value is an integer
Constant Value: "max-input-size"
String KEY_MAX_WIDTH
A key describing the maximum expected width of the content in a video decoder format, in case there are resolution changes in the video content. The associated value is an integer
Constant Value: "max-width"
String KEY_MIME
A key describing the mime type of the MediaFormat. The associated value is a string.
Constant Value: "mime"
String KEY_OPERATING_RATE
A key describing the desired operating frame rate for video or sample rate for audio that the codec will need to operate at.
The associated value is an integer or a float representing frames-per-second or samples-per-second
This is used for cases like high-speed/slow-motion video capture, where the video encoder format contains the target playback rate (e.g. 30fps), but the component must be able to handle the high operating capture rate (e.g. 240fps).
This rate will be used by codec for resource planning and setting the operating points.
Constant Value: "operating-rate"
String KEY_PCM_ENCODING
A key describing the raw audio sample encoding/format.
The associated value is an integer, using one of the
AudioFormat
.ENCODING_PCM_ values.
This is an optional key for audio decoders and encoders specifying the
desired raw audio sample format during MediaCodec.configure(…)
call. Use MediaCodec.getInput
/OutputFormat(…)
to confirm the actual format. For the PCM decoder this key specifies both
input and output sample encodings.
This key is also used by MediaExtractor
to specify the sample
format of audio data, if it is specified.
If this key is missing, the raw audio sample format is signed 16-bit short.
Constant Value: "pcm-encoding"
String KEY_PRIORITY
A key describing the desired codec priority.
The associated value is an integer. Higher value means lower priority.
Currently, only two levels are supported:
0: realtime priority - meaning that the codec shall support the given
performance configuration (e.g. framerate) at realtime. This should
only be used by media playback, capture, and possibly by realtime
communication scenarios if best effort performance is not suitable.
1: non-realtime priority (best effort).
This is a hint used at codec configuration and resource planning - to understand the realtime requirements of the application; however, due to the nature of media components, performance is not guaranteed.
Constant Value: "priority"
String KEY_PROFILE
A key describing the desired profile to be used by an encoder.
The associated value is an integer.
Constants are declared in MediaCodecInfo.CodecProfileLevel
.
This key is used as a hint, and is only supported for codecs
that specify a profile. Note: Codecs are free to use all the available
coding tools at the specified profile.
See also:
Constant Value: "profile"
String KEY_PUSH_BLANK_BUFFERS_ON_STOP
If specified when configuring a video decoder rendering to a surface, causes the decoder to output "blank", i.e. black frames to the surface when stopped to clear out any previously displayed contents. The associated value is an integer of value 1.
Constant Value: "push-blank-buffers-on-shutdown"
String KEY_REPEAT_PREVIOUS_FRAME_AFTER
Applies only when configuring a video encoder in "surface-input" mode. The associated value is a long and gives the time in microseconds after which the frame previously submitted to the encoder will be repeated (once) if no new frame became available since.
Constant Value: "repeat-previous-frame-after"
String KEY_ROTATION
A key describing the desired clockwise rotation on an output surface. This key is only used when the codec is configured using an output surface. The associated value is an integer, representing degrees. Supported values are 0, 90, 180 or 270. This is an optional field; if not specified, rotation defaults to 0.
See also:
Constant Value: "rotation-degrees"
String KEY_SAMPLE_RATE
A key describing the sample rate of an audio format. The associated value is an integer
Constant Value: "sample-rate"
String KEY_SLICE_HEIGHT
A key describing the plane height of a multi-planar (YUV) video bytebuffer layout. Slice height (or plane height/vertical stride) is the number of rows that must be skipped to get from the top of the Y plane to the top of the U plane in the bytebuffer. In essence the offset of the U plane is sliceHeight * stride. The height of the U/V planes can be calculated based on the color format, though it is generally undefined and depends on the device and release. The associated value is an integer, representing number of rows.
Constant Value: "slice-height"
String KEY_STRIDE
A key describing the stride of the video bytebuffer layout. Stride (or row increment) is the difference between the index of a pixel and that of the pixel directly underneath. For YUV 420 formats, the stride corresponds to the Y plane; the stride of the U and V planes can be calculated based on the color format, though it is generally undefined and depends on the device and release. The associated value is an integer, representing number of bytes.
Constant Value: "stride"
String KEY_TEMPORAL_LAYERING
A key describing the temporal layering schema. This is an optional parameter
that applies only to video encoders. Use getInputFormat()
after configure
to query if the encoder supports
the desired schema. Supported values are webrtc.vp8.1-layer
,
webrtc.vp8.2-layer
, webrtc.vp8.3-layer
, and none
.
If the encoder does not support temporal layering, the input format will
not have an entry with this key.
The associated value is a string.
Constant Value: "ts-schema"
String KEY_TRACK_ID
A key describing a unique ID for the content of a media track.
This key is used by MediaExtractor
. Some extractors provide multiple encodings
of the same track (e.g. float audio tracks for FLAC and WAV may be expressed as two
tracks via MediaExtractor: a normal PCM track for backward compatibility, and a float PCM
track for added fidelity. Similarly, Dolby Vision extractor may provide a baseline SDR
version of a DV track.) This key can be used to identify which MediaExtractor tracks refer
to the same underlying content.
Constant Value: "track-id"
String KEY_WIDTH
A key describing the width of the content in a video format. The associated value is an integer
Constant Value: "width"
String MIMETYPE_AUDIO_AAC
Constant Value: "audio/mp4a-latm"
String MIMETYPE_AUDIO_AMR_NB
Constant Value: "audio/3gpp"
String MIMETYPE_AUDIO_AMR_WB
Constant Value: "audio/amr-wb"
String MIMETYPE_AUDIO_G711_ALAW
Constant Value: "audio/g711-alaw"
String MIMETYPE_AUDIO_G711_MLAW
Constant Value: "audio/g711-mlaw"
String MIMETYPE_AUDIO_QCELP
Constant Value: "audio/qcelp"
String MIMETYPE_AUDIO_VORBIS
Constant Value: "audio/vorbis"
String MIMETYPE_TEXT_CEA_608
MIME type for CEA-608 closed caption data.
Constant Value: "text/cea-608"
String MIMETYPE_TEXT_VTT
MIME type for WebVTT subtitle data.
Constant Value: "text/vtt"
String MIMETYPE_VIDEO_DOLBY_VISION
Constant Value: "video/dolby-vision"
String MIMETYPE_VIDEO_MPEG2
Constant Value: "video/mpeg2"
String MIMETYPE_VIDEO_MPEG4
Constant Value: "video/mp4v-es"
String MIMETYPE_VIDEO_VP8
Constant Value: "video/x-vnd.on2.vp8"
String MIMETYPE_VIDEO_VP9
Constant Value: "video/x-vnd.on2.vp9"
boolean containsKey (String name)
Returns true iff a key of the given name exists in the format.
Parameters | |
---|---|
name |
String
|
Returns | |
---|---|
boolean |
MediaFormat createAudioFormat (String mime, int sampleRate, int channelCount)
Creates a minimal audio format.
Parameters | |
---|---|
mime |
String :
The mime type of the content. |
sampleRate |
int :
The sampling rate of the content. |
channelCount |
int :
The number of audio channels in the content.
|
Returns | |
---|---|
MediaFormat |
MediaFormat createSubtitleFormat (String mime, String language)
Creates a minimal subtitle format.
Parameters | |
---|---|
mime |
String :
The mime type of the content. |
language |
String :
The language of the content, using either ISO 639-1 or 639-2/T
codes. Specify null or "und" if language information is only included
in the content. (This will also work if there are multiple language
tracks in the content.)
|
Returns | |
---|---|
MediaFormat |
MediaFormat createVideoFormat (String mime, int width, int height)
Creates a minimal video format.
Parameters | |
---|---|
mime |
String :
The mime type of the content. |
width |
int :
The width of the content (in pixels) |
height |
int :
The height of the content (in pixels)
|
Returns | |
---|---|
MediaFormat |
ByteBuffer getByteBuffer (String name)
Returns the value of a ByteBuffer key.
Parameters | |
---|---|
name |
String
|
Returns | |
---|---|
ByteBuffer |
boolean getFeatureEnabled (String feature)
Returns whether a feature is to be enabled (true
) or disabled
(false
).
Parameters | |
---|---|
feature |
String :
the name of a MediaCodecInfo.CodecCapabilities feature. |
Returns | |
---|---|
boolean |
Throws | |
---|---|
IllegalArgumentException |
if the feature was neither set to be enabled nor to be disabled. |
float getFloat (String name)
Returns the value of a float key.
Parameters | |
---|---|
name |
String
|
Returns | |
---|---|
float |
int getInteger (String name)
Returns the value of an integer key.
Parameters | |
---|---|
name |
String
|
Returns | |
---|---|
int |
long getLong (String name)
Returns the value of a long key.
Parameters | |
---|---|
name |
String
|
Returns | |
---|---|
long |
String getString (String name)
Returns the value of a string key.
Parameters | |
---|---|
name |
String
|
Returns | |
---|---|
String |
void setByteBuffer (String name, ByteBuffer bytes)
Sets the value of a ByteBuffer key.
Parameters | |
---|---|
name |
String
|
bytes |
ByteBuffer
|
void setFeatureEnabled (String feature, boolean enabled)
Sets whether a feature is to be enabled (true
) or disabled
(false
).
If enabled
is true
, the feature is requested to be present.
Otherwise, the feature is requested to be not present.
Parameters | |
---|---|
feature |
String :
the name of a MediaCodecInfo.CodecCapabilities feature. |
enabled |
boolean
|
void setFloat (String name, float value)
Sets the value of a float key.
Parameters | |
---|---|
name |
String
|
value |
float
|
void setInteger (String name, int value)
Sets the value of an integer key.
Parameters | |
---|---|
name |
String
|
value |
int
|
void setLong (String name, long value)
Sets the value of a long key.
Parameters | |
---|---|
name |
String
|
value |
long
|
void setString (String name, String value)
Sets the value of a string key.
Parameters | |
---|---|
name |
String
|
value |
String
|
String toString ()
Returns a string representation of the object. In general, the
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String |
a string representation of the object. |