Renderer

const val MSG_CUSTOM_BASE = 10000: Int

Applications or extensions may define custom MSG_* constants that can be passed to renderers. These custom constants must be greater than or equal to this value.

const val MSG_SET_AUDIO_ATTRIBUTES = 3: Int

A type of a message that can be passed to an audio renderer via createMessage. The message payload should be an instance that will configure the underlying audio track. If not set, the default audio attributes will be used. They are suitable for general media playback.

Setting the audio attributes during playback may introduce a short gap in audio output as the audio track is recreated. A new audio session id will also be generated.

If tunneling is enabled by the track selector, the specified audio attributes will be ignored, but they will take effect if audio is later played without tunneling.

If the device is running a build before platform API version 21, audio attributes cannot be set directly on the underlying audio track. In this case, the usage will be mapped onto an equivalent stream type using getStreamTypeForAudioUsage.

To get audio attributes that are equivalent to a legacy stream type, pass the stream type to getAudioUsageForStreamType and use the returned C.AudioUsage to build an audio attributes instance.

const val MSG_SET_AUDIO_SESSION_ID = 10: Int

The type of a message that can be passed to audio and video renderers via createMessage. The message payload should be an instance representing the audio session ID that will be attached to the underlying audio track. Video renderers that support tunneling will use the audio session ID when tunneling is enabled.

const val MSG_SET_AUX_EFFECT_INFO = 6: Int

A type of a message that can be passed to an audio renderer via createMessage. The message payload should be an instance representing an auxiliary audio effect for the underlying audio track.

const val MSG_SET_CAMERA_MOTION_LISTENER = 8: Int

The type of a message that can be passed to a camera motion renderer via createMessage. The message payload should be a instance, or null.

const val MSG_SET_CHANGE_FRAME_RATE_STRATEGY = 5: Int

The type of a message that can be passed to a video renderer via createMessage. The message payload should be one of the integer strategy constants in C.VideoChangeFrameRateStrategy.

const val MSG_SET_IMAGE_OUTPUT = 15: Int

The type of message that can be passed to an image renderer to set a desired image output. The message payload should be an ImageOutput.

const val MSG_SET_PREFERRED_AUDIO_DEVICE = 12: Int

The type of a message that can be passed to audio renderers via createMessage. The message payload should be an instance representing the preferred audio device, or null to restore the default.

const val MSG_SET_SCALING_MODE = 4: Int

The type of a message that can be passed to a MediaCodec-based video renderer via createMessage. The message payload should be one of the integer scaling modes in C.VideoScalingMode.

Note that the scaling mode only applies if the Surface targeted by the renderer is owned by a android.view.SurfaceView.

const val MSG_SET_SKIP_SILENCE_ENABLED = 9: Int

The type of a message that can be passed to an audio renderer via createMessage. The message payload should be a Boolean instance telling whether to enable or disable skipping silences in the audio stream.

const val MSG_SET_VIDEO_EFFECTS = 13: Int

The type of a message that can be passed to a video renderer. The message payload should be a List containing video effects.

const val MSG_SET_VIDEO_FRAME_METADATA_LISTENER = 7: Int

The type of a message that can be passed to a video renderer via createMessage. The message payload should be a instance, or null.

const val MSG_SET_VIDEO_OUTPUT = 1: Int

The type of a message that can be passed to a video renderer via createMessage. The message payload is normally a , however some video renderers may accept other outputs (e.g., ).

If the receiving renderer does not support the payload type as an output, then it will clear any existing output that it has.

const val MSG_SET_VIDEO_OUTPUT_RESOLUTION = 14: Int

The type of a message that can be passed to a video renderer to set the desired output resolution. The message payload should be a Size of the desired output width and height. Use this method only when playing with video effects.

const val MSG_SET_VOLUME = 2: Int

A type of a message that can be passed to an audio renderer via createMessage. The message payload should be a Float with 0 being silence and 1 being unity gain.

const val MSG_SET_WAKEUP_LISTENER = 11: 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.

The message payload must be a WakeupListener instance.

const val STATE_DISABLED = 0: Int

The renderer is disabled. A renderer in this state will not proactively acquire resources that it requires for rendering (e.g., media decoders), but may continue to hold any that it already has. reset can be called to force the renderer to release such resources.

const val STATE_ENABLED = 1: Int

The renderer is enabled but not started. A renderer in this state may render media at the current position (e.g. an initial video frame), but the position will not advance. A renderer in this state will typically hold resources that it requires for rendering (e.g. media decoders).

const val STATE_STARTED = 2: Int

The renderer is started. Calls to render will cause media to be rendered.

fun disable(): Unit

Disable the renderer, transitioning it to the STATE_DISABLED state.

This method may be called when the renderer is in the following states: STATE_ENABLED.

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

Enables the renderer to consume from the specified SampleStream.

This method may be called when the renderer is in the following states: STATE_DISABLED.

fun enableMayRenderStartOfStream(): Unit

Enables this renderer to render the start of the stream even if the state is not STATE_STARTED yet.

This is used to update the value of mayRenderStartOfStream passed to enable.

fun getCapabilities(): RendererCapabilities!

Returns the capabilities of the renderer.

fun getMediaClock(): MediaClock?

If the renderer advances its own playback position then this method returns a corresponding MediaClock. If provided, the player will use the returned MediaClock as its source of time during playback. A player may have at most one renderer that returns a from this method.

fun getName(): String!

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

fun getReadingPositionUs(): 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.

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

@Renderer.State
fun getState(): Int

Returns the current state of the renderer.

fun getStream(): SampleStream?

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

@C.TrackType
fun getTrackType(): Int

Returns the track type that the renderer handles.

fun hasReadStreamToEnd(): Boolean

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

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

fun init(index: Int, playerId: PlayerId!, clock: Clock!): Unit

Initializes the renderer for playback with a player.

fun isCurrentStreamFinal(): Boolean

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

fun isEnded(): Boolean

Whether the renderer is ready for the ExoPlayer instance to transition to STATE_ENDED. The player will make this transition as soon as true is returned by all of its renderers.

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

fun isReady(): Boolean

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

If the renderer is in the STATE_STARTED state then returning true indicates that the renderer has everything that it needs to continue playback. Returning false indicates that the player should pause until the renderer is ready.

If the renderer is in the STATE_ENABLED state then returning true indicates that the renderer is ready for playback to be started. Returning false indicates that it is not.

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

fun maybeThrowStreamError(): Unit

Throws an error that's preventing the renderer from reading from its SampleStream. Does nothing if no such error exists.

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

fun release(): Unit

Releases the renderer.

The renderer must not be used after calling this method.

fun render(positionUs: Long, elapsedRealtimeUs: Long): Unit

Incrementally renders the SampleStream.

If the renderer is in the STATE_ENABLED state then each call to this method will do work toward being ready to render the SampleStream when the renderer is started. If the renderer is in the STATE_STARTED state then calls to this method will render the SampleStream in sync with the specified media positions.

The renderer may also render the very start of the media at the current position (e.g. the first frame of a video stream) while still in the STATE_ENABLED state, unless it's the initial start of the media after calling enable with mayRenderStartOfStream set to false.

This method should return quickly, and should not block if the renderer is unable to make useful progress.

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

fun replaceStream(
    formats: Array<Format!>!,
    stream: SampleStream!,
    startPositionUs: Long,
    offsetUs: Long,
    mediaPeriodId: MediaSource.MediaPeriodId!
): Unit

Replaces the SampleStream from which samples will be consumed.

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

fun reset(): Unit

Forces the renderer to give up any resources (e.g. media decoders) that it may be holding. If the renderer is not holding any resources, the call is a no-op.

This method may be called when the renderer is in the following states: STATE_DISABLED.

fun resetPosition(positionUs: Long): Unit

Signals to the renderer that a position discontinuity has occurred.

After a position discontinuity, the renderer's SampleStream is guaranteed to provide samples starting from a key frame.

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

fun setCurrentStreamFinal(): Unit

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

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

fun setPlaybackSpeed(currentPlaybackSpeed: Float, targetPlaybackSpeed: Float): Unit

Indicates the playback speed to this renderer.

The default implementation is a no-op.

fun setTimeline(timeline: Timeline!): Unit

Sets the timeline that is currently being played.

fun start(): Unit

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

This method may be called when the renderer is in the following states: STATE_ENABLED.

fun stop(): Unit

Stops the renderer, transitioning it to the STATE_ENABLED state.

This method may be called when the renderer is in the following states: STATE_STARTED.