ForwardingAudioSink

fun configure(
    inputFormat: Format!,
    specifiedBufferSize: Int,
    outputChannels: IntArray?
): Unit

Configures (or reconfigures) the sink.

fun disableTunneling(): Unit

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

fun enableTunnelingV21(): Unit

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.

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.

fun getAudioAttributes(): AudioAttributes?

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

fun getAudioTrackBufferSizeUs(): Long

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.

fun getCurrentPositionUs(sourceEnded: Boolean): Long

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

fun getFormatOffloadSupport(format: Format!): AudioOffloadSupport!

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

@AudioSink.SinkFormatSupport
fun getFormatSupport(format: Format!): Int

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

fun getPlaybackParameters(): PlaybackParameters!

Returns the active PlaybackParameters.

fun getSkipSilenceEnabled(): Boolean

Returns whether silences are skipped in the audio stream.

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

fun handleDiscontinuity(): Unit

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

fun hasPendingData(): Boolean

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

fun isEnded(): Boolean

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

fun pause(): Unit

Pauses playback.

fun play(): Unit

Starts or resumes consuming audio if initialized.

fun playToEndOfStream(): Unit

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

fun release(): Unit

Releases the audio sink.

fun reset(): Unit

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

fun setAudioAttributes(audioAttributes: AudioAttributes!): Unit

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.

fun setAudioOutputProvider(audioOutputProvider: AudioOutputProvider!): Unit

Sets the AudioOutputProvider to use as the output path.

fun setAudioSessionId(audioSessionId: Int): Unit

Sets the audio session id.

fun setAuxEffectInfo(auxEffectInfo: AuxEffectInfo!): Unit

Sets the auxiliary effect.

fun setClock(clock: Clock!): Unit

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

fun setListener(listener: AudioSink.Listener!): Unit

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

@RequiresApi(value = 29)
fun setOffloadDelayPadding(delayInFrames: Int, paddingInFrames: Int): Unit

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)
fun setOffloadMode(@AudioSink.OffloadMode offloadMode: Int): Unit

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.

fun setOutputStreamOffsetUs(outputStreamOffsetUs: Long): Unit

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

fun setPlaybackParameters(playbackParameters: PlaybackParameters!): Unit

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

fun setPlayerId(playerId: PlayerId?): Unit

Sets the PlayerId of the player using this audio sink.

fun setPreferredDevice(audioDeviceInfo: AudioDeviceInfo?): Unit

Sets the preferred audio device.

fun setSkipSilenceEnabled(skipSilenceEnabled: Boolean): Unit

Sets whether silences should be skipped in the audio stream.

fun setVirtualDeviceId(virtualDeviceId: Int): Unit

Sets the virtual device id.

fun setVolume(volume: Float): Unit

Sets the playback volume.

fun supportsFormat(format: Format!): Boolean

Returns whether the sink supports a given Format.