com.google.android.exoplayer2.upstream.cache

Class CacheDataSink

java.lang.Object

com.google.android.exoplayer2.upstream.cache.CacheDataSink

All Implemented Interfaces:

DataSink

public final class CacheDataSink
extends java.lang.Object
implements DataSink

Writes data into a cache.

If the DataSpec object used with open(DataSpec) method call has the length field set to C.LENGTH_UNSET but DataSpec.FLAG_ALLOW_CACHING_UNKNOWN_LENGTH isn't set then write(byte[], int, int) calls are ignored.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CacheDataSink.CacheDataSinkException Thrown when IOException is encountered when writing data into sink.

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

DataSink.Factory

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_SIZE Default buffer size in bytes.

Constructor Summary

Constructors

Constructor and Description
CacheDataSink(Cache cache, long maxCacheFileSize) Constructs a CacheDataSink using the DEFAULT_BUFFER_SIZE.
CacheDataSink(Cache cache, long maxCacheFileSize, int bufferSize)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the sink.
void	experimental_setSyncFileDescriptor(boolean syncFileDescriptor) Sets whether file descriptors are synced when closing output streams.
void	open(DataSpec dataSpec) Opens the sink to consume the specified data.
void	write(byte[] buffer, int offset, int length) Consumes the provided data.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

Default buffer size in bytes.

See Also:

Constant Field Values

Constructor Detail

CacheDataSink

public CacheDataSink(Cache cache,
                     long maxCacheFileSize)

Constructs a CacheDataSink using the DEFAULT_BUFFER_SIZE.

Parameters:

cache - The cache into which data should be written.

maxCacheFileSize - The maximum size of a cache file, in bytes. If the sink is opened for a DataSpec whose size exceeds this value, then the data will be fragmented into multiple cache files.

CacheDataSink

public CacheDataSink(Cache cache,
                     long maxCacheFileSize,
                     int bufferSize)

Parameters:

cache - The cache into which data should be written.

maxCacheFileSize - The maximum size of a cache file, in bytes. If the sink is opened for a DataSpec whose size exceeds this value, then the data will be fragmented into multiple cache files.

bufferSize - The buffer size in bytes for writing to a cache file. A zero or negative value disables buffering.

Method Detail

experimental_setSyncFileDescriptor

public void experimental_setSyncFileDescriptor(boolean syncFileDescriptor)

Sets whether file descriptors are synced when closing output streams.

This method is experimental, and will be renamed or removed in a future release. It should only be called before the renderer is used.

Parameters:

syncFileDescriptor - Whether file descriptors are synced when closing output streams.

open

public void open(DataSpec dataSpec)
          throws CacheDataSink.CacheDataSinkException

Description copied from interface: DataSink

Opens the sink to consume the specified data.

Note: If an IOException is thrown, callers must still call DataSink.close() to ensure that any partial effects of the invocation are cleaned up.

Specified by:

open in interface DataSink

Parameters:

dataSpec - Defines the data to be consumed.

Throws:

CacheDataSink.CacheDataSinkException

write

public void write(byte[] buffer,
                  int offset,
                  int length)
           throws CacheDataSink.CacheDataSinkException

Description copied from interface: DataSink

Consumes the provided data.

Specified by:

write in interface DataSink

Parameters:

buffer - The buffer from which data should be consumed.

offset - The offset of the data to consume in buffer.

length - The length of the data to consume, in bytes.

Throws:

CacheDataSink.CacheDataSinkException

close

public void close()
           throws CacheDataSink.CacheDataSinkException

Description copied from interface: DataSink

Closes the sink.

Note: This method must be called even if the corresponding call to DataSink.open(DataSpec) threw an IOException. See DataSink.open(DataSpec) for more details.

Specified by:

close in interface DataSink

Throws:

CacheDataSink.CacheDataSinkException