com.google.android.exoplayer2.upstream

Class UdpDataSource

java.lang.Object

com.google.android.exoplayer2.upstream.BaseDataSource

com.google.android.exoplayer2.upstream.UdpDataSource

All Implemented Interfaces:

DataSource

public final class UdpDataSource
extends BaseDataSource

A UDP DataSource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UdpDataSource.UdpDataSourceException 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 and 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.

Constructor Summary

Constructors

Constructor and Description
UdpDataSource()
UdpDataSource(int maxPacketSize) Constructs a new instance.
UdpDataSource(int maxPacketSize, int socketTimeoutMillis) Constructs a new instance.
UdpDataSource(TransferListener listener) Deprecated. Use UdpDataSource() and BaseDataSource.addTransferListener(TransferListener).
UdpDataSource(TransferListener listener, int maxPacketSize) Deprecated. Use UdpDataSource(int) and BaseDataSource.addTransferListener(TransferListener).
UdpDataSource(TransferListener listener, int maxPacketSize, int socketTimeoutMillis) Deprecated. Use UdpDataSource(int, int) and BaseDataSource.addTransferListener(TransferListener).

Method Summary

Modifier and Type	Method and Description
void	close() Closes the source.
android.net.Uri	getUri() When the source is open, returns the Uri 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 readLength) Reads up to length bytes of data and stores them into buffer, starting at index offset.

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

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.

UdpDataSource

@Deprecated
public UdpDataSource(@Nullable
                                 TransferListener listener)

Deprecated. Use UdpDataSource() and BaseDataSource.addTransferListener(TransferListener).

Constructs a new instance.

Parameters:

listener - An optional listener.

UdpDataSource

@Deprecated
public UdpDataSource(@Nullable
                                 TransferListener listener,
                                 int maxPacketSize)

Deprecated. Use UdpDataSource(int) and BaseDataSource.addTransferListener(TransferListener).

Constructs a new instance.

Parameters:

listener - An optional listener.

maxPacketSize - The maximum datagram packet size, in bytes.

UdpDataSource

@Deprecated
public UdpDataSource(@Nullable
                                 TransferListener listener,
                                 int maxPacketSize,
                                 int socketTimeoutMillis)

Deprecated. Use UdpDataSource(int, int) and BaseDataSource.addTransferListener(TransferListener).

Constructs a new instance.

Parameters:

listener - An optional listener.

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.

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

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 readLength)
         throws UdpDataSource.UdpDataSourceException

Description copied from interface: DataSource

Reads up to length bytes of data and stores them into buffer, starting at index offset.

If length 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 - The buffer into which the read data should be stored.

offset - The start offset into buffer at which data should be written.

readLength - The maximum number of bytes to read.

Returns:

The number of bytes read, or C.RESULT_END_OF_INPUT if no data is available because the end of the opened range has been reached.

Throws:

UdpDataSource.UdpDataSourceException

getUri

@Nullable
public android.net.Uri getUri()

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()

Description copied from interface: DataSource

Closes the source.

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