SampleStream (ExoPlayer library)

All Known Implementing Classes:

ChunkSampleStream, ChunkSampleStream.EmbeddedSampleStream, EmptySampleStream
```
public interface SampleStream
```
A stream of media samples (and associated format information).

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`isReady()` Returns whether data is available to be read.
`void`	`maybeThrowError()` Throws an error that's preventing data from being read.
`int`	`readData(FormatHolder formatHolder, DecoderInputBuffer buffer, boolean formatRequired)` Attempts to read from the stream.
`int`	`skipData(long positionUs)` Attempts to skip to the keyframe before the specified position, or to the end of the stream if `positionUs` is beyond it.

- Method Detail
  - isReady
```
boolean isReady()
```
    Returns whether data is available to be read.
    Note: If the stream has ended then a buffer with the end of stream flag can always be read from readData(FormatHolder, DecoderInputBuffer, boolean). Hence an ended stream is always ready.
    
    Returns:
    
    Whether data is available to be read.
  - maybeThrowError
```
void maybeThrowError()
              throws IOException
```
    Throws an error that's preventing data from being read. Does nothing if no such error exists.
    
    Throws:
    
    IOException - The underlying error.
  - readData
```
int readData(FormatHolder formatHolder,
             DecoderInputBuffer buffer,
             boolean formatRequired)
```
    Attempts to read from the stream.
    If the stream has ended then C.BUFFER_FLAG_END_OF_STREAM flag is set on buffer and C.RESULT_BUFFER_READ is returned. Else if no data is available then C.RESULT_NOTHING_READ is returned. Else if the format of the media is changing or if formatRequired is set then formatHolder is populated and C.RESULT_FORMAT_READ is returned. Else buffer is populated and C.RESULT_BUFFER_READ is returned.
    
    Parameters:
    
    formatHolder - A FormatHolder to populate in the case of reading a format.
    
    buffer - A DecoderInputBuffer to populate in the case of reading a sample or the end of the stream. If the end of the stream has been reached, the C.BUFFER_FLAG_END_OF_STREAM flag will be set on the buffer.
    
    formatRequired - Whether the caller requires that the format of the stream be read even if it's not changing. A sample will never be read if set to true, however it is still possible for the end of stream or nothing to be read.
    
    Returns:
    
    The result, which can be C.RESULT_NOTHING_READ, C.RESULT_FORMAT_READ or C.RESULT_BUFFER_READ.
  - skipData
```
int skipData(long positionUs)
```
    Attempts to skip to the keyframe before the specified position, or to the end of the stream if positionUs is beyond it.
    
    Parameters:
    
    positionUs - The specified time.
    
    Returns:
    
    The number of samples that were skipped.

Interface SampleStream

Method Summary

Method Detail

isReady

maybeThrowError

readData

skipData