AudioSink

default static final long CURRENT_POSITION_NOT_SET = -9223372036854775808

Returned by getCurrentPositionUs when the position is not set.

default static final int OFFLOAD_MODE_DISABLED = 0

The audio sink will never play in offload mode.

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

Use this option to prioritize battery saving at the cost of a possible non seamless transitions between tracks of the same album.

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

Use this option to prioritize uninterrupted playback of consecutive audio tracks over power savings.

default static final int SINK_FORMAT_SUPPORTED_DIRECTLY = 2

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

default static final int SINK_FORMAT_SUPPORTED_WITH_TRANSCODING = 1

The sink supports the format, but needs to transcode it internally to do so. Internal transcoding may result in lower quality and higher CPU load in some cases.

default static final int SINK_FORMAT_UNSUPPORTED = 0

The sink does not support the format.

default void configure(AudioSink.AudioSinkConfig audioSinkConfig)

Configures (or reconfigures) the sink.

abstract void disableTunneling()

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

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

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

abstract @Nullable AudioAttributes getAudioAttributes()

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

default @Nullable AudioCapabilities getAudioCapabilities()

Returns the AudioCapabilities of the sink, if supported by the sink implementation.

abstract long getAudioTrackBufferSizeUs()

Returns the size of the underlying AudioTrack buffer in microseconds. If unsupported or the AudioTrack is not initialized then return TIME_UNSET.

If the AudioTrack is configured with a compressed encoding, then the returned duration is an estimated minimum based on the encoding's maximum encoded byte rate.

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

default AudioOffloadSupport getFormatOffloadSupport(Format format)

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

@AudioSink.SinkFormatSupport
abstract int getFormatSupport(Format format)

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

abstract PlaybackParameters getPlaybackParameters()

Returns the active PlaybackParameters.

abstract boolean getSkipSilenceEnabled()

Returns whether silences are skipped in the audio stream.

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

abstract void handleDiscontinuity()

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

abstract boolean hasPendingData()

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

abstract boolean isEnded()

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

abstract void pause()

Pauses playback.

abstract void play()

Starts or resumes consuming audio if initialized.

abstract void playToEndOfStream()

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

default void release()

Releases the audio sink.

abstract void reset()

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

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

default void setAudioOutputProvider(AudioOutputProvider audioOutputProvider)

Sets the AudioOutputProvider to use as the output path.

abstract void setAudioSessionId(int audioSessionId)

Sets the audio session id.

abstract void setAuxEffectInfo(AuxEffectInfo auxEffectInfo)

Sets the auxiliary effect.

default void setClock(Clock clock)

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

abstract void setListener(AudioSink.Listener listener)

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

@RequiresApi(value = 29)
default 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)
default 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.

default void setOutputStreamOffsetUs(long outputStreamOffsetUs)

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

abstract void setPlaybackParameters(PlaybackParameters playbackParameters)

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

default void setPlayerId(@Nullable PlayerId playerId)

Sets the PlayerId of the player using this audio sink.

default void setPreferredDevice(@Nullable AudioDeviceInfo audioDeviceInfo)

Sets the preferred audio device.

abstract void setSkipSilenceEnabled(boolean skipSilenceEnabled)

Sets whether silences should be skipped in the audio stream.

default void setVirtualDeviceId(int virtualDeviceId)

Sets the virtual device id.

abstract void setVolume(float volume)

Sets the playback volume.

abstract boolean supportsFormat(Format format)

Returns whether the sink supports a given Format.