Added in API level 12
Deprecated in API level 31

RtpStream

open class RtpStream
kotlin.Any
   ↳ android.net.rtp.RtpStream

RtpStream represents the base class of streams which send and receive network packets with media payloads over Real-time Transport Protocol (RTP).

Using this class requires android.Manifest.permission#INTERNET permission.

Summary

Constants
static Int

This mode indicates that the stream sends and receives packets at the same time.

static Int

This mode indicates that the stream only receives packets.

static Int

This mode indicates that the stream only sends packets.

Public methods
open Unit
associate(address: InetAddress!, port: Int)

Associates with a remote host.

open InetAddress!

Returns the network address of the local host.

open Int

Returns the network port of the local host.

open Int

Returns the current mode.

open InetAddress!

Returns the network address of the remote host or null if the stream is not associated.

open Int

Returns the network port of the remote host or -1 if the stream is not associated.

open Boolean

Returns true if the stream is busy.

open Unit

Releases allocated resources.

open Unit
setMode(mode: Int)

Changes the current mode.

Protected methods
open Unit

Constants

MODE_NORMAL

Added in API level 12
static val MODE_NORMAL: Int

Deprecated: Deprecated in Java.

This mode indicates that the stream sends and receives packets at the same time. This is the initial mode for new streams.

Value: 0

MODE_RECEIVE_ONLY

Added in API level 12
static val MODE_RECEIVE_ONLY: Int

Deprecated: Deprecated in Java.

This mode indicates that the stream only receives packets.

Value: 2

MODE_SEND_ONLY

Added in API level 12
static val MODE_SEND_ONLY: Int

Deprecated: Deprecated in Java.

This mode indicates that the stream only sends packets.

Value: 1

Public methods

associate

Added in API level 12
open fun associate(
    address: InetAddress!,
    port: Int
): Unit

Deprecated: Deprecated in Java.

Associates with a remote host. This defines the destination of the outgoing packets.

Parameters
address InetAddress!: The network address of the remote host.
port Int: The network port of the remote host.
Exceptions
java.lang.IllegalArgumentException if the address is not supported or the port is invalid.
java.lang.IllegalStateException if the stream is busy.

See Also

getLocalAddress

Added in API level 12
open fun getLocalAddress(): InetAddress!

Deprecated: Deprecated in Java.

Returns the network address of the local host.

getLocalPort

Added in API level 12
open fun getLocalPort(): Int

Deprecated: Deprecated in Java.

Returns the network port of the local host.

getMode

Added in API level 12
open fun getMode(): Int

Deprecated: Deprecated in Java.

Returns the current mode.

getRemoteAddress

Added in API level 12
open fun getRemoteAddress(): InetAddress!

Deprecated: Deprecated in Java.

Returns the network address of the remote host or null if the stream is not associated.

getRemotePort

Added in API level 12
open fun getRemotePort(): Int

Deprecated: Deprecated in Java.

Returns the network port of the remote host or -1 if the stream is not associated.

isBusy

Added in API level 12
open fun isBusy(): Boolean

Deprecated: Deprecated in Java.

Returns true if the stream is busy. In this case most of the setter methods are disabled. This method is intended to be overridden by subclasses.

release

Added in API level 12
open fun release(): Unit

Deprecated: Deprecated in Java.

Releases allocated resources. The stream becomes inoperable after calling this method.

Exceptions
java.lang.IllegalStateException if the stream is busy.

See Also

setMode

Added in API level 12
open fun setMode(mode: Int): Unit

Deprecated: Deprecated in Java.

Changes the current mode. It must be one of MODE_NORMAL, MODE_SEND_ONLY, and MODE_RECEIVE_ONLY.

Parameters
mode Int: The mode to change to.
Exceptions
java.lang.IllegalArgumentException if the mode is invalid.
java.lang.IllegalStateException if the stream is busy.

See Also

Protected methods

finalize

Added in API level 12
protected open fun finalize(): Unit

Deprecated: Deprecated in Java.

Exceptions
java.lang.Throwable the Exception raised by this method