UdpDataSource

Artifact: androidx.media3:media3-datasource

Kotlin |Java

@UnstableApi
class UdpDataSource : BaseDataSource

kotlin.Any
↳	androidx.media3.datasource.BaseDataSource
	↳	androidx.media3.datasource.UdpDataSource

A UDP DataSource.

Summary

Nested types
`class UdpDataSource.UdpDataSourceException : DataSourceException` Thrown when an error is encountered when trying to read from a `UdpDataSource`.

Constants
`const Int`	`DEFAULT_MAX_PACKET_SIZE = 2000` The default maximum datagram packet size, in bytes.
`const Int`	`DEFAULT_SOCKET_TIMEOUT_MILLIS = 8000` The default socket timeout, in milliseconds.
`const Int`	`UDP_PORT_UNSET = -1`

Public constructors
`UdpDataSource()`
`UdpDataSource(maxPacketSize: Int)` Constructs a new instance.
`UdpDataSource(maxPacketSize: Int, socketTimeoutMillis: Int)` Constructs a new instance.

Public functions
`Unit`	`close()` Closes the source.
`Int`	`getLocalPort()` Returns the local port number opened for the UDP connection, or `UDP_PORT_UNSET` if no connection is open
`Long`	`open(dataSpec: DataSpec!)` Opens the source to read the specified data.
`Int`	`read(buffer: ByteArray!, offset: Int, length: Int)` Reads up to `length` bytes of data from the input.

Public properties
`Uri?`	`uri`

Inherited functions

From androidx.media3.datasource.BaseDataSource

`Unit`	`@UnstableApi addTransferListener(transferListener: TransferListener!)` Adds a `TransferListener` to listen to data transfers.
`Unit`	`bytesTransferred(bytesTransferred: Int)` Notifies listeners that bytes were transferred.
`Unit`	`transferEnded()` Notifies listeners that a transfer ended.
`Unit`	`transferInitializing(dataSpec: DataSpec!)` Notifies listeners that data transfer for the specified `DataSpec` is being initialized.
`Unit`	`transferStarted(dataSpec: DataSpec!)` Notifies listeners that data transfer for the specified `DataSpec` started.

From androidx.media3.datasource.DataSource

(Mutable)Map<String!, (Mutable)List<String!>!>!

@UnstableApi
getResponseHeaders()

When the source is open, returns the response headers associated with the last open call.

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.

UDP_PORT_UNSET

const val UDP_PORT_UNSET = -1: Int

Public constructors

UdpDataSource

UdpDataSource()

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.

Parameters
`maxPacketSize: Int`	The maximum datagram packet size, in bytes.
`socketTimeoutMillis: Int`	The socket timeout in milliseconds. A timeout of zero is interpreted as an infinite timeout.

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 position is within the resource, but the requested length extends beyond the end of the resource, then open will succeed and data from the requested position to the end of the resource will be made available through read.
If the requested position is equal to the length of the resource, then open will succeed, and read will immediately return RESULT_END_OF_INPUT.
If the requested position is greater than the length of the resource, then open will throw an IOException for which isCausedByPositionOutOfRange will be true.

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 `length` equals `LENGTH_UNSET`) this value is the resolved length of the request, or `LENGTH_UNSET` if the length is still unresolved. For all other requests, the value returned will be equal to the request's `length`.

Throws
`java.io.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.
`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 `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
`java.io.IOException`	If an error occurs reading from the input.
`androidx.media3.datasource.UdpDataSource.UdpDataSourceException`

Public properties

uri

val uri: Uri?

UdpDataSource

Summary

Nested types

Constants

Public constructors

Public functions

Public properties

Inherited functions

Constants

DEFAULT_MAX_PACKET_SIZE

DEFAULT_SOCKET_TIMEOUT_MILLIS

UDP_PORT_UNSET

Public constructors

UdpDataSource

UdpDataSource

UdpDataSource

Public functions

close

getLocalPort

open

read

Public properties

uri