fm.liveswitch.pcma.Format Class Reference

A PCMA (G.711a) format. More...

Public Member Functions

 Format ()
 Initializes a new instance of the fm.liveswitch.pcma.Format class. More...
 
 Format (int clockRate, int channelCount)
 Initializes a new instance of the fm.liveswitch.pcma.Format class. More...
 
 Format (fm.liveswitch.AudioConfig config)
 Initializes a new instance of the fm.liveswitch.pcma.Format class. More...
 
- Public Member Functions inherited from fm.liveswitch.g711.Format
 Format (String name, int clockRate, int channelCount)
 Initializes a new instance of the fm.liveswitch.g711.Format class. More...
 
int getMaxBitrate ()
 Gets the maximum bitrate supported by this format, in kbps. More...
 
int getMinBitrate ()
 Gets the minimum bitrate supported by this format, in kbps. More...
 
- Public Member Functions inherited from fm.liveswitch.AudioFormat
 AudioFormat (String name, int clockRate, int channelCount)
 Initializes a new instance of the fm.liveswitch.AudioFormat class. More...
 
 AudioFormat (String name, fm.liveswitch.AudioConfig config)
 Initializes a new instance of the fm.liveswitch.AudioFormat class. More...
 
fm.liveswitch.AudioFormat clone ()
 Clones this instance. More...
 
int getChannelCount ()
 Gets the channel count. More...
 
fm.liveswitch.AudioConfig getConfig ()
 Gets the clock rate and channel count as a configuration. More...
 
fm.liveswitch.FormatInfo getInfo ()
 Gets this format as an info object. More...
 
boolean getIsCompressed ()
 Gets whether this is a compressed format. More...
 
boolean getIsDtmf ()
 Gets a value indicating whether this format is DTMF. More...
 
boolean getIsG722 ()
 Gets a value indicating whether this format is G.722. More...
 
boolean getIsL16 ()
 Gets a value indicating whether this format is L16. More...
 
boolean getIsOpus ()
 Gets a value indicating whether this format is Opus. More...
 
boolean getIsPcm ()
 Gets a value indicating whether this format is PCM. More...
 
boolean getIsPcma ()
 Gets a value indicating whether this format is PCMA. More...
 
boolean getIsPcmu ()
 Gets a value indicating whether this format is PCMU. More...
 
boolean getLittleEndian ()
 Gets whether the format uses little endian byte order. More...
 
String getParameters ()
 Gets the parameters. More...
 
boolean isCompatible (fm.liveswitch.AudioFormat format)
 Determines whether the specified format is compatible. More...
 
boolean isEquivalent (fm.liveswitch.AudioFormat format, boolean ignoreIsPacketized)
 Determines whether the specified format is equivalent. More...
 
void setChannelCount (int value)
 Sets the channel count. More...
 
void setLittleEndian (boolean value)
 Sets whether the format uses little endian byte order. More...
 
String toJson ()
 Serializes this instance to JSON. More...
 

Protected Member Functions

fm.liveswitch.AudioFormat createInstance ()
 Creates a new instance. More...
 
- Protected Member Functions inherited from fm.liveswitch.AudioFormat
 AudioFormat ()
 Initializes a new instance of the fm.liveswitch.AudioFormat class. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from fm.liveswitch.g711.Format
static int getDefaultChannelCount ()
 Gets the default clock rate (1). More...
 
static int getDefaultClockRate ()
 Gets the default clock rate (8000). More...
 
static fm.liveswitch.AudioConfig getDefaultConfig ()
 Gets the default configuration (8000/1). More...
 
- Static Public Member Functions inherited from fm.liveswitch.AudioFormat
static fm.liveswitch.AudioFormat fromFormatInfo (fm.liveswitch.FormatInfo info)
 Transforms a FormatInfo into an AudioFormat. More...
 
static fm.liveswitch.AudioFormat fromJson (String audioFormatJson)
 Deserializes an instance from JSON. More...
 
static String getDtmfName ()
 Gets the name of the DTMF audio format ("telephone-event"). More...
 
static String getG722Name ()
 Gets the name of the G.722 audio format ("G722"). More...
 
static String getL16Name ()
 Gets the name of the Linear PCM 16-bit audio (PCM Uncompressed). More...
 
static String getOpusName ()
 Gets the name of the Opus audio format ("opus"). More...
 
static String getPcmaName ()
 Gets the name of the PCMA audio format ("PCMA"). More...
 
static String getPcmName ()
 Gets the name of the PCM audio format ("PCM"). More...
 
static String getPcmuName ()
 Gets the name of the PCMU audio format ("PCMU"). More...
 
static String toJson (final fm.liveswitch.AudioFormat audioFormat)
 Serializes an instance to JSON. More...
 

Detailed Description

A PCMA (G.711a) format.

Constructor & Destructor Documentation

◆ Format() [1/3]

fm.liveswitch.pcma.Format.Format ( )

Initializes a new instance of the fm.liveswitch.pcma.Format class.

◆ Format() [2/3]

fm.liveswitch.pcma.Format.Format ( int  clockRate,
int  channelCount 
)

Initializes a new instance of the fm.liveswitch.pcma.Format class.

Parameters
clockRateThe clock rate.
channelCountThe channel count.

◆ Format() [3/3]

fm.liveswitch.pcma.Format.Format ( fm.liveswitch.AudioConfig  config)

Initializes a new instance of the fm.liveswitch.pcma.Format class.

Parameters
configThe configuration.

Member Function Documentation

◆ createInstance()

fm.liveswitch.AudioFormat fm.liveswitch.pcma.Format.createInstance ( )
protected

Creates a new instance.

Reimplemented from fm.liveswitch.AudioFormat.