java.lang.Object | ||
↳ | 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
INTERNET
permission.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.net.rtp.RtpStream
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates an AudioStream on the given local address.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the
AudioCodec , or null if it is not set. | |||||||||||
Returns the RTP payload type for dual-tone multi-frequency (DTMF) digits,
or
-1 if it is not enabled. | |||||||||||
Returns the joined
AudioGroup . | |||||||||||
Returns
true if the stream has already joined an
AudioGroup . | |||||||||||
Joins an
AudioGroup . | |||||||||||
Sets the
AudioCodec . | |||||||||||
Sets the RTP payload type for dual-tone multi-frequency (DTMF) digits.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.net.rtp.RtpStream
| |||||||||||
From class
java.lang.Object
|
Creates an AudioStream on the given local address. Note that the local port is assigned automatically to conform with RFC 3550.
address | The network address of the local host to bind to. |
---|
SocketException | if the address cannot be bound or a problem occurs during binding. |
---|
Returns the AudioCodec
, or null
if it is not set.
Returns the RTP payload type for dual-tone multi-frequency (DTMF) digits,
or -1
if it is not enabled.
Returns true
if the stream has already joined an
AudioGroup
.
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
.
group | The AudioGroup to join or null to leave. |
---|
IllegalStateException | if the stream is not properly configured. |
---|
Sets the AudioCodec
.
codec | The AudioCodec to be used. |
---|
IllegalArgumentException | if its type is used by DTMF. |
---|---|
IllegalStateException | if the stream is busy. |
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
.
type | The RTP payload type to be used or -1 to disable it. |
---|
IllegalArgumentException | if the type is invalid or used by codec. |
---|---|
IllegalStateException | if the stream is busy. |