com.google.android.exoplayer2.ext.okhttp

Class OkHttpDataSource

java.lang.Object

com.google.android.exoplayer2.ext.okhttp.OkHttpDataSource

All Implemented Interfaces:

com.google.android.exoplayer2.upstream.DataSource, com.google.android.exoplayer2.upstream.HttpDataSource

public class OkHttpDataSource
extends java.lang.Object
implements com.google.android.exoplayer2.upstream.HttpDataSource

An HttpDataSource that delegates to Square's Call.Factory.

Nested Class Summary

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

com.google.android.exoplayer2.upstream.HttpDataSource.BaseFactory, com.google.android.exoplayer2.upstream.HttpDataSource.Factory, com.google.android.exoplayer2.upstream.HttpDataSource.HttpDataSourceException, com.google.android.exoplayer2.upstream.HttpDataSource.InvalidContentTypeException, com.google.android.exoplayer2.upstream.HttpDataSource.InvalidResponseCodeException, com.google.android.exoplayer2.upstream.HttpDataSource.RequestProperties

Field Summary

Fields inherited from interface com.google.android.exoplayer2.upstream.HttpDataSource

REJECT_PAYWALL_TYPES

Constructor Summary

Constructors

Constructor and Description
OkHttpDataSource(okhttp3.Call.Factory callFactory, java.lang.String userAgent, com.google.android.exoplayer2.util.Predicate<java.lang.String> contentTypePredicate)
OkHttpDataSource(okhttp3.Call.Factory callFactory, java.lang.String userAgent, com.google.android.exoplayer2.util.Predicate<java.lang.String> contentTypePredicate, com.google.android.exoplayer2.upstream.TransferListener<? super OkHttpDataSource> listener)
OkHttpDataSource(okhttp3.Call.Factory callFactory, java.lang.String userAgent, com.google.android.exoplayer2.util.Predicate<java.lang.String> contentTypePredicate, com.google.android.exoplayer2.upstream.TransferListener<? super OkHttpDataSource> listener, okhttp3.CacheControl cacheControl, com.google.android.exoplayer2.upstream.HttpDataSource.RequestProperties defaultRequestProperties)

Method Summary

Modifier and Type	Method and Description
protected long	bytesRead() Returns the number of bytes that have been read since the most recent call to open(DataSpec).
protected long	bytesRemaining() Returns the number of bytes that are still to be read for the current DataSpec.
protected long	bytesSkipped() Returns the number of bytes that have been skipped since the most recent call to open(DataSpec).
void	clearAllRequestProperties()
void	clearRequestProperty(java.lang.String name)
void	close()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getResponseHeaders()
android.net.Uri	getUri()
long	open(com.google.android.exoplayer2.upstream.DataSpec dataSpec)
int	read(byte[] buffer, int offset, int readLength)
void	setRequestProperty(java.lang.String name, java.lang.String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

OkHttpDataSource

public OkHttpDataSource(@NonNull
                        okhttp3.Call.Factory callFactory,
                        @Nullable
                        java.lang.String userAgent,
                        @Nullable
                        com.google.android.exoplayer2.util.Predicate<java.lang.String> contentTypePredicate)

Parameters:

callFactory - A Call.Factory (typically an OkHttpClient) for use by the source.

userAgent - An optional User-Agent string.

contentTypePredicate - An optional Predicate. If a content type is rejected by the predicate then a InvalidContentTypeException} is thrown from open(DataSpec).

OkHttpDataSource

public OkHttpDataSource(@NonNull
                        okhttp3.Call.Factory callFactory,
                        @Nullable
                        java.lang.String userAgent,
                        @Nullable
                        com.google.android.exoplayer2.util.Predicate<java.lang.String> contentTypePredicate,
                        @Nullable
                        com.google.android.exoplayer2.upstream.TransferListener<? super OkHttpDataSource> listener)

Parameters:

callFactory - A Call.Factory (typically an OkHttpClient) for use by the source.

userAgent - An optional User-Agent string.

contentTypePredicate - An optional Predicate. If a content type is rejected by the predicate then a InvalidContentTypeException is thrown from open(DataSpec).

listener - An optional listener.

OkHttpDataSource

public OkHttpDataSource(@NonNull
                        okhttp3.Call.Factory callFactory,
                        @Nullable
                        java.lang.String userAgent,
                        @Nullable
                        com.google.android.exoplayer2.util.Predicate<java.lang.String> contentTypePredicate,
                        @Nullable
                        com.google.android.exoplayer2.upstream.TransferListener<? super OkHttpDataSource> listener,
                        @Nullable
                        okhttp3.CacheControl cacheControl,
                        @Nullable
                        com.google.android.exoplayer2.upstream.HttpDataSource.RequestProperties defaultRequestProperties)

Parameters:

callFactory - A Call.Factory (typically an OkHttpClient) for use by the source.

userAgent - An optional User-Agent string.

contentTypePredicate - An optional Predicate. If a content type is rejected by the predicate then a InvalidContentTypeException is thrown from open(DataSpec).

listener - An optional listener.

cacheControl - An optional CacheControl for setting the Cache-Control header.

defaultRequestProperties - The optional default RequestProperties to be sent to the server as HTTP headers on every request.

Method Detail

getUri

public android.net.Uri getUri()

Specified by:

getUri in interface com.google.android.exoplayer2.upstream.DataSource

getResponseHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getResponseHeaders()

Specified by:

getResponseHeaders in interface com.google.android.exoplayer2.upstream.HttpDataSource

setRequestProperty

public void setRequestProperty(java.lang.String name,
                               java.lang.String value)

Specified by:

setRequestProperty in interface com.google.android.exoplayer2.upstream.HttpDataSource

clearRequestProperty

public void clearRequestProperty(java.lang.String name)

Specified by:

clearRequestProperty in interface com.google.android.exoplayer2.upstream.HttpDataSource

clearAllRequestProperties

public void clearAllRequestProperties()

Specified by:

clearAllRequestProperties in interface com.google.android.exoplayer2.upstream.HttpDataSource

open

public long open(com.google.android.exoplayer2.upstream.DataSpec dataSpec)
          throws com.google.android.exoplayer2.upstream.HttpDataSource.HttpDataSourceException

Specified by:

open in interface com.google.android.exoplayer2.upstream.DataSource

Specified by:

open in interface com.google.android.exoplayer2.upstream.HttpDataSource

Throws:

com.google.android.exoplayer2.upstream.HttpDataSource.HttpDataSourceException

read

public int read(byte[] buffer,
                int offset,
                int readLength)
         throws com.google.android.exoplayer2.upstream.HttpDataSource.HttpDataSourceException

Specified by:

read in interface com.google.android.exoplayer2.upstream.DataSource

Specified by:

read in interface com.google.android.exoplayer2.upstream.HttpDataSource

Throws:

com.google.android.exoplayer2.upstream.HttpDataSource.HttpDataSourceException

close

public void close()
           throws com.google.android.exoplayer2.upstream.HttpDataSource.HttpDataSourceException

Specified by:

close in interface com.google.android.exoplayer2.upstream.DataSource

Specified by:

close in interface com.google.android.exoplayer2.upstream.HttpDataSource

Throws:

com.google.android.exoplayer2.upstream.HttpDataSource.HttpDataSourceException

bytesSkipped

protected final long bytesSkipped()

Returns the number of bytes that have been skipped since the most recent call to open(DataSpec).

Returns:

The number of bytes skipped.

bytesRead

protected final long bytesRead()

Returns the number of bytes that have been read since the most recent call to open(DataSpec).

Returns:

The number of bytes read.

bytesRemaining

protected final long bytesRemaining()

Returns the number of bytes that are still to be read for the current DataSpec.

If the total length of the data being read is known, then this length minus bytesRead() is returned. If the total length is unknown, C.LENGTH_UNSET is returned.

Returns:

The remaining length, or C.LENGTH_UNSET.