/ fm / liveswitch / AudioFormat

Class: AudioFormat

fm.liveswitch.AudioFormat

An audio format.

Hierarchy

• MediaFormat<AudioFormat>

  ↳ AudioFormat

  ↳↳ Format

  ↳↳ Format

  ↳↳ Format

  ↳↳ Format

Table of contents

Constructors

• constructor

Methods

• clone
• createInstance
• fmliveswitchAudioFormatInit
• getChannelCount
• getClockRate
• getConfig
• getFullName
• getInfo
• getIsCompressed
• getIsDtmf
• getIsEncrypted
• getIsFixedBitrate
• getIsG722
• getIsInjected
• getIsL16
• getIsOpus
• getIsPacketized
• getIsPcm
• getIsPcma
• getIsPcmu
• getLevel
• getLevelIsStrict
• getLittleEndian
• getMaxBitrate
• getMaxLevel
• getMinBitrate
• getMinLevel
• getName
• getPacketizationMode
• getParameters
• getProfile
• getStaticPayloadType
• getTier
• getTypeString
• isCompatible
• isEquivalent
• isLevelCompatible
• isProfileCompatible
• setChannelCount
• setClockRate
• setIsEncrypted
• setIsFixedBitrate
• setIsInjected
• setIsPacketized
• setLevel
• setLevelIsStrict
• setLittleEndian
• setName
• setPacketizationMode
• setProfile
• setStaticPayloadType
• setTier
• toJson
• toString
• updateLevelIsStrictToCompatible
• updateLevelToCompatible
• updateProfileToCompatible
• updateTierToCompatible
• fromFormatInfo
• fromJson
• getDtmfName
• getG722Name
• getL16Name
• getOpusName
• getPcmName
• getPcmaName
• getPcmuName
• getRedName
• getUlpFecName
• toJson

Constructors

constructor

+ new AudioFormat(): AudioFormat

Initializes a new instance of the [[fm.liveswitch.audioFormat]] class.

Returns: AudioFormat

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:22

+ new AudioFormat(name: string, clockRate: number, channelCount: number): AudioFormat

Initializes a new instance of the [[fm.liveswitch.audioFormat]] class.

Parameters:

Name	Type	Description
name	string	The name.
clockRate	number	The clock rate.
channelCount	number	The channel count.

Returns: AudioFormat

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:28

+ new AudioFormat(name: string, config: AudioConfig): AudioFormat

Initializes a new instance of the [[fm.liveswitch.audioFormat]] class.

Parameters:

Name	Type	Description
name	string	The name.
config	AudioConfig	The configuration.

Returns: AudioFormat

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:37

Methods

clone

▸ clone(): AudioFormat

Clones this instance.

Returns: AudioFormat

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:242

---

createInstance

▸ ProtectedcreateInstance(): AudioFormat

Creates a new instance.

Returns: AudioFormat

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:257

---

fmliveswitchAudioFormatInit

▸ PrivatefmliveswitchAudioFormatInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:18

---

getChannelCount

▸ getChannelCount(): number

Gets the channel count.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:269

---

getClockRate

▸ getClockRate(): number

Gets the clock rate.

Returns: number

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:225

---

getConfig

▸ getConfig(): AudioConfig

Gets the clock rate and channel count as a configuration.

Returns: AudioConfig

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:281

---

getFullName

▸ getFullName(): string

Gets the full name, including clock rate and encoding parameters.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:237

---

getInfo

▸ getInfo(): FormatInfo

Gets this format as an info object.

Returns: FormatInfo

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:293

---

getIsCompressed

▸ getIsCompressed(): boolean

Gets whether this is a compressed format.

Returns: boolean

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:305

---

getIsDtmf

▸ getIsDtmf(): boolean

Gets a value indicating whether this format is DTMF.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:317

---

getIsEncrypted

▸ getIsEncrypted(): boolean

Gets a value indicating that the data is encrypted.

Returns: boolean

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:268

---

getIsFixedBitrate

▸ getIsFixedBitrate(): boolean

Gets a value indicating whether a format only supports fixed bitrate.

Returns: boolean

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:280

---

getIsG722

▸ getIsG722(): boolean

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

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:329

---

getIsInjected

▸ getIsInjected(): boolean

Gets a value indicating that the data is injected into the primary media stream (e.g. DTMF).

Returns: boolean

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:293

---

getIsL16

▸ getIsL16(): boolean

Gets a value indicating whether this format is L16.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:341

---

getIsOpus

▸ getIsOpus(): boolean

Gets a value indicating whether this format is Opus.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:353

---

getIsPacketized

▸ getIsPacketized(): boolean

Gets a value indicating whether the data is packetized.

Returns: boolean

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:305

---

getIsPcm

▸ getIsPcm(): boolean

Gets a value indicating whether this format is PCM.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:365

---

getIsPcma

▸ getIsPcma(): boolean

Gets a value indicating whether this format is PCMA.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:377

---

getIsPcmu

▸ getIsPcmu(): boolean

Gets a value indicating whether this format is PCMU.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:389

---

getLevel

▸ getLevel(): string

Gets the level.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:317

---

getLevelIsStrict

▸ getLevelIsStrict(): boolean

Gets a value indicating whether the level is strict.

Returns: boolean

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:329

---

getLittleEndian

▸ getLittleEndian(): boolean

Gets whether the format uses little endian byte order.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:401

---

getMaxBitrate

▸ getMaxBitrate(): number

Gets the maximum bitrate supported by this format, in kbps.

Returns: number

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:341

---

getMaxLevel

▸ ProtectedgetMaxLevel(level1: string, level2: string): string

Gets the maximum level.

Parameters:

Name	Type	Description
level1	string	The first level.
level2	string	The second level.

Returns: string

The maximum level.

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:356

---

getMinBitrate

▸ getMinBitrate(): number

Gets the minimum bitrate supported by this format, in kbps.

Returns: number

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:368

---

getMinLevel

▸ ProtectedgetMinLevel(level1: string, level2: string): string

Gets the minimum level.

Parameters:

Name	Type	Description
level1	string	The first level.
level2	string	The second level.

Returns: string

The minimum level.

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:383

---

getName

▸ getName(): string

Gets the name.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:395

---

getPacketizationMode

▸ getPacketizationMode(): string

Gets the packetization mode.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:407

---

getParameters

▸ getParameters(): string

Gets the parameters.

Returns: string

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:413

---

getProfile

▸ getProfile(): string

Gets the profile.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:428

---

getStaticPayloadType

▸ getStaticPayloadType(): number

Gets the static payload type, if this format has a static payload type registered with IANA.

Returns: number

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:449

---

getTier

▸ getTier(): string

Gets the tier.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:461

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:10

---

isCompatible

▸ isCompatible(format: AudioFormat): boolean

Determines whether the specified format is compatible.

Parameters:

Name	Type	Description
format	AudioFormat	The format.

Returns: boolean

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:430

---

isEquivalent

▸ isEquivalent(format: AudioFormat, ignoreIsPacketized: boolean): boolean

Determines whether the specified format is equivalent.

Parameters:

Name	Type	Description
format	AudioFormat	The format.
ignoreIsPacketized	boolean	Whether to ignore if the two formats differ in whether they are packetized.

Returns: boolean

Overrides: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:450

---

isLevelCompatible

▸ ProtectedisLevelCompatible(level: string): boolean

Gets whether a level is compatible.

Parameters:

Name	Type	Description
level	string	The level.

Returns: boolean

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:597

---

isProfileCompatible

▸ ProtectedisProfileCompatible(profile: string): boolean

Gets whether a profile is compatible.

Parameters:

Name	Type	Description
profile	string	The profile.

Returns: boolean

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:610

---

setChannelCount

▸ setChannelCount(value: number): void

Sets the channel count.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:462

---

setClockRate

▸ setClockRate(value: number): void

Sets the clock rate.

Parameters:

Name	Type
value	number

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:622

---

setIsEncrypted

▸ setIsEncrypted(value: boolean): void

Sets a value indicating that the data is encrypted.

Parameters:

Name	Type
value	boolean

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:635

---

setIsFixedBitrate

▸ ProtectedsetIsFixedBitrate(value: boolean): void

Sets a value indicating whether a format only supports fixed bitrate.

Parameters:

Name	Type
value	boolean

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:647

---

setIsInjected

▸ setIsInjected(value: boolean): void

Sets a value indicating that the data is injected into the primary media stream (e.g. DTMF).

Parameters:

Name	Type
value	boolean

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:660

---

setIsPacketized

▸ setIsPacketized(value: boolean): void

Sets a value indicating whether the data is packetized.

Parameters:

Name	Type
value	boolean

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:672

---

setLevel

▸ setLevel(value: string): void

Sets the level.

Parameters:

Name	Type
value	string

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:684

---

setLevelIsStrict

▸ setLevelIsStrict(value: boolean): void

Sets a value indicating whether the level is strict.

Parameters:

Name	Type
value	boolean

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:696

---

setLittleEndian

▸ setLittleEndian(value: boolean): void

Sets whether the format uses little endian byte order.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:475

---

setName

▸ setName(value: string): void

Sets the name.

Parameters:

Name	Type
value	string

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:708

---

setPacketizationMode

▸ setPacketizationMode(value: string): void

Sets the packetization mode.

Parameters:

Name	Type
value	string

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:723

---

setProfile

▸ setProfile(value: string): void

Sets the profile.

Parameters:

Name	Type
value	string

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:735

---

setStaticPayloadType

▸ ProtectedsetStaticPayloadType(value: number): void

Sets the static payload type, if this format has a static payload type registered with IANA.

Parameters:

Name	Type
value	number

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:757

---

setTier

▸ setTier(value: string): void

Sets the tier.

Parameters:

Name	Type
value	string

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:770

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:487

---

toString

▸ toString(): string

Returns a string that represents this instance.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:782

---

updateLevelIsStrictToCompatible

▸ ProtectedupdateLevelIsStrictToCompatible(format: AudioFormat): void

Updates the level-is-strict flag to a compatible value.

Parameters:

Name	Type	Description
format	AudioFormat	The format.

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:815

---

updateLevelToCompatible

▸ ProtectedupdateLevelToCompatible(format: AudioFormat): void

Updates the level to a compatible value.

Parameters:

Name	Type	Description
format	AudioFormat	The format.

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:830

---

updateProfileToCompatible

▸ ProtectedupdateProfileToCompatible(format: AudioFormat): void

Updates the profile to a compatible value.

Parameters:

Name	Type	Description
format	AudioFormat	The format.

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:855

---

updateTierToCompatible

▸ ProtectedupdateTierToCompatible(format: AudioFormat): void

Updates the tier to a compatible value.

Parameters:

Name	Type	Description
format	AudioFormat	The format.

Returns: void

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:870

---

fromFormatInfo

▸ StaticfromFormatInfo(info: FormatInfo): AudioFormat

Transforms a FormatInfo into an AudioFormat.

Parameters:

Name	Type	Description
info	FormatInfo	The format info.

Returns: AudioFormat

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:77

---

fromJson

▸ StaticfromJson(audioFormatJson: string): AudioFormat

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
audioFormatJson	string	The audio format JSON.

Returns: AudioFormat

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:93

---

getDtmfName

▸ StaticgetDtmfName(): string

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

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:136

---

getG722Name

▸ StaticgetG722Name(): string

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

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:148

---

getL16Name

▸ StaticgetL16Name(): string

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

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:160

---

getOpusName

▸ StaticgetOpusName(): string

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

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:172

---

getPcmName

▸ StaticgetPcmName(): string

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

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:196

---

getPcmaName

▸ StaticgetPcmaName(): string

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

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:184

---

getPcmuName

▸ StaticgetPcmuName(): string

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

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:208

---

getRedName

▸ StaticgetRedName(): string

Gets the name of the RED media format.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:169

---

getUlpFecName

▸ StaticgetUlpFecName(): string

Gets the name of the ULPFEC media format.

Returns: string

Inherited from: MediaFormat

Defined in: Generated/TypeScript/fm.liveswitch/MediaFormat.ts:181

---

toJson

▸ StatictoJson(audioFormat: AudioFormat): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
audioFormat	AudioFormat	The audio format.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/AudioFormat.ts:221