ForwardingAudioSink

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public class ForwardingAudioSink implements AudioSink

Known direct subclasses

CapturingAudioSink, OggFileAudioBufferSink

`CapturingAudioSink`	A `ForwardingAudioSink` that captures configuration, discontinuity and buffer events.
`OggFileAudioBufferSink`	A sink for audio buffers that writes output audio as .ogg files with a given path prefix.

An overridable AudioSink implementation forwarding all methods to another sink.

Summary

Public constructors
`ForwardingAudioSink(AudioSink sink)`

Public methods
`void`	`configure( Format inputFormat, int specifiedBufferSize, @Nullable int[] outputChannels )` Configures (or reconfigures) the sink.
`void`	`disableTunneling()` Disables tunneling.
`void`	`enableTunnelingV21()` Enables tunneling, if possible.
`void`	`flush()` Flushes the sink, after which it is ready to receive buffers from a new playback position.
`@Nullable AudioAttributes`	`getAudioAttributes()` 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.
`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.
`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`	`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.
`void`	`pause()` Pauses playback.
`void`	`play()` Starts or resumes consuming audio if initialized.
`void`	`playToEndOfStream()` Processes any remaining data.
`void`	`release()` Releases the audio sink.
`void`	`reset()` Resets the sink, releasing any resources that it currently holds.
`void`	`setAudioAttributes(AudioAttributes audioAttributes)` Sets attributes for audio playback.
`void`	`setAudioSessionId(int audioSessionId)` Sets the audio session id.
`void`	`setAuxEffectInfo(AuxEffectInfo auxEffectInfo)` Sets the auxiliary effect.
`void`	`setClock(Clock clock)` Sets the `Clock` to use for timing in this audio sink.
`void`	`setListener(AudioSink.Listener listener)` Sets the listener for sink events, which should be the audio renderer.
`void`	`@RequiresApi(value = 29) setOffloadDelayPadding(int delayInFrames, int paddingInFrames)` Sets offload delay padding on the `AudioTrack`, if possible.
`void`	`@RequiresApi(value = 29) setOffloadMode(@AudioSink.OffloadMode int offloadMode)` Sets audio offload mode, if possible.
`void`	`setOutputStreamOffsetUs(long outputStreamOffsetUs)` Sets the offset that is added to the media timestamp before it is passed as `presentationTimeUs` in `handleBuffer`.
`void`	`setPlaybackParameters(PlaybackParameters playbackParameters)` Attempts to set the playback parameters.
`void`	`setPlayerId(@Nullable PlayerId playerId)` 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`	`supportsFormat(Format format)` Returns whether the sink supports a given `Format`.

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`	`OFFLOAD_MODE_DISABLED = 0` The audio sink will never play in offload mode.
`static final 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.
`static final 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.
`static final int`	`SINK_FORMAT_SUPPORTED_DIRECTLY = 2` The sink supports the format directly, without the need for internal transcoding.
`static final int`	`SINK_FORMAT_SUPPORTED_WITH_TRANSCODING = 1` The sink supports the format, but needs to transcode it internally to do so.
`static final int`	`SINK_FORMAT_UNSUPPORTED = 0` The sink does not support the format.

Public constructors

ForwardingAudioSink

public ForwardingAudioSink(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`	If an error occurs configuring the sink.

disableTunneling

public void disableTunneling()

Disables tunneling. If tunneling was previously enabled then the sink is reset and any audio session id is cleared.

enableTunnelingV21

public void enableTunnelingV21()

Enables tunneling, if possible. The sink is reset if tunneling was previously disabled. Enabling tunneling is only possible if the sink is based on a platform AudioTrack, and requires platform API version 21 onwards.

Throws
`java.lang.IllegalStateException`	Thrown if enabling tunneling on platform API version <21.

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.

getAudioAttributes

public @Nullable AudioAttributes getAudioAttributes()

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

getCurrentPositionUs

public 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.

Parameters
`boolean sourceEnded`	Specify `true` if no more input buffers will be provided.

Returns
`long`	The playback position relative to the start of playback, in microseconds.

getFormatOffloadSupport

public AudioOffloadSupport getFormatOffloadSupport(Format format)

Returns the level of offload support that the sink can provide for a given Format.

Parameters
`Format format`	The format.

Returns
`AudioOffloadSupport`	The level of support provided.

getFormatSupport

@AudioSink.SinkFormatSupport
public int getFormatSupport(Format format)

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

Parameters
`Format format`	The format.

Returns
`int`	The level of support provided.

getPlaybackParameters

public PlaybackParameters getPlaybackParameters()

Returns the active PlaybackParameters.

getSkipSilenceEnabled

public boolean getSkipSilenceEnabled()

Returns whether silences are skipped in the audio stream.

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`	If an error occurs initializing the sink.
`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.

hasPendingData

public boolean hasPendingData()

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

isEnded

public boolean isEnded()

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

pause

public void pause()

Pauses playback.

play

public void play()

Starts or resumes consuming audio if initialized.

playToEndOfStream

public void playToEndOfStream()

Processes any remaining data. isEnded will return true when no data remains.

Throws
`androidx.media3.exoplayer.audio.AudioSink.WriteException`	If an error occurs draining data to the sink.

release

public void release()

Releases the audio sink.

reset

public void reset()

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

setAudioAttributes

public void setAudioAttributes(AudioAttributes audioAttributes)

Sets attributes for audio playback. If the attributes have changed and if the sink is not configured for use with tunneling, then it is reset and the audio session id is cleared.

If the sink is configured for use with tunneling then the audio attributes are ignored. The sink is not reset and the audio session id is not cleared. The passed attributes will be used if the sink is later re-configured into non-tunneled mode.

Parameters
`AudioAttributes audioAttributes`	The attributes for audio playback.

setAudioSessionId

public void setAudioSessionId(int audioSessionId)

Sets the audio session id.

setAuxEffectInfo

public void setAuxEffectInfo(AuxEffectInfo auxEffectInfo)

Sets the auxiliary effect.

setClock

public void setClock(Clock clock)

Sets the Clock to use for timing in this audio sink.

Parameters
`Clock clock`	The `Clock`.

setListener

public void setListener(AudioSink.Listener listener)

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

Parameters
`AudioSink.Listener listener`	The listener for sink events, which should be the audio renderer.

setOffloadDelayPadding

@RequiresApi(value = 29)
public void setOffloadDelayPadding(int delayInFrames, int paddingInFrames)

Sets offload delay padding on the AudioTrack, if possible. Setting the offload delay padding is only possible if the sink is based on a platform AudioTrack in offload mode. Also requires platform API version 29 onwards.

setOffloadMode

@RequiresApi(value = 29)
public void setOffloadMode(@AudioSink.OffloadMode int offloadMode)

Sets audio offload mode, if possible. Enabling offload is only possible if the sink is based on a platform AudioTrack, and requires platform API version 29 onwards.

setOutputStreamOffsetUs

public void setOutputStreamOffsetUs(long outputStreamOffsetUs)

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

Parameters
`long outputStreamOffsetUs`	The output stream offset in microseconds.

setPlaybackParameters

public void setPlaybackParameters(PlaybackParameters playbackParameters)

Attempts to set the playback parameters. The audio sink may override these parameters if they are not supported.

Parameters
`PlaybackParameters playbackParameters`	The new playback parameters to attempt to set.

setPlayerId

public void setPlayerId(@Nullable PlayerId playerId)

Sets the PlayerId of the player using this audio sink.

Parameters
`@Nullable PlayerId playerId`	The `PlayerId`, or null to clear a previously set id.

setPreferredDevice

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

Sets the preferred audio device.

Parameters
`@Nullable AudioDeviceInfo audioDeviceInfo`	The preferred `audio device`, or null to restore the default.

setSkipSilenceEnabled

public void setSkipSilenceEnabled(boolean skipSilenceEnabled)

Sets whether silences should be skipped in the audio stream.

setVolume

public void setVolume(float volume)

Sets the playback volume.

Parameters
`float volume`	Linear output gain to apply to all channels. Should be in the range [0.0, 1.0].

supportsFormat

public boolean supportsFormat(Format format)

Returns whether the sink supports a given Format.

Parameters
`Format format`	The format.

Returns
`boolean`	Whether the sink supports the format.