Class UdpDataSource
- java.lang.Object
-
- com.google.android.exoplayer2.upstream.BaseDataSource
-
- com.google.android.exoplayer2.upstream.UdpDataSource
-
- All Implemented Interfaces:
DataReader
,DataSource
public final class UdpDataSource extends BaseDataSource
A UDPDataSource
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
UdpDataSource.UdpDataSourceException
Thrown when an error is encountered when trying to read from aUdpDataSource
.-
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
The default maximum datagram packet size, in bytes.static int
DEFAULT_SOCKET_TIMEOUT_MILLIS
The default socket timeout, in milliseconds.static int
UDP_PORT_UNSET
-
Constructor Summary
Constructors Constructor Description UdpDataSource()
UdpDataSource(int maxPacketSize)
Constructs a new instance.UdpDataSource(int maxPacketSize, int socketTimeoutMillis)
Constructs a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Closes the source.int
getLocalPort()
Returns the local port number opened for the UDP connection, orUDP_PORT_UNSET
if no connection is openUri
getUri()
When the source is open, returns theUri
from which data is being read.long
open(DataSpec dataSpec)
Opens the source to read the specified data.int
read(byte[] buffer, int offset, int length)
Reads up tolength
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
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
The default socket timeout, in milliseconds.- See Also:
- Constant Field Values
-
UDP_PORT_UNSET
public static final int UDP_PORT_UNSET
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
UdpDataSource
public UdpDataSource()
-
UdpDataSource
public UdpDataSource(int maxPacketSize)
Constructs a new instance.- Parameters:
maxPacketSize
- The maximum datagram packet size, in bytes.
-
UdpDataSource
public UdpDataSource(int maxPacketSize, int socketTimeoutMillis)
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) throws UdpDataSource.UdpDataSourceException
Description copied from interface:DataSource
Opens the source to read the specified data. If anIOException
is thrown, callers must still callDataSource.close()
to ensure that any partial effects of the invocation are cleaned up.The following edge case behaviors apply:
- If the
requested position
is within the resource, but therequested length
extends beyond the end of the resource, thenDataSource.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 throughDataReader.read(byte[], int, int)
. - If the
requested position
is equal to the length of the resource, thenDataSource.open(com.google.android.exoplayer2.upstream.DataSpec)
will succeed, andDataReader.read(byte[], int, int)
will immediately returnC.RESULT_END_OF_INPUT
. - If the
requested position
is greater than the length of the resource, thenDataSource.open(com.google.android.exoplayer2.upstream.DataSpec)
will throw anIOException
for whichDataSourceException.isCausedByPositionOutOfRange(java.io.IOException)
will betrue
.
- 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
equalsC.LENGTH_UNSET
) this value is the resolved length of the request, orC.LENGTH_UNSET
if the length is still unresolved. For all other requests, the value returned will be equal to the request'sDataSpec.length
. - Throws:
UdpDataSource.UdpDataSourceException
- If the
-
read
public int read(byte[] buffer, int offset, int length) throws UdpDataSource.UdpDataSourceException
Description copied from interface:DataReader
Reads up tolength
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, thenC.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 thanlength
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 getUri()
Description copied from interface:DataSource
When the source is open, returns theUri
from which data is being read. The returnedUri
will be identical to the one passedDataSource.open(DataSpec)
in theDataSpec
unless redirection has occurred. If redirection has occurred, theUri
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()
Description copied from interface:DataSource
Closes the source. This method must be called even if the corresponding call toDataSource.open(DataSpec)
threw anIOException
.
-
getLocalPort
public int getLocalPort()
Returns the local port number opened for the UDP connection, orUDP_PORT_UNSET
if no connection is open
-
-