Class AudioFormat

An audio format.

Inheritance

System.Object

MediaFormat<AudioFormat>

AudioFormat

Format

Inherited Members

MediaFormat<AudioFormat>.RedName

MediaFormat<AudioFormat>.UlpFecName

MediaFormat<AudioFormat>.Name

MediaFormat<AudioFormat>.ClockRate

MediaFormat<AudioFormat>.IsPacketized

MediaFormat<AudioFormat>.PacketizationMode

MediaFormat<AudioFormat>.Profile

MediaFormat<AudioFormat>.Level

MediaFormat<AudioFormat>.Tier

MediaFormat<AudioFormat>.LevelIsStrict

MediaFormat<AudioFormat>.IsEncrypted

MediaFormat<AudioFormat>.IsInjected

MediaFormat<AudioFormat>.IsFixedBitrate

MediaFormat<AudioFormat>.FullName

MediaFormat<AudioFormat>.StaticPayloadType

MediaFormat<AudioFormat>.MinBitrate

MediaFormat<AudioFormat>.MaxBitrate

MediaFormat<AudioFormat>.IsEquivalent(AudioFormat)

MediaFormat<AudioFormat>.IsProfileCompatible(String)

MediaFormat<AudioFormat>.IsLevelCompatible(String)

MediaFormat<AudioFormat>.UpdateProfileToCompatible(AudioFormat)

MediaFormat<AudioFormat>.UpdateLevelToCompatible(AudioFormat)

MediaFormat<AudioFormat>.UpdateLevelIsStrictToCompatible(AudioFormat)

MediaFormat<AudioFormat>.UpdateTierToCompatible(AudioFormat)

MediaFormat<AudioFormat>.GetMinLevel(String, String)

MediaFormat<AudioFormat>.GetMaxLevel(String, String)

MediaFormat<AudioFormat>.ToString()

Namespace: FM.LiveSwitch

Assembly: FM.LiveSwitch.dll

Syntax

public class AudioFormat : MediaFormat<AudioFormat>

Constructors

AudioFormat()

Initializes a new instance of the AudioFormat class.

Declaration

protected AudioFormat()

AudioFormat(String, AudioConfig)

Initializes a new instance of the AudioFormat class.

Declaration

public AudioFormat(string name, AudioConfig config)

Parameters

Type	Name	Description
System.String	name	The name.
AudioConfig	config	The configuration.

AudioFormat(String, Int32, Int32)

Initializes a new instance of the AudioFormat class.

Declaration

public AudioFormat(string name, int clockRate, int channelCount)

Parameters

Type	Name	Description
System.String	name	The name.
System.Int32	clockRate	The clock rate.
System.Int32	channelCount	The channel count.

Properties

ChannelCount

Gets or sets the channel count.

Declaration

public int ChannelCount { get; set; }

Property Value

Type	Description
System.Int32

Config

Gets the clock rate and channel count as a configuration.

Declaration

public AudioConfig Config { get; }

Property Value

Type	Description
AudioConfig

DtmfName

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

Declaration

public static string DtmfName { get; }

Property Value

Type	Description
System.String

G722Name

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

Declaration

public static string G722Name { get; }

Property Value

Type	Description
System.String

Info

Gets this format as an info object.

Declaration

public override FormatInfo Info { get; }

Property Value

Type	Description
FormatInfo

Overrides

FM.LiveSwitch.MediaFormat<FM.LiveSwitch.AudioFormat>.Info

IsCompressed

Gets whether this is a compressed format.

Declaration

public override bool IsCompressed { get; }

Property Value

Type	Description
System.Boolean

Overrides

FM.LiveSwitch.MediaFormat<FM.LiveSwitch.AudioFormat>.IsCompressed

IsDtmf

Gets a value indicating whether this format is DTMF.

Declaration

public bool IsDtmf { get; }

Property Value

Type	Description
System.Boolean

IsG722

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

Declaration

public bool IsG722 { get; }

Property Value

Type	Description
System.Boolean

IsL16

Gets a value indicating whether this format is L16.

Declaration

public bool IsL16 { get; }

Property Value

Type	Description
System.Boolean

IsOpus

Gets a value indicating whether this format is Opus.

Declaration

public bool IsOpus { get; }

Property Value

Type	Description
System.Boolean

IsPcm

Gets a value indicating whether this format is PCM.

Declaration

public bool IsPcm { get; }

Property Value

Type	Description
System.Boolean

IsPcma

Gets a value indicating whether this format is PCMA.

Declaration

public bool IsPcma { get; }

Property Value

Type	Description
System.Boolean

IsPcmu

Gets a value indicating whether this format is PCMU.

Declaration

public bool IsPcmu { get; }

Property Value

Type	Description
System.Boolean

L16Name

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

Declaration

public static string L16Name { get; }

Property Value

Type	Description
System.String

LittleEndian

Gets or sets whether the format uses little endian byte order.

Declaration

public bool LittleEndian { get; set; }

Property Value

Type	Description
System.Boolean

OpusName

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

Declaration

public static string OpusName { get; }

Property Value

Type	Description
System.String

Parameters

Gets the parameters.

Declaration

public override string Parameters { get; }

Property Value

Type	Description
System.String

Overrides

FM.LiveSwitch.MediaFormat<FM.LiveSwitch.AudioFormat>.Parameters

PcmaName

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

Declaration

public static string PcmaName { get; }

Property Value

Type	Description
System.String

PcmName

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

Declaration

public static string PcmName { get; }

Property Value

Type	Description
System.String

PcmuName

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

Declaration

public static string PcmuName { get; }

Property Value

Type	Description
System.String

Methods

Clone()

Clones this instance.

Declaration

public override AudioFormat Clone()

Returns

Type	Description
AudioFormat

Overrides

FM.LiveSwitch.MediaFormat<FM.LiveSwitch.AudioFormat>.Clone()

CreateInstance()

Creates a new instance.

Declaration

protected override AudioFormat CreateInstance()

Returns

Type	Description
AudioFormat

Overrides

FM.LiveSwitch.MediaFormat<FM.LiveSwitch.AudioFormat>.CreateInstance()

FromFormatInfo(FormatInfo)

Transforms a FormatInfo into an AudioFormat.

Declaration

public static AudioFormat FromFormatInfo(FormatInfo info)

Parameters

Type	Name	Description
FormatInfo	info	The format info.

Returns

Type	Description
AudioFormat

FromJson(String)

Deserializes an instance from JSON.

Declaration

public static AudioFormat FromJson(string audioFormatJson)

Parameters

Type	Name	Description
System.String	audioFormatJson	The audio format JSON.

Returns

Type	Description
AudioFormat

IsCompatible(AudioFormat)

Determines whether the specified format is compatible.

Declaration

public override bool IsCompatible(AudioFormat format)

Parameters

Type	Name	Description
AudioFormat	format	The format.

Returns

Type	Description
System.Boolean

Overrides

FM.LiveSwitch.MediaFormat<FM.LiveSwitch.AudioFormat>.IsCompatible(FM.LiveSwitch.AudioFormat)

IsEquivalent(AudioFormat, Boolean)

Determines whether the specified format is equivalent.

Declaration

public override bool IsEquivalent(AudioFormat format, bool ignoreIsPacketized)

Parameters

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

Returns

Type	Description
System.Boolean

Overrides

FM.LiveSwitch.MediaFormat<FM.LiveSwitch.AudioFormat>.IsEquivalent(FM.LiveSwitch.AudioFormat, System.Boolean)

ToJson()

Serializes this instance to JSON.

Declaration

public string ToJson()

Returns

Type	Description
System.String

ToJson(AudioFormat)

Serializes an instance to JSON.

Declaration

public static string ToJson(AudioFormat audioFormat)

Parameters

Type	Name	Description
AudioFormat	audioFormat	The audio format.

Returns

Type	Description
System.String