/ fm / liveswitch / opus / Format

Class: Format

liveswitch.opus.Format

An Opus format.

Hierarchy

Table of contents

Constructors

Methods

Constructors

constructor

+ new Format(): Format

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

Returns: Format

Inherited from: AudioFormat

Defined in: Generated/TypeScript/fm.liveswitch/opus/Format.ts:12

+ new Format(clockRate: number, channelCount: number): Format

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

Parameters:

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

Returns: Format

Inherited from: AudioFormat

Defined in: Generated/TypeScript/fm.liveswitch/opus/Format.ts:18

+ new Format(config: AudioConfig): Format

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

Parameters:

Name Type Description
config AudioConfig The configuration.

Returns: Format

Inherited from: AudioFormat

Defined in: Generated/TypeScript/fm.liveswitch/opus/Format.ts:26

Methods

clone

▸ clone(): AudioFormat

Clones this instance.

Returns: AudioFormat

Inherited from: AudioFormat

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

createInstance

▸ ProtectedcreateInstance(): AudioFormat

Creates a new instance.

Returns: AudioFormat

Overrides: AudioFormat

Defined in: Generated/TypeScript/fm.liveswitch/opus/Format.ts:115

getChannelCount

▸ getChannelCount(): number

Gets the channel count.

Returns: number

Inherited from: AudioFormat

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

getClockRate

▸ getClockRate(): number

Gets the clock rate.

Returns: number

Inherited from: AudioFormat

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

getConfig

▸ getConfig(): AudioConfig

Gets the clock rate and channel count as a configuration.

Returns: AudioConfig

Inherited from: AudioFormat

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

getFullName

▸ getFullName(): string

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

Returns: string

Inherited from: AudioFormat

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

getInfo

▸ getInfo(): FormatInfo

Gets this format as an info object.

Returns: FormatInfo

Inherited from: AudioFormat

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

getIsAac

▸ getIsAac(): boolean

Gets a value indicating whether this format is AAC.

Returns: boolean

Inherited from: AudioFormat

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

getIsCompressed

▸ getIsCompressed(): boolean

Gets whether this is a compressed format.

Returns: boolean

Inherited from: AudioFormat

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

getIsDtmf

▸ getIsDtmf(): boolean

Gets a value indicating whether this format is DTMF.

Returns: boolean

Inherited from: AudioFormat

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

getIsEncrypted

▸ getIsEncrypted(): boolean

Gets a value indicating that the data is encrypted.

Returns: boolean

Inherited from: AudioFormat

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: AudioFormat

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

getIsG722

▸ getIsG722(): boolean

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

Returns: boolean

Inherited from: AudioFormat

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

getIsInjected

▸ getIsInjected(): boolean

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

Returns: boolean

Inherited from: AudioFormat

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

getIsL16

▸ getIsL16(): boolean

Gets a value indicating whether this format is L16.

Returns: boolean

Inherited from: AudioFormat

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

getIsOpus

▸ getIsOpus(): boolean

Gets a value indicating whether this format is Opus.

Returns: boolean

Inherited from: AudioFormat

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

getIsPacketized

▸ getIsPacketized(): boolean

Gets a value indicating whether the data is packetized.

Returns: boolean

Inherited from: AudioFormat

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

getIsPcm

▸ getIsPcm(): boolean

Gets a value indicating whether this format is PCM.

Returns: boolean

Inherited from: AudioFormat

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

getIsPcma

▸ getIsPcma(): boolean

Gets a value indicating whether this format is PCMA.

Returns: boolean

Inherited from: AudioFormat

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

getIsPcmu

▸ getIsPcmu(): boolean

Gets a value indicating whether this format is PCMU.

Returns: boolean

Inherited from: AudioFormat

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

getLevel

▸ getLevel(): string

Gets the level.

Returns: string

Inherited from: AudioFormat

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: AudioFormat

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

getLittleEndian

▸ getLittleEndian(): boolean

Gets whether the format uses little endian byte order.

Returns: boolean

Inherited from: AudioFormat

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

getMaxBitrate

▸ getMaxBitrate(): number

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

Returns: number

Overrides: AudioFormat

Defined in: Generated/TypeScript/fm.liveswitch/opus/Format.ts:127

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: AudioFormat

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

getMinBitrate

▸ getMinBitrate(): number

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

Returns: number

Overrides: AudioFormat

Defined in: Generated/TypeScript/fm.liveswitch/opus/Format.ts:139

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: AudioFormat

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

getName

▸ getName(): string

Gets the name.

Returns: string

Inherited from: AudioFormat

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

getPacketizationMode

▸ getPacketizationMode(): string

Gets the packetization mode.

Returns: string

Inherited from: AudioFormat

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

getParameters

▸ getParameters(): string

Gets the parameters.

Returns: string

Inherited from: AudioFormat

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

getProfile

▸ getProfile(): string

Gets the profile.

Returns: string

Inherited from: AudioFormat

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: AudioFormat

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

getTier

▸ getTier(): string

Gets the tier.

Returns: string

Inherited from: AudioFormat

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

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: AudioFormat

Defined in: Generated/TypeScript/fm.liveswitch/opus/Format.ts:10

isCompatible

▸ isCompatible(format: AudioFormat): boolean

Determines whether the specified format is compatible.

Parameters:

Name Type Description
format AudioFormat The format.

Returns: boolean

Inherited from: AudioFormat

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

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

Inherited from: AudioFormat

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

isLevelCompatible

▸ ProtectedisLevelCompatible(level: string): boolean

Gets whether a level is compatible.

Parameters:

Name Type Description
level string The level.

Returns: boolean

Inherited from: AudioFormat

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: AudioFormat

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

Inherited from: AudioFormat

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

setClockRate

▸ setClockRate(value: number): void

Sets the clock rate.

Parameters:

Name Type
value number

Returns: void

Inherited from: AudioFormat

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: AudioFormat

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: AudioFormat

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: AudioFormat

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: AudioFormat

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: AudioFormat

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: AudioFormat

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

Inherited from: AudioFormat

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

setName

▸ setName(value: string): void

Sets the name.

Parameters:

Name Type
value string

Returns: void

Inherited from: AudioFormat

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: AudioFormat

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: AudioFormat

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: AudioFormat

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: AudioFormat

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

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Inherited from: AudioFormat

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

toString

▸ toString(): string

Returns a string that represents this instance.

Returns: string

Inherited from: AudioFormat

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: AudioFormat

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: AudioFormat

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: AudioFormat

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: AudioFormat

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

Inherited from: 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

Inherited from: AudioFormat

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

getAacName

▸ StaticgetAacName(): string

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

Returns: string

Inherited from: AudioFormat

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

getDefaultChannelCount

▸ StaticgetDefaultChannelCount(): number

Gets the default clock rate (2).

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/opus/Format.ts:79

getDefaultClockRate

▸ StaticgetDefaultClockRate(): number

Gets the default clock rate (48000).

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/opus/Format.ts:91

getDefaultConfig

▸ StaticgetDefaultConfig(): AudioConfig

Gets the default configuration (48000/2).

Returns: AudioConfig

Defined in: Generated/TypeScript/fm.liveswitch/opus/Format.ts:103

getDtmfName

▸ StaticgetDtmfName(): string

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

Returns: string

Inherited from: AudioFormat

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

getG722Name

▸ StaticgetG722Name(): string

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

Returns: string

Inherited from: AudioFormat

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

getL16Name

▸ StaticgetL16Name(): string

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

Returns: string

Inherited from: AudioFormat

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

getOpusName

▸ StaticgetOpusName(): string

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

Returns: string

Inherited from: AudioFormat

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

getPcmName

▸ StaticgetPcmName(): string

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

Returns: string

Inherited from: AudioFormat

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

getPcmaName

▸ StaticgetPcmaName(): string

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

Returns: string

Inherited from: AudioFormat

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

getPcmuName

▸ StaticgetPcmuName(): string

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

Returns: string

Inherited from: AudioFormat

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

getRedName

▸ StaticgetRedName(): string

Gets the name of the RED media format.

Returns: string

Inherited from: AudioFormat

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

getUlpFecName

▸ StaticgetUlpFecName(): string

Gets the name of the ULPFEC media format.

Returns: string

Inherited from: AudioFormat

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

Inherited from: AudioFormat

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