# TrackOutput

Artifact: [androidx.media3:media3-extractor](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/extractor/TrackOutput.java+class:androidx.media3.extractor.TrackOutput)

*** ** * ** ***

<br />

```
@UnstableApi
interface TrackOutput
```

<br />

Known direct subclasses [DiscardingTrackOutput](https://developer.android.com/reference/kotlin/androidx/media3/extractor/DiscardingTrackOutput), [FakeTrackOutput](https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FakeTrackOutput), [ForwardingTrackOutput](https://developer.android.com/reference/kotlin/androidx/media3/extractor/ForwardingTrackOutput), [PlayerEmsgHandler.PlayerTrackEmsgHandler](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/dash/PlayerEmsgHandler.PlayerTrackEmsgHandler), [SampleQueue](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleQueue)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/extractor/DiscardingTrackOutput` | A `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput` that consumes and discards all reported samples. |
| `https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FakeTrackOutput` | A fake `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput`. |
| `https://developer.android.com/reference/kotlin/androidx/media3/extractor/ForwardingTrackOutput` | An overridable `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput` implementation forwarding all methods to another track output. |
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/dash/PlayerEmsgHandler.PlayerTrackEmsgHandler` | Handles emsg messages for a specific track for the player. |
| `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleQueue` | A queue of media samples. |

*** ** * ** ***

Receives track level data extracted by an `https://developer.android.com/reference/kotlin/androidx/media3/extractor/Extractor`.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput.CryptoData` Holds data required to decrypt a sample. |
| `@https://developer.android.com/reference/java/lang/annotation/Documented.html @https://developer.android.com/reference/java/lang/annotation/Retention.html(value = https://developer.android.com/reference/java/lang/annotation/RetentionPolicy.html#SOURCE) @https://developer.android.com/reference/java/lang/annotation/Target.html(value = https://developer.android.com/reference/java/lang/annotation/ElementType.html#TYPE_USE) @https://developer.android.com/reference/kotlin/androidx/annotation/IntDef(value = ) annotation https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput.SampleDataPart` Defines the part of the sample data to which a call to `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#sampleData(androidx.media3.common.DataReader,int,boolean)` corresponds. |

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#SAMPLE_DATA_PART_ENCRYPTION() = 1` Sample encryption data. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#SAMPLE_DATA_PART_MAIN() = 0` Main media sample data. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#SAMPLE_DATA_PART_SUPPLEMENTAL() = 2` Sample supplemental data. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#durationUs(long)(durationUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)` Called to set the duration of the track in microseconds. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#format(androidx.media3.common.Format)(format: https://developer.android.com/reference/kotlin/androidx/media3/common/Format!)` Called when the `https://developer.android.com/reference/kotlin/androidx/media3/common/Format` of the track has been extracted from the stream. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#sampleData(androidx.media3.common.util.ParsableByteArray,int)(data: https://developer.android.com/reference/kotlin/androidx/media3/common/util/ParsableByteArray!, length: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Equivalent to `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#sampleData(androidx.media3.common.util.ParsableByteArray,int,int)` sampleData(data, length, SAMPLE_DATA_PART_MAIN)}. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#sampleData(androidx.media3.common.util.ParsableByteArray,int,int)( data: https://developer.android.com/reference/kotlin/androidx/media3/common/util/ParsableByteArray!, length: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, @https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput.SampleDataPart sampleDataPart: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` Called to write sample data to the output. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#sampleData(androidx.media3.common.DataReader,int,boolean)(input: https://developer.android.com/reference/kotlin/androidx/media3/common/DataReader!, length: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, allowEndOfInput: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Equivalent to `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#sampleData(androidx.media3.common.DataReader,int,boolean,int)`. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#sampleData(androidx.media3.common.DataReader,int,boolean,int)( input: https://developer.android.com/reference/kotlin/androidx/media3/common/DataReader!, length: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, allowEndOfInput: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, @https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput.SampleDataPart sampleDataPart: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` Called to write sample data to the output. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#sampleMetadata(long,int,int,int,androidx.media3.extractor.TrackOutput.CryptoData)( timeUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, @https://developer.android.com/reference/kotlin/androidx/media3/common/C.BufferFlags flags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, size: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, offset: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, cryptoData: https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput.CryptoData? )` Called when metadata associated with a sample has been extracted from the stream. |

## Constants

### SAMPLE_DATA_PART_ENCRYPTION

```
const val SAMPLE_DATA_PART_ENCRYPTION = 1: Int
```

Sample encryption data.

The format for encryption information is:

- (1 byte) `encryption_signal_byte`: Most significant bit signals whether the encryption data contains subsample encryption data. The remaining bits contain ` initialization_vector_size`.
- (`initialization_vector_size` bytes) Initialization vector.
- If subsample encryption data is present, as per `encryption_signal_byte`, the encryption data also contains:
  - (2 bytes) `subsample_encryption_data_length`.
  - (`subsample_encryption_data_length * 6` bytes) Subsample encryption data (repeated `subsample_encryption_data_length` times:
    - (2 bytes) Size of a clear section in sample.
    - (4 bytes) Size of an encryption section in sample.

### SAMPLE_DATA_PART_MAIN

```
const val SAMPLE_DATA_PART_MAIN = 0: Int
```

Main media sample data.

### SAMPLE_DATA_PART_SUPPLEMENTAL

```
const val SAMPLE_DATA_PART_SUPPLEMENTAL = 2: Int
```

Sample supplemental data.

If a sample contains supplemental data, the format of the entire sample data will be:

- If the sample has the `https://developer.android.com/reference/kotlin/androidx/media3/common/C#BUFFER_FLAG_ENCRYPTED()` flag set, all encryption information.
- (4 bytes) `sample_data_size`: The size of the actual sample data, not including supplemental data or encryption information.
- (`sample_data_size` bytes): The media sample data.
- (remaining bytes) The supplemental data.

## Public functions

### durationUs

```
fun durationUs(durationUs: Long): Unit
```

Called to set the duration of the track in microseconds.

| Parameters |
|---|---|
| `durationUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The duration of the track in microseconds. |

### format

```
fun format(format: Format!): Unit
```

Called when the `https://developer.android.com/reference/kotlin/androidx/media3/common/Format` of the track has been extracted from the stream.

| Parameters |
|---|---|
| `format: https://developer.android.com/reference/kotlin/androidx/media3/common/Format!` | The extracted `https://developer.android.com/reference/kotlin/androidx/media3/common/Format`. |

### sampleData

```
fun sampleData(data: ParsableByteArray!, length: Int): Unit
```

Equivalent to `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#sampleData(androidx.media3.common.util.ParsableByteArray,int,int)` sampleData(data, length, SAMPLE_DATA_PART_MAIN)}.

### sampleData

```
fun sampleData(
    data: ParsableByteArray!,
    length: Int,
    @TrackOutput.SampleDataPart sampleDataPart: Int
): Unit
```

Called to write sample data to the output.

| Parameters |
|---|---|
| `data: https://developer.android.com/reference/kotlin/androidx/media3/common/util/ParsableByteArray!` | A `https://developer.android.com/reference/kotlin/androidx/media3/common/util/ParsableByteArray` from which to read the sample data. |
| `length: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The number of bytes to read, starting from `data.getPosition()`. |
| `@https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput.SampleDataPart sampleDataPart: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The part of the sample data to which this call corresponds. |

### sampleData

```
fun sampleData(input: DataReader!, length: Int, allowEndOfInput: Boolean): Int
```

Equivalent to `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#sampleData(androidx.media3.common.DataReader,int,boolean,int)`.

| Throws |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` |   |

### sampleData

```
fun sampleData(
    input: DataReader!,
    length: Int,
    allowEndOfInput: Boolean,
    @TrackOutput.SampleDataPart sampleDataPart: Int
): Int
```

Called to write sample data to the output.

| Parameters |
|---|---|
| `input: https://developer.android.com/reference/kotlin/androidx/media3/common/DataReader!` | A `https://developer.android.com/reference/kotlin/androidx/media3/common/DataReader` from which to read the sample data. |
| `length: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The maximum length to read from the input. |
| `allowEndOfInput: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | True if encountering the end of the input having read no data is allowed, and should result in `https://developer.android.com/reference/kotlin/androidx/media3/common/C#RESULT_END_OF_INPUT()` being returned. False if it should be considered an error, causing an `https://developer.android.com/reference/java/io/EOFException.html` to be thrown. |
| `@https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput.SampleDataPart sampleDataPart: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The part of the sample data to which this call corresponds. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The number of bytes appended. |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | If an error occurred reading from the input. |

### sampleMetadata

```
fun sampleMetadata(
    timeUs: Long,
    @C.BufferFlags flags: Int,
    size: Int,
    offset: Int,
    cryptoData: TrackOutput.CryptoData?
): Unit
```

Called when metadata associated with a sample has been extracted from the stream.

The corresponding sample data will have already been passed to the output via calls to `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#sampleData(androidx.media3.common.DataReader,int,boolean)` or `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#sampleData(androidx.media3.common.util.ParsableByteArray,int)`.

| Parameters |
|---|---|
| `timeUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The media timestamp associated with the sample, in microseconds. |
| `@https://developer.android.com/reference/kotlin/androidx/media3/common/C.BufferFlags flags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | Flags associated with the sample. See `C.BUFFER_FLAG_*`. |
| `size: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The size of the sample data, in bytes. |
| `offset: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The number of bytes that have been passed to `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#sampleData(androidx.media3.common.DataReader,int,boolean)` or `https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput#sampleData(androidx.media3.common.util.ParsableByteArray,int)` since the last byte belonging to the sample whose metadata is being passed. |
| `cryptoData: https://developer.android.com/reference/kotlin/androidx/media3/extractor/TrackOutput.CryptoData?` | The encryption data required to decrypt the sample. May be null. |