ForwardingAudioSink

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

Configures (or reconfigures) the sink.

public void disableTunneling()

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

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.

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.

public @Nullable AudioAttributes getAudioAttributes()

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

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.

public AudioOffloadSupport getFormatOffloadSupport(Format format)

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

@AudioSink.SinkFormatSupport
public int getFormatSupport(Format format)

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

public PlaybackParameters getPlaybackParameters()

Returns the active PlaybackParameters.

public boolean getSkipSilenceEnabled()

Returns whether silences are skipped in the audio stream.

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

public void handleDiscontinuity()

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

public boolean hasPendingData()

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

public boolean isEnded()

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

public void pause()

Pauses playback.

public void play()

Starts or resumes consuming audio if initialized.

public void playToEndOfStream()

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

public void release()

Releases the audio sink.

public void reset()

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

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.

public void setAudioSessionId(int audioSessionId)

Sets the audio session id.

public void setAuxEffectInfo(AuxEffectInfo auxEffectInfo)

Sets the auxiliary effect.

public void setClock(Clock clock)

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

public void setListener(AudioSink.Listener listener)

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

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

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

public void setOutputStreamOffsetUs(long outputStreamOffsetUs)

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

public void setPlaybackParameters(PlaybackParameters playbackParameters)

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

public void setPlayerId(@Nullable PlayerId playerId)

Sets the PlayerId of the player using this audio sink.

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

Sets the preferred audio device.

public void setSkipSilenceEnabled(boolean skipSilenceEnabled)

Sets whether silences should be skipped in the audio stream.

public void setVolume(float volume)

Sets the playback volume.

public boolean supportsFormat(Format format)

Returns whether the sink supports a given Format.