Android APIs
public class

RtpStream

extends Object
java.lang.Object
   ↳ android.net.rtp.RtpStream
Known Direct Subclasses

Class Overview

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 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()
Invoked when the garbage collector has detected that this instance is no longer reachable.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int MODE_NORMAL

Added in API level 12

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)

public static final int MODE_RECEIVE_ONLY

Added in API level 12

This mode indicates that the stream only receives packets.

Constant Value: 2 (0x00000002)

public static final int MODE_SEND_ONLY

Added in API level 12

This mode indicates that the stream only sends packets.

Constant Value: 1 (0x00000001)

Public Methods

public void associate (InetAddress address, int port)

Added in API level 12

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:

public InetAddress getLocalAddress ()

Added in API level 12

Returns the network address of the local host.

Returns
InetAddress

public int getLocalPort ()

Added in API level 12

Returns the network port of the local host.

Returns
int

public int getMode ()

Added in API level 12

Returns the current mode.

Returns
int

public InetAddress getRemoteAddress ()

Added in API level 12

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

Returns
InetAddress

public int getRemotePort ()

Added in API level 12

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

Returns
int

public boolean isBusy ()

Added in API level 12

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

public void release ()

Added in API level 12

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

Throws
IllegalStateException if the stream is busy.

See also:

public void setMode (int mode)

Added in API level 12

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:

Protected Methods

protected void finalize ()

Added in API level 12

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.

Throws
Throwable