OggMuxer

Kotlin |Java

@UnstableApi
public final class OggMuxer implements Muxer

A muxer for creating an Ogg container file.

This muxer supports muxing of Opus audio codec.

Summary

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

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

abstract void

close()

public void addMetadataEntry(Metadata.Entry metadataEntry)

Adds metadata about the output file.

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

public int addTrack(Format format)

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.

public void close()

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.

public void writeSampleData(
    int trackId,
    ByteBuffer byteBuffer,
    BufferInfo bufferInfo
)

Writes encoded sample data.

Parameters
`int trackId`	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.