Added in [API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/net/rtp/RtpStream#constants) \| [Methods](https://developer.android.com/reference/android/net/rtp/RtpStream#pubmethods) \| [Protected Methods](https://developer.android.com/reference/android/net/rtp/RtpStream#promethods) \| [Inherited Methods](https://developer.android.com/reference/android/net/rtp/RtpStream#inhmethods)

# RtpStream

*** ** * ** ***

` public class RtpStream `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.net.rtp.RtpStream |

Known direct subclasses [AudioStream](https://developer.android.com/reference/android/net/rtp/AudioStream) [AudioStream](https://developer.android.com/reference/android/net/rtp/AudioStream) *This class was deprecated in API level 31. `https://developer.android.com/reference/android/net/sip/SipManager` and associated classes are no longer supported and should not be used as the basis of future VOIP apps.*   

*** ** * ** ***

<br />

**This class was deprecated in API level 31.**   
`https://developer.android.com/reference/android/net/sip/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 `https://developer.android.com/reference/android/Manifest.permission#INTERNET` permission.

<br />

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/net/rtp/RtpStream#MODE_NORMAL` This mode indicates that the stream sends and receives packets at the same time. |
| `int` | `https://developer.android.com/reference/android/net/rtp/RtpStream#MODE_RECEIVE_ONLY` This mode indicates that the stream only receives packets. |
| `int` | `https://developer.android.com/reference/android/net/rtp/RtpStream#MODE_SEND_ONLY` This mode indicates that the stream only sends packets. |

| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/net/rtp/RtpStream#associate(java.net.InetAddress,%20int)(https://developer.android.com/reference/java/net/InetAddress address, int port) ` Associates with a remote host. |
| ` https://developer.android.com/reference/java/net/InetAddress` | ` https://developer.android.com/reference/android/net/rtp/RtpStream#getLocalAddress()() ` Returns the network address of the local host. |
| ` int` | ` https://developer.android.com/reference/android/net/rtp/RtpStream#getLocalPort()() ` Returns the network port of the local host. |
| ` int` | ` https://developer.android.com/reference/android/net/rtp/RtpStream#getMode()() ` Returns the current mode. |
| ` https://developer.android.com/reference/java/net/InetAddress` | ` https://developer.android.com/reference/android/net/rtp/RtpStream#getRemoteAddress()() ` Returns the network address of the remote host or `null` if the stream is not associated. |
| ` int` | ` https://developer.android.com/reference/android/net/rtp/RtpStream#getRemotePort()() ` Returns the network port of the remote host or `-1` if the stream is not associated. |
| ` boolean` | ` https://developer.android.com/reference/android/net/rtp/RtpStream#isBusy()() ` Returns `true` if the stream is busy. |
| ` void` | ` https://developer.android.com/reference/android/net/rtp/RtpStream#release()() ` Releases allocated resources. |
| ` void` | ` https://developer.android.com/reference/android/net/rtp/RtpStream#setMode(int)(int mode) ` Changes the current mode. |

| ### Protected methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/net/rtp/RtpStream#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 ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

Constant Value: 0 (0x00000000)

### MODE_RECEIVE_ONLY

Added in [API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MODE_RECEIVE_ONLY
```

This mode indicates that the stream only receives packets.

<br />

Constant Value: 2 (0x00000002)

### MODE_SEND_ONLY

Added in [API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MODE_SEND_ONLY
```

This mode indicates that the stream only sends packets.

<br />

Constant Value: 1 (0x00000001)

## Public methods

### associate

Added in [API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void associate (InetAddress address, 
                int port)
```

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

<br />

| Parameters ||
|---|---|
| `address` | `InetAddress`: The network address of the remote host. <br /> |
| `port` | `int`: The network port of the remote host. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the address is not supported or the port is invalid. |
| `https://developer.android.com/reference/java/lang/IllegalStateException` | if the stream is busy. |

**See also:**

- `https://developer.android.com/reference/android/net/rtp/RtpStream#isBusy()`

### getLocalAddress

Added in [API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public InetAddress getLocalAddress ()
```

Returns the network address of the local host.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/net/InetAddress` | <br /> |

### getLocalPort

Added in [API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getLocalPort ()
```

Returns the network port of the local host.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getMode

Added in [API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getMode ()
```

Returns the current mode.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getRemoteAddress

Added in [API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public InetAddress getRemoteAddress ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/net/InetAddress` | <br /> |

### getRemotePort

Added in [API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getRemotePort ()
```

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

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### isBusy

Added in [API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### release

Added in [API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void release ()
```

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

<br />

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException` | if the stream is busy. |

**See also:**

- `https://developer.android.com/reference/android/net/rtp/RtpStream#isBusy()`

### setMode

Added in [API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void setMode (int mode)
```

Changes the current mode. It must be one of `https://developer.android.com/reference/android/net/rtp/RtpStream#MODE_NORMAL`, `https://developer.android.com/reference/android/net/rtp/RtpStream#MODE_SEND_ONLY`, and `https://developer.android.com/reference/android/net/rtp/RtpStream#MODE_RECEIVE_ONLY`.

<br />

| Parameters ||
|---|---|
| `mode` | `int`: The mode to change to. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the mode is invalid. |
| `https://developer.android.com/reference/java/lang/IllegalStateException` | if the stream is busy. |

**See also:**

- `https://developer.android.com/reference/android/net/rtp/RtpStream#isBusy()`

## Protected methods

### finalize

Added in [API level 12](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/Throwable` |   |