DefaultAudioSink (library-core API)

java.lang.Object
- com.google.android.exoplayer2.audio.DefaultAudioSink

All Implemented Interfaces:

AudioSink
```
public final class DefaultAudioSink
extends java.lang.Object
implements AudioSink
```
Plays audio data. The implementation delegates to an AudioTrack and handles playback position smoothing, non-blocking writes and reconfiguration.
If tunneling mode is enabled, care must be taken that audio processors do not output buffers with a different duration than their input, and buffer processors must produce output corresponding to their last input immediately after that input is queued. This means that, for example, speed adjustment is not possible while using tunneling.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DefaultAudioSink.AudioProcessorChain` Provides a chain of audio processors, which are used for any user-defined processing and applying playback parameters (if supported).
`static class`	`DefaultAudioSink.DefaultAudioProcessorChain` The default audio processor chain, which applies a (possibly empty) chain of user-defined audio processors followed by `SilenceSkippingAudioProcessor` and `SonicAudioProcessor`.
`static class`	`DefaultAudioSink.InvalidAudioTrackTimestampException` Thrown when the audio track has provided a spurious timestamp, if `failOnSpuriousAudioTimestamp` is set.

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.audio.AudioSink
AudioSink.ConfigurationException, AudioSink.InitializationException, AudioSink.Listener, AudioSink.WriteException

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`enablePreV21AudioSessionWorkaround` Whether to enable a workaround for an issue where an audio effect does not keep its session active across releasing/initializing a new audio track, on platform builds where `Util.SDK_INT` < 21.
`static boolean`	`failOnSpuriousAudioTimestamp` Whether to throw an `DefaultAudioSink.InvalidAudioTrackTimestampException` when a spurious timestamp is reported from `AudioTrack.getTimestamp(android.media.AudioTimestamp)`.

Fields inherited from interface com.google.android.exoplayer2.audio.AudioSink
CURRENT_POSITION_NOT_SET

Constructor Summary

Constructors
Constructor and Description
`DefaultAudioSink(AudioCapabilities audioCapabilities, AudioProcessor[] audioProcessors)` Creates a new default audio sink.
`DefaultAudioSink(AudioCapabilities audioCapabilities, AudioProcessor[] audioProcessors, boolean enableConvertHighResIntPcmToFloat)` Creates a new default audio sink, optionally using float output for high resolution PCM.
`DefaultAudioSink(AudioCapabilities audioCapabilities, DefaultAudioSink.AudioProcessorChain audioProcessorChain, boolean enableConvertHighResIntPcmToFloat)` Creates a new default audio sink, optionally using float output for high resolution PCM and with the specified `audioProcessorChain`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`configure(int inputEncoding, int inputChannelCount, int inputSampleRate, int specifiedBufferSize, int[] outputChannels, int trimStartFrames, int trimEndFrames)` Configures (or reconfigures) the sink.
`void`	`disableTunneling()` Disables tunneling.
`void`	`enableTunnelingV21(int tunnelingAudioSessionId)` Enables tunneling, if possible.
`long`	`getCurrentPositionUs(boolean sourceEnded)` Returns the playback position in the stream starting at zero, in microseconds, or `AudioSink.CURRENT_POSITION_NOT_SET` if it is not yet available.
`PlaybackParameters`	`getPlaybackParameters()` Gets the active `PlaybackParameters`.
`boolean`	`handleBuffer(java.nio.ByteBuffer buffer, long presentationTimeUs)` 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`	`isEncodingSupported(int encoding)` Returns whether it's possible to play audio in the specified encoding.
`boolean`	`isEnded()` Returns whether `AudioSink.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 any resources associated with this instance.
`void`	`reset()` Resets the sink, after which it is ready to receive buffers from a new playback position.
`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`	`setListener(AudioSink.Listener listener)` Sets the listener for sink events, which should be the audio renderer.
`PlaybackParameters`	`setPlaybackParameters(PlaybackParameters playbackParameters)` Attempts to set the playback parameters and returns the active playback parameters, which may differ from those passed in.
`void`	`setVolume(float volume)` Sets the playback volume.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - enablePreV21AudioSessionWorkaround
```
public static boolean enablePreV21AudioSessionWorkaround
```
    Whether to enable a workaround for an issue where an audio effect does not keep its session active across releasing/initializing a new audio track, on platform builds where Util.SDK_INT < 21.
    The flag must be set before creating a player.
  - failOnSpuriousAudioTimestamp
```
public static boolean failOnSpuriousAudioTimestamp
```
    Whether to throw an DefaultAudioSink.InvalidAudioTrackTimestampException when a spurious timestamp is reported from AudioTrack.getTimestamp(android.media.AudioTimestamp).
    The flag must be set before creating a player. Should be set to true for testing and debugging purposes only.
- Constructor Detail
  - DefaultAudioSink
```
public DefaultAudioSink(@Nullable
                        AudioCapabilities audioCapabilities,
                        AudioProcessor[] audioProcessors)
```
    Creates a new default audio sink.
    
    Parameters:
    
    audioCapabilities - The audio capabilities for playback on this device. May be null if the default capabilities (no encoded audio passthrough support) should be assumed.
    
    audioProcessors - An array of AudioProcessors that will process PCM audio before output. May be empty.
  - DefaultAudioSink
```
public DefaultAudioSink(@Nullable
                        AudioCapabilities audioCapabilities,
                        AudioProcessor[] audioProcessors,
                        boolean enableConvertHighResIntPcmToFloat)
```
    Creates a new default audio sink, optionally using float output for high resolution PCM.
    
    Parameters:
    
    audioCapabilities - The audio capabilities for playback on this device. May be null if the default capabilities (no encoded audio passthrough support) should be assumed.
    
    audioProcessors - An array of AudioProcessors that will process PCM audio before output. May be empty.
    
    enableConvertHighResIntPcmToFloat - Whether to enable conversion of high resolution integer PCM to 32-bit float for output, if possible. Functionality that uses 16-bit integer audio processing (for example, speed and pitch adjustment) will not be available when float output is in use.
  - DefaultAudioSink
```
public DefaultAudioSink(@Nullable
                        AudioCapabilities audioCapabilities,
                        DefaultAudioSink.AudioProcessorChain audioProcessorChain,
                        boolean enableConvertHighResIntPcmToFloat)
```
    Creates a new default audio sink, optionally using float output for high resolution PCM and with the specified audioProcessorChain.
    
    Parameters:
    
    audioCapabilities - The audio capabilities for playback on this device. May be null if the default capabilities (no encoded audio passthrough support) should be assumed.
    
    audioProcessorChain - An DefaultAudioSink.AudioProcessorChain which is used to apply playback parameters adjustments. The instance passed in must not be reused in other sinks.
    
    enableConvertHighResIntPcmToFloat - Whether to enable conversion of high resolution integer PCM to 32-bit float for output, if possible. Functionality that uses 16-bit integer audio processing (for example, speed and pitch adjustment) will not be available when float output is in use.
- Method Detail
  - setListener
```
public void setListener(AudioSink.Listener listener)
```
    Description copied from interface: AudioSink
    
    Sets the listener for sink events, which should be the audio renderer.
    
    Specified by:
    
    setListener in interface AudioSink
    
    Parameters:
    
    listener - The listener for sink events, which should be the audio renderer.
  - isEncodingSupported
```
public boolean isEncodingSupported(@C.Encoding
                                   int encoding)
```
    Description copied from interface: AudioSink
    
    Returns whether it's possible to play audio in the specified encoding.
    
    Specified by:
    
    isEncodingSupported in interface AudioSink
    
    Parameters:
    
    encoding - The audio encoding.
    
    Returns:
    
    Whether it's possible to play audio in the specified encoding.
  - getCurrentPositionUs
```
public long getCurrentPositionUs(boolean sourceEnded)
```
    Description copied from interface: AudioSink
    
    Returns the playback position in the stream starting at zero, in microseconds, or AudioSink.CURRENT_POSITION_NOT_SET if it is not yet available.
    
    Specified by:
    
    getCurrentPositionUs in interface AudioSink
    
    Parameters:
    
    sourceEnded - Specify true if no more input buffers will be provided.
    
    Returns:
    
    The playback position relative to the start of playback, in microseconds.
  - configure
```
public void configure(@C.Encoding
                      int inputEncoding,
                      int inputChannelCount,
                      int inputSampleRate,
                      int specifiedBufferSize,
                      @Nullable
                      int[] outputChannels,
                      int trimStartFrames,
                      int trimEndFrames)
               throws AudioSink.ConfigurationException
```
    Description copied from interface: AudioSink
    
    Configures (or reconfigures) the sink.
    
    Specified by:
    
    configure in interface AudioSink
    
    Parameters:
    
    inputEncoding - The encoding of audio data provided in the input buffers.
    
    inputChannelCount - The number of channels.
    
    inputSampleRate - The sample rate in Hz.
    
    specifiedBufferSize - A specific size for the playback buffer in bytes, or 0 to infer a suitable buffer size.
    
    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.
    
    trimStartFrames - The number of audio frames to trim from the start of data written to the sink after this call.
    
    trimEndFrames - The number of audio frames to trim from data written to the sink immediately preceding the next call to AudioSink.reset() or this method.
    
    Throws:
    
    AudioSink.ConfigurationException - If an error occurs configuring the sink.
  - play
```
public void play()
```
    Description copied from interface: AudioSink
    
    Starts or resumes consuming audio if initialized.
    
    Specified by:
    
    play in interface AudioSink
  - handleDiscontinuity
```
public void handleDiscontinuity()
```
    Description copied from interface: AudioSink
    
    Signals to the sink that the next buffer may be discontinuous with the previous buffer.
    
    Specified by:
    
    handleDiscontinuity in interface AudioSink
  - handleBuffer
```
public boolean handleBuffer(java.nio.ByteBuffer buffer,
                            long presentationTimeUs)
                     throws AudioSink.InitializationException,
                            AudioSink.WriteException
```
    Description copied from interface: AudioSink
    
    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. AudioSink.Listener.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 AudioSink.reset() (or to AudioSink.configure(int, int, int, int, int[], int, int) that causes the sink to be reset).
    
    Specified by:
    
    handleBuffer in interface AudioSink
    
    Parameters:
    
    buffer - The buffer containing audio data.
    
    presentationTimeUs - The presentation timestamp of the buffer in microseconds.
    
    Returns:
    
    Whether the buffer was handled fully.
    
    Throws:
    
    AudioSink.InitializationException - If an error occurs initializing the sink.
    
    AudioSink.WriteException - If an error occurs writing the audio data.
  - playToEndOfStream
```
public void playToEndOfStream()
                       throws AudioSink.WriteException
```
    Description copied from interface: AudioSink
    
    Processes any remaining data. AudioSink.isEnded() will return true when no data remains.
    
    Specified by:
    
    playToEndOfStream in interface AudioSink
    
    Throws:
    
    AudioSink.WriteException - If an error occurs draining data to the sink.
  - isEnded
```
public boolean isEnded()
```
    Description copied from interface: AudioSink
    
    Returns whether AudioSink.playToEndOfStream() has been called and all buffers have been processed.
    
    Specified by:
    
    isEnded in interface AudioSink
  - hasPendingData
```
public boolean hasPendingData()
```
    Description copied from interface: AudioSink
    
    Returns whether the sink has data pending that has not been consumed yet.
    
    Specified by:
    
    hasPendingData in interface AudioSink
  - setPlaybackParameters
```
public PlaybackParameters setPlaybackParameters(PlaybackParameters playbackParameters)
```
    Description copied from interface: AudioSink
    
    Attempts to set the playback parameters and returns the active playback parameters, which may differ from those passed in.
    
    Specified by:
    
    setPlaybackParameters in interface AudioSink
    
    Parameters:
    
    playbackParameters - The new playback parameters to attempt to set.
    
    Returns:
    
    The active playback parameters.
  - getPlaybackParameters
```
public PlaybackParameters getPlaybackParameters()
```
    Description copied from interface: AudioSink
    
    Gets the active PlaybackParameters.
    
    Specified by:
    
    getPlaybackParameters in interface AudioSink
  - setAudioAttributes
```
public void setAudioAttributes(AudioAttributes audioAttributes)
```
    Description copied from interface: AudioSink
    
    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.
    
    Specified by:
    
    setAudioAttributes in interface AudioSink
    
    Parameters:
    
    audioAttributes - The attributes for audio playback.
  - setAudioSessionId
```
public void setAudioSessionId(int audioSessionId)
```
    Description copied from interface: AudioSink
    
    Sets the audio session id.
    
    Specified by:
    
    setAudioSessionId in interface AudioSink
  - setAuxEffectInfo
```
public void setAuxEffectInfo(AuxEffectInfo auxEffectInfo)
```
    Description copied from interface: AudioSink
    
    Sets the auxiliary effect.
    
    Specified by:
    
    setAuxEffectInfo in interface AudioSink
  - enableTunnelingV21
```
public void enableTunnelingV21(int tunnelingAudioSessionId)
```
    Description copied from interface: AudioSink
    
    Enables tunneling, if possible. The sink is reset if tunneling was previously disabled or if the audio session id has changed. Enabling tunneling is only possible if the sink is based on a platform AudioTrack, and requires platform API version 21 onwards.
    
    Specified by:
    
    enableTunnelingV21 in interface AudioSink
    
    Parameters:
    
    tunnelingAudioSessionId - The audio session id to use.
  - disableTunneling
```
public void disableTunneling()
```
    Description copied from interface: AudioSink
    
    Disables tunneling. If tunneling was previously enabled then the sink is reset and any audio session id is cleared.
    
    Specified by:
    
    disableTunneling in interface AudioSink
  - setVolume
```
public void setVolume(float volume)
```
    Description copied from interface: AudioSink
    
    Sets the playback volume.
    
    Specified by:
    
    setVolume in interface AudioSink
    
    Parameters:
    
    volume - A volume in the range [0.0, 1.0].
  - pause
```
public void pause()
```
    Description copied from interface: AudioSink
    
    Pauses playback.
    
    Specified by:
    
    pause in interface AudioSink
  - reset
```
public void reset()
```
    Description copied from interface: AudioSink
    
    Resets the sink, after which it is ready to receive buffers from a new playback position.
    The audio session may remain active until AudioSink.release() is called.
    
    Specified by:
    
    reset in interface AudioSink
  - release
```
public void release()
```
    Description copied from interface: AudioSink
    
    Releases any resources associated with this instance.
    
    Specified by:
    
    release in interface AudioSink

Class DefaultAudioSink

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.audio.AudioSink

Field Summary

Fields inherited from interface com.google.android.exoplayer2.audio.AudioSink

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

enablePreV21AudioSessionWorkaround

failOnSpuriousAudioTimestamp

Constructor Detail

DefaultAudioSink

DefaultAudioSink

DefaultAudioSink

Method Detail

setListener

isEncodingSupported

getCurrentPositionUs

configure

play

handleDiscontinuity

handleBuffer

playToEndOfStream

isEnded

hasPendingData

setPlaybackParameters

getPlaybackParameters

setAudioAttributes

setAudioSessionId

setAuxEffectInfo

enableTunnelingV21

disableTunneling

setVolume

pause

reset

release