SampleHolder (ExoPlayer library)

java.lang.Object
- com.google.android.exoplayer.SampleHolder

public final class SampleHolder
extends Object

Holds sample data and corresponding metadata.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BUFFER_REPLACEMENT_MODE_DIRECT` Allows buffer replacement using `ByteBuffer.allocateDirect(int)`.
`static int`	`BUFFER_REPLACEMENT_MODE_DISABLED` Disallows buffer replacement.
`static int`	`BUFFER_REPLACEMENT_MODE_NORMAL` Allows buffer replacement using `ByteBuffer.allocate(int)`.
`CryptoInfo`	`cryptoInfo`
`ByteBuffer`	`data` A buffer holding the sample data.
`int`	`flags` Flags that accompany the sample.
`int`	`size` The size of the sample in bytes.
`long`	`timeUs` The time at which the sample should be presented.

Constructor Summary

Constructors
Constructor and Description

SampleHolder(int bufferReplacementMode)

Constructors
Constructor and Description
`SampleHolder(int bufferReplacementMode)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearData()` Clears `data`.
`void`	`ensureSpaceForWrite(int length)` Ensures that `data` is large enough to accommodate a write of a given length at its current position.
`boolean`	`isDecodeOnly()` Returns whether `flags` has `C.SAMPLE_FLAG_DECODE_ONLY` set.
`boolean`	`isEncrypted()` Returns whether `flags` has `C.SAMPLE_FLAG_ENCRYPTED` set.
`boolean`	`isSyncFrame()` Returns whether `flags` has `C.SAMPLE_FLAG_SYNC` set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BUFFER_REPLACEMENT_MODE_DISABLED
```
public static final int BUFFER_REPLACEMENT_MODE_DISABLED
```
    Disallows buffer replacement.
    
    See Also:
    
    Constant Field Values
  - BUFFER_REPLACEMENT_MODE_NORMAL
```
public static final int BUFFER_REPLACEMENT_MODE_NORMAL
```
    Allows buffer replacement using ByteBuffer.allocate(int).
    
    See Also:
    
    Constant Field Values
  - BUFFER_REPLACEMENT_MODE_DIRECT
```
public static final int BUFFER_REPLACEMENT_MODE_DIRECT
```
    Allows buffer replacement using ByteBuffer.allocateDirect(int).
    
    See Also:
    
    Constant Field Values
  - cryptoInfo
```
public final CryptoInfo cryptoInfo
```
  - data
```
public ByteBuffer data
```
    A buffer holding the sample data.
  - size
```
public int size
```
    The size of the sample in bytes.
  - flags
```
public int flags
```
    Flags that accompany the sample. A combination of C.SAMPLE_FLAG_SYNC, C.SAMPLE_FLAG_ENCRYPTED and C.SAMPLE_FLAG_DECODE_ONLY.
  - timeUs
```
public long timeUs
```
    The time at which the sample should be presented.
- Constructor Detail
  - SampleHolder
```
public SampleHolder(int bufferReplacementMode)
```
    Parameters:
    
    bufferReplacementMode - Determines the behavior of ensureSpaceForWrite(int). One of BUFFER_REPLACEMENT_MODE_DISABLED, BUFFER_REPLACEMENT_MODE_NORMAL and BUFFER_REPLACEMENT_MODE_DIRECT.
- Method Detail
  - ensureSpaceForWrite
```
public void ensureSpaceForWrite(int length)
                         throws IllegalStateException
```
    Ensures that data is large enough to accommodate a write of a given length at its current position.
    If the capacity of data is sufficient this method does nothing. If the capacity is insufficient then an attempt is made to replace data with a new ByteBuffer whose capacity is sufficient. Data up to the current position is copied to the new buffer.
    
    Parameters:
    
    length - The length of the write that must be accommodated, in bytes.
    
    Throws:
    
    IllegalStateException - If there is insufficient capacity to accommodate the write and the buffer replacement mode of the holder is BUFFER_REPLACEMENT_MODE_DISABLED.
  - isEncrypted
```
public boolean isEncrypted()
```
    Returns whether flags has C.SAMPLE_FLAG_ENCRYPTED set.
  - isDecodeOnly
```
public boolean isDecodeOnly()
```
    Returns whether flags has C.SAMPLE_FLAG_DECODE_ONLY set.
  - isSyncFrame
```
public boolean isSyncFrame()
```
    Returns whether flags has C.SAMPLE_FLAG_SYNC set.
  - clearData
```
public void clearData()
```
    Clears data. Does nothing if data is null.

Class SampleHolder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BUFFER_REPLACEMENT_MODE_DISABLED

BUFFER_REPLACEMENT_MODE_NORMAL

BUFFER_REPLACEMENT_MODE_DIRECT

cryptoInfo

data

size

flags

timeUs

Constructor Detail

SampleHolder

Method Detail

ensureSpaceForWrite

isEncrypted

isDecodeOnly

isSyncFrame

clearData