ContextQMD
Back to Exoplayer

DefaultDataSource (ExoPlayer library)

docs/doc/reference/com/google/android/exoplayer2/upstream/DefaultDataSource.html

latest16.6 KB
Original Source

Package com.google.android.exoplayer2.upstream

Class DefaultDataSource

  • java.lang.Object

    • com.google.android.exoplayer2.upstream.DefaultDataSource

  • All Implemented Interfaces:DataReader, DataSource

[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public final classDefaultDataSourceextends[Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")implements[DataSource](DataSource.html "interface in com.google.android.exoplayer2.upstream")

Deprecated. com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.

A DataSource that supports multiple URI schemes. The supported schemes are:

  • file: For fetching data from a local file (e.g. file:///path/to/media/media.mp4, or just /path/to/media/media.mp4 because the implementation assumes that a URI without a scheme is a local file URI).

  • asset: For fetching data from an asset in the application's APK (e.g. asset:///media.mp4).

  • rawresource: For fetching data from a raw resource in the application's APK (e.g. rawresource:///resourceId, where rawResourceId is the integer identifier of the raw resource).

  • android.resource: For fetching data in the application's APK (e.g. android.resource:///resourceId or android.resource://resourceType/resourceName). See RawResourceDataSource for more information about the URI form.

  • content: For fetching data from a content URI (e.g. content://authority/path/123).

  • rtmp: For fetching data over RTMP. Only supported if the project using ExoPlayer has an explicit dependency on ExoPlayer's RTMP extension.

  • data: For parsing data inlined in the URI as defined in RFC 2397.

  • udp: For fetching data over UDP (e.g. udp://something.com/media).

  • http(s): For fetching data over HTTP and HTTPS (e.g. https://www.something.com/media.mp4), if constructed using DefaultDataSource(Context, String, boolean), or any other schemes supported by a base data source if constructed using DefaultDataSource(Context, DataSource).

Nested Class Summary

Nested Classes | Modifier and Type | Class | Description | | --- | --- | --- | | static class | DefaultDataSource.Factory | Deprecated.

DataSource.Factory for DefaultDataSource instances. |

Constructor Summary

Constructors | Constructor | Description | | --- | --- | | DefaultDataSource​(Context context, boolean allowCrossProtocolRedirects) | Deprecated.

Constructs a new instance, optionally configured to follow cross-protocol redirects. | | DefaultDataSource​(Context context, DataSource baseDataSource) | Deprecated.

Constructs a new instance that delegates to a provided DataSource for URI schemes other than file, asset and content. | | DefaultDataSource​(Context context, String userAgent, boolean allowCrossProtocolRedirects) | Deprecated.

Constructs a new instance, optionally configured to follow cross-protocol redirects. | | DefaultDataSource​(Context context, String userAgent, int connectTimeoutMillis, int readTimeoutMillis, boolean allowCrossProtocolRedirects) | Deprecated.

Constructs a new instance, optionally configured to follow cross-protocol redirects. |

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods | Modifier and Type | Method | Description | | --- | --- | --- | | void | addTransferListener​(TransferListener transferListener) | Deprecated.

Adds a TransferListener to listen to data transfers. | | void | close() | Deprecated.

Closes the source. | | Map<String,​List<String>> | getResponseHeaders() | Deprecated.

When the source is open, returns the response headers associated with the last DataSource.open(com.google.android.exoplayer2.upstream.DataSpec) call. | | Uri | getUri() | Deprecated.

When the source is open, returns the Uri from which data is being read. | | long | open​(DataSpec dataSpec) | Deprecated.

Opens the source to read the specified data. | | int | read​(byte[] buffer, int offset, int length) | Deprecated.

Reads up to length bytes of data from the input. |

-

Methods inherited from class java.lang.Object

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

Constructor Detail

-

DefaultDataSource

public DefaultDataSource​([Context](https://developer.android.com/reference/android/content/Context.html "class or interface in android.content")context,
                         boolean allowCrossProtocolRedirects)

Deprecated.

Constructs a new instance, optionally configured to follow cross-protocol redirects. Parameters:context - A context.allowCrossProtocolRedirects - Whether to allow cross-protocol redirects.

-

DefaultDataSource

public DefaultDataSource​([Context](https://developer.android.com/reference/android/content/Context.html "class or interface in android.content")context,
                         @Nullable[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")userAgent,
                         boolean allowCrossProtocolRedirects)

Deprecated.

Constructs a new instance, optionally configured to follow cross-protocol redirects. Parameters:context - A context.userAgent - The user agent that will be used when requesting remote data, or null to use the default user agent of the underlying platform.allowCrossProtocolRedirects - Whether cross-protocol redirects (i.e. redirects from HTTP to HTTPS and vice versa) are enabled when fetching remote data.

-

DefaultDataSource

public DefaultDataSource​([Context](https://developer.android.com/reference/android/content/Context.html "class or interface in android.content")context,
                         @Nullable[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")userAgent,
                         int connectTimeoutMillis,
                         int readTimeoutMillis,
                         boolean allowCrossProtocolRedirects)

Deprecated.

Constructs a new instance, optionally configured to follow cross-protocol redirects. Parameters:context - A context.userAgent - The user agent that will be used when requesting remote data, or null to use the default user agent of the underlying platform.connectTimeoutMillis - The connection timeout that should be used when requesting remote data, in milliseconds. A timeout of zero is interpreted as an infinite timeout.readTimeoutMillis - The read timeout that should be used when requesting remote data, in milliseconds. A timeout of zero is interpreted as an infinite timeout.allowCrossProtocolRedirects - Whether cross-protocol redirects (i.e. redirects from HTTP to HTTPS and vice versa) are enabled when fetching remote data.

-

DefaultDataSource

public DefaultDataSource​([Context](https://developer.android.com/reference/android/content/Context.html "class or interface in android.content")context,[DataSource](DataSource.html "interface in com.google.android.exoplayer2.upstream")baseDataSource)

Deprecated.

Constructs a new instance that delegates to a provided DataSource for URI schemes other than file, asset and content. Parameters:context - A context.baseDataSource - A DataSource to use for URI schemes other than file, asset and content. This DataSource should normally support at least http(s).

Method Detail

-

addTransferListener

public void addTransferListener​([TransferListener](TransferListener.html "interface in com.google.android.exoplayer2.upstream")transferListener)

Deprecated.

Description copied from interface: DataSource

Adds a TransferListener to listen to data transfers. This method is not thread-safe. Specified by:addTransferListener in interface DataSourceParameters:transferListener - A TransferListener.

-

open

public long open​([DataSpec](DataSpec.html "class in com.google.android.exoplayer2.upstream")dataSpec)
          throws[IOException](https://developer.android.com/reference/java/io/IOException.html "class or interface in java.io")

Deprecated.

Description copied from interface: DataSource

Opens the source to read the specified data. If an IOException is thrown, callers must still call DataSource.close() to ensure that any partial effects of the invocation are cleaned up.

The following edge case behaviors apply:

  - If the [`requested position`](DataSpec.html#position) is within the resource, but the [`requested length`](DataSpec.html#length) extends beyond the end of the resource, then [`DataSource.open(com.google.android.exoplayer2.upstream.DataSpec)`](DataSource.html#open(com.google.android.exoplayer2.upstream.DataSpec)) will succeed and data from the requested position to the end of the resource will be made available through [`DataReader.read(byte[], int, int)`](DataReader.html#read(byte%5B%5D,int,int)). 
  - If the [`requested position`](DataSpec.html#position) is equal to the length of the resource, then [`DataSource.open(com.google.android.exoplayer2.upstream.DataSpec)`](DataSource.html#open(com.google.android.exoplayer2.upstream.DataSpec)) will succeed, and [`DataReader.read(byte[], int, int)`](DataReader.html#read(byte%5B%5D,int,int)) will immediately return [`C.RESULT_END_OF_INPUT`](../C.html#RESULT_END_OF_INPUT). 
  - If the [`requested position`](DataSpec.html#position) is greater than the length of the resource, then [`DataSource.open(com.google.android.exoplayer2.upstream.DataSpec)`](DataSource.html#open(com.google.android.exoplayer2.upstream.DataSpec)) will throw an [`IOException`](https://developer.android.com/reference/java/io/IOException.html "class or interface in java.io") for which [`DataSourceException.isCausedByPositionOutOfRange(java.io.IOException)`](DataSourceException.html#isCausedByPositionOutOfRange(java.io.IOException)) will be `true`.

Specified by:open in interface DataSourceParameters:dataSpec - Defines the data to be read.Returns:The number of bytes that can be read from the opened source. For unbounded requests (i.e., requests where DataSpec.length equals C.LENGTH_UNSET) this value is the resolved length of the request, or C.LENGTH_UNSET if the length is still unresolved. For all other requests, the value returned will be equal to the request's DataSpec.length.Throws:IOException - If an error occurs opening the source. DataSourceException can be thrown or used as a cause of the thrown exception to specify the reason of the error.

-

read

public int read​(byte[] buffer,
                int offset,
                int length)
         throws[IOException](https://developer.android.com/reference/java/io/IOException.html "class or interface in java.io")

Deprecated.

Description copied from interface: DataReader

Reads up to length bytes of data from the input.

If readLength is zero then 0 is returned. Otherwise, if no data is available because the end of the opened range has been reached, then C.RESULT_END_OF_INPUT is returned. Otherwise, the call will block until at least one byte of data has been read and the number of bytes read is returned.

Specified by:read in interface DataReaderParameters:buffer - A target array into which data should be written.offset - The offset into the target array at which to write.length - The maximum number of bytes to read from the input.Returns:The number of bytes read, or C.RESULT_END_OF_INPUT if the input has ended. This may be less than length because the end of the input (or available data) was reached, the method was interrupted, or the operation was aborted early for another reason.Throws:IOException - If an error occurs reading from the input.

-

getUri

@Nullable
public[Uri](https://developer.android.com/reference/android/net/Uri.html "class or interface in android.net")getUri()

Deprecated.

Description copied from interface: DataSource

When the source is open, returns the Uri from which data is being read. The returned Uri will be identical to the one passed DataSource.open(DataSpec) in the DataSpec unless redirection has occurred. If redirection has occurred, the Uri after redirection is returned. Specified by:getUri in interface DataSourceReturns:The Uri from which data is being read, or null if the source is not open.

-

getResponseHeaders

public[Map](https://developer.android.com/reference/java/util/Map.html "class or interface in java.util")<[String](https://developer.android.com/reference/java/lang/String.html?is-external=true "class or interface in java.lang"),​[List](https://developer.android.com/reference/java/util/List.html?is-external=true "class or interface in java.util")<[String](https://developer.android.com/reference/java/lang/String.html?is-external=true "class or interface in java.lang")>> getResponseHeaders()

Deprecated.

Description copied from interface: DataSource

When the source is open, returns the response headers associated with the last DataSource.open(com.google.android.exoplayer2.upstream.DataSpec) call. Otherwise, returns an empty map.

Key look-up in the returned map is case-insensitive.

Specified by:getResponseHeaders in interface DataSource

-

close

public void close()
           throws[IOException](https://developer.android.com/reference/java/io/IOException.html "class or interface in java.io")

Deprecated.

Description copied from interface: DataSource

Closes the source. This method must be called even if the corresponding call to DataSource.open(DataSpec) threw an IOException. Specified by:close in interface DataSourceThrows:IOException - If an error occurs closing the source.