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.


Requires API level 12 (Android 3.1, Honeycomb)

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
setMode(mode: Int)

Changes the current mode.

open InetAddress!

Returns the network address of the local host.

open Int

Returns the network port of the local host.

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

Associates with a remote host.

open Int

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

open Int

Returns the current mode.

open Boolean

Returns true if the stream is busy.

open Unit

Releases allocated resources.

open InetAddress!

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

Protected methods
open Unit

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Constants

MODE_NORMAL

added in API level 12
static val MODE_NORMAL: Int

This mode indicates that the stream sends and receives packets at the same time. This is the initial mode for new streams.
Requires API level 12 (Android 3.1, Honeycomb)

Value: 0

MODE_RECEIVE_ONLY

added in API level 12
static val MODE_RECEIVE_ONLY: Int

This mode indicates that the stream only receives packets.
Requires API level 12 (Android 3.1, Honeycomb)

Value: 2

MODE_SEND_ONLY

added in API level 12
static val MODE_SEND_ONLY: Int

This mode indicates that the stream only sends packets.
Requires API level 12 (Android 3.1, Honeycomb)

Value: 1

Public methods

setMode

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

Changes the current mode. It must be one of #MODE_NORMAL, #MODE_SEND_ONLY, and #MODE_RECEIVE_ONLY.
Requires API level 12 (Android 3.1, Honeycomb)

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

See Also

getLocalAddress

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

Returns the network address of the local host.
Requires API level 12 (Android 3.1, Honeycomb)

getLocalPort

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

Returns the network port of the local host.
Requires API level 12 (Android 3.1, Honeycomb)

associate

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

Associates with a remote host. This defines the destination of the outgoing packets.
Requires API level 12 (Android 3.1, Honeycomb)

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

See Also

getRemotePort

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

Returns the network port of the remote host or -1 if the stream is not associated.
Requires API level 12 (Android 3.1, Honeycomb)

getMode

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

Returns the current mode.
Requires API level 12 (Android 3.1, Honeycomb)

isBusy

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

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.
Requires API level 12 (Android 3.1, Honeycomb)

release

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

Releases allocated resources. The stream becomes inoperable after calling this method.
Requires API level 12 (Android 3.1, Honeycomb)

Exceptions
IllegalStateException if the stream is busy.

See Also

getRemoteAddress

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

Returns the network address of the remote host or null if the stream is not associated.
Requires API level 12 (Android 3.1, Honeycomb)

Protected methods

finalize

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

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored. Requires API level 12 (Android 3.1, Honeycomb)

Exceptions
Throwable the Exception raised by this method