ForwardingTrackOutput

Artifact: androidx.media3:media3-extractor

Kotlin |Java

@UnstableApi
public class ForwardingTrackOutput implements TrackOutput

An overridable TrackOutput implementation forwarding all methods to another track output.

Summary

Public constructors
`ForwardingTrackOutput(TrackOutput trackOutput)` Creates a new instance that forwards all operations to `trackOutput`.

Public methods
`void`	`durationUs(long durationUs)` Called to set the duration of the track in microseconds.
`void`	`format(Format format)` Called when the `Format` of the track has been extracted from the stream.
`void`	`sampleData(ParsableByteArray data, int length)` Equivalent to `sampleData` sampleData(data, length, SAMPLE_DATA_PART_MAIN)}.
`void`	`sampleData( ParsableByteArray data, int length, @TrackOutput.SampleDataPart int sampleDataPart )` Called to write sample data to the output.
`int`	`sampleData(DataReader input, int length, boolean allowEndOfInput)` Equivalent to `sampleData(input, length, allowEndOfInput, SAMPLE_DATA_PART_MAIN)`.
`int`	`sampleData( DataReader input, int length, boolean allowEndOfInput, @TrackOutput.SampleDataPart int sampleDataPart )` Called to write sample data to the output.
`void`	`sampleMetadata( long timeUs, @C.BufferFlags int flags, int size, int offset, @Nullable TrackOutput.CryptoData cryptoData )` Called when metadata associated with a sample has been extracted from the stream.

Inherited Constants

From androidx.media3.extractor.TrackOutput

`static final int`	`SAMPLE_DATA_PART_ENCRYPTION = 1` Sample encryption data.
`static final int`	`SAMPLE_DATA_PART_MAIN = 0` Main media sample data.
`static final int`	`SAMPLE_DATA_PART_SUPPLEMENTAL = 2` Sample supplemental data.

Public constructors

ForwardingTrackOutput

public ForwardingTrackOutput(TrackOutput trackOutput)

Creates a new instance that forwards all operations to trackOutput.

Public methods

durationUs

public void durationUs(long durationUs)

Called to set the duration of the track in microseconds.

Parameters
`long durationUs`	The duration of the track in microseconds.

format

public void format(Format format)

Called when the Format of the track has been extracted from the stream.

Parameters
`Format format`	The extracted `Format`.

sampleData

public void sampleData(ParsableByteArray data, int length)

Equivalent to sampleData sampleData(data, length, SAMPLE_DATA_PART_MAIN)}.

sampleData

public void sampleData(
    ParsableByteArray data,
    int length,
    @TrackOutput.SampleDataPart int sampleDataPart
)

Called to write sample data to the output.

Parameters
`ParsableByteArray data`	A `ParsableByteArray` from which to read the sample data.
`int length`	The number of bytes to read, starting from `data.getPosition()`.
`@TrackOutput.SampleDataPart int sampleDataPart`	The part of the sample data to which this call corresponds.

sampleData

public int sampleData(DataReader input, int length, boolean allowEndOfInput)

Equivalent to sampleData(input, length, allowEndOfInput, SAMPLE_DATA_PART_MAIN).

Throws
`java.io.IOException`

sampleData

public int sampleData(
    DataReader input,
    int length,
    boolean allowEndOfInput,
    @TrackOutput.SampleDataPart int sampleDataPart
)

Called to write sample data to the output.

Parameters
`DataReader input`	A `DataReader` from which to read the sample data.
`int length`	The maximum length to read from the input.
`boolean allowEndOfInput`	True if encountering the end of the input having read no data is allowed, and should result in `RESULT_END_OF_INPUT` being returned. False if it should be considered an error, causing an `EOFException` to be thrown.
`@TrackOutput.SampleDataPart int sampleDataPart`	The part of the sample data to which this call corresponds.

Returns
`int`	The number of bytes appended.

Throws
`java.io.IOException`	If an error occurred reading from the input.

sampleMetadata

public void sampleMetadata(
    long timeUs,
    @C.BufferFlags int flags,
    int size,
    int offset,
    @Nullable TrackOutput.CryptoData cryptoData
)

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 sampleData or sampleData.

Parameters
`long timeUs`	The media timestamp associated with the sample, in microseconds.
`@C.BufferFlags int flags`	Flags associated with the sample. See `C.BUFFER_FLAG_*`.
`int size`	The size of the sample data, in bytes.
`int offset`	The number of bytes that have been passed to `sampleData` or `sampleData` since the last byte belonging to the sample whose metadata is being passed.
`@Nullable TrackOutput.CryptoData cryptoData`	The encryption data required to decrypt the sample. May be null.