UdpDataSource
@UnstableApi
class UdpDataSource : BaseDataSource
A UDP DataSource.
Summary
Nested types |
|---|
|
Thrown when an error is encountered when trying to read from a |
Constants |
|
|---|---|
const Int |
DEFAULT_MAX_PACKET_SIZE = 2000The default maximum datagram packet size, in bytes. |
const Int |
The default socket timeout, in milliseconds. |
const Int |
UDP_PORT_UNSET = -1 |
Public constructors |
|---|
UdpDataSource(maxPacketSize: Int)Constructs a new instance. |
UdpDataSource(maxPacketSize: Int, socketTimeoutMillis: Int)Constructs a new instance. |
Public functions |
|
|---|---|
Unit |
close()Closes the source. |
Int |
Returns the local port number opened for the UDP connection, or |
Long |
Opens the source to read the specified data. |
Int |
Reads up to |
Inherited functions |
||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
||||||||||
Constants
DEFAULT_MAX_PACKET_SIZE
const val DEFAULT_MAX_PACKET_SIZE = 2000: Int
The default maximum datagram packet size, in bytes.
DEFAULT_SOCKET_TIMEOUT_MILLIS
const val DEFAULT_SOCKET_TIMEOUT_MILLIS = 8000: Int
The default socket timeout, in milliseconds.
Public constructors
UdpDataSource
UdpDataSource(maxPacketSize: Int)
Constructs a new instance.
| Parameters | |
|---|---|
maxPacketSize: Int |
The maximum datagram packet size, in bytes. |
UdpDataSource
UdpDataSource(maxPacketSize: Int, socketTimeoutMillis: Int)
Constructs a new instance.
Public functions
close
fun close(): Unit
Closes the source. This method must be called even if the corresponding call to open threw an IOException.
| Throws | |
|---|---|
java.io.IOException |
If an error occurs closing the source. |
getLocalPort
fun getLocalPort(): Int
Returns the local port number opened for the UDP connection, or UDP_PORT_UNSET if no connection is open
open
fun open(dataSpec: DataSpec!): Long
Opens the source to read the specified data. If an IOException is thrown, callers must still call close to ensure that any partial effects of the invocation are cleaned up.
The following edge case behaviors apply:
- If the
requested positionis within the resource, but therequested lengthextends beyond the end of the resource, thenopenwill succeed and data from the requested position to the end of the resource will be made available throughread. - If the
requested positionis equal to the length of the resource, thenopenwill succeed, andreadwill immediately returnRESULT_END_OF_INPUT. - If the
requested positionis greater than the length of the resource, thenopenwill throw anIOExceptionfor whichisCausedByPositionOutOfRangewill betrue.
| Parameters | |
|---|---|
dataSpec: DataSpec! |
Defines the data to be read. |
| Returns | |
|---|---|
Long |
The number of bytes that can be read from the opened source. For unbounded requests (i.e., requests where |
| Throws | |
|---|---|
java.io.IOException |
If an error occurs opening the source. |
androidx.media3.datasource.UdpDataSource.UdpDataSourceException |
read
fun read(buffer: ByteArray!, offset: Int, length: Int): Int
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 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: ByteArray! |
A target array into which data should be written. |
offset: Int |
The offset into the target array at which to write. |
length: Int |
The maximum number of bytes to read from the input. |
| Returns | |
|---|---|
Int |
The number of bytes read, or |
| Throws | |
|---|---|
java.io.IOException |
If an error occurs reading from the input. |
androidx.media3.datasource.UdpDataSource.UdpDataSourceException |