An audio format. More...

Instance Methods
(int)	- channelCount
	Gets the channel count. More...

(FMLiveSwitchAudioFormat *)	- clone
	Clones this instance. More...

(FMLiveSwitchAudioConfig *)	- config
	Gets the clock rate and channel count as a configuration. More...

(FMLiveSwitchAudioFormat *)	- createInstance
	Creates a new instance. More...

(FMLiveSwitchFormatInfo *)	- info
	Gets this format as an info object. More...

(instancetype)	- init
	Initializes a new instance of the FMLiveSwitchAudioFormat class. More...

(instancetype)	- initWithName:clockRate:channelCount:
	Initializes a new instance of the FMLiveSwitchAudioFormat class. More...

(instancetype)	- initWithName:config:
	Initializes a new instance of the FMLiveSwitchAudioFormat class. More...

(bool)	- isAac
	Gets a value indicating whether this format is AAC. More...

(bool)	- isCompatibleWithFormat:
	Determines whether the specified format is compatible. More...

(bool)	- isCompressed
	Gets whether this is a compressed format. More...

(bool)	- isDtmf
	Gets a value indicating whether this format is DTMF. More...

(bool)	- isEquivalentWithFormat:ignoreIsPacketized:
	Determines whether the specified format is equivalent. More...

(bool)	- isG722
	Gets a value indicating whether this format is G.722. More...

(bool)	- isL16
	Gets a value indicating whether this format is L16. More...

(bool)	- isOpus
	Gets a value indicating whether this format is Opus. More...

(bool)	- isPcm
	Gets a value indicating whether this format is PCM. More...

(bool)	- isPcma
	Gets a value indicating whether this format is PCMA. More...

(bool)	- isPcmu
	Gets a value indicating whether this format is PCMU. More...

(bool)	- littleEndian
	Gets whether the format uses little endian byte order. More...

(NSString *)	- parameters
	Gets the parameters. More...

(void)	- setChannelCount:
	Sets the channel count. More...

(void)	- setLittleEndian:
	Sets whether the format uses little endian byte order. More...

(NSString *)	- toJson
	Serializes this instance to JSON. More...

Instance Methods inherited from FMLiveSwitchMediaFormat
(NSString *)	- description
	Returns a string that represents this instance. More...

(NSString *)	- fullName
	Gets the full name, including clock rate and encoding parameters. More...

(NSString *)	- getMaxLevelWithLevel1:level2:
	Gets the maximum level. More...

(NSString *)	- getMinLevelWithLevel1:level2:
	Gets the minimum level. More...

(instancetype)	- initWithName:clockRate:
	Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...

(instancetype)	- initWithName:clockRate:packetizationMode:
	Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...

(instancetype)	- initWithName:clockRate:profile:level:
	Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...

(instancetype)	- initWithName:clockRate:profile:level:packetizationMode:
	Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...

(instancetype)	- initWithName:clockRate:profile:level:packetizationMode:tier:
	Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...

(bool)	- isCompatibleWithFormat:
	Determines whether the specified format is compatible. More...

(bool)	- isEncrypted
	Gets a value indicating that the data is encrypted. More...

(bool)	- isEquivalentWithFormat:
	Determines whether the specified format is equivalent. More...

(bool)	- isEquivalentWithFormat:ignoreIsPacketized:
	Determines whether the specified format is equivalent. More...

(bool)	- isFixedBitrate
	Gets a value indicating whether a format only supports fixed bitrate. More...

(bool)	- isInjected
	Gets a value indicating that the data is injected into the primary media stream (e.g. More...

(bool)	- isLevelCompatibleWithLevel:
	Gets whether a level is compatible. More...

(bool)	- isPacketized
	Gets a value indicating whether the data is packetized. More...

(bool)	- isProfileCompatibleWithProfile:
	Gets whether a profile is compatible. More...

(NSString *)	- level
	Gets the level. More...

(bool)	- levelIsStrict
	Gets a value indicating whether the level is strict. More...

(int)	- maxBitrate
	Gets the maximum bitrate supported by this format, in kbps. More...

(int)	- minBitrate
	Gets the minimum bitrate supported by this format, in kbps. More...

(NSString *)	- name
	Gets the name. More...

(NSString *)	- packetizationMode
	Gets the packetization mode. More...

(NSString *)	- profile
	Gets the profile. More...

(void)	- setClockRate:
	Sets the clock rate. More...

(void)	- setIsEncrypted:
	Sets a value indicating that the data is encrypted. More...

(void)	- setIsFixedBitrate:
	Sets a value indicating whether a format only supports fixed bitrate. More...

(void)	- setIsInjected:
	Sets a value indicating that the data is injected into the primary media stream (e.g. More...

(void)	- setIsPacketized:
	Sets a value indicating whether the data is packetized. More...

(void)	- setLevel:
	Sets the level. More...

(void)	- setLevelIsStrict:
	Sets a value indicating whether the level is strict. More...

(void)	- setName:
	Sets the name. More...

(void)	- setPacketizationMode:
	Sets the packetization mode. More...

(void)	- setProfile:
	Sets the profile. More...

(void)	- setStaticPayloadType:
	Sets the static payload type, if this format has a static payload type registered with IANA. More...

(void)	- setTier:
	Sets the tier. More...

(int)	- staticPayloadType
	Gets the static payload type, if this format has a static payload type registered with IANA. More...

(NSString *)	- tier
	Gets the tier. More...

(void)	- updateLevelIsStrictToCompatibleWithFormat:
	Updates the level-is-strict flag to a compatible value. More...

(void)	- updateLevelToCompatibleWithFormat:
	Updates the level to a compatible value. More...

(void)	- updateProfileToCompatibleWithFormat:
	Updates the profile to a compatible value. More...

(void)	- updateTierToCompatibleWithFormat:
	Updates the tier to a compatible value. More...

Class Methods
(NSString *)	+ aacName
	Gets the name of the AAC audio format ("aac"). More...

(FMLiveSwitchAudioFormat *)	+ audioFormat
	Initializes a new instance of the FMLiveSwitchAudioFormat class. More...

(FMLiveSwitchAudioFormat *)	+ audioFormatWithName:clockRate:channelCount:
	Initializes a new instance of the FMLiveSwitchAudioFormat class. More...

(FMLiveSwitchAudioFormat *)	+ audioFormatWithName:config:
	Initializes a new instance of the FMLiveSwitchAudioFormat class. More...

(NSString *)	+ dtmfName
	Gets the name of the DTMF audio format ("telephone-event"). More...

(FMLiveSwitchAudioFormat *)	+ fromFormatInfo:
	Transforms a FormatInfo into an AudioFormat. More...

(FMLiveSwitchAudioFormat *)	+ fromJsonWithAudioFormatJson:
	Deserializes an instance from JSON. More...

(NSString *)	+ g722Name
	Gets the name of the G.722 audio format ("G722"). More...

(NSString *)	+ l16Name
	Gets the name of the Linear PCM 16-bit audio (PCM Uncompressed). More...

(NSString *)	+ opusName
	Gets the name of the Opus audio format ("opus"). More...

(NSString *)	+ pcmaName
	Gets the name of the PCMA audio format ("PCMA"). More...

(NSString *)	+ pcmName
	Gets the name of the PCM audio format ("PCM"). More...

(NSString *)	+ pcmuName
	Gets the name of the PCMU audio format ("PCMU"). More...

(NSString *)	+ toJsonWithAudioFormat:
	Serializes an instance to JSON. More...

Class Methods inherited from FMLiveSwitchMediaFormat
(FMLiveSwitchMediaFormat *)	+ mediaFormat
	Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...

(FMLiveSwitchMediaFormat *)	+ mediaFormatWithName:clockRate:
	Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...

(FMLiveSwitchMediaFormat *)	+ mediaFormatWithName:clockRate:packetizationMode:
	Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...

(FMLiveSwitchMediaFormat *)	+ mediaFormatWithName:clockRate:profile:level:
	Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...

(FMLiveSwitchMediaFormat *)	+ mediaFormatWithName:clockRate:profile:level:packetizationMode:
	Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...

(FMLiveSwitchMediaFormat *)	+ mediaFormatWithName:clockRate:profile:level:packetizationMode:tier:
	Initializes a new instance of the FMLiveSwitchMediaFormat`1 class. More...

(NSString *)	+ redName
	Gets the name of the RED media format. More...

(NSString *)	+ ulpFecName
	Gets the name of the ULPFEC media format. More...

Additional Inherited Members
Protected Attributes inherited from FMLiveSwitchMediaFormat
	__pad0__: NSObject- (int) clockRate

Detailed Description

An audio format.

Method Documentation

◆ aacName

+ (NSString*) aacName

Gets the name of the AAC audio format ("aac").

◆ audioFormat

+ (FMLiveSwitchAudioFormat*) audioFormat

Initializes a new instance of the FMLiveSwitchAudioFormat class.

◆ audioFormatWithName:clockRate:channelCount:

+ (FMLiveSwitchAudioFormat*) audioFormatWithName:	(NSString *)	name
clockRate:	(int)	clockRate
channelCount:	(int)	channelCount

Initializes a new instance of the FMLiveSwitchAudioFormat class.

Parameters

name	The name.
clockRate	The clock rate.
channelCount	The channel count.

◆ audioFormatWithName:config:

+ (FMLiveSwitchAudioFormat*) audioFormatWithName:	(NSString *)	name
config:	(FMLiveSwitchAudioConfig *)	config

Initializes a new instance of the FMLiveSwitchAudioFormat class.

Parameters

name	The name.
config	The configuration.

◆ channelCount

- (int) channelCount

Gets the channel count.

◆ clone

- (FMLiveSwitchAudioFormat*) clone

Clones this instance.

Implements FMLiveSwitchMediaFormat.

◆ config

- (FMLiveSwitchAudioConfig*) config

Gets the clock rate and channel count as a configuration.

◆ createInstance

- (FMLiveSwitchAudioFormat*) createInstance

Creates a new instance.

Implements FMLiveSwitchMediaFormat.

Implemented in FMLiveSwitchPcmuFormat, FMLiveSwitchPcmaFormat, FMLiveSwitchOpusFormat, and FMLiveSwitchG722Format.

◆ dtmfName

+ (NSString*) dtmfName

Gets the name of the DTMF audio format ("telephone-event").

◆ fromFormatInfo:

+ (FMLiveSwitchAudioFormat*) fromFormatInfo: (FMLiveSwitchFormatInfo *) info

Transforms a FormatInfo into an AudioFormat.

Parameters

info	The format info.

◆ fromJsonWithAudioFormatJson:

+ (FMLiveSwitchAudioFormat*) fromJsonWithAudioFormatJson: (NSString *) audioFormatJson

Deserializes an instance from JSON.

Parameters

audioFormatJson The audio format JSON.

◆ g722Name

+ (NSString*) g722Name

Gets the name of the G.722 audio format ("G722").

◆ info

- (FMLiveSwitchFormatInfo*) info

Gets this format as an info object.

Implements FMLiveSwitchMediaFormat.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchAudioFormat class.

Implements FMLiveSwitchMediaFormat.

Implemented in FMLiveSwitchPcmuFormat, FMLiveSwitchPcmaFormat, FMLiveSwitchOpusFormat, FMLiveSwitchL16Format, FMLiveSwitchG722Format, and FMLiveSwitchDtmfFormat.

◆ initWithName:clockRate:channelCount:

- (instancetype) initWithName:	(NSString *)	name
clockRate:	(int)	clockRate
channelCount:	(int)	channelCount

Initializes a new instance of the FMLiveSwitchAudioFormat class.

Parameters

name	The name.
clockRate	The clock rate.
channelCount	The channel count.

Implemented in FMLiveSwitchG711Format.

◆ initWithName:config:

- (instancetype) initWithName:	(NSString *)	name
config:	(FMLiveSwitchAudioConfig *)	config

Initializes a new instance of the FMLiveSwitchAudioFormat class.

Parameters

name	The name.
config	The configuration.

◆ isAac

- (bool) isAac

Gets a value indicating whether this format is AAC.

◆ isCompatibleWithFormat:

- (bool) isCompatibleWithFormat: (FMLiveSwitchAudioFormat *) format

Determines whether the specified format is compatible.

Parameters

format The format.

◆ isCompressed

- (bool) isCompressed

Gets whether this is a compressed format.

Implements FMLiveSwitchMediaFormat.

◆ isDtmf

- (bool) isDtmf

Gets a value indicating whether this format is DTMF.

◆ isEquivalentWithFormat:ignoreIsPacketized:

- (bool) isEquivalentWithFormat:	(FMLiveSwitchAudioFormat *)	format
ignoreIsPacketized:	(bool)	ignoreIsPacketized

Determines whether the specified format is equivalent.

Parameters

format	The format.
ignoreIsPacketized	Whether to ignore if the two formats differ in whether they are packetized.

◆ isG722

- (bool) isG722

Gets a value indicating whether this format is G.722.

◆ isL16

- (bool) isL16

Gets a value indicating whether this format is L16.

◆ isOpus

- (bool) isOpus

Gets a value indicating whether this format is Opus.

◆ isPcm

- (bool) isPcm

Gets a value indicating whether this format is PCM.

◆ isPcma

- (bool) isPcma

Gets a value indicating whether this format is PCMA.

◆ isPcmu

- (bool) isPcmu

Gets a value indicating whether this format is PCMU.

◆ l16Name

+ (NSString*) l16Name

Gets the name of the Linear PCM 16-bit audio (PCM Uncompressed).

◆ littleEndian

- (bool) littleEndian

Gets whether the format uses little endian byte order.

◆ opusName

+ (NSString*) opusName

Gets the name of the Opus audio format ("opus").

◆ parameters

- (NSString*) parameters

Gets the parameters.

Implements FMLiveSwitchMediaFormat.

◆ pcmaName

+ (NSString*) pcmaName

Gets the name of the PCMA audio format ("PCMA").

◆ pcmName

+ (NSString*) pcmName

Gets the name of the PCM audio format ("PCM").

◆ pcmuName

+ (NSString*) pcmuName

Gets the name of the PCMU audio format ("PCMU").

◆ setChannelCount:

- (void) setChannelCount: (int) value

Sets the channel count.

◆ setLittleEndian:

- (void) setLittleEndian: (bool) value

Sets whether the format uses little endian byte order.

◆ toJson

- (NSString*) toJson

Serializes this instance to JSON.

◆ toJsonWithAudioFormat:

+ (NSString*) toJsonWithAudioFormat: (FMLiveSwitchAudioFormat *) audioFormat

Serializes an instance to JSON.

Parameters

audioFormat The audio format.

Instance Methods

Class Methods

Additional Inherited Members

Detailed Description

Method Documentation

◆ aacName

◆ audioFormat

◆ audioFormatWithName:clockRate:channelCount:

◆ audioFormatWithName:config:

◆ channelCount

◆ clone

◆ config

◆ createInstance

◆ dtmfName

◆ fromFormatInfo:

◆ fromJsonWithAudioFormatJson:

◆ g722Name

◆ info

◆ init

◆ initWithName:clockRate:channelCount:

◆ initWithName:config:

◆ isAac

◆ isCompatibleWithFormat:

◆ isCompressed

◆ isDtmf

◆ isEquivalentWithFormat:ignoreIsPacketized:

◆ isG722

◆ isL16

◆ isOpus

◆ isPcm

◆ isPcma

◆ isPcmu

◆ l16Name

◆ littleEndian

◆ opusName

◆ parameters

◆ pcmaName

◆ pcmName

◆ pcmuName

◆ setChannelCount:

◆ setLittleEndian:

◆ toJson

◆ toJsonWithAudioFormat: