Added in API level 12
Deprecated in API level 31

Summary: Constants | Methods | Protected Methods | Inherited Methods

RtpStream

---

Kotlin |Java

public class RtpStream
extends Object

java.lang.Object
↳	android.net.rtp.RtpStream

Known direct subclasses AudioStream AudioStream This class was deprecated in API level 31. SipManager and associated classes are no longer supported and should not be used as the basis of future VOIP apps.

---

This class was deprecated in API level 31.
SipManager and associated classes are no longer supported and should not be used as the basis of future VOIP apps.

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 Manifest.permission.INTERNET permission.

Summary

Constants
int	MODE_NORMAL This mode indicates that the stream sends and receives packets at the same time.
int	MODE_RECEIVE_ONLY This mode indicates that the stream only receives packets.
int	MODE_SEND_ONLY This mode indicates that the stream only sends packets.

Public methods
void	associate(InetAddress address, int port) Associates with a remote host.
InetAddress	getLocalAddress() Returns the network address of the local host.
int	getLocalPort() Returns the network port of the local host.
int	getMode() Returns the current mode.
InetAddress	getRemoteAddress() Returns the network address of the remote host or null if the stream is not associated.
int	getRemotePort() Returns the network port of the remote host or -1 if the stream is not associated.
boolean	isBusy() Returns true if the stream is busy.
void	release() Releases allocated resources.
void	setMode(int mode) Changes the current mode.

Protected methods
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

MODE_NORMAL

Added in API level 12

public static final int MODE_NORMAL

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

Constant Value: 0 (0x00000000)

MODE_RECEIVE_ONLY

Added in API level 12

public static final int MODE_RECEIVE_ONLY

This mode indicates that the stream only receives packets.

Constant Value: 2 (0x00000002)

MODE_SEND_ONLY

Added in API level 12

public static final int MODE_SEND_ONLY

This mode indicates that the stream only sends packets.

Constant Value: 1 (0x00000001)

Public methods

associate

Added in API level 12

public void associate (InetAddress address, 
                int port)

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.

Throws
IllegalArgumentException	if the address is not supported or the port is invalid.
IllegalStateException	if the stream is busy.

See also:

• isBusy()

getLocalAddress

Added in API level 12

public InetAddress getLocalAddress ()

Returns the network address of the local host.

Returns
InetAddress

getLocalPort

Added in API level 12

public int getLocalPort ()

Returns the network port of the local host.

Returns
int

getMode

Added in API level 12

public int getMode ()

Returns the current mode.

Returns
int

getRemoteAddress

Added in API level 12

public InetAddress getRemoteAddress ()

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

Returns
InetAddress

getRemotePort

Added in API level 12

public int getRemotePort ()

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

Returns
int

isBusy

Added in API level 12

public boolean isBusy ()

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.

Returns
boolean

release

Added in API level 12

public void release ()

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

Throws
IllegalStateException	if the stream is busy.

See also:

• isBusy()

setMode

Added in API level 12

public void setMode (int mode)

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.

Throws
IllegalArgumentException	if the mode is invalid.
IllegalStateException	if the stream is busy.

See also:

• isBusy()

Protected methods

finalize

Added in API level 12

protected void finalize ()

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.

Throws
Throwable