Format

@UnstableApi
const val CREATOR: Bundleable.Creator<Format!>!

Object that can restore Format from a Bundle.

@UnstableApi
const val CUE_REPLACEMENT_BEHAVIOR_MERGE = 1: Int

Subsequent cues should be merged with any previous cues that should still be shown on screen.

Tracks with this behavior must not contain samples with an unset duration.

@UnstableApi
const val CUE_REPLACEMENT_BEHAVIOR_REPLACE = 2: Int

Subsequent cues should replace all previous cues.

Tracks with this behavior may contain samples with an unset duration (but the duration may also be set to a 'real' value).

const val NO_VALUE = -1: Int

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

@UnstableApi
const val OFFSET_SAMPLE_RELATIVE = 9223372036854775807: Long

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

@UnstableApi
fun buildUpon(): Format.Builder!

Returns a Format.Builder initialized with the values of this instance.

@UnstableApi
fun copyWithCryptoType(@C.CryptoType cryptoType: Int): Format!

Returns a copy of this format with the specified cryptoType.

fun equals(obj: Any?): Boolean

@UnstableApi
java-static fun fromBundle(bundle: Bundle!): Format!

Restores a Format from a Bundle.

@UnstableApi
fun getPixelCount(): Int

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

fun hashCode(): Int

@UnstableApi
fun initializationDataEquals(other: Format!): Boolean

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

@UnstableApi
fun toBundle(): Bundle!

Returns a Bundle representing the information stored in this object.

@UnstableApi
fun toBundle(excludeMetadata: Boolean): Bundle!

Returns a Bundle representing the information stored in this object. If excludeMetadata is true, metadata is excluded.

@UnstableApi
java-static fun toLogString(format: Format?): String!

Returns a prettier String than toString, intended for logging.

fun toString(): String!

@UnstableApi
fun withManifestFormatInfo(manifestFormat: Format!): Format!

@UnstableApi
val accessibilityChannel: Int

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

@UnstableApi
val averageBitrate: Int

The average bitrate in bits per second, or NO_VALUE if unknown or not applicable. The way in which this field is populated depends on the type of media to which the format corresponds:

• DASH representations: Always NO_VALUE.
• HLS variants: The AVERAGE-BANDWIDTH attribute defined on the corresponding EXT-X-STREAM-INF tag in the multivariant playlist, or NO_VALUE if not present.
• SmoothStreaming track elements: The Bitrate attribute defined on the corresponding TrackElement in the manifest, or NO_VALUE if not present.
• Progressive container formats: Often NO_VALUE, but may be populated with the average bitrate of the container if known.
• Sample formats: Often NO_VALUE, but may be populated with the average bitrate of the stream of samples with type sampleMimeType if known. Note that if sampleMimeType is a compressed format (e.g., AUDIO_AAC), then this bitrate is for the stream of still compressed samples.

@UnstableApi
val bitrate: Int

The bitrate in bits per second. This is the peak bitrate if known, or else the average bitrate if known, or else NO_VALUE. Equivalent to: peakBitrate != NO_VALUE ? peakBitrate : averageBitrate.

val channelCount: Int

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

val codecs: String?

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

@UnstableApi
val colorInfo: ColorInfo?

The color metadata associated with the video, or null if not applicable.

val containerMimeType: String?

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

@UnstableApi
@C.CryptoType
val cryptoType: Int

The type of crypto that must be used to decode samples associated with this format, or CRYPTO_TYPE_NONE if the content is not encrypted. Cannot be CRYPTO_TYPE_NONE if drmInitData is non-null, but may be CRYPTO_TYPE_UNSUPPORTED to indicate that the samples are encrypted using an unsupported crypto type.

@UnstableApi
@Format.CueReplacementBehavior
val cueReplacementBehavior: Int

The replacement behavior that should be followed when handling consecutive samples in a text track of type APPLICATION_MEDIA3_CUES.

@UnstableApi
val drmInitData: DrmInitData?

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

@UnstableApi
val encoderDelay: Int

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

@UnstableApi
val encoderPadding: Int

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

val frameRate: Float

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

val height: Int

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

val id: String?

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

@UnstableApi
val initializationData: (Mutable)List<ByteArray<Byte>!>!

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

val label: String?

The default human readable label, or null if unknown or not applicable.

If non-null, the same label will be part of labels too. If null, labels will be empty.

@UnstableApi
val labels: (Mutable)List<Label!>!

The human readable list of labels, or an empty list if unknown or not applicable.

If non-empty, the default label will be part of this list. If empty, the default label will be null.

val language: String?

The language as an IETF BCP 47 conformant tag, or null if unknown or not applicable.

@UnstableApi
val maxInputSize: Int

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

@UnstableApi
val metadata: Metadata?

Metadata, or null if unknown or not applicable.

@UnstableApi
@C.PcmEncoding
val pcmEncoding: Int

The C.PcmEncoding for PCM audio. Set to NO_VALUE for other media types.

@UnstableApi
val peakBitrate: Int

The peak bitrate in bits per second, or NO_VALUE if unknown or not applicable. The way in which this field is populated depends on the type of media to which the format corresponds:

• DASH representations: The @bandwidth attribute of the corresponding Representation element in the manifest.
• HLS variants: The BANDWIDTH attribute defined on the corresponding EXT-X-STREAM-INF tag.
• SmoothStreaming track elements: Always NO_VALUE.
• Progressive container formats: Often NO_VALUE, but may be populated with the peak bitrate of the container if known.
• Sample formats: Often NO_VALUE, but may be populated with the peak bitrate of the stream of samples with type sampleMimeType if known. Note that if sampleMimeType is a compressed format (e.g., AUDIO_AAC), then this bitrate is for the stream of still compressed samples.

val pixelWidthHeightRatio: Float

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

@UnstableApi
val projectionData: ByteArray<Byte>?

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

@C.RoleFlags
val roleFlags: Int

Track role flags.

@UnstableApi
val rotationDegrees: Int

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.

val sampleMimeType: String?

The sample MIME type, or null if unknown or not applicable.

val sampleRate: Int

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

@C.SelectionFlags
val selectionFlags: Int

Track selection flags.

@UnstableApi
@C.StereoMode
val stereoMode: Int

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

@UnstableApi
val subsampleOffsetUs: Long

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.

@UnstableApi
val tileCountHorizontal: Int

The number of horizontal tiles in an image, or NO_VALUE if not known or applicable.

@UnstableApi
val tileCountVertical: Int

The number of vertical tiles in an image, or NO_VALUE if not known or applicable.

val width: Int

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