OggMuxer

Kotlin |Java

@UnstableApi
class OggMuxer : Muxer

A muxer for creating an Ogg container file.

This muxer supports muxing of Opus audio codec.

Summary

Nested types
`class OggMuxer.Builder` Builder for `OggMuxer` instances.

Public functions
`Unit`	`addMetadataEntry(metadataEntry: Metadata.Entry!)` Adds metadata about the output file.
`Int`	`addTrack(format: Format!)` Adds a track of the given media format.
`Unit`	`close()` Closes the file.
`Unit`	`writeSampleData( trackId: Int, byteBuffer: ByteBuffer!, bufferInfo: BufferInfo! )` Writes encoded sample data.

abstract Unit

close()

fun addMetadataEntry(metadataEntry: Metadata.Entry!): Unit

Adds metadata about the output file.

This operation is not supported for Ogg muxing and will always throw an UnsupportedOperationException.

fun addTrack(format: Format!): Int

Adds a track of the given media format.

All tracks must be added before any samples are written to any track.

Parameters
`format: Format!`	The `Format` of the track.

Returns
`Int`	A track id for this track, which should be passed to `writeSampleData`.

Throws
`androidx.media3.muxer.MuxerException`	If the muxer encounters a problem while adding the track.

fun close(): Unit

Closes the file.

The muxer cannot be used anymore once this method returns.

Throws
`androidx.media3.muxer.MuxerException`	If the muxer fails to finish writing the output.

fun writeSampleData(
    trackId: Int,
    byteBuffer: ByteBuffer!,
    bufferInfo: BufferInfo!
): Unit

Writes encoded sample data.

Parameters
`trackId: Int`	The track id, previously returned by `addTrack`.
`byteBuffer: ByteBuffer!`	A buffer containing the sample data to write to the container.
`bufferInfo: BufferInfo!`	The `BufferInfo` of the sample.

Throws
`androidx.media3.muxer.MuxerException`	If the muxer fails to write the sample.