com.google.android.exoplayer2

Class Format

java.lang.Object

com.google.android.exoplayer2.Format

All Implemented Interfaces:

android.os.Parcelable

public final class Format
extends java.lang.Object
implements android.os.Parcelable

Representation of a media format.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
int	accessibilityChannel The Accessibility channel, or NO_VALUE if not known or applicable.
int	bitrate The average bandwidth in bits per second, or NO_VALUE if unknown or not applicable.
int	channelCount The number of audio channels, or NO_VALUE if unknown or not applicable.
java.lang.String	codecs Codecs of the format as described in RFC 6381, or null if unknown or not applicable.
ColorInfo	colorInfo The color metadata associated with the video, helps with accurate color reproduction.
java.lang.String	containerMimeType The mime type of the container, or null if unknown or not applicable.
static android.os.Parcelable.Creator<Format>	CREATOR
DrmInitData	drmInitData DRM initialization data if the stream is protected, or null otherwise.
int	encoderDelay The number of frames to trim from the start of the decoded audio stream, or 0 if not applicable.
int	encoderPadding The number of frames to trim from the end of the decoded audio stream, or 0 if not applicable.
float	frameRate The frame rate in frames per second, or NO_VALUE if unknown or not applicable.
int	height The height of the video in pixels, or NO_VALUE if unknown or not applicable.
java.lang.String	id An identifier for the format, or null if unknown or not applicable.
java.util.List<byte[]>	initializationData Initialization data that must be provided to the decoder.
java.lang.String	language The language, or null if unknown or not applicable.
int	maxInputSize The maximum size of a buffer of data (typically one sample), or NO_VALUE if unknown or not applicable.
Metadata	metadata Metadata, or null if unknown or not applicable.
static int	NO_VALUE A value for various fields to indicate that the field's value is unknown or not applicable.
static long	OFFSET_SAMPLE_RELATIVE A value for subsampleOffsetUs to indicate that subsample timestamps are relative to the timestamps of their parent samples.
int	pcmEncoding The encoding for PCM audio streams.
float	pixelWidthHeightRatio The width to height ratio of pixels in the video, or 1.0 if unknown or not applicable.
byte[]	projectionData The projection data for 360/VR video, or null if not applicable.
int	rotationDegrees The clockwise rotation that should be applied to the video for it to be rendered in the correct orientation, or 0 if unknown or not applicable.
java.lang.String	sampleMimeType The mime type of the elementary stream (i.e.
int	sampleRate The audio sampling rate in Hz, or NO_VALUE if unknown or not applicable.
int	selectionFlags Track selection flags.
int	stereoMode The stereo layout for 360/3D/VR video, or NO_VALUE if not applicable.
long	subsampleOffsetUs For samples that contain subsamples, this is an offset that should be added to subsample timestamps.
int	width The width of the video in pixels, or NO_VALUE if unknown or not applicable.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
Format	copyWithContainerInfo(java.lang.String id, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int width, int height, int selectionFlags, java.lang.String language)
Format	copyWithDrmInitData(DrmInitData drmInitData)
Format	copyWithGaplessInfo(int encoderDelay, int encoderPadding)
Format	copyWithManifestFormatInfo(Format manifestFormat)
Format	copyWithMaxInputSize(int maxInputSize)
Format	copyWithMetadata(Metadata metadata)
Format	copyWithRotationDegrees(int rotationDegrees)
Format	copyWithSubsampleOffsetUs(long subsampleOffsetUs)
static Format	createAudioContainerFormat(java.lang.String id, java.lang.String containerMimeType, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int channelCount, int sampleRate, java.util.List<byte[]> initializationData, int selectionFlags, java.lang.String language)
static Format	createAudioSampleFormat(java.lang.String id, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int maxInputSize, int channelCount, int sampleRate, int pcmEncoding, int encoderDelay, int encoderPadding, java.util.List<byte[]> initializationData, DrmInitData drmInitData, int selectionFlags, java.lang.String language, Metadata metadata)
static Format	createAudioSampleFormat(java.lang.String id, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int maxInputSize, int channelCount, int sampleRate, int pcmEncoding, java.util.List<byte[]> initializationData, DrmInitData drmInitData, int selectionFlags, java.lang.String language)
static Format	createAudioSampleFormat(java.lang.String id, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int maxInputSize, int channelCount, int sampleRate, java.util.List<byte[]> initializationData, DrmInitData drmInitData, int selectionFlags, java.lang.String language)
static Format	createContainerFormat(java.lang.String id, java.lang.String containerMimeType, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int selectionFlags, java.lang.String language)
static Format	createImageSampleFormat(java.lang.String id, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int selectionFlags, java.util.List<byte[]> initializationData, java.lang.String language, DrmInitData drmInitData)
static Format	createSampleFormat(java.lang.String id, java.lang.String sampleMimeType, long subsampleOffsetUs)
static Format	createSampleFormat(java.lang.String id, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, DrmInitData drmInitData)
static Format	createTextContainerFormat(java.lang.String id, java.lang.String containerMimeType, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int selectionFlags, java.lang.String language)
static Format	createTextContainerFormat(java.lang.String id, java.lang.String containerMimeType, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int selectionFlags, java.lang.String language, int accessibilityChannel)
static Format	createTextSampleFormat(java.lang.String id, java.lang.String sampleMimeType, int selectionFlags, java.lang.String language)
static Format	createTextSampleFormat(java.lang.String id, java.lang.String sampleMimeType, int selectionFlags, java.lang.String language, DrmInitData drmInitData)
static Format	createTextSampleFormat(java.lang.String id, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int selectionFlags, java.lang.String language, DrmInitData drmInitData, long subsampleOffsetUs)
static Format	createTextSampleFormat(java.lang.String id, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int selectionFlags, java.lang.String language, int accessibilityChannel, DrmInitData drmInitData)
static Format	createTextSampleFormat(java.lang.String id, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int selectionFlags, java.lang.String language, int accessibilityChannel, DrmInitData drmInitData, long subsampleOffsetUs, java.util.List<byte[]> initializationData)
static Format	createVideoContainerFormat(java.lang.String id, java.lang.String containerMimeType, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int width, int height, float frameRate, java.util.List<byte[]> initializationData, int selectionFlags)
static Format	createVideoSampleFormat(java.lang.String id, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int maxInputSize, int width, int height, float frameRate, java.util.List<byte[]> initializationData, DrmInitData drmInitData)
static Format	createVideoSampleFormat(java.lang.String id, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int maxInputSize, int width, int height, float frameRate, java.util.List<byte[]> initializationData, int rotationDegrees, float pixelWidthHeightRatio, byte[] projectionData, int stereoMode, ColorInfo colorInfo, DrmInitData drmInitData)
static Format	createVideoSampleFormat(java.lang.String id, java.lang.String sampleMimeType, java.lang.String codecs, int bitrate, int maxInputSize, int width, int height, float frameRate, java.util.List<byte[]> initializationData, int rotationDegrees, float pixelWidthHeightRatio, DrmInitData drmInitData)
int	describeContents()
boolean	equals(java.lang.Object obj)
int	getPixelCount() Returns the number of pixels if this is a video format whose width and height are known, or NO_VALUE otherwise
int	hashCode()
boolean	initializationDataEquals(Format other) Returns whether the initializationDatas belonging to this format and other are equal.
static java.lang.String	toLogString(Format format) Returns a prettier String than toString(), intended for logging.
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_VALUE

public static final int NO_VALUE

A value for various fields to indicate that the field's value is unknown or not applicable.

See Also:

Constant Field Values

OFFSET_SAMPLE_RELATIVE

public static final long OFFSET_SAMPLE_RELATIVE

A value for subsampleOffsetUs to indicate that subsample timestamps are relative to the timestamps of their parent samples.

See Also:

Constant Field Values

id

@Nullable
public final java.lang.String id

An identifier for the format, or null if unknown or not applicable.

bitrate

public final int bitrate

The average bandwidth in bits per second, or NO_VALUE if unknown or not applicable.

codecs

@Nullable
public final java.lang.String codecs

Codecs of the format as described in RFC 6381, or null if unknown or not applicable.

metadata

@Nullable
public final Metadata metadata

Metadata, or null if unknown or not applicable.

containerMimeType

@Nullable
public final java.lang.String containerMimeType

The mime type of the container, or null if unknown or not applicable.

sampleMimeType

@Nullable
public final java.lang.String sampleMimeType

The mime type of the elementary stream (i.e. the individual samples), or null if unknown or not applicable.

maxInputSize

public final int maxInputSize

The maximum size of a buffer of data (typically one sample), or NO_VALUE if unknown or not applicable.

initializationData

public final java.util.List<byte[]> initializationData

Initialization data that must be provided to the decoder. Will not be null, but may be empty if initialization data is not required.

drmInitData

@Nullable
public final DrmInitData drmInitData

DRM initialization data if the stream is protected, or null otherwise.

subsampleOffsetUs

public final long subsampleOffsetUs

For samples that contain subsamples, this is an offset that should be added to subsample timestamps. A value of OFFSET_SAMPLE_RELATIVE indicates that subsample timestamps are relative to the timestamps of their parent samples.

width

public final int width

The width of the video in pixels, or NO_VALUE if unknown or not applicable.

height

public final int height

The height of the video in pixels, or NO_VALUE if unknown or not applicable.

frameRate

public final float frameRate

The frame rate in frames per second, or NO_VALUE if unknown or not applicable.

rotationDegrees

public final int rotationDegrees

The clockwise rotation that should be applied to the video for it to be rendered in the correct orientation, or 0 if unknown or not applicable. Only 0, 90, 180 and 270 are supported.

pixelWidthHeightRatio

public final float pixelWidthHeightRatio

The width to height ratio of pixels in the video, or 1.0 if unknown or not applicable.

stereoMode

public final int stereoMode

The stereo layout for 360/3D/VR video, or NO_VALUE if not applicable. Valid stereo modes are C.STEREO_MODE_MONO, C.STEREO_MODE_TOP_BOTTOM, C.STEREO_MODE_LEFT_RIGHT, C.STEREO_MODE_STEREO_MESH.

projectionData

@Nullable
public final byte[] projectionData

The projection data for 360/VR video, or null if not applicable.

colorInfo

@Nullable
public final ColorInfo colorInfo

The color metadata associated with the video, helps with accurate color reproduction.

channelCount

public final int channelCount

The number of audio channels, or NO_VALUE if unknown or not applicable.

sampleRate

public final int sampleRate

The audio sampling rate in Hz, or NO_VALUE if unknown or not applicable.

pcmEncoding

public final int pcmEncoding

The encoding for PCM audio streams. If sampleMimeType is MimeTypes.AUDIO_RAW then one of C.ENCODING_PCM_8BIT, C.ENCODING_PCM_16BIT, C.ENCODING_PCM_24BIT and C.ENCODING_PCM_32BIT. Set to NO_VALUE for other media types.

encoderDelay

public final int encoderDelay

The number of frames to trim from the start of the decoded audio stream, or 0 if not applicable.

encoderPadding

public final int encoderPadding

The number of frames to trim from the end of the decoded audio stream, or 0 if not applicable.

selectionFlags

public final int selectionFlags

Track selection flags.

language

@Nullable
public final java.lang.String language

The language, or null if unknown or not applicable.

accessibilityChannel

public final int accessibilityChannel

The Accessibility channel, or NO_VALUE if not known or applicable.

CREATOR

public static final android.os.Parcelable.Creator<Format> CREATOR

Method Detail

createVideoContainerFormat

public static Format createVideoContainerFormat(@Nullable
                                                java.lang.String id,
                                                @Nullable
                                                java.lang.String containerMimeType,
                                                java.lang.String sampleMimeType,
                                                java.lang.String codecs,
                                                int bitrate,
                                                int width,
                                                int height,
                                                float frameRate,
                                                java.util.List<byte[]> initializationData,
                                                int selectionFlags)

createVideoSampleFormat

public static Format createVideoSampleFormat(@Nullable
                                             java.lang.String id,
                                             @Nullable
                                             java.lang.String sampleMimeType,
                                             @Nullable
                                             java.lang.String codecs,
                                             int bitrate,
                                             int maxInputSize,
                                             int width,
                                             int height,
                                             float frameRate,
                                             java.util.List<byte[]> initializationData,
                                             @Nullable
                                             DrmInitData drmInitData)

createVideoSampleFormat

public static Format createVideoSampleFormat(@Nullable
                                             java.lang.String id,
                                             @Nullable
                                             java.lang.String sampleMimeType,
                                             @Nullable
                                             java.lang.String codecs,
                                             int bitrate,
                                             int maxInputSize,
                                             int width,
                                             int height,
                                             float frameRate,
                                             java.util.List<byte[]> initializationData,
                                             int rotationDegrees,
                                             float pixelWidthHeightRatio,
                                             @Nullable
                                             DrmInitData drmInitData)

createVideoSampleFormat

public static Format createVideoSampleFormat(@Nullable
                                             java.lang.String id,
                                             @Nullable
                                             java.lang.String sampleMimeType,
                                             @Nullable
                                             java.lang.String codecs,
                                             int bitrate,
                                             int maxInputSize,
                                             int width,
                                             int height,
                                             float frameRate,
                                             java.util.List<byte[]> initializationData,
                                             int rotationDegrees,
                                             float pixelWidthHeightRatio,
                                             byte[] projectionData,
                                             int stereoMode,
                                             @Nullable
                                             ColorInfo colorInfo,
                                             @Nullable
                                             DrmInitData drmInitData)

createAudioContainerFormat

public static Format createAudioContainerFormat(@Nullable
                                                java.lang.String id,
                                                @Nullable
                                                java.lang.String containerMimeType,
                                                @Nullable
                                                java.lang.String sampleMimeType,
                                                @Nullable
                                                java.lang.String codecs,
                                                int bitrate,
                                                int channelCount,
                                                int sampleRate,
                                                java.util.List<byte[]> initializationData,
                                                int selectionFlags,
                                                @Nullable
                                                java.lang.String language)

createAudioSampleFormat

public static Format createAudioSampleFormat(@Nullable
                                             java.lang.String id,
                                             @Nullable
                                             java.lang.String sampleMimeType,
                                             @Nullable
                                             java.lang.String codecs,
                                             int bitrate,
                                             int maxInputSize,
                                             int channelCount,
                                             int sampleRate,
                                             java.util.List<byte[]> initializationData,
                                             @Nullable
                                             DrmInitData drmInitData,
                                             int selectionFlags,
                                             @Nullable
                                             java.lang.String language)

createAudioSampleFormat

public static Format createAudioSampleFormat(@Nullable
                                             java.lang.String id,
                                             @Nullable
                                             java.lang.String sampleMimeType,
                                             @Nullable
                                             java.lang.String codecs,
                                             int bitrate,
                                             int maxInputSize,
                                             int channelCount,
                                             int sampleRate,
                                             int pcmEncoding,
                                             java.util.List<byte[]> initializationData,
                                             @Nullable
                                             DrmInitData drmInitData,
                                             int selectionFlags,
                                             @Nullable
                                             java.lang.String language)

createAudioSampleFormat

public static Format createAudioSampleFormat(@Nullable
                                             java.lang.String id,
                                             @Nullable
                                             java.lang.String sampleMimeType,
                                             @Nullable
                                             java.lang.String codecs,
                                             int bitrate,
                                             int maxInputSize,
                                             int channelCount,
                                             int sampleRate,
                                             int pcmEncoding,
                                             int encoderDelay,
                                             int encoderPadding,
                                             java.util.List<byte[]> initializationData,
                                             @Nullable
                                             DrmInitData drmInitData,
                                             int selectionFlags,
                                             @Nullable
                                             java.lang.String language,
                                             @Nullable
                                             Metadata metadata)

createTextContainerFormat

public static Format createTextContainerFormat(@Nullable
                                               java.lang.String id,
                                               @Nullable
                                               java.lang.String containerMimeType,
                                               @Nullable
                                               java.lang.String sampleMimeType,
                                               @Nullable
                                               java.lang.String codecs,
                                               int bitrate,
                                               int selectionFlags,
                                               @Nullable
                                               java.lang.String language)

createTextContainerFormat

public static Format createTextContainerFormat(@Nullable
                                               java.lang.String id,
                                               @Nullable
                                               java.lang.String containerMimeType,
                                               @Nullable
                                               java.lang.String sampleMimeType,
                                               @Nullable
                                               java.lang.String codecs,
                                               int bitrate,
                                               int selectionFlags,
                                               @Nullable
                                               java.lang.String language,
                                               int accessibilityChannel)

createTextSampleFormat

public static Format createTextSampleFormat(@Nullable
                                            java.lang.String id,
                                            java.lang.String sampleMimeType,
                                            int selectionFlags,
                                            @Nullable
                                            java.lang.String language)

createTextSampleFormat

public static Format createTextSampleFormat(@Nullable
                                            java.lang.String id,
                                            java.lang.String sampleMimeType,
                                            int selectionFlags,
                                            @Nullable
                                            java.lang.String language,
                                            @Nullable
                                            DrmInitData drmInitData)

createTextSampleFormat

public static Format createTextSampleFormat(@Nullable
                                            java.lang.String id,
                                            @Nullable
                                            java.lang.String sampleMimeType,
                                            @Nullable
                                            java.lang.String codecs,
                                            int bitrate,
                                            int selectionFlags,
                                            @Nullable
                                            java.lang.String language,
                                            int accessibilityChannel,
                                            @Nullable
                                            DrmInitData drmInitData)

createTextSampleFormat

public static Format createTextSampleFormat(@Nullable
                                            java.lang.String id,
                                            @Nullable
                                            java.lang.String sampleMimeType,
                                            @Nullable
                                            java.lang.String codecs,
                                            int bitrate,
                                            int selectionFlags,
                                            @Nullable
                                            java.lang.String language,
                                            @Nullable
                                            DrmInitData drmInitData,
                                            long subsampleOffsetUs)

createTextSampleFormat

public static Format createTextSampleFormat(@Nullable
                                            java.lang.String id,
                                            @Nullable
                                            java.lang.String sampleMimeType,
                                            @Nullable
                                            java.lang.String codecs,
                                            int bitrate,
                                            int selectionFlags,
                                            @Nullable
                                            java.lang.String language,
                                            int accessibilityChannel,
                                            @Nullable
                                            DrmInitData drmInitData,
                                            long subsampleOffsetUs,
                                            java.util.List<byte[]> initializationData)

createImageSampleFormat

public static Format createImageSampleFormat(@Nullable
                                             java.lang.String id,
                                             @Nullable
                                             java.lang.String sampleMimeType,
                                             @Nullable
                                             java.lang.String codecs,
                                             int bitrate,
                                             int selectionFlags,
                                             java.util.List<byte[]> initializationData,
                                             @Nullable
                                             java.lang.String language,
                                             @Nullable
                                             DrmInitData drmInitData)

createContainerFormat

public static Format createContainerFormat(@Nullable
                                           java.lang.String id,
                                           @Nullable
                                           java.lang.String containerMimeType,
                                           @Nullable
                                           java.lang.String sampleMimeType,
                                           @Nullable
                                           java.lang.String codecs,
                                           int bitrate,
                                           int selectionFlags,
                                           @Nullable
                                           java.lang.String language)

createSampleFormat

public static Format createSampleFormat(@Nullable
                                        java.lang.String id,
                                        @Nullable
                                        java.lang.String sampleMimeType,
                                        long subsampleOffsetUs)

createSampleFormat

public static Format createSampleFormat(@Nullable
                                        java.lang.String id,
                                        @Nullable
                                        java.lang.String sampleMimeType,
                                        @Nullable
                                        java.lang.String codecs,
                                        int bitrate,
                                        @Nullable
                                        DrmInitData drmInitData)

copyWithMaxInputSize

public Format copyWithMaxInputSize(int maxInputSize)

copyWithSubsampleOffsetUs

public Format copyWithSubsampleOffsetUs(long subsampleOffsetUs)

copyWithContainerInfo

public Format copyWithContainerInfo(@Nullable
                                    java.lang.String id,
                                    @Nullable
                                    java.lang.String sampleMimeType,
                                    @Nullable
                                    java.lang.String codecs,
                                    int bitrate,
                                    int width,
                                    int height,
                                    int selectionFlags,
                                    @Nullable
                                    java.lang.String language)

copyWithManifestFormatInfo

public Format copyWithManifestFormatInfo(Format manifestFormat)

copyWithGaplessInfo

public Format copyWithGaplessInfo(int encoderDelay,
                                  int encoderPadding)

copyWithDrmInitData

public Format copyWithDrmInitData(@Nullable
                                  DrmInitData drmInitData)

copyWithMetadata

public Format copyWithMetadata(@Nullable
                               Metadata metadata)

copyWithRotationDegrees

public Format copyWithRotationDegrees(int rotationDegrees)

getPixelCount

public int getPixelCount()

Returns the number of pixels if this is a video format whose width and height are known, or NO_VALUE otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(@Nullable
                      java.lang.Object obj)

Overrides:

equals in class java.lang.Object

initializationDataEquals

public boolean initializationDataEquals(Format other)

Returns whether the initializationDatas belonging to this format and other are equal.

Parameters:

other - The other format whose initializationData is being compared.

Returns:

Whether the initializationDatas belonging to this format and other are equal.

toLogString

public static java.lang.String toLogString(Format format)

Returns a prettier String than toString(), intended for logging.

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable