Stay organized with collections Save and categorize content based on your preferences.

CapturingAudioSink

@UnstableApi
public final class CapturingAudioSink extends ForwardingAudioSink implements Dumper.Dumpable


A ForwardingAudioSink that captures configuration, discontinuity and buffer events.

Summary

Public constructors

Public methods

void
configure(
    Format inputFormat,
    int specifiedBufferSize,
    @Nullable int[] outputChannels
)

Configures (or reconfigures) the sink.

void
dump(Dumper dumper)

Dumps the fields of the object using the dumper.

void

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

boolean
handleBuffer(
    ByteBuffer buffer,
    long presentationTimeUs,
    int encodedAccessUnitCount
)

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

void

Signals to the sink that the next buffer may be discontinuous with the previous buffer.

void

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

Inherited Constants

From androidx.media3.exoplayer.audio.AudioSink
static final long
CURRENT_POSITION_NOT_SET = -9223372036854775808

Returned by getCurrentPositionUs when the position is not set.

static final int

The sink supports the format directly, without the need for internal transcoding.

static final int

The sink supports the format, but needs to transcode it internally to do so.

static final int

The sink does not support the format.

Inherited methods

From androidx.media3.exoplayer.audio.AudioSink
abstract boolean
handleBuffer(
    ByteBuffer buffer,
    long presentationTimeUs,
    int encodedAccessUnitCount
)

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

From androidx.media3.exoplayer.audio.ForwardingAudioSink
void

Disables tunneling.

void

Enables tunneling, if possible.

void

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

@Nullable AudioAttributes

Returns the audio attributes used for audio playback, or null if the sink does not use audio attributes.

long
getCurrentPositionUs(boolean sourceEnded)

Returns the playback position in the stream starting at zero, in microseconds, or CURRENT_POSITION_NOT_SET if it is not yet available.

int

Returns the level of support that the sink provides for a given Format.

PlaybackParameters

Returns the active PlaybackParameters.

boolean

Returns whether silences are skipped in the audio stream.

boolean

Returns whether the sink has data pending that has not been consumed yet.

boolean

Returns whether playToEndOfStream has been called and all buffers have been processed.

void

Pauses playback.

void

Starts or resumes consuming audio if initialized.

void

Processes any remaining data.

void

Sets attributes for audio playback.

void
setAudioSessionId(int audioSessionId)

Sets the audio session id.

void

Sets the auxiliary effect.

void

Sets the listener for sink events, which should be the audio renderer.

void
setOutputStreamOffsetUs(long outputStreamOffsetUs)

Sets the offset that is added to the media timestamp before it is passed as presentationTimeUs in handleBuffer.

void

Attempts to set the playback parameters.

void

Sets the PlayerId of the player using this audio sink.

void
@RequiresApi(value = 23)
setPreferredDevice(@Nullable AudioDeviceInfo audioDeviceInfo)

Sets the preferred audio device.

void
setSkipSilenceEnabled(boolean skipSilenceEnabled)

Sets whether silences should be skipped in the audio stream.

void
setVolume(float volume)

Sets the playback volume.

boolean

Returns whether the sink supports a given Format.

Public constructors

CapturingAudioSink

public CapturingAudioSink(AudioSink sink)

Public methods

configure

public void configure(
    Format inputFormat,
    int specifiedBufferSize,
    @Nullable int[] outputChannels
)

Configures (or reconfigures) the sink.

Parameters
Format inputFormat

The format of audio data provided in the input buffers.

int specifiedBufferSize

A specific size for the playback buffer in bytes, or 0 to infer a suitable buffer size.

@Nullable int[] outputChannels

A mapping from input to output channels that is applied to this sink's input as a preprocessing step, if handling PCM input. Specify null to leave the input unchanged. Otherwise, the element at index i specifies index of the input channel to map to output channel i when preprocessing input buffers. After the map is applied the audio data will have outputChannels.length channels.

Throws
androidx.media3.exoplayer.audio.AudioSink.ConfigurationException androidx.media3.exoplayer.audio.AudioSink.ConfigurationException

If an error occurs configuring the sink.

dump

public void dump(Dumper dumper)

Dumps the fields of the object using the dumper.

Parameters
Dumper dumper

The Dumper to be used to dump fields.

flush

public void flush()

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

public boolean handleBuffer(
    ByteBuffer buffer,
    long presentationTimeUs,
    int encodedAccessUnitCount
)

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
ByteBuffer buffer

The buffer containing audio data.

long presentationTimeUs

The presentation timestamp of the buffer in microseconds.

int encodedAccessUnitCount

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 androidx.media3.exoplayer.audio.AudioSink.InitializationException

If an error occurs initializing the sink.

androidx.media3.exoplayer.audio.AudioSink.WriteException androidx.media3.exoplayer.audio.AudioSink.WriteException

If an error occurs writing the audio data.

handleDiscontinuity

public void handleDiscontinuity()

Signals to the sink that the next buffer may be discontinuous with the previous buffer.

reset

public void reset()

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