OggFileAudioBufferSink

Artifact: androidx.media3:media3-test-utils

Kotlin |Java

@UnstableApi
class OggFileAudioBufferSink : ForwardingAudioSink

kotlin.Any
↳	androidx.media3.exoplayer.audio.ForwardingAudioSink
	↳	androidx.media3.test.utils.OggFileAudioBufferSink

A sink for audio buffers that writes output audio as .ogg files with a given path prefix. When new audio data is handled after flushing the audio packetizer, a counter is incremented and its value is appended to the output file name.

Note: if writing to external storage it's necessary to grant the WRITE_EXTERNAL_STORAGE permission.

Summary

Constants
`const Int`	`SAMPLE_RATE = 48000` Opus streams are always 48000 Hz.

Public constructors
`OggFileAudioBufferSink( audioSink: AudioSink!, outputFileNamePrefix: String! )` Creates an instance.

Public functions
`Unit`	`flush()` Flushes the sink, after which it is ready to receive buffers from a new playback position.
`Boolean`	`handleBuffer( buffer: ByteBuffer!, presentationTimeUs: Long, encodedAccessUnitCount: Int )` Attempts to process data from a `ByteBuffer`, starting from its current position and ending at its limit (exclusive).
`Unit`	`reset()` Resets the sink, releasing any resources that it currently holds.

Inherited Constants

From androidx.media3.exoplayer.audio.AudioSink

`const Long`	`CURRENT_POSITION_NOT_SET = -9223372036854775808` Returned by `getCurrentPositionUs` when the position is not set.
`const Int`	`OFFLOAD_MODE_DISABLED = 0` The audio sink will never play in offload mode.
`const Int`	`OFFLOAD_MODE_ENABLED_GAPLESS_NOT_REQUIRED = 2` The audio sink will prefer offload playback even if this might result in silence gaps between tracks.
`const Int`	`OFFLOAD_MODE_ENABLED_GAPLESS_REQUIRED = 1` The audio sink will prefer offload playback except in the case where both the track is gapless and the device does support gapless offload playback.
`const Int`	`SINK_FORMAT_SUPPORTED_DIRECTLY = 2` The sink supports the format directly, without the need for internal transcoding.
`const Int`	`SINK_FORMAT_SUPPORTED_WITH_TRANSCODING = 1` The sink supports the format, but needs to transcode it internally to do so.
`const Int`	`SINK_FORMAT_UNSUPPORTED = 0` The sink does not support the format.

Inherited functions

From androidx.media3.exoplayer.audio.AudioSink

abstract Boolean

handleBuffer(
    buffer: ByteBuffer!,
    presentationTimeUs: Long,
    encodedAccessUnitCount: Int
)

Attempts to process data from a ByteBuffer, starting from its current position and ending at its limit (exclusive).

From androidx.media3.exoplayer.audio.ForwardingAudioSink

`Unit`	`configure( inputFormat: Format!, specifiedBufferSize: Int, outputChannels: IntArray? )` Configures (or reconfigures) the sink.
`Unit`	`disableTunneling()` Disables tunneling.
`Unit`	`enableTunnelingV21()` Enables tunneling, if possible.
`AudioAttributes?`	`getAudioAttributes()` Returns the audio attributes used for audio playback, or `null` if the sink does not use audio attributes.
`Long`	`getAudioTrackBufferSizeUs()` Returns the size of the underlying `AudioTrack` buffer in microseconds.
`Long`	`getCurrentPositionUs(sourceEnded: Boolean)` Returns the playback position in the stream starting at zero, in microseconds, or `CURRENT_POSITION_NOT_SET` if it is not yet available.
`AudioOffloadSupport!`	`getFormatOffloadSupport(format: Format!)` Returns the level of offload support that the sink can provide for a given `Format`.
`Int`	`@AudioSink.SinkFormatSupport getFormatSupport(format: Format!)` Returns the level of support that the sink provides for a given `Format`.
`PlaybackParameters!`	`getPlaybackParameters()` Returns the active `PlaybackParameters`.
`Boolean`	`getSkipSilenceEnabled()` Returns whether silences are skipped in the audio stream.
`Unit`	`handleDiscontinuity()` Signals to the sink that the next buffer may be discontinuous with the previous buffer.
`Boolean`	`hasPendingData()` Returns whether the sink has data pending that has not been consumed yet.
`Boolean`	`isEnded()` Returns whether `playToEndOfStream` has been called and all buffers have been processed.
`Unit`	`pause()` Pauses playback.
`Unit`	`play()` Starts or resumes consuming audio if initialized.
`Unit`	`playToEndOfStream()` Processes any remaining data.
`Unit`	`release()` Releases the audio sink.
`Unit`	`setAudioAttributes(audioAttributes: AudioAttributes!)` Sets attributes for audio playback.
`Unit`	`setAudioOutputProvider(audioOutputProvider: AudioOutputProvider!)` Sets the `AudioOutputProvider` to use as the output path.
`Unit`	`setAudioSessionId(audioSessionId: Int)` Sets the audio session id.
`Unit`	`setAuxEffectInfo(auxEffectInfo: AuxEffectInfo!)` Sets the auxiliary effect.
`Unit`	`setClock(clock: Clock!)` Sets the `Clock` to use for timing in this audio sink.
`Unit`	`setListener(listener: AudioSink.Listener!)` Sets the listener for sink events, which should be the audio renderer.
`Unit`	`@RequiresApi(value = 29) setOffloadDelayPadding(delayInFrames: Int, paddingInFrames: Int)` Sets offload delay padding on the `AudioTrack`, if possible.
`Unit`	`@RequiresApi(value = 29) setOffloadMode(@AudioSink.OffloadMode offloadMode: Int)` Sets audio offload mode, if possible.
`Unit`	`setOutputStreamOffsetUs(outputStreamOffsetUs: Long)` Sets the offset that is added to the media timestamp before it is passed as `presentationTimeUs` in `handleBuffer`.
`Unit`	`setPlaybackParameters(playbackParameters: PlaybackParameters!)` Attempts to set the playback parameters.
`Unit`	`setPlayerId(playerId: PlayerId?)` Sets the `PlayerId` of the player using this audio sink.
`Unit`	`setPreferredDevice(audioDeviceInfo: AudioDeviceInfo?)` Sets the preferred audio device.
`Unit`	`setSkipSilenceEnabled(skipSilenceEnabled: Boolean)` Sets whether silences should be skipped in the audio stream.
`Unit`	`setVirtualDeviceId(virtualDeviceId: Int)` Sets the virtual device id.
`Unit`	`setVolume(volume: Float)` Sets the playback volume.
`Boolean`	`supportsFormat(format: Format!)` Returns whether the sink supports a given `Format`.

Constants

SAMPLE_RATE

const val SAMPLE_RATE = 48000: Int

Opus streams are always 48000 Hz.

Public constructors

OggFileAudioBufferSink

OggFileAudioBufferSink(
    audioSink: AudioSink!,
    outputFileNamePrefix: String!
)

Creates an instance.

Parameters
`audioSink: AudioSink!`	The base audioSink calls are forwarded to.
`outputFileNamePrefix: String!`	The prefix for output files.

Public functions

flush

fun flush(): Unit

Flushes the sink, after which it is ready to receive buffers from a new playback position.

The audio session may remain active until reset is called.

handleBuffer

fun handleBuffer(
    buffer: ByteBuffer!,
    presentationTimeUs: Long,
    encodedAccessUnitCount: Int
): Boolean

Attempts to process data from a ByteBuffer, starting from its current position and ending at its limit (exclusive). The position of the ByteBuffer is advanced by the number of bytes that were handled. onPositionDiscontinuity will be called if presentationTimeUs is discontinuous with the last buffer handled since the last reset.

Returns whether the data was handled in full. If the data was not handled in full then the same ByteBuffer must be provided to subsequent calls until it has been fully consumed, except in the case of an intervening call to flush (or to configure that causes the sink to be flushed).

Parameters
`buffer: ByteBuffer!`	The buffer containing audio data.
`presentationTimeUs: Long`	The presentation timestamp of the buffer in microseconds.
`encodedAccessUnitCount: Int`	The number of encoded access units in the buffer, or 1 if the buffer contains PCM audio. This allows batching multiple encoded access units in one buffer.

Returns
`Boolean`	Whether the buffer was handled fully.

Throws
`androidx.media3.exoplayer.audio.AudioSink.InitializationException`	If an error occurs initializing the sink.
`androidx.media3.exoplayer.audio.AudioSink.WriteException`	If an error occurs writing the audio data.

reset

fun reset(): Unit

Resets the sink, releasing any resources that it currently holds.