FMIceLinkAudioFormat Class Reference

Inherits from FMIceLinkMediaFormat : NSObject
Conforms to *
FMIceLinkAudioFormat
Declared in FMIceLinkAudioFormat.h
FMIceLinkAudioFormat.m

Overview

An audio format.

+ audioFormat

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

Discussion

Initializes a new instance of the FMIceLinkAudioFormat class.

Declared In

FMIceLinkAudioFormat.h

+ audioFormatWithName:clockRate:channelCount:

Initializes a new instance of the FMIceLinkAudioFormat class.
+ (FMIceLinkAudioFormat *)audioFormatWithName:(NSString *)name clockRate:(int)clockRate channelCount:(int)channelCount

Parameters

name

The name.
clockRate

The clock rate.
channelCount

The channel count.

Discussion

Initializes a new instance of the FMIceLinkAudioFormat class.

Declared In

FMIceLinkAudioFormat.h

+ audioFormatWithName:config:

Initializes a new instance of the FMIceLinkAudioFormat class.
+ (FMIceLinkAudioFormat *)audioFormatWithName:(NSString *)name config:(FMIceLinkAudioConfig *)config

Parameters

name

The name.
config

The configuration.

Discussion

Initializes a new instance of the FMIceLinkAudioFormat class.

Declared In

FMIceLinkAudioFormat.h

– channelCount

Gets the channel count.
- (int)channelCount

Discussion

Gets the channel count.

Declared In

FMIceLinkAudioFormat.h

– clone

Clones this instance.
- (FMIceLinkAudioFormat *)clone

Discussion

Clones this instance.

Declared In

FMIceLinkAudioFormat.h

– config

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

Discussion

Gets the clock rate and channel count as a configuration.

Declared In

FMIceLinkAudioFormat.h

– createInstance

Creates a new instance.
- (FMIceLinkAudioFormat *)createInstance

Discussion

Creates a new instance.

Declared In

FMIceLinkAudioFormat.h

+ dtmfName

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

Discussion

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

Declared In

FMIceLinkAudioFormat.h

– init

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

Discussion

Initializes a new instance of the FMIceLinkAudioFormat class.

Declared In

FMIceLinkAudioFormat.h

– initWithName:clockRate:channelCount:

Initializes a new instance of the FMIceLinkAudioFormat class.
- (instancetype)initWithName:(NSString *)name clockRate:(int)clockRate channelCount:(int)channelCount

Parameters

name

The name.
clockRate

The clock rate.
channelCount

The channel count.

Discussion

Initializes a new instance of the FMIceLinkAudioFormat class.

Declared In

FMIceLinkAudioFormat.h

– initWithName:config:

Initializes a new instance of the FMIceLinkAudioFormat class.
- (instancetype)initWithName:(NSString *)name config:(FMIceLinkAudioConfig *)config

Parameters

name

The name.
config

The configuration.

Discussion

Initializes a new instance of the FMIceLinkAudioFormat class.

Declared In

FMIceLinkAudioFormat.h

– isDtmf

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

Discussion

Gets a value indicating whether this format is DTMF.

Declared In

FMIceLinkAudioFormat.h

– isEquivalentWithFormat:ignoreIsPacketized:

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

Parameters

format

The format.
ignoreIsPacketized

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

Discussion

Determines whether the specified format is equivalent.

Declared In

FMIceLinkAudioFormat.h

– isOpus

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

Discussion

Gets a value indicating whether this format is Opus.

Declared In

FMIceLinkAudioFormat.h

– isPcm

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

Discussion

Gets a value indicating whether this format is PCM.

Declared In

FMIceLinkAudioFormat.h

– isPcma

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

Discussion

Gets a value indicating whether this format is PCMA.

Declared In

FMIceLinkAudioFormat.h

– isPcmu

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

Discussion

Gets a value indicating whether this format is PCMU.

Declared In

FMIceLinkAudioFormat.h

– littleEndian

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

Discussion

Gets whether the format uses little endian byte order.

Declared In

FMIceLinkAudioFormat.h

+ opusName

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

Discussion

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

Declared In

FMIceLinkAudioFormat.h

– parameters

Gets the parameters.
- (NSString *)parameters

Discussion

Gets the parameters.

Declared In

FMIceLinkAudioFormat.h

+ pcmaName

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

Discussion

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

Declared In

FMIceLinkAudioFormat.h

+ pcmName

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

Discussion

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

Declared In

FMIceLinkAudioFormat.h

+ pcmuName

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

Discussion

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

Declared In

FMIceLinkAudioFormat.h

– setChannelCount:

Sets the channel count.
- (void)setChannelCount:(int)value

Discussion

Sets the channel count.

Declared In

FMIceLinkAudioFormat.h

– setLittleEndian:

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

Discussion

Sets whether the format uses little endian byte order.

Declared In

FMIceLinkAudioFormat.h