AudioStream

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(AudioGroup) with null and put it back after the modification is done.

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

Requires API level 12 (Android 3.1, Honeycomb)

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

Int

MODE_RECEIVE_ONLY

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

Int

MODE_SEND_ONLY

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

Public constructors
`<init>(address: InetAddress!)` Creates an AudioStream on the given local address.

Public methods
open AudioGroup!	`getGroup()` Returns the joined `AudioGroup`.
open Unit	`setDtmfType(type: Int)` Sets the RTP payload type for dual-tone multi-frequency (DTMF) digits.
open Unit	`setCodec(codec: AudioCodec!)` Sets the `AudioCodec`.
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.
Boolean	`isBusy()` Returns `true` if the stream has already joined an `AudioGroup`.
open Unit	`join(group: AudioGroup!)` Joins an `AudioGroup`.

Inherited functions

From class RtpStream

`Unit`	`setMode(mode: Int)` 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)
`InetAddress!`	`getLocalAddress()` Returns the network address of the local host. Requires API level 12 (Android 3.1, Honeycomb)
`Int`	`getLocalPort()` Returns the network port of the local host. Requires API level 12 (Android 3.1, Honeycomb)
`Unit`	`associate(address: InetAddress!, port: Int)` Associates with a remote host. This defines the destination of the outgoing packets. Requires API level 12 (Android 3.1, Honeycomb)
`Unit`	`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. Requires API level 12 (Android 3.1, Honeycomb)
`Int`	`getRemotePort()` Returns the network port of the remote host or `-1` if the stream is not associated. Requires API level 12 (Android 3.1, Honeycomb)
`Int`	`getMode()` Returns the current mode. Requires API level 12 (Android 3.1, Honeycomb)
`Unit`	`release()` Releases allocated resources. The stream becomes inoperable after calling this method. Requires API level 12 (Android 3.1, Honeycomb)
`InetAddress!`	`getRemoteAddress()` Returns the network address of the remote host or `null` if the stream is not associated. Requires API level 12 (Android 3.1, Honeycomb)

Public constructors

<init>

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
`SocketException`	if the address cannot be bound or a problem occurs during binding.

Public methods

getGroup

added in API level 12

open fun getGroup(): AudioGroup!

Returns the joined AudioGroup.
Requires API level 12 (Android 3.1, Honeycomb)

setDtmfType

added in API level 12

open fun setDtmfType(type: Int): Unit

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

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

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

See Also

AudioGroup#sendDtmf(int)

setCodec

added in API level 12

open fun setCodec(codec: AudioCodec!): Unit

Sets the AudioCodec.
Requires API level 12 (Android 3.1, Honeycomb)

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

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

getCodec

added in API level 12

open fun getCodec(): AudioCodec!

Returns the AudioCodec, or null if it is not set.
Requires API level 12 (Android 3.1, Honeycomb)

See Also

#setCodec(AudioCodec)

getDtmfType

added in API level 12

open fun getDtmfType(): Int

Returns the RTP payload type for dual-tone multi-frequency (DTMF) digits, or -1 if it is not enabled.
Requires API level 12 (Android 3.1, Honeycomb)

See Also

#setDtmfType(int)

isBusy

added in API level 12

fun isBusy(): Boolean

Returns true if the stream has already joined an AudioGroup.
Requires API level 12 (Android 3.1, Honeycomb)

join

added in API level 12

open fun join(group: AudioGroup!): Unit

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

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

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

See Also

AudioGroup