com.google.android.exoplayer

Class SingleSampleSource

java.lang.Object

com.google.android.exoplayer.SingleSampleSource

All Implemented Interfaces:

SampleSource, SampleSource.SampleSourceReader, Loader.Callback, Loader.Loadable

public final class SingleSampleSource
extends Object
implements SampleSource, SampleSource.SampleSourceReader, Loader.Callback, Loader.Loadable

A SampleSource that loads the data at a given Uri as a single sample.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SingleSampleSource.EventListener Interface definition for a callback to be notified of SingleSampleSource events.

Nested classes/interfaces inherited from interface com.google.android.exoplayer.SampleSource

SampleSource.SampleSourceReader

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MIN_LOADABLE_RETRY_COUNT The default minimum number of times to retry loading data prior to failing.

Fields inherited from interface com.google.android.exoplayer.SampleSource

END_OF_STREAM, FORMAT_READ, NO_DISCONTINUITY, NOTHING_READ, SAMPLE_READ

Constructor Summary

Constructors

Constructor and Description
SingleSampleSource(Uri uri, DataSource dataSource, MediaFormat format)
SingleSampleSource(Uri uri, DataSource dataSource, MediaFormat format, int minLoadableRetryCount)
SingleSampleSource(Uri uri, DataSource dataSource, MediaFormat format, int minLoadableRetryCount, Handler eventHandler, SingleSampleSource.EventListener eventListener, int eventSourceId)

Method Summary

Modifier and Type	Method and Description
void	cancelLoad() Cancels the load.
boolean	continueBuffering(int track, long positionUs) Indicates to the source that it should still be buffering data for the specified track.
void	disable(int track) Disable the specified track.
void	enable(int track, long positionUs) Enable the specified track.
long	getBufferedPositionUs() Returns an estimate of the position up to which data is buffered.
MediaFormat	getFormat(int track) Returns the format of the specified track.
int	getTrackCount() Returns the number of tracks exposed by the source.
boolean	isLoadCanceled() Whether the load has been canceled.
void	load() Performs the load, returning on completion or cancelation.
void	maybeThrowError() If the source is currently having difficulty preparing or loading samples, then this method throws the underlying error.
void	onLoadCanceled(Loader.Loadable loadable) Invoked when loading has been canceled.
void	onLoadCompleted(Loader.Loadable loadable) Invoked when the data source has been fully loaded.
void	onLoadError(Loader.Loadable loadable, IOException e) Invoked when the data source is stopped due to an error.
boolean	prepare(long positionUs) Prepares the source.
int	readData(int track, long positionUs, MediaFormatHolder formatHolder, SampleHolder sampleHolder) Attempts to read a sample or a new format from the source.
long	readDiscontinuity(int track) Attempts to read a pending discontinuity from the source.
SampleSource.SampleSourceReader	register() A consumer of samples should call this method to register themselves and gain access to the source through the returned SampleSource.SampleSourceReader.
void	release() Releases the SampleSource.SampleSourceReader.
void	seekToUs(long positionUs) Seeks to the specified time in microseconds.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MIN_LOADABLE_RETRY_COUNT

public static final int DEFAULT_MIN_LOADABLE_RETRY_COUNT

The default minimum number of times to retry loading data prior to failing.

See Also:

Constant Field Values

Constructor Detail

SingleSampleSource

public SingleSampleSource(Uri uri,
                          DataSource dataSource,
                          MediaFormat format)

SingleSampleSource

public SingleSampleSource(Uri uri,
                          DataSource dataSource,
                          MediaFormat format,
                          int minLoadableRetryCount)

SingleSampleSource

public SingleSampleSource(Uri uri,
                          DataSource dataSource,
                          MediaFormat format,
                          int minLoadableRetryCount,
                          Handler eventHandler,
                          SingleSampleSource.EventListener eventListener,
                          int eventSourceId)

Method Detail

register

public SampleSource.SampleSourceReader register()

Description copied from interface: SampleSource

A consumer of samples should call this method to register themselves and gain access to the source through the returned SampleSource.SampleSourceReader.

SampleSource.SampleSourceReader.release() should be called on the returned object when access is no longer required.

Specified by:

register in interface SampleSource

Returns:

A SampleSource.SampleSourceReader that provides access to the source.

prepare

public boolean prepare(long positionUs)

Description copied from interface: SampleSource.SampleSourceReader

Prepares the source.

Preparation may require reading from the data source (e.g. to determine the available tracks and formats). If insufficient data is available then the call will return false rather than block. The method can be called repeatedly until the return value indicates success.

Specified by:

prepare in interface SampleSource.SampleSourceReader

Parameters:

positionUs - The player's current playback position.

Returns:

True if the source was prepared, false otherwise.

getTrackCount

public int getTrackCount()

Description copied from interface: SampleSource.SampleSourceReader

Returns the number of tracks exposed by the source.

This method should only be called after the source has been prepared.

Specified by:

getTrackCount in interface SampleSource.SampleSourceReader

Returns:

The number of tracks.

getFormat

public MediaFormat getFormat(int track)

Description copied from interface: SampleSource.SampleSourceReader

Returns the format of the specified track.

Note that whilst the format of a track will remain constant, the format of the actual media stream may change dynamically. An example of this is where the track is adaptive (i.e. @link MediaFormat.adaptive is true). Hence the track formats returned through this method should not be used to configure decoders. Decoder configuration should be performed using the formats obtained when reading the media stream through calls to SampleSource.SampleSourceReader.readData(int, long, MediaFormatHolder, SampleHolder).

This method should only be called after the source has been prepared.

Specified by:

getFormat in interface SampleSource.SampleSourceReader

Parameters:

track - The track index.

Returns:

The format of the specified track.

enable

public void enable(int track,
                   long positionUs)

Description copied from interface: SampleSource.SampleSourceReader

Enable the specified track. This allows the track's format and samples to be read from SampleSource.SampleSourceReader.readData(int, long, MediaFormatHolder, SampleHolder).

This method should only be called after the source has been prepared, and when the specified track is disabled.

Specified by:

enable in interface SampleSource.SampleSourceReader

Parameters:

track - The track to enable.

positionUs - The player's current playback position.

continueBuffering

public boolean continueBuffering(int track,
                                 long positionUs)

Description copied from interface: SampleSource.SampleSourceReader

Indicates to the source that it should still be buffering data for the specified track.

This method should only be called when the specified track is enabled.

Specified by:

continueBuffering in interface SampleSource.SampleSourceReader

Parameters:

track - The track to continue buffering.

positionUs - The current playback position.

Returns:

True if the track has available samples, or if the end of the stream has been reached. False if more data needs to be buffered for samples to become available.

maybeThrowError

public void maybeThrowError()
                     throws IOException

Description copied from interface: SampleSource.SampleSourceReader

If the source is currently having difficulty preparing or loading samples, then this method throws the underlying error. Otherwise does nothing.

Specified by:

maybeThrowError in interface SampleSource.SampleSourceReader

Throws:

IOException - The underlying error.

readDiscontinuity

public long readDiscontinuity(int track)

Description copied from interface: SampleSource.SampleSourceReader

Attempts to read a pending discontinuity from the source.

This method should only be called when the specified track is enabled.

Specified by:

readDiscontinuity in interface SampleSource.SampleSourceReader

Parameters:

track - The track from which to read.

Returns:

If a discontinuity was read then the playback position after the discontinuity. Else SampleSource.NO_DISCONTINUITY.

readData

public int readData(int track,
                    long positionUs,
                    MediaFormatHolder formatHolder,
                    SampleHolder sampleHolder)

Description copied from interface: SampleSource.SampleSourceReader

Attempts to read a sample or a new format from the source.

This method should only be called when the specified track is enabled.

Note that where multiple tracks are enabled, SampleSource.NOTHING_READ may be returned if the next piece of data to be read from the SampleSource corresponds to a different track than the one for which data was requested.

This method will always return SampleSource.NOTHING_READ in the case that there's a pending discontinuity to be read from SampleSource.SampleSourceReader.readDiscontinuity(int) for the specified track.

Specified by:

readData in interface SampleSource.SampleSourceReader

Parameters:

track - The track from which to read.

positionUs - The current playback position.

formatHolder - A MediaFormatHolder object to populate in the case of a new format.

sampleHolder - A SampleHolder object to populate in the case of a new sample. If the caller requires the sample data then it must ensure that SampleHolder.data references a valid output buffer.

Returns:

The result, which can be SampleSource.SAMPLE_READ, SampleSource.FORMAT_READ, SampleSource.NOTHING_READ or SampleSource.END_OF_STREAM.

seekToUs

public void seekToUs(long positionUs)

Description copied from interface: SampleSource.SampleSourceReader

Seeks to the specified time in microseconds.

This method should only be called when at least one track is enabled.

Specified by:

seekToUs in interface SampleSource.SampleSourceReader

Parameters:

positionUs - The seek position in microseconds.

getBufferedPositionUs

public long getBufferedPositionUs()

Description copied from interface: SampleSource.SampleSourceReader

Returns an estimate of the position up to which data is buffered.

This method should only be called when at least one track is enabled.

Specified by:

getBufferedPositionUs in interface SampleSource.SampleSourceReader

Returns:

An estimate of the absolute position in microseconds up to which data is buffered, or TrackRenderer.END_OF_TRACK_US if data is buffered to the end of the stream, or TrackRenderer.UNKNOWN_TIME_US if no estimate is available.

disable

public void disable(int track)

Description copied from interface: SampleSource.SampleSourceReader

Disable the specified track.

This method should only be called when the specified track is enabled.

Specified by:

disable in interface SampleSource.SampleSourceReader

Parameters:

track - The track to disable.

release

public void release()

Description copied from interface: SampleSource.SampleSourceReader

Releases the SampleSource.SampleSourceReader.

This method should be called when access to the SampleSource is no longer required.

Specified by:

release in interface SampleSource.SampleSourceReader

onLoadCompleted

public void onLoadCompleted(Loader.Loadable loadable)

Description copied from interface: Loader.Callback

Invoked when the data source has been fully loaded.

Specified by:

onLoadCompleted in interface Loader.Callback

Parameters:

loadable - The loadable whose load has completed.

onLoadCanceled

public void onLoadCanceled(Loader.Loadable loadable)

Description copied from interface: Loader.Callback

Invoked when loading has been canceled.

Specified by:

onLoadCanceled in interface Loader.Callback

Parameters:

loadable - The loadable whose load has been canceled.

onLoadError

public void onLoadError(Loader.Loadable loadable,
                        IOException e)

Description copied from interface: Loader.Callback

Invoked when the data source is stopped due to an error.

Specified by:

onLoadError in interface Loader.Callback

Parameters:

loadable - The loadable whose load has failed.

cancelLoad

public void cancelLoad()

Description copied from interface: Loader.Loadable

Cancels the load.

Specified by:

cancelLoad in interface Loader.Loadable

isLoadCanceled

public boolean isLoadCanceled()

Description copied from interface: Loader.Loadable

Whether the load has been canceled.

Specified by:

isLoadCanceled in interface Loader.Loadable

Returns:

True if the load has been canceled. False otherwise.

load

public void load()
          throws IOException,
                 InterruptedException

Description copied from interface: Loader.Loadable

Performs the load, returning on completion or cancelation.

Specified by:

load in interface Loader.Loadable

Throws:

IOException

InterruptedException