NoSampleRenderer (library-core API)

java.lang.Object
- com.google.android.exoplayer2.NoSampleRenderer

All Implemented Interfaces:

PlayerMessage.Target, Renderer, RendererCapabilities
```
public abstract class NoSampleRenderer
extends java.lang.Object
implements Renderer, RendererCapabilities
```
A Renderer implementation whose track type is C.TRACK_TYPE_NONE and does not consume data from its SampleStream.

Field Summary
- Fields inherited from interface com.google.android.exoplayer2.Renderer
  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, FORMAT_EXCEEDS_CAPABILITIES, FORMAT_HANDLED, FORMAT_SUPPORT_MASK, FORMAT_UNSUPPORTED_DRM, FORMAT_UNSUPPORTED_SUBTYPE, FORMAT_UNSUPPORTED_TYPE, TUNNELING_NOT_SUPPORTED, TUNNELING_SUPPORT_MASK, TUNNELING_SUPPORTED

Constructor Summary

Constructors
Constructor and Description

NoSampleRenderer()

Constructors
Constructor and Description
`NoSampleRenderer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`disable()` Disable the renderer, transitioning it to the `Renderer.STATE_DISABLED` state.
`void`	`enable(RendererConfiguration configuration, Format[] formats, SampleStream stream, long positionUs, boolean joining, long offsetUs)` Replaces the `SampleStream` that will be associated with this renderer.
`RendererCapabilities`	`getCapabilities()` Returns the capabilities of the renderer.
`protected RendererConfiguration`	`getConfiguration()` Returns the configuration set when the renderer was most recently enabled.
`protected int`	`getIndex()` Returns the index of the renderer within the player.
`MediaClock`	`getMediaClock()` If the renderer advances its own playback position then this method returns a corresponding `MediaClock`.
`int`	`getState()` Returns the current state of the renderer.
`SampleStream`	`getStream()` Returns the `SampleStream` being consumed, or null if the renderer is disabled.
`int`	`getTrackType()` Returns the track type that the `Renderer` handles.
`void`	`handleMessage(int what, java.lang.Object object)` Handles a message delivered to the target.
`boolean`	`hasReadStreamToEnd()` Returns whether the renderer has read the current `SampleStream` to the end.
`boolean`	`isCurrentStreamFinal()` Returns whether the current `SampleStream` will be the final one supplied before the renderer is next disabled or reset.
`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.
`void`	`maybeThrowStreamError()` Throws an error that's preventing the renderer from reading from its `SampleStream`.
`protected void`	`onDisabled()` Called when the renderer is disabled.
`protected void`	`onEnabled(boolean joining)` Called when the renderer is enabled.
`protected void`	`onPositionReset(long positionUs, boolean joining)` Called when the position is reset.
`protected void`	`onRendererOffsetChanged(long offsetUs)` Called when the renderer's offset has been changed.
`protected void`	`onStarted()` Called when the renderer is started.
`protected void`	`onStopped()` Called when the renderer is stopped.
`void`	`replaceStream(Format[] formats, SampleStream stream, long offsetUs)` Replaces the `SampleStream` that will be associated with this renderer.
`void`	`resetPosition(long positionUs)` Signals to the renderer that a position discontinuity has occurred.
`void`	`setCurrentStreamFinal()` Signals to the renderer that the current `SampleStream` will be the final one supplied before it is next disabled or reset.
`void`	`setIndex(int index)` Sets the index of this renderer within the player.
`void`	`start()` Starts the renderer, meaning that calls to `Renderer.render(long, long)` will cause media to be rendered.
`void`	`stop()` Stops the renderer, transitioning it to the `Renderer.STATE_ENABLED` state.
`int`	`supportsFormat(Format format)` Returns the extent to which the `Renderer` supports a given format.
`int`	`supportsMixedMimeTypeAdaptation()` Returns the extent to which the `Renderer` supports adapting between supported formats that have different mime types.

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
render

- Constructor Detail
  - NoSampleRenderer
```
public NoSampleRenderer()
```
- Method Detail
  - getTrackType
```
public final int getTrackType()
```
    Description copied from interface: Renderer
    
    Returns the track type that the Renderer handles. For example, a video renderer will return C.TRACK_TYPE_VIDEO, an audio renderer will return C.TRACK_TYPE_AUDIO, a text renderer will return C.TRACK_TYPE_TEXT, and so on.
    
    Specified by:
    
    getTrackType in interface Renderer
    
    Specified by:
    
    getTrackType in interface RendererCapabilities
    
    Returns:
    
    One of the TRACK_TYPE_* constants defined in C.
    
    See Also:
    
    Renderer.getTrackType()
  - getCapabilities
```
public final RendererCapabilities getCapabilities()
```
    Description copied from interface: Renderer
    
    Returns the capabilities of the renderer.
    
    Specified by:
    
    getCapabilities in interface Renderer
    
    Returns:
    
    The capabilities of the renderer.
  - setIndex
```
public final void setIndex(int index)
```
    Description copied from interface: Renderer
    
    Sets the index of this renderer within the player.
    
    Specified by:
    
    setIndex in interface Renderer
    
    Parameters:
    
    index - The renderer index.
  - getMediaClock
```
public MediaClock getMediaClock()
```
    Description copied from interface: Renderer
    
    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 MediaClock from this method.
    
    Specified by:
    
    getMediaClock in interface Renderer
    
    Returns:
    
    The MediaClock tracking the playback position of the renderer, or null.
  - getState
```
public final int getState()
```
    Description copied from interface: Renderer
    
    Returns the current state of the renderer.
    
    Specified by:
    
    getState in interface Renderer
    
    Returns:
    
    The current state (one of the STATE_* constants).
  - enable
```
public final void enable(RendererConfiguration configuration,
                         Format[] formats,
                         SampleStream stream,
                         long positionUs,
                         boolean joining,
                         long offsetUs)
                  throws ExoPlaybackException
```
    Replaces the SampleStream that will be associated with this renderer.
    This method may be called when the renderer is in the following states: Renderer.STATE_DISABLED.
    
    Specified by:
    
    enable in interface Renderer
    
    Parameters:
    
    configuration - The renderer configuration.
    
    formats - The enabled formats. Should be empty.
    
    stream - The SampleStream from which the renderer should consume.
    
    positionUs - The player's current position.
    
    joining - Whether this renderer is being enabled to join an ongoing playback.
    
    offsetUs - The offset that should be subtracted from positionUs to get the playback position with respect to the media.
    
    Throws:
    
    ExoPlaybackException - If an error occurs.
  - start
```
public final void start()
                 throws ExoPlaybackException
```
    Description copied from interface: Renderer
    
    Starts the renderer, meaning that calls to Renderer.render(long, long) will cause media to be rendered.
    This method may be called when the renderer is in the following states: Renderer.STATE_ENABLED.
    
    Specified by:
    
    start in interface Renderer
    
    Throws:
    
    ExoPlaybackException - If an error occurs.
  - replaceStream
```
public final void replaceStream(Format[] formats,
                                SampleStream stream,
                                long offsetUs)
                         throws ExoPlaybackException
```
    Replaces the SampleStream that will be associated with this renderer.
    This method may be called when the renderer is in the following states: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.
    
    Specified by:
    
    replaceStream in interface Renderer
    
    Parameters:
    
    formats - The enabled formats. Should be empty.
    
    stream - The SampleStream to be associated with this renderer.
    
    offsetUs - The offset that should be subtracted from positionUs in Renderer.render(long, long) to get the playback position with respect to the media.
    
    Throws:
    
    ExoPlaybackException - If an error occurs.
  - getStream
```
public final SampleStream getStream()
```
    Description copied from interface: Renderer
    
    Returns the SampleStream being consumed, or null if the renderer is disabled.
    
    Specified by:
    
    getStream in interface Renderer
  - hasReadStreamToEnd
```
public final boolean hasReadStreamToEnd()
```
    Description copied from interface: Renderer
    
    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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.
    
    Specified by:
    
    hasReadStreamToEnd in interface Renderer
  - setCurrentStreamFinal
```
public final void setCurrentStreamFinal()
```
    Description copied from interface: Renderer
    
    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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.
    
    Specified by:
    
    setCurrentStreamFinal in interface Renderer
  - isCurrentStreamFinal
```
public final boolean isCurrentStreamFinal()
```
    Description copied from interface: Renderer
    
    Returns whether the current SampleStream will be the final one supplied before the renderer is next disabled or reset.
    
    Specified by:
    
    isCurrentStreamFinal in interface Renderer
  - maybeThrowStreamError
```
public final void maybeThrowStreamError()
                                 throws java.io.IOException
```
    Description copied from interface: Renderer
    
    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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.
    
    Specified by:
    
    maybeThrowStreamError in interface Renderer
    
    Throws:
    
    java.io.IOException - An error that's preventing the renderer from making progress or buffering more data.
  - resetPosition
```
public final void resetPosition(long positionUs)
                         throws ExoPlaybackException
```
    Description copied from interface: Renderer
    
    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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.
    
    Specified by:
    
    resetPosition in interface Renderer
    
    Parameters:
    
    positionUs - The new playback position in microseconds.
    
    Throws:
    
    ExoPlaybackException - If an error occurs handling the reset.
  - stop
```
public final void stop()
                throws ExoPlaybackException
```
    Description copied from interface: Renderer
    
    Stops the renderer, transitioning it to the Renderer.STATE_ENABLED state.
    This method may be called when the renderer is in the following states: Renderer.STATE_STARTED.
    
    Specified by:
    
    stop in interface Renderer
    
    Throws:
    
    ExoPlaybackException - If an error occurs.
  - disable
```
public final void disable()
```
    Description copied from interface: Renderer
    
    Disable the renderer, transitioning it to the Renderer.STATE_DISABLED state.
    This method may be called when the renderer is in the following states: Renderer.STATE_ENABLED.
    
    Specified by:
    
    disable in interface Renderer
  - 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.
    
    Specified by:
    
    isReady in interface Renderer
    
    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.
    
    Specified by:
    
    isEnded in interface Renderer
    
    Returns:
    
    Whether the renderer is ready for the player to transition to the ended state.
  - supportsFormat
```
public int supportsFormat(Format format)
                   throws ExoPlaybackException
```
    Description copied from interface: RendererCapabilities
    Returns the extent to which the Renderer supports a given format. The returned value is the bitwise OR of three properties:
    - The level of support for the format itself. One of RendererCapabilities.FORMAT_HANDLED, RendererCapabilities.FORMAT_EXCEEDS_CAPABILITIES, RendererCapabilities.FORMAT_UNSUPPORTED_DRM, RendererCapabilities.FORMAT_UNSUPPORTED_SUBTYPE and RendererCapabilities.FORMAT_UNSUPPORTED_TYPE.
    - The level of support for adapting from the format to another format of the same mime type. One of RendererCapabilities.ADAPTIVE_SEAMLESS, RendererCapabilities.ADAPTIVE_NOT_SEAMLESS and RendererCapabilities.ADAPTIVE_NOT_SUPPORTED. Only set if the level of support for the format itself is RendererCapabilities.FORMAT_HANDLED or RendererCapabilities.FORMAT_EXCEEDS_CAPABILITIES.
    - The level of support for tunneling. One of RendererCapabilities.TUNNELING_SUPPORTED and RendererCapabilities.TUNNELING_NOT_SUPPORTED. Only set if the level of support for the format itself is RendererCapabilities.FORMAT_HANDLED or RendererCapabilities.FORMAT_EXCEEDS_CAPABILITIES.
    The individual properties can be retrieved by performing a bitwise AND with RendererCapabilities.FORMAT_SUPPORT_MASK, RendererCapabilities.ADAPTIVE_SUPPORT_MASK and RendererCapabilities.TUNNELING_SUPPORT_MASK respectively.
    Specified by:
    
    supportsFormat in interface RendererCapabilities
    
    Parameters:
    
    format - The format.
    
    Returns:
    
    The extent to which the renderer is capable of supporting the given format.
    
    Throws:
    
    ExoPlaybackException - If an error occurs.
  - supportsMixedMimeTypeAdaptation
```
public int supportsMixedMimeTypeAdaptation()
                                    throws ExoPlaybackException
```
    Description copied from interface: RendererCapabilities
    
    Returns the extent to which the Renderer supports adapting between supported formats that have different mime types.
    
    Specified by:
    
    supportsMixedMimeTypeAdaptation in interface RendererCapabilities
    
    Returns:
    
    The extent to which the renderer supports adapting between supported formats that have different mime types. One of RendererCapabilities.ADAPTIVE_SEAMLESS, RendererCapabilities.ADAPTIVE_NOT_SEAMLESS and RendererCapabilities.ADAPTIVE_NOT_SUPPORTED.
    
    Throws:
    
    ExoPlaybackException - If an error occurs.
  - handleMessage
```
public void handleMessage(int what,
                          java.lang.Object object)
                   throws ExoPlaybackException
```
    Description copied from interface: PlayerMessage.Target
    
    Handles a message delivered to the target.
    
    Specified by:
    
    handleMessage in interface PlayerMessage.Target
    
    Parameters:
    
    what - The message type.
    
    object - The message payload.
    
    Throws:
    
    ExoPlaybackException - If an error occurred whilst handling the message. Should only be thrown by targets that handle messages on the playback thread.
  - onEnabled
```
protected void onEnabled(boolean joining)
                  throws ExoPlaybackException
```
    Called when the renderer is enabled.
    The default implementation is a no-op.
    
    Parameters:
    
    joining - Whether this renderer is being enabled to join an ongoing playback.
    
    Throws:
    
    ExoPlaybackException - If an error occurs.
  - onRendererOffsetChanged
```
protected void onRendererOffsetChanged(long offsetUs)
                                throws ExoPlaybackException
```
    Called when the renderer's offset has been changed.
    The default implementation is a no-op.
    
    Parameters:
    
    offsetUs - The offset that should be subtracted from positionUs in Renderer.render(long, long) to get the playback position with respect to the media.
    
    Throws:
    
    ExoPlaybackException - If an error occurs.
  - onPositionReset
```
protected void onPositionReset(long positionUs,
                               boolean joining)
                        throws ExoPlaybackException
```
    Called when the position is reset. This occurs when the renderer is enabled after onRendererOffsetChanged(long) has been called, and also when a position discontinuity is encountered.
    The default implementation is a no-op.
    
    Parameters:
    
    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.
  - onStarted
```
protected void onStarted()
                  throws ExoPlaybackException
```
    Called when the renderer is started.
    The default implementation is a no-op.
    
    Throws:
    
    ExoPlaybackException - If an error occurs.
  - onStopped
```
protected void onStopped()
                  throws ExoPlaybackException
```
    Called when the renderer is stopped.
    The default implementation is a no-op.
    
    Throws:
    
    ExoPlaybackException - If an error occurs.
  - onDisabled
```
protected void onDisabled()
```
    Called when the renderer is disabled.
    The default implementation is a no-op.
  - getConfiguration
```
protected final RendererConfiguration getConfiguration()
```
    Returns the configuration set when the renderer was most recently enabled.
  - getIndex
```
protected final int getIndex()
```
    Returns the index of the renderer within the player.

Class NoSampleRenderer

Field Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

NoSampleRenderer

Method Detail

getTrackType

getCapabilities

setIndex

getMediaClock

getState

enable

start

replaceStream

getStream

hasReadStreamToEnd

setCurrentStreamFinal

isCurrentStreamFinal

maybeThrowStreamError

resetPosition

stop

disable

isReady

isEnded

supportsFormat

supportsMixedMimeTypeAdaptation

handleMessage

onEnabled

onRendererOffsetChanged

onPositionReset

onStarted

onStopped

onDisabled

getConfiguration

getIndex