Added in API level 12
Deprecated in API level 31

Summary: Fields | Methods | Inherited Methods

AudioCodec

Kotlin |Java

public class AudioCodec
extends Object

java.lang.Object
↳	android.net.rtp.AudioCodec

This class was deprecated in API level 31.
SipManager and associated classes are no longer supported and should not be used as the basis of future VOIP apps.

This class defines a collection of audio codecs to be used with AudioStreams. Their parameters are designed to be exchanged using Session Description Protocol (SDP). Most of the values listed here can be found in RFC 3551, while others are described in separated standards.

Few simple configurations are defined as public static instances for the convenience of direct uses. More complicated ones could be obtained using getCodec(int, java.lang.String, java.lang.String). For example, one can use the following snippet to create a mode-1-only AMR codec.

 AudioCodec codec = AudioCodec.getCodec(100, "AMR/8000", "mode-set=1");

See also:

AudioStream

Summary

Fields
`public static final AudioCodec`	`AMR` Adaptive Multi-Rate narrowband audio codec, also known as AMR or AMR-NB.
`public static final AudioCodec`	`GSM` GSM Full-Rate audio codec, also known as GSM-FR, GSM 06.10, GSM, or simply FR.
`public static final AudioCodec`	`GSM_EFR` GSM Enhanced Full-Rate audio codec, also known as GSM-EFR, GSM 06.60, or simply EFR.
`public static final AudioCodec`	`PCMA` G.711 a-law audio codec.
`public static final AudioCodec`	`PCMU` G.711 u-law audio codec.
`public final String`	`fmtp` The format parameters to be used in the corresponding SDP attribute.
`public final String`	`rtpmap` The encoding parameters to be used in the corresponding SDP attribute.
`public final int`	`type` The RTP payload type of the encoding.

Public methods
`static AudioCodec`	`getCodec(int type, String rtpmap, String fmtp)` Creates an AudioCodec according to the given configuration.
`static AudioCodec[]`	`getCodecs()` Returns system supported audio codecs.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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`	`wait(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`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Fields

AMR

Added in API level 12

public static final AudioCodec AMR

Adaptive Multi-Rate narrowband audio codec, also known as AMR or AMR-NB. Currently CRC, robust sorting, and interleaving are not supported. See more details about these features in RFC 4867.

GSM

Added in API level 12

public static final AudioCodec GSM

GSM Full-Rate audio codec, also known as GSM-FR, GSM 06.10, GSM, or simply FR.

GSM_EFR

Added in API level 12

public static final AudioCodec GSM_EFR

GSM Enhanced Full-Rate audio codec, also known as GSM-EFR, GSM 06.60, or simply EFR.

PCMA

Added in API level 12

public static final AudioCodec PCMA

G.711 a-law audio codec.

PCMU

Added in API level 12

public static final AudioCodec PCMU

G.711 u-law audio codec.

fmtp

Added in API level 12

public final String fmtp

The format parameters to be used in the corresponding SDP attribute.

rtpmap

Added in API level 12

public final String rtpmap

The encoding parameters to be used in the corresponding SDP attribute.

type

Added in API level 12

public final int type

The RTP payload type of the encoding.

Public methods

getCodec

Added in API level 12

public static AudioCodec getCodec (int type, 
                String rtpmap, 
                String fmtp)

Creates an AudioCodec according to the given configuration.

Parameters
`type`	`int`: The payload type of the encoding defined in RTP/AVP.
`rtpmap`	`String`: The encoding parameters specified in the corresponding SDP attribute, or null if it is not available.
`fmtp`	`String`: The format parameters specified in the corresponding SDP attribute, or null if it is not available.

Returns
`AudioCodec`	The configured AudioCodec or `null` if it is not supported.

getCodecs

Added in API level 12

public static AudioCodec[] getCodecs ()

Returns system supported audio codecs.

Returns
`AudioCodec[]`