Stay organized with collections Save and categorize content based on your preferences.

LibflacAudioRenderer

@UnstableApi
class LibflacAudioRenderer : DecoderAudioRenderer


Decodes and renders audio using the native Flac decoder.

Summary

Public constructors

LibflacAudioRenderer(
    eventHandler: Handler?,
    eventListener: AudioRendererEventListener?,
    audioProcessors: Array<AudioProcessor!>!
)

Creates an instance.

LibflacAudioRenderer(
    eventHandler: Handler?,
    eventListener: AudioRendererEventListener?,
    audioSink: AudioSink!
)

Creates an instance.

Public functions

String!

Returns the name of this renderer, for logging and debugging purposes.

Protected functions

Int

Returns the C.FormatSupport for the given Format.

Inherited Constants

From androidx.media3.exoplayer.Renderer
const Int

Applications or extensions may define custom MSG_* constants that can be passed to renderers.

const Int

A type of a message that can be passed to an audio renderer via createMessage.

const Int

The type of a message that can be passed to audio and video renderers via createMessage.

const Int

A type of a message that can be passed to an audio renderer via createMessage.

const Int

The type of a message that can be passed to a camera motion renderer via createMessage.

const Int

The type of a message that can be passed to a video renderer via createMessage.

const Int

The type of a message that can be passed to audio renderers via createMessage.

const Int

The type of a message that can be passed to a MediaCodec-based video renderer via createMessage.

const Int

The type of a message that can be passed to an audio renderer via createMessage.

const Int

The type of a message that can be passed to a video renderer via createMessage.

const Int

The type of a message that can be passed to a video renderer via createMessage.

const Int

A type of a message that can be passed to an audio renderer via createMessage.

const Int

The type of a message that can be passed to a Renderer via createMessage, to inform the renderer that it can schedule waking up another component.

const Int

The renderer is disabled.

const Int

The renderer is enabled but not started.

const Int

The renderer is started.

From androidx.media3.exoplayer.RendererCapabilities
const Int

The Renderer can adapt between formats, but may suffer a brief discontinuity (~50-100ms) when adaptation occurs.

const Int

The Renderer does not support adaptation between formats.

const Int

The Renderer can seamlessly adapt between formats.

const Int

A mask to apply to Capabilities to obtain the AdaptiveSupport only.

const Int

The renderer will use a fallback decoder.

const Int

The renderer will use a decoder for fallback mimetype if possible as format's MIME type is unsupported

const Int

The renderer is able to use the primary decoder for the format's MIME type.

const Int

This property is deprecated.

Use FORMAT_EXCEEDS_CAPABILITIES instead.

const Int

This property is deprecated.

Use FORMAT_HANDLED instead.

const Int

A mask to apply to Capabilities to obtain the C.FormatSupport only.

const Int

This property is deprecated.

Use FORMAT_UNSUPPORTED_DRM instead.

const Int

This property is deprecated.

Use FORMAT_UNSUPPORTED_SUBTYPE instead.

const Int

This property is deprecated.

Use FORMAT_UNSUPPORTED_TYPE instead.

const Int

The renderer is not able to use hardware acceleration.

const Int

The renderer is able to use hardware acceleration.

const Int

A mask to apply to Capabilities to obtain HardwareAccelerationSupport only.

const Int

A mask to apply to Capabilities to obtain DecoderSupport only.

const Int

The Renderer does not support tunneled output.

const Int

The Renderer supports tunneled output.

const Int

A mask to apply to Capabilities to obtain TunnelingSupport only.

Inherited functions

From androidx.media3.exoplayer.BaseRenderer
ExoPlaybackException!
createRendererException(
    cause: Throwable!,
    format: Format?,
    @PlaybackException.ErrorCode errorCode: Int
)

Creates an ExoPlaybackException of type TYPE_RENDERER for this renderer.

ExoPlaybackException!
createRendererException(
    cause: Throwable!,
    format: Format?,
    isRecoverable: Boolean,
    @PlaybackException.ErrorCode errorCode: Int
)

Creates an ExoPlaybackException of type TYPE_RENDERER for this renderer.

Unit

Disable the renderer, transitioning it to the STATE_DISABLED state.

Unit
enable(
    configuration: RendererConfiguration!,
    formats: Array<Format!>!,
    stream: SampleStream!,
    positionUs: Long,
    joining: Boolean,
    mayRenderStartOfStream: Boolean,
    startPositionUs: Long,
    offsetUs: Long
)

Enables the renderer to consume from the specified SampleStream.

RendererCapabilities!

Returns the capabilities of the renderer.

RendererConfiguration!

Returns the configuration set when the renderer was most recently enabled.

FormatHolder!

Returns a clear FormatHolder.

Int

Returns the index of the renderer within the player.

Long

Returns the position passed to the most recent call to enable or resetPosition.

PlayerId!

Returns the PlayerId of the player using this renderer.

Long

Returns the renderer time up to which the renderer has read samples, in microseconds, or TIME_END_OF_SOURCE if the renderer has read the current SampleStream to the end.

Int

Returns the current state of the renderer.

SampleStream?

Returns the SampleStream being consumed, or null if the renderer is disabled.

Array<Format!>!

Returns the formats of the currently enabled stream.

Int

Returns the track type that the renderer handles.

Boolean

Returns whether the renderer has read the current SampleStream to the end.

Unit
init(index: Int, playerId: PlayerId!)

Initializes the renderer for playback with a player.

Boolean

Returns whether the current SampleStream will be the final one supplied before the renderer is next disabled or reset.

Boolean

Returns whether the upstream source is ready.

Unit

Throws an error that's preventing the renderer from reading from its SampleStream.

Unit

Called when the renderer is reset.

Int
@SampleStream.ReadDataResult
readSource(
    formatHolder: FormatHolder!,
    buffer: DecoderInputBuffer!,
    @SampleStream.ReadFlags readFlags: Int
)

Reads from the enabled upstream source.

Unit
replaceStream(
    formats: Array<Format!>!,
    stream: SampleStream!,
    startPositionUs: Long,
    offsetUs: Long
)

Replaces the SampleStream from which samples will be consumed.

Unit

Forces the renderer to give up any resources (e.g. media decoders) that it may be holding.

Unit
resetPosition(positionUs: Long)

Signals to the renderer that a position discontinuity has occurred.

Unit

Signals to the renderer that the current SampleStream will be the final one supplied before it is next disabled or reset.

Int
skipSource(positionUs: Long)

Attempts to skip to the keyframe before the specified position, or to the end of the stream if positionUs is beyond it.

Unit

Starts the renderer, meaning that calls to render will cause media to be rendered.

Unit

Stops the renderer, transitioning it to the STATE_ENABLED state.

Int

Returns the extent to which the Renderer supports adapting between supported formats that have different MIME types.

From androidx.media3.exoplayer.audio.DecoderAudioRenderer
DecoderReuseEvaluation!
@ForOverride
canReuseDecoder(decoderName: String!, oldFormat: Format!, newFormat: Format!)

Evaluates whether the existing decoder can be reused for a new Format.

Unit
experimentalSetEnableKeepAudioTrackOnSeek(
    enableKeepAudioTrackOnSeek: Boolean
)

Sets whether to enable the experimental feature that keeps and flushes the when a seek occurs, as opposed to releasing and reinitialising.

MediaClock?

If the renderer advances its own playback position then this method returns a corresponding MediaClock.

PlaybackParameters!

Returns the active playback parameters.

Long

Returns the current media position in microseconds.

Int

Returns the level of support that the renderer's AudioSink provides for a given .

Unit
handleMessage(@Renderer.MessageType messageType: Int, message: Any?)

Handles a message delivered to the target.

Boolean

Whether the renderer is ready for the ExoPlayer instance to transition to STATE_ENDED.

Boolean

Whether the renderer is able to immediately render media from the current position.

Unit

Called when the renderer is disabled.

Unit
onEnabled(joining: Boolean, mayRenderStartOfStream: Boolean)

Called when the renderer is enabled.

Unit

See onPositionDiscontinuity.

Unit
onPositionReset(positionUs: Long, joining: Boolean)

Called when the position is reset.

Unit
Unit

Called when the renderer is started.

Unit

Called when the renderer is stopped.

Unit
onStreamChanged(
    formats: Array<Format!>!,
    startPositionUs: Long,
    offsetUs: Long
)

Called when the renderer's stream has changed.

Unit
render(positionUs: Long, elapsedRealtimeUs: Long)

Incrementally renders the SampleStream.

Unit

Attempts to set the playback parameters.

Boolean

Returns whether the renderer's AudioSink supports a given Format.

Int

Returns the extent to which the Renderer supports a given format.

From androidx.media3.exoplayer.Renderer
abstract Unit
replaceStream(
    formats: Array<Format!>!,
    stream: SampleStream!,
    startPositionUs: Long,
    offsetUs: Long
)

Replaces the SampleStream from which samples will be consumed.

Unit
setPlaybackSpeed(currentPlaybackSpeed: Float, targetPlaybackSpeed: Float)

Indicates the playback speed to this renderer.

From androidx.media3.exoplayer.RendererCapabilities
java-static Int

Returns Capabilities for the given C.FormatSupport.

java-static Int

Returns Capabilities combining the given C.FormatSupport, and TunnelingSupport.

java-static Int
@RendererCapabilities.Capabilities
create(
    @C.FormatSupport formatSupport: Int,
    @RendererCapabilities.AdaptiveSupport adaptiveSupport: Int,
    @RendererCapabilities.TunnelingSupport tunnelingSupport: Int,
    @RendererCapabilities.HardwareAccelerationSupport hardwareAccelerationSupport: Int,
    @RendererCapabilities.DecoderSupport decoderSupport: Int
)

Returns Capabilities combining the given C.FormatSupport, , TunnelingSupport, HardwareAccelerationSupport and .

java-static Int

Returns the AdaptiveSupport from the combined Capabilities.

java-static Int

Returns the DecoderSupport from the combined Capabilities.

java-static Int

Returns the C.FormatSupport from the combined Capabilities.

java-static Int

Returns the HardwareAccelerationSupport from the combined Capabilities.

java-static Int

Returns the TunnelingSupport from the combined Capabilities.

Public constructors

LibflacAudioRenderer

LibflacAudioRenderer()

LibflacAudioRenderer

LibflacAudioRenderer(
    eventHandler: Handler?,
    eventListener: AudioRendererEventListener?,
    audioProcessors: Array<AudioProcessor!>!
)

Creates an instance.

Parameters
eventHandler: Handler?

A handler to use when delivering events to eventListener. May be null if delivery of events is not required.

eventListener: AudioRendererEventListener?

A listener of events. May be null if delivery of events is not required.

audioProcessors: Array<AudioProcessor!>!

Optional AudioProcessors that will process audio before output.

LibflacAudioRenderer

LibflacAudioRenderer(
    eventHandler: Handler?,
    eventListener: AudioRendererEventListener?,
    audioSink: AudioSink!
)

Creates an instance.

Parameters
eventHandler: Handler?

A handler to use when delivering events to eventListener. May be null if delivery of events is not required.

eventListener: AudioRendererEventListener?

A listener of events. May be null if delivery of events is not required.

audioSink: AudioSink!

The sink to which audio will be output.

Public functions

getName

fun getName(): String!

Returns the name of this renderer, for logging and debugging purposes. Should typically be the renderer's (un-obfuscated) class name.

Returns
String!

The name of this renderer.

Protected functions

supportsFormatInternal

@C.FormatSupport
protected fun supportsFormatInternal(format: Format!): Int

Returns the C.FormatSupport for the given Format.

Parameters
format: Format!

The format, which has an audio sampleMimeType.

Returns
Int

The C.FormatSupport for this Format.