Back to Exoplayer

UdpDataSource (ExoPlayer library)

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

latest11.0 KB
Original Source

Package com.google.android.exoplayer2.upstream

Class UdpDataSource


[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public final classUdpDataSourceextends[BaseDataSource](BaseDataSource.html "class 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 UDP DataSource.

Nested Class Summary

Nested Classes | Modifier and Type | Class | Description | | --- | --- | --- | | static class | UdpDataSource.UdpDataSourceException | Deprecated.

Thrown when an error is encountered when trying to read from a UdpDataSource. |

- 

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

DataSource.Factory

Field Summary

Fields | Modifier and Type | Field | Description | | --- | --- | --- | | static int | DEFAULT_MAX_PACKET_SIZE | Deprecated.

The default maximum datagram packet size, in bytes. | | static int | DEFAULT_SOCKET_TIMEOUT_MILLIS | Deprecated.

The default socket timeout, in milliseconds. | | static int | UDP_PORT_UNSET | Deprecated. |

Constructor Summary

Constructors | Constructor | Description | | --- | --- | | UdpDataSource() | Deprecated. | | UdpDataSource​(int maxPacketSize) | Deprecated.

Constructs a new instance. | | UdpDataSource​(int maxPacketSize, int socketTimeoutMillis) | Deprecated.

Constructs a new instance. |

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods | Modifier and Type | Method | Description | | --- | --- | --- | | void | close() | Deprecated.

Closes the source. | | int | getLocalPort() | Deprecated.

Returns the local port number opened for the UDP connection, or UDP_PORT_UNSET if no connection is open | | 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 com.google.android.exoplayer2.upstream.BaseDataSource

addTransferListener, bytesTransferred, transferEnded, transferInitializing, transferStarted

- 

Methods inherited from class java.lang.Object

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

- 

Methods inherited from interface com.google.android.exoplayer2.upstream.DataSource

getResponseHeaders

Field Detail

- 

DEFAULT_MAX_PACKET_SIZE

public static final int DEFAULT_MAX_PACKET_SIZE

Deprecated.

The default maximum datagram packet size, in bytes. See Also:Constant Field Values

- 

DEFAULT_SOCKET_TIMEOUT_MILLIS

public static final int DEFAULT_SOCKET_TIMEOUT_MILLIS

Deprecated.

The default socket timeout, in milliseconds. See Also:Constant Field Values

- 

UDP_PORT_UNSET

public static final int UDP_PORT_UNSET

Deprecated. See Also:Constant Field Values

Constructor Detail

- 

UdpDataSource

public UdpDataSource()

Deprecated.

- 

UdpDataSource

public UdpDataSource​(int maxPacketSize)

Deprecated.

Constructs a new instance. Parameters:maxPacketSize - The maximum datagram packet size, in bytes.

- 

UdpDataSource

public UdpDataSource​(int maxPacketSize,
                     int socketTimeoutMillis)

Deprecated.

Constructs a new instance. Parameters:maxPacketSize - The maximum datagram packet size, in bytes.socketTimeoutMillis - The socket timeout in milliseconds. A timeout of zero is interpreted as an infinite timeout.

Method Detail

- 

open

public long open​([DataSpec](DataSpec.html "class in com.google.android.exoplayer2.upstream")dataSpec)
          throws[UdpDataSource.UdpDataSourceException](UdpDataSource.UdpDataSourceException.html "class in com.google.android.exoplayer2.upstream")

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`. 

Parameters: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:UdpDataSource.UdpDataSourceException

- 

read

public int read​(byte[] buffer,
                int offset,
                int length)
         throws[UdpDataSource.UdpDataSourceException](UdpDataSource.UdpDataSourceException.html "class in com.google.android.exoplayer2.upstream")

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.

Parameters: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:UdpDataSource.UdpDataSourceException

- 

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. Returns:The Uri from which data is being read, or null if the source is not open.

- 

close

public void close()

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.

- 

getLocalPort

public int getLocalPort()

Deprecated.

Returns the local port number opened for the UDP connection, or UDP_PORT_UNSET if no connection is open