Added in API level 12
Deprecated in API level 31

AudioStream

Kotlin |Java

open class AudioStream : RtpStream

kotlin.Any
↳	android.net.rtp.RtpStream
	↳	android.net.rtp.AudioStream

An AudioStream is a RtpStream which carrys audio payloads over Real-time Transport Protocol (RTP). Two different classes are developed in order to support various usages such as audio conferencing. An AudioStream represents a remote endpoint which consists of a network mapping and a configured AudioCodec. On the other side, An AudioGroup represents a local endpoint which mixes all the AudioStreams and optionally interacts with the speaker and the microphone at the same time. The simplest usage includes one for each endpoints. For other combinations, developers should be aware of the limitations described in AudioGroup.

An AudioStream becomes busy when it joins an AudioGroup. In this case most of the setter methods are disabled. This is designed to ease the task of managing native resources. One can always make an AudioStream leave its AudioGroup by calling join(android.net.rtp.AudioGroup) with null and put it back after the modification is done.

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

Summary

Inherited constants

From class RtpStream

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.

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 constructors
`AudioStream(address: InetAddress!)` Creates an AudioStream on the given local address.

Public methods
open AudioCodec!	`getCodec()` Returns the `AudioCodec`, or `null` if it is not set.
open Int	`getDtmfType()` Returns the RTP payload type for dual-tone multi-frequency (DTMF) digits, or `-1` if it is not enabled.
open AudioGroup!	`getGroup()` Returns the joined `AudioGroup`.
Boolean	`isBusy()` Returns `true` if the stream has already joined an `AudioGroup`.
open Unit	`join(group: AudioGroup!)` Joins an `AudioGroup`.
open Unit	`setCodec(codec: AudioCodec!)` Sets the `AudioCodec`.
open Unit	`setDtmfType(type: Int)` Sets the RTP payload type for dual-tone multi-frequency (DTMF) digits.

Inherited functions

From class RtpStream

`Unit`	`associate(address: InetAddress!, port: Int)` Associates with a remote host. This defines the destination of the outgoing packets.
`Unit`	`finalize()`
`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.
`Unit`	`release()` Releases allocated resources. The stream becomes inoperable after calling this method.
`Unit`	`setMode(mode: Int)` Changes the current mode. It must be one of `MODE_NORMAL`, `MODE_SEND_ONLY`, and `MODE_RECEIVE_ONLY`.

Public constructors

AudioStream

Added in API level 12

AudioStream(address: InetAddress!)

Creates an AudioStream on the given local address. Note that the local port is assigned automatically to conform with RFC 3550.

Parameters
`address`	InetAddress!: The network address of the local host to bind to.

Exceptions
`java.net.SocketException`	if the address cannot be bound or a problem occurs during binding.

Public methods

getCodec

Added in API level 12

open fun getCodec(): AudioCodec!

Deprecated: Deprecated in Java.

Returns the AudioCodec, or null if it is not set.

See Also

#setCodec(AudioCodec)

getDtmfType

Added in API level 12

open fun getDtmfType(): Int

Deprecated: Deprecated in Java.

Returns the RTP payload type for dual-tone multi-frequency (DTMF) digits, or -1 if it is not enabled.

See Also

#setDtmfType(int)

getGroup

Added in API level 12

open fun getGroup(): AudioGroup!

Deprecated: Deprecated in Java.

Returns the joined AudioGroup.

isBusy

Added in API level 12

fun isBusy(): Boolean

Deprecated: Deprecated in Java.

Returns true if the stream has already joined an AudioGroup.

join

Added in API level 12

open fun join(group: AudioGroup!): Unit

Deprecated: Deprecated in Java.

Joins an AudioGroup. Each stream can join only one group at a time. The group can be changed by passing a different one or removed by calling this method with null.

Parameters
`group`	AudioGroup!: The AudioGroup to join or `null` to leave.

Exceptions
`java.lang.IllegalStateException`	if the stream is not properly configured.

See Also

android.net.rtp.AudioGroup

setCodec

Added in API level 12

open fun setCodec(codec: AudioCodec!): Unit

Deprecated: Deprecated in Java.

Sets the AudioCodec.

Parameters
`codec`	AudioCodec!: The AudioCodec to be used.

Exceptions
`java.lang.IllegalArgumentException`	if its type is used by DTMF.
`java.lang.IllegalStateException`	if the stream is busy.

setDtmfType

Added in API level 12

open fun setDtmfType(type: Int): Unit

Deprecated: Deprecated in Java.

Sets the RTP payload type for dual-tone multi-frequency (DTMF) digits. The primary usage is to send digits to the remote gateway to perform certain tasks, such as second-stage dialing. According to RFC 2833, the RTP payload type for DTMF is assigned dynamically, so it must be in the range of 96 and 127. One can use -1 to disable DTMF and free up the previous assigned type. This method cannot be called when the stream already joined an AudioGroup.

Parameters
`type`	Int: The RTP payload type to be used or `-1` to disable it.

Exceptions
`java.lang.IllegalArgumentException`	if the type is invalid or used by codec.
`java.lang.IllegalStateException`	if the stream is busy.

See Also

android.net.rtp.AudioGroup#sendDtmf(int)