Back to Exoplayer

FakeRenderer (ExoPlayer library)

docs/doc/reference/com/google/android/exoplayer2/testutil/FakeRenderer.html

latest14.8 KB
Original Source

Package com.google.android.exoplayer2.testutil

Class FakeRenderer


public classFakeRendererextends[BaseRenderer](../BaseRenderer.html "class in com.google.android.exoplayer2")

Fake Renderer that supports any format with the matching track type.

The renderer verifies that all the formats it reads have the provided track type.

Nested Class Summary

- 

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

Renderer.MessageType, Renderer.State, Renderer.WakeupListener

- 

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

RendererCapabilities.AdaptiveSupport, RendererCapabilities.Capabilities, RendererCapabilities.DecoderSupport, RendererCapabilities.FormatSupport, RendererCapabilities.HardwareAccelerationSupport, RendererCapabilities.Listener, RendererCapabilities.TunnelingSupport

Field Summary

Fields | Modifier and Type | Field | Description | | --- | --- | --- | | int | enabledCount | | | boolean | isEnded | | | int | positionResetCount | | | int | resetCount | | | int | sampleBufferReadCount | |

- 

Fields inherited from interface com.google.android.exoplayer2.Renderer

MSG_CUSTOM_BASE, MSG_SET_AUDIO_ATTRIBUTES, MSG_SET_AUDIO_SESSION_ID, MSG_SET_AUX_EFFECT_INFO, MSG_SET_CAMERA_MOTION_LISTENER, MSG_SET_CHANGE_FRAME_RATE_STRATEGY, MSG_SET_PREFERRED_AUDIO_DEVICE, MSG_SET_SCALING_MODE, MSG_SET_SKIP_SILENCE_ENABLED, MSG_SET_VIDEO_EFFECTS, MSG_SET_VIDEO_FRAME_METADATA_LISTENER, MSG_SET_VIDEO_OUTPUT, MSG_SET_VIDEO_OUTPUT_RESOLUTION, MSG_SET_VOLUME, MSG_SET_WAKEUP_LISTENER, STATE_DISABLED, STATE_ENABLED, STATE_STARTED

- 

Fields inherited from interface com.google.android.exoplayer2.RendererCapabilities

ADAPTIVE_NOT_SEAMLESS, ADAPTIVE_NOT_SUPPORTED, ADAPTIVE_SEAMLESS, ADAPTIVE_SUPPORT_MASK, DECODER_SUPPORT_FALLBACK, DECODER_SUPPORT_FALLBACK_MIMETYPE, DECODER_SUPPORT_PRIMARY, FORMAT_EXCEEDS_CAPABILITIES, FORMAT_HANDLED, FORMAT_SUPPORT_MASK, FORMAT_UNSUPPORTED_DRM, FORMAT_UNSUPPORTED_SUBTYPE, FORMAT_UNSUPPORTED_TYPE, HARDWARE_ACCELERATION_NOT_SUPPORTED, HARDWARE_ACCELERATION_SUPPORT_MASK, HARDWARE_ACCELERATION_SUPPORTED, MODE_SUPPORT_MASK, TUNNELING_NOT_SUPPORTED, TUNNELING_SUPPORT_MASK, TUNNELING_SUPPORTED

Constructor Summary

Constructors | Constructor | Description | | --- | --- | | FakeRenderer​(@com.google.android.exoplayer2.C.TrackType int trackType) | |

Method Summary

All Methods Instance Methods Concrete Methods | Modifier and Type | Method | Description | | --- | --- | --- | | List<Format> | getFormatsRead() | Returns the list of formats read by the renderer. | | String | getName() | Returns the name of this renderer, for logging and debugging purposes. | | boolean | isEnded() | Whether the renderer is ready for the ExoPlayer instance to transition to Player.STATE_ENDED. | | boolean | isReady() | Whether the renderer is able to immediately render media from the current position. | | protected void | onDisabled() | Called when the renderer is disabled. | | protected void | onEnabled​(boolean joining, boolean mayRenderStartOfStream) | Called when the renderer is enabled. | | protected void | onFormatChanged​(Format format) | Called when the renderer reads a new format. | | protected void | onPositionReset​(long positionUs, boolean joining) | Called when the position is reset. | | protected void | onReset() | Called when the renderer is reset. | | void | render​(long positionUs, long elapsedRealtimeUs) | Incrementally renders the SampleStream. | | protected boolean | shouldProcessBuffer​(long bufferTimeUs, long playbackPositionUs) | Called before the renderer processes a buffer. | | @com.google.android.exoplayer2.RendererCapabilities.Capabilities int | supportsFormat​(Format format) | Returns the extent to which the Renderer supports a given format. |

- 

Methods inherited from class com.google.android.exoplayer2.BaseRenderer

clearListener, createRendererException, createRendererException, disable, enable, getCapabilities, getConfiguration, getFormatHolder, getIndex, getLastResetPositionUs, getMediaClock, getPlayerId, getReadingPositionUs, getState, getStream, getStreamFormats, getTrackType, handleMessage, hasReadStreamToEnd, init, isCurrentStreamFinal, isSourceReady, maybeThrowStreamError, onRelease, onRendererCapabilitiesChanged, onStarted, onStopped, onStreamChanged, readSource, release, replaceStream, reset, resetPosition, setCurrentStreamFinal, setListener, skipSource, start, stop, supportsMixedMimeTypeAdaptation

- 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 

Methods inherited from interface com.google.android.exoplayer2.Renderer

setPlaybackSpeed

Field Detail

- 

isEnded

public boolean isEnded
- 

positionResetCount

public int positionResetCount
- 

sampleBufferReadCount

public int sampleBufferReadCount
- 

enabledCount

public int enabledCount
- 

resetCount

public int resetCount

Constructor Detail

- 

FakeRenderer

public FakeRenderer​(@com.google.android.exoplayer2.C.TrackType int trackType)

Method Detail

- 

getName

public[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")getName()

Description copied from interface: Renderer

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

- 

onPositionReset

protected void onPositionReset​(long positionUs,
                               boolean joining)
                        throws[ExoPlaybackException](../ExoPlaybackException.html "class in com.google.android.exoplayer2")

Description copied from class: BaseRenderer

Called when the position is reset. This occurs when the renderer is enabled after BaseRenderer.onStreamChanged(Format[], long, long) has been called, and also when a position discontinuity is encountered.

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

The default implementation is a no-op.

Overrides:onPositionReset in class BaseRendererParameters:positionUs - The new playback position in microseconds.joining - Whether this renderer is being enabled to join an ongoing playback.Throws:ExoPlaybackException - If an error occurs.

- 

render

public void render​(long positionUs,
                   long elapsedRealtimeUs)
            throws[ExoPlaybackException](../ExoPlaybackException.html "class in com.google.android.exoplayer2")

Description copied from interface: Renderer

Incrementally renders the SampleStream.

If the renderer is in the Renderer.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 Renderer.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 Renderer.STATE_ENABLED state, unless it's the initial start of the media after calling Renderer.enable(RendererConfiguration, Format[], SampleStream, long, boolean, boolean, long, long) 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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.

Parameters:positionUs - The current media time in microseconds, measured at the start of the current iteration of the rendering loop.elapsedRealtimeUs - SystemClock.elapsedRealtime() in microseconds, measured at the start of the current iteration of the rendering loop.Throws:ExoPlaybackException - If an error occurs.

- 

onEnabled

protected void onEnabled​(boolean joining,
                         boolean mayRenderStartOfStream)
                  throws[ExoPlaybackException](../ExoPlaybackException.html "class in com.google.android.exoplayer2")

Description copied from class: BaseRenderer

Called when the renderer is enabled.

The default implementation is a no-op.

Overrides:onEnabled in class BaseRendererParameters:joining - Whether this renderer is being enabled to join an ongoing playback.mayRenderStartOfStream - Whether this renderer is allowed to render the start of the stream even if the state is not Renderer.STATE_STARTED yet.Throws:ExoPlaybackException - If an error occurs.

- 

onReset

protected void onReset()

Description copied from class: BaseRenderer

Called when the renderer is reset.

The default implementation is a no-op.

Overrides:onReset in class BaseRenderer

- 

isReady

public boolean isReady()

Description copied from interface: Renderer

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

If the renderer is in the Renderer.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 Renderer.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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.

Returns:Whether the renderer is ready to render media.

- 

isEnded

public boolean isEnded()

Description copied from interface: Renderer

Whether the renderer is ready for the ExoPlayer instance to transition to Player.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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.

Returns:Whether the renderer is ready for the player to transition to the ended state.

- 

supportsFormat

public @com.google.android.exoplayer2.RendererCapabilities.Capabilities int supportsFormat​([Format](../Format.html "class in com.google.android.exoplayer2")format)
                                                                                    throws[ExoPlaybackException](../ExoPlaybackException.html "class in com.google.android.exoplayer2")

Description copied from interface: RendererCapabilities

Returns the extent to which the Renderer supports a given format. Parameters:format - The format.Returns:The RendererCapabilities.Capabilities for this format.Throws:ExoPlaybackException - If an error occurs.

- 

onDisabled

protected void onDisabled()

Description copied from class: BaseRenderer

Called when the renderer is disabled.

The default implementation is a no-op.

Overrides:onDisabled in class BaseRenderer

- 

onFormatChanged

protected void onFormatChanged​([Format](../Format.html "class in com.google.android.exoplayer2")format)

Called when the renderer reads a new format.

- 

getFormatsRead

public[List](https://developer.android.com/reference/java/util/List.html "class or interface in java.util")<[Format](../Format.html "class in com.google.android.exoplayer2")> getFormatsRead()

Returns the list of formats read by the renderer.

- 

shouldProcessBuffer

protected boolean shouldProcessBuffer​(long bufferTimeUs,
                                      long playbackPositionUs)

Called before the renderer processes a buffer. Parameters:bufferTimeUs - The buffer timestamp, in microseconds.playbackPositionUs - The playback position, in microsecondsReturns:Whether the buffer should be processed.