DiscardingTrackOutput

Kotlin |Java

@UnstableApi
class DiscardingTrackOutput : TrackOutput

A TrackOutput that consumes and discards all reported samples.

Summary

Public constructors
`DiscardingTrackOutput()` Creates discarding track output.

Public functions
`Unit`	`format(format: Format!)` Called when the `Format` of the track has been extracted from the stream.
`Unit`	`sampleData( data: ParsableByteArray!, length: Int, @TrackOutput.SampleDataPart sampleDataPart: Int )` Called to write sample data to the output.
`Int`	`sampleData( input: DataReader!, length: Int, allowEndOfInput: Boolean, @TrackOutput.SampleDataPart sampleDataPart: Int )` Called to write sample data to the output.
`Unit`	`sampleMetadata( timeUs: Long, @C.BufferFlags flags: Int, size: Int, offset: Int, cryptoData: TrackOutput.CryptoData? )` Called when metadata associated with a sample has been extracted from the stream.

`const Int`	`SAMPLE_DATA_PART_ENCRYPTION = 1` Sample encryption data.
`const Int`	`SAMPLE_DATA_PART_MAIN = 0` Main media sample data.
`const Int`	`SAMPLE_DATA_PART_SUPPLEMENTAL = 2` Sample supplemental data.

`Unit`	`sampleData(data: ParsableByteArray!, length: Int)` Equivalent to `sampleData` sampleData(data, length, SAMPLE_DATA_PART_MAIN)}.
`Int`	`sampleData(input: DataReader!, length: Int, allowEndOfInput: Boolean)` Equivalent to `sampleData(input, length, allowEndOfInput, SAMPLE_DATA_PART_MAIN)`.

DiscardingTrackOutput()

Creates discarding track output.

fun format(format: Format!): Unit

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

Parameters
`format: Format!`	The extracted `Format`.

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

Called to write sample data to the output.

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

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

Called to write sample data to the output.

Parameters
`input: DataReader!`	A `DataReader` from which to read the sample data.
`length: Int`	The maximum length to read from the input.
`allowEndOfInput: Boolean`	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 sampleDataPart: Int`	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.

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

Parameters
`timeUs: Long`	The media timestamp associated with the sample, in microseconds.
`@C.BufferFlags flags: Int`	Flags associated with the sample. See `C.BUFFER_FLAG_*`.
`size: Int`	The size of the sample data, in bytes.
`offset: Int`	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.
`cryptoData: TrackOutput.CryptoData?`	The encryption data required to decrypt the sample. May be null.