FMIceLinkDtmfTone Class Reference

Inherits from NSObject
Declared in FMIceLinkDtmfTone.h
FMIceLinkDtmfTone.m

Overview

A DTMF (telephone-event) t[one](#//api/name/one).

+ a

Gets A [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)a

Discussion

Gets A [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ aValue

Gets the A [value](#//api/name/value) ("A").
+ (NSString *)aValue

Discussion

Gets the A [value](#//api/name/value) ("A").

Declared In

FMIceLinkDtmfTone.h

+ b

Gets the B [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)b

Discussion

Gets the B [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ bValue

Gets the B [value](#//api/name/value) ("B").
+ (NSString *)bValue

Discussion

Gets the B [value](#//api/name/value) ("B").

Declared In

FMIceLinkDtmfTone.h

+ c

Gets the C [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)c

Discussion

Gets the C [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

– clone

Clones this instance.
- (FMIceLinkDtmfTone *)clone

Discussion

Clones this instance.

Declared In

FMIceLinkDtmfTone.h

+ cValue

Gets the C [value](#//api/name/value) ("C").
+ (NSString *)cValue

Discussion

Gets the C [value](#//api/name/value) ("C").

Declared In

FMIceLinkDtmfTone.h

+ d

Gets the D [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)d

Discussion

Gets the D [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

– description

Serializes to [a](#//api/name/a) string.

@return

- (NSString *)description

Discussion

Serializes to [a](#//api/name/a) string.

@return

Declared In

FMIceLinkDtmfTone.h

– duration

Gets the duration in milliseconds.
- (int)duration

Discussion

Gets the duration in milliseconds.

Declared In

FMIceLinkDtmfTone.h

+ dValue

Gets the D [value](#//api/name/value) ("D").
+ (NSString *)dValue

Discussion

Gets the D [value](#//api/name/value) ("D").

Declared In

FMIceLinkDtmfTone.h

+ eight

Gets the eight [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)eight

Discussion

Gets the eight [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ eightValue

Gets the [eight](#//api/name/eight) [value](#//api/name/value) ("8").
+ (NSString *)eightValue

Discussion

Gets the [eight](#//api/name/eight) [value](#//api/name/value) ("8").

Declared In

FMIceLinkDtmfTone.h

+ empty

Gets the empty [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)empty

Discussion

Gets the empty [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ emptyValue

Gets the [empty](#//api/name/empty) [value](#//api/name/value) ("").
+ (NSString *)emptyValue

Discussion

Gets the [empty](#//api/name/empty) [value](#//api/name/value) ("").

Declared In

FMIceLinkDtmfTone.h

+ five

Gets the five [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)five

Discussion

Gets the five [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ fiveValue

Gets the [five](#//api/name/five) [value](#//api/name/value) ("5").
+ (NSString *)fiveValue

Discussion

Gets the [five](#//api/name/five) [value](#//api/name/value) ("5").

Declared In

FMIceLinkDtmfTone.h

+ four

Gets the four [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)four

Discussion

Gets the four [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ fourValue

Gets the [four](#//api/name/four) [value](#//api/name/value) ("4").
+ (NSString *)fourValue

Discussion

Gets the [four](#//api/name/four) [value](#//api/name/value) ("4").

Declared In

FMIceLinkDtmfTone.h

+ fromJsonArrayWithTonesJson:

Deserializes an array from JSON.
+ (NSMutableArray *)fromJsonArrayWithTonesJson:(NSString *)tonesJson

Parameters

tonesJson

The JSON. @return

Discussion

Deserializes an array from JSON.

Declared In

FMIceLinkDtmfTone.h

+ fromJsonWithToneJson:

Deserializes from JSON.
+ (FMIceLinkDtmfTone *)fromJsonWithToneJson:(NSString *)toneJson

Parameters

toneJson

The JSON. @return

Discussion

Deserializes from JSON.

Declared In

FMIceLinkDtmfTone.h

+ fromPacket:clockRate:

Deserializes from [a](#//api/name/a) packet.
+ (FMIceLinkDtmfTone *)fromPacket:(FMIceLinkDtmfPacket *)packet clockRate:(int)clockRate

Parameters

packet

The packet.
clockRate

The clock rate. @return

Discussion

Deserializes from [a](#//api/name/a) packet.

Declared In

FMIceLinkDtmfTone.h

+ fromToneString:

Converts [a](#//api/name/a) DTMF [tone](#//api/name/tone) string into an array of tones. Each [tone](#//api/name/tone) will have [a](#//api/name/a) [duration](#//api/name/duration) of 100ms an[d](#//api/name/d) an inter[tone](#//api/name/tone) gap of 100ms.
+ (NSMutableArray *)fromToneString:(NSString *)toneString

Parameters

toneString

The tone string. @return

Discussion

Converts [a](#//api/name/a) DTMF [tone](#//api/name/tone) string into an array of tones. Each [tone](#//api/name/tone) will have [a](#//api/name/a) [duration](#//api/name/duration) of 100ms an[d](#//api/name/d) an inter[tone](#//api/name/tone) gap of 100ms.

Declared In

FMIceLinkDtmfTone.h

+ fromToneString:duration:

Converts [a](#//api/name/a) DTMF [tone](#//api/name/tone) string into an array of tones. Each [tone](#//api/name/tone) will have an inter[tone](#//api/name/tone) gap of 100ms.
+ (NSMutableArray *)fromToneString:(NSString *)toneString duration:(int)duration

Parameters

toneString

The tone string.
duration

The duration, in milliseconds (minimum of 40, maximum of 2,000). @return

Discussion

Converts [a](#//api/name/a) DTMF [tone](#//api/name/tone) string into an array of tones. Each [tone](#//api/name/tone) will have an inter[tone](#//api/name/tone) gap of 100ms.

Declared In

FMIceLinkDtmfTone.h

+ fromToneString:duration:interToneGap:

Converts [a](#//api/name/a) DTMF [tone](#//api/name/tone) string into an array of tones.
+ (NSMutableArray *)fromToneString:(NSString *)toneString duration:(int)duration interToneGap:(int)interToneGap

Parameters

toneString

The tone string.
duration

The duration, in milliseconds (minimum of 40, maximum of 2,000).
interToneGap

The time between tones, in milliseconds (minimum of 40). @return

Discussion

Converts [a](#//api/name/a) DTMF [tone](#//api/name/tone) string into an array of tones.

Declared In

FMIceLinkDtmfTone.h

+ hash

Gets the hash [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)hash

Discussion

Gets the hash [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ hashValue

Gets the [hash](#//api/name/hash) [value](#//api/name/value) ("#").
+ (NSString *)hashValue

Discussion

Gets the [hash](#//api/name/hash) [value](#//api/name/value) ("#").

Declared In

FMIceLinkDtmfTone.h

– initWithValue:

Initializes [a](#//api/name/a) new instance of the FMIceLinkDtmfT[one](#//api/name/one) class.
- (instancetype)initWithValue:(NSString *)value

Parameters

value

The value.

Discussion

Initializes [a](#//api/name/a) new instance of the FMIceLinkDtmfT[one](#//api/name/one) class.

Declared In

FMIceLinkDtmfTone.h

– initWithValue:duration:

Initializes [a](#//api/name/a) new instance of the FMIceLinkDtmfT[one](#//api/name/one) class.
- (instancetype)initWithValue:(NSString *)value duration:(int)duration

Parameters

value

The value.
duration

The duration.

Discussion

Initializes [a](#//api/name/a) new instance of the FMIceLinkDtmfT[one](#//api/name/one) class.

Declared In

FMIceLinkDtmfTone.h

+ nine

Gets the nine [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)nine

Discussion

Gets the nine [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ nineValue

Gets the [nine](#//api/name/nine) [value](#//api/name/value) ("9").
+ (NSString *)nineValue

Discussion

Gets the [nine](#//api/name/nine) [value](#//api/name/value) ("9").

Declared In

FMIceLinkDtmfTone.h

+ one

Gets the one [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)one

Discussion

Gets the one [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ oneValue

Gets the [one](#//api/name/one) [value](#//api/name/value) ("1").
+ (NSString *)oneValue

Discussion

Gets the [one](#//api/name/one) [value](#//api/name/value) ("1").

Declared In

FMIceLinkDtmfTone.h

+ pause

Gets the pause [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)pause

Discussion

Gets the pause [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ pauseDuration

Gets the [pause](#//api/name/pause) [duration](#//api/name/duration) in milliseconds (2000).
+ (int)pauseDuration

Discussion

Gets the [pause](#//api/name/pause) [duration](#//api/name/duration) in milliseconds (2000).

Declared In

FMIceLinkDtmfTone.h

+ pauseValue

Gets the [pause](#//api/name/pause) [value](#//api/name/value) (",").
+ (NSString *)pauseValue

Discussion

Gets the [pause](#//api/name/pause) [value](#//api/name/value) (",").

Declared In

FMIceLinkDtmfTone.h

+ seven

Gets the seven [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)seven

Discussion

Gets the seven [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ sevenValue

Gets the [seven](#//api/name/seven) [value](#//api/name/value) ("7").
+ (NSString *)sevenValue

Discussion

Gets the [seven](#//api/name/seven) [value](#//api/name/value) ("7").

Declared In

FMIceLinkDtmfTone.h

+ six

Gets the six [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)six

Discussion

Gets the six [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ sixValue

Gets the [six](#//api/name/six) [value](#//api/name/value) ("6").
+ (NSString *)sixValue

Discussion

Gets the [six](#//api/name/six) [value](#//api/name/value) ("6").

Declared In

FMIceLinkDtmfTone.h

+ star

Gets the star [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)star

Discussion

Gets the star [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ starValue

Gets the [star](#//api/name/star) [value](#//api/name/value) ("*").
+ (NSString *)starValue

Discussion

Gets the [star](#//api/name/star) [value](#//api/name/value) ("*").

Declared In

FMIceLinkDtmfTone.h

+ three

Gets the three [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)three

Discussion

Gets the three [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ threeValue

Gets the [three](#//api/name/three) [value](#//api/name/value) ("3").
+ (NSString *)threeValue

Discussion

Gets the [three](#//api/name/three) [value](#//api/name/value) ("3").

Declared In

FMIceLinkDtmfTone.h

– toJson

Serializes to JSON.

@return

- (NSString *)toJson

Discussion

Serializes to JSON.

@return

Declared In

FMIceLinkDtmfTone.h

+ toJsonArrayWithTones:

Serializes an array to JSON.
+ (NSString *)toJsonArrayWithTones:(NSMutableArray *)tones

Parameters

tones

The array. @return

Discussion

Serializes an array to JSON.

Declared In

FMIceLinkDtmfTone.h

+ toJsonWithTone:

Serializes to JSON.

@return

+ (NSString *)toJsonWithTone:(FMIceLinkDtmfTone *)tone

Discussion

Serializes to JSON.

@return

Declared In

FMIceLinkDtmfTone.h

+ tone:

Initializes [a](#//api/name/a) new instance of the FMIceLinkDtmfT[one](#//api/name/one) class.
+ (FMIceLinkDtmfTone *)tone:(NSString *)value

Parameters

value

The value.

Discussion

Initializes [a](#//api/name/a) new instance of the FMIceLinkDtmfT[one](#//api/name/one) class.

Declared In

FMIceLinkDtmfTone.h

+ tone:duration:

Initializes [a](#//api/name/a) new instance of the FMIceLinkDtmfT[one](#//api/name/one) class.
+ (FMIceLinkDtmfTone *)tone:(NSString *)value duration:(int)duration

Parameters

value

The value.
duration

The duration.

Discussion

Initializes [a](#//api/name/a) new instance of the FMIceLinkDtmfT[one](#//api/name/one) class.

Declared In

FMIceLinkDtmfTone.h

– toPacketWithClockRate:

Serializes to [a](#//api/name/a) packet.
- (FMIceLinkDtmfPacket *)toPacketWithClockRate:(int)clockRate

Parameters

clockRate

The clock rate. @return

Discussion

Serializes to [a](#//api/name/a) packet.

Declared In

FMIceLinkDtmfTone.h

+ toToneStringWithTones:

Converts an array of DTMF tones into [a](#//api/name/a) [tone](#//api/name/tone) string. This discards [duration](#//api/name/duration) an[d](#//api/name/d) inter[tone](#//api/name/tone) gap dat[a](#//api/name/a).
+ (NSString *)toToneStringWithTones:(NSMutableArray *)tones

Parameters

tones

The tones. @return

Discussion

Converts an array of DTMF tones into [a](#//api/name/a) [tone](#//api/name/tone) string. This discards [duration](#//api/name/duration) an[d](#//api/name/d) inter[tone](#//api/name/tone) gap dat[a](#//api/name/a).

Declared In

FMIceLinkDtmfTone.h

+ two

Gets the two [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)two

Discussion

Gets the two [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ twoValue

Gets the [two](#//api/name/two) [value](#//api/name/value) ("2").
+ (NSString *)twoValue

Discussion

Gets the [two](#//api/name/two) [value](#//api/name/value) ("2").

Declared In

FMIceLinkDtmfTone.h

– value

Gets the value.
- (NSString *)value

Discussion

Gets the value.

Declared In

FMIceLinkDtmfTone.h

+ zero

Gets the zero [tone](#//api/name/tone).
+ (FMIceLinkDtmfTone *)zero

Discussion

Gets the zero [tone](#//api/name/tone).

Declared In

FMIceLinkDtmfTone.h

+ zeroValue

Gets the [zero](#//api/name/zero) [value](#//api/name/value) ("0").
+ (NSString *)zeroValue

Discussion

Gets the [zero](#//api/name/zero) [value](#//api/name/value) ("0").

Declared In

FMIceLinkDtmfTone.h