FMIceLinkAudioStream Class Reference

Inherits from FMIceLinkMediaStream : FMIceLinkMediaStreamBase : FMIceLinkStream : FMIceLinkStreamBase : FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Conforms to *
<
>
FMIceLinkAudioBuffer
FMIceLinkAudioBufferCollection
FMIceLinkAudioFormat
FMIceLinkAudioFormatCollection
FMIceLinkAudioFrame
FMIceLinkIAudioInput
FMIceLinkIAudioInputCollection
FMIceLinkIAudioOutput
FMIceLinkIAudioOutputCollection
NSObject
Declared in FMIceLinkAudioStream.h
FMIceLinkAudioStream.m

Overview

An audio stream.

– addOnReceiveDtmfTone:

Adds a handler that is raised when a DTMF packet is received.
- (void)addOnReceiveDtmfTone:(FMIceLinkAction1 *)value

Discussion

Adds a handler that is raised when a DTMF packet is received.

Declared In

FMIceLinkAudioStream.h

– addOnReceiveDtmfToneChange:

Adds a handler that is raised when the received DTMF tone changes.
- (void)addOnReceiveDtmfToneChange:(FMIceLinkAction1 *)value

Discussion

Adds a handler that is raised when the received DTMF tone changes.

Declared In

FMIceLinkAudioStream.h

– addOnReceiveDtmfToneChangeWithBlock

Adds a handler that is raised when the received DTMF tone changes.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkDtmfTone *) ))addOnReceiveDtmfToneChangeWithBlock

Discussion

Adds a handler that is raised when the received DTMF tone changes.

Declared In

FMIceLinkAudioStream.h

– addOnReceiveDtmfToneChangeWithBlock:

Adds a handler that is raised when the received DTMF tone changes.
- (void)addOnReceiveDtmfToneChangeWithBlock:(void ( ^ ) ( FMIceLinkDtmfTone *))valueBlock

Discussion

Adds a handler that is raised when the received DTMF tone changes.

Declared In

FMIceLinkAudioStream.h

– addOnReceiveDtmfToneWithBlock

Adds a handler that is raised when a DTMF packet is received.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkDtmfTone *) ))addOnReceiveDtmfToneWithBlock

Discussion

Adds a handler that is raised when a DTMF packet is received.

Declared In

FMIceLinkAudioStream.h

– addOnReceiveDtmfToneWithBlock:

Adds a handler that is raised when a DTMF packet is received.
- (void)addOnReceiveDtmfToneWithBlock:(void ( ^ ) ( FMIceLinkDtmfTone *))valueBlock

Discussion

Adds a handler that is raised when a DTMF packet is received.

Declared In

FMIceLinkAudioStream.h

– addOnSendDtmfTone:

Adds a handler that is raised when a DTMF packet is sent.
- (void)addOnSendDtmfTone:(FMIceLinkAction1 *)value

Discussion

Adds a handler that is raised when a DTMF packet is sent.

Declared In

FMIceLinkAudioStream.h

– addOnSendDtmfToneChange:

Adds a handler that is raised when the sent DTMF tone changes.
- (void)addOnSendDtmfToneChange:(FMIceLinkAction1 *)value

Discussion

Adds a handler that is raised when the sent DTMF tone changes.

Declared In

FMIceLinkAudioStream.h

– addOnSendDtmfToneChangeWithBlock

Adds a handler that is raised when the sent DTMF tone changes.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkDtmfTone *) ))addOnSendDtmfToneChangeWithBlock

Discussion

Adds a handler that is raised when the sent DTMF tone changes.

Declared In

FMIceLinkAudioStream.h

– addOnSendDtmfToneChangeWithBlock:

Adds a handler that is raised when the sent DTMF tone changes.
- (void)addOnSendDtmfToneChangeWithBlock:(void ( ^ ) ( FMIceLinkDtmfTone *))valueBlock

Discussion

Adds a handler that is raised when the sent DTMF tone changes.

Declared In

FMIceLinkAudioStream.h

– addOnSendDtmfToneWithBlock

Adds a handler that is raised when a DTMF packet is sent.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkDtmfTone *) ))addOnSendDtmfToneWithBlock

Discussion

Adds a handler that is raised when a DTMF packet is sent.

Declared In

FMIceLinkAudioStream.h

– addOnSendDtmfToneWithBlock:

Adds a handler that is raised when a DTMF packet is sent.
- (void)addOnSendDtmfToneWithBlock:(void ( ^ ) ( FMIceLinkDtmfTone *))valueBlock

Discussion

Adds a handler that is raised when a DTMF packet is sent.

Declared In

FMIceLinkAudioStream.h

+ audioStream

Initializes a new instance of the FMIceLinkAudioStream class.
+ (FMIceLinkAudioStream *)audioStream

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

+ audioStreamWithInput:

Initializes a new instance of the FMIceLinkAudioStream class.
+ (FMIceLinkAudioStream *)audioStreamWithInput:(NSObject<FMIceLinkIAudioOutput> *)input

Parameters

input

The input.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

+ audioStreamWithInput:output:

Initializes a new instance of the FMIceLinkAudioStream class.
+ (FMIceLinkAudioStream *)audioStreamWithInput:(NSObject<FMIceLinkIAudioOutput> *)input output:(NSObject<FMIceLinkIAudioInput> *)output

Parameters

input

The input.
output

The output.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

+ audioStreamWithInputs:

Initializes a new instance of the FMIceLinkAudioStream class.
+ (FMIceLinkAudioStream *)audioStreamWithInputs:(NSMutableArray *)inputs

Parameters

inputs

The inputs.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

+ audioStreamWithInputs:outputs:

Initializes a new instance of the FMIceLinkAudioStream class.
+ (FMIceLinkAudioStream *)audioStreamWithInputs:(NSMutableArray *)inputs outputs:(NSMutableArray *)outputs

Parameters

inputs

The inputs.
outputs

The outputs.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

+ audioStreamWithLocalMedia:

Initializes a new instance of the FMIceLinkAudioStream class.
+ (FMIceLinkAudioStream *)audioStreamWithLocalMedia:(FMIceLinkLocalMedia *)localMedia

Parameters

localMedia

The local media.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

+ audioStreamWithLocalMedia:remoteMedia:

Initializes a new instance of the FMIceLinkAudioStream class.
+ (FMIceLinkAudioStream *)audioStreamWithLocalMedia:(FMIceLinkLocalMedia *)localMedia remoteMedia:(FMIceLinkRemoteMedia *)remoteMedia

Parameters

localMedia

The local media.
remoteMedia

The remote media.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

+ audioStreamWithLocalTrack:

Initializes a new instance of the FMIceLinkAudioStream class.
+ (FMIceLinkAudioStream *)audioStreamWithLocalTrack:(FMIceLinkAudioTrack *)localTrack

Parameters

localTrack

The local track.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

+ audioStreamWithLocalTrack:remoteTrack:

Initializes a new instance of the FMIceLinkAudioStream class.
+ (FMIceLinkAudioStream *)audioStreamWithLocalTrack:(FMIceLinkAudioTrack *)localTrack remoteTrack:(FMIceLinkAudioTrack *)remoteTrack

Parameters

localTrack

The local track.
remoteTrack

The remote track.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

+ audioStreamWithOutput:

Initializes a new instance of the FMIceLinkAudioStream class.
+ (FMIceLinkAudioStream *)audioStreamWithOutput:(NSObject<FMIceLinkIAudioInput> *)output

Parameters

output

The output.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

+ audioStreamWithOutputs:

Initializes a new instance of the FMIceLinkAudioStream class.
+ (FMIceLinkAudioStream *)audioStreamWithOutputs:(NSMutableArray *)outputs

Parameters

outputs

The outputs.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

+ audioStreamWithRemoteMedia:

Initializes a new instance of the FMIceLinkAudioStream class.
+ (FMIceLinkAudioStream *)audioStreamWithRemoteMedia:(FMIceLinkRemoteMedia *)remoteMedia

Parameters

remoteMedia

The remote media.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

– config

Gets the output configuration. (Alias for FMIceLinkAudioStream#[outputConfig](#//api/name/outputConfig).)
- (FMIceLinkAudioConfig *)config

Discussion

Gets the output configuration. (Alias for FMIceLinkAudioStream#[outputConfig](#//api/name/outputConfig).)

Declared In

FMIceLinkAudioStream.h

– createFormatWithAttribute:

Creates a format.
- (FMIceLinkAudioFormat *)createFormatWithAttribute:(FMIceLinkSdpRtpMapAttribute *)attribute

Parameters

attribute

The attribute.

Discussion

Creates a format.

Declared In

FMIceLinkAudioStream.h

– createFormatWithName:clockRate:parameters:payloadType:

Creates a format.
- (FMIceLinkAudioFormat *)createFormatWithName:(NSString *)name clockRate:(int)clockRate parameters:(NSString *)parameters payloadType:(int)payloadType

Parameters

name

The format name.
clockRate

The clock rate.
parameters

The parameters.
payloadType

The payload type.

Discussion

Creates a format.

Declared In

FMIceLinkAudioStream.h

– createInputCollectionWithOutput:

Creates an input collection.
- (FMIceLinkIAudioInputCollection *)createInputCollectionWithOutput:(NSObject<FMIceLinkIAudioOutput> *)output

Parameters

output

The output.

Discussion

Creates an input collection.

Declared In

FMIceLinkAudioStream.h

– createMediaFormatCollection

Creates a media format collection.
- (FMIceLinkAudioFormatCollection *)createMediaFormatCollection

Discussion

Creates a media format collection.

Declared In

FMIceLinkAudioStream.h

– createOutputCollectionWithInput:

Creates an output collection.
- (FMIceLinkIAudioOutputCollection *)createOutputCollectionWithInput:(NSObject<FMIceLinkIAudioInput> *)input

Parameters

input

The input.

Discussion

Creates an output collection.

Declared In

FMIceLinkAudioStream.h

– formatArrayFromListWithFormatList:

Creates a format array from a format list.
- (NSMutableArray *)formatArrayFromListWithFormatList:(NSMutableArray *)formatList

Parameters

formatList

The format list.

Discussion

Creates a format array from a format list.

Declared In

FMIceLinkAudioStream.h

– gain

Gets a value indicating the gain (input amplification) of this sink. Any value greater than or equal to 0.0 is acceptable. Currently, this value is not used since audio streams require packetized input/output formats.
- (double)gain

Discussion

Gets a value indicating the gain (input amplification) of this sink. Any value greater than or equal to 0.0 is acceptable. Currently, this value is not used since audio streams require packetized input/output formats.

Declared In

FMIceLinkAudioStream.h

– init

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

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

– initWithInput:

Initializes a new instance of the FMIceLinkAudioStream class.
- (instancetype)initWithInput:(NSObject<FMIceLinkIAudioOutput> *)input

Parameters

input

The input.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

– initWithInput:output:

Initializes a new instance of the FMIceLinkAudioStream class.
- (instancetype)initWithInput:(NSObject<FMIceLinkIAudioOutput> *)input output:(NSObject<FMIceLinkIAudioInput> *)output

Parameters

input

The input.
output

The output.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

– initWithInputs:

Initializes a new instance of the FMIceLinkAudioStream class.
- (instancetype)initWithInputs:(NSMutableArray *)inputs

Parameters

inputs

The inputs.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

– initWithInputs:outputs:

Initializes a new instance of the FMIceLinkAudioStream class.
- (instancetype)initWithInputs:(NSMutableArray *)inputs outputs:(NSMutableArray *)outputs

Parameters

inputs

The inputs.
outputs

The outputs.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

– initWithLocalMedia:

Initializes a new instance of the FMIceLinkAudioStream class.
- (instancetype)initWithLocalMedia:(FMIceLinkLocalMedia *)localMedia

Parameters

localMedia

The local media.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

– initWithLocalMedia:remoteMedia:

Initializes a new instance of the FMIceLinkAudioStream class.
- (instancetype)initWithLocalMedia:(FMIceLinkLocalMedia *)localMedia remoteMedia:(FMIceLinkRemoteMedia *)remoteMedia

Parameters

localMedia

The local media.
remoteMedia

The remote media.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

– initWithLocalTrack:

Initializes a new instance of the FMIceLinkAudioStream class.
- (instancetype)initWithLocalTrack:(FMIceLinkAudioTrack *)localTrack

Parameters

localTrack

The local track.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

– initWithLocalTrack:remoteTrack:

Initializes a new instance of the FMIceLinkAudioStream class.
- (instancetype)initWithLocalTrack:(FMIceLinkAudioTrack *)localTrack remoteTrack:(FMIceLinkAudioTrack *)remoteTrack

Parameters

localTrack

The local track.
remoteTrack

The remote track.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

– initWithOutput:

Initializes a new instance of the FMIceLinkAudioStream class.
- (instancetype)initWithOutput:(NSObject<FMIceLinkIAudioInput> *)output

Parameters

output

The output.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

– initWithOutputs:

Initializes a new instance of the FMIceLinkAudioStream class.
- (instancetype)initWithOutputs:(NSMutableArray *)outputs

Parameters

outputs

The outputs.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

– initWithRemoteMedia:

Initializes a new instance of the FMIceLinkAudioStream class.
- (instancetype)initWithRemoteMedia:(FMIceLinkRemoteMedia *)remoteMedia

Parameters

remoteMedia

The remote media.

Discussion

Initializes a new instance of the FMIceLinkAudioStream class.

Declared In

FMIceLinkAudioStream.h

– inputConfig

Gets the input configuration.
- (FMIceLinkAudioConfig *)inputConfig

Discussion

Gets the input configuration.

Declared In

FMIceLinkAudioStream.h

– insertDtmfTone:

Inserts a DTMF tone.
- (bool)insertDtmfTone:(FMIceLinkDtmfTone *)dtmfTone

Parameters

dtmfTone

The DTMF tone.

Discussion

Inserts a DTMF tone.

Declared In

FMIceLinkAudioStream.h

– insertDtmfTones:

Inserts DTMF tones.
- (bool)insertDtmfTones:(NSMutableArray *)dtmfTones

Parameters

dtmfTones

The DTMF tones.

Discussion

Inserts DTMF tones.

Declared In

FMIceLinkAudioStream.h

– localTrack

Gets the local track, if one was specified.
- (FMIceLinkAudioTrack *)localTrack

Discussion

Gets the local track, if one was specified.

Declared In

FMIceLinkAudioStream.h

– outputConfig

Gets the output configuration.
- (FMIceLinkAudioConfig *)outputConfig

Discussion

Gets the output configuration.

Declared In

FMIceLinkAudioStream.h

– processBandwidthAdapatationPolicyChangeWithPolicy:

Contains logic updating internal policies when bandwidth adapation policy chnages.
- (void)processBandwidthAdapatationPolicyChangeWithPolicy:(FMIceLinkBandwidthAdaptationPolicy)policy

Discussion

Contains logic updating internal policies when bandwidth adapation policy chnages.

Declared In

FMIceLinkAudioStream.h

– remoteTrack

Gets the remote track, if one was specified.
- (FMIceLinkAudioTrack *)remoteTrack

Discussion

Gets the remote track, if one was specified.

Declared In

FMIceLinkAudioStream.h

– removeOnReceiveDtmfTone:

Removes a handler that is raised when a DTMF packet is received.
- (void)removeOnReceiveDtmfTone:(FMIceLinkAction1 *)value

Discussion

Removes a handler that is raised when a DTMF packet is received.

Declared In

FMIceLinkAudioStream.h

– removeOnReceiveDtmfToneChange:

Removes a handler that is raised when the received DTMF tone changes.
- (void)removeOnReceiveDtmfToneChange:(FMIceLinkAction1 *)value

Discussion

Removes a handler that is raised when the received DTMF tone changes.

Declared In

FMIceLinkAudioStream.h

– removeOnSendDtmfTone:

Removes a handler that is raised when a DTMF packet is sent.
- (void)removeOnSendDtmfTone:(FMIceLinkAction1 *)value

Discussion

Removes a handler that is raised when a DTMF packet is sent.

Declared In

FMIceLinkAudioStream.h

– removeOnSendDtmfToneChange:

Removes a handler that is raised when the sent DTMF tone changes.
- (void)removeOnSendDtmfToneChange:(FMIceLinkAction1 *)value

Discussion

Removes a handler that is raised when the sent DTMF tone changes.

Declared In

FMIceLinkAudioStream.h

– setGain:

Sets a value indicating the [gain](#//api/name/gain) (input amplification) of this sink. Any value greater than or equal to 0.0 is acceptable. Currently, this value is not used since audio streams require packetized input/output formats.
- (void)setGain:(double)value

Discussion

Sets a value indicating the [gain](#//api/name/gain) (input amplification) of this sink. Any value greater than or equal to 0.0 is acceptable. Currently, this value is not used since audio streams require packetized input/output formats.

Declared In

FMIceLinkAudioStream.h

– setVolume:

Sets a value indicating the [volume](#//api/name/volume) (output resistance) of this source. Valid value range is 0.0 to 1.0, inclusive. Currently, this value is not used since audio streams require packetized input/output formats.
- (void)setVolume:(double)value

Discussion

Sets a value indicating the [volume](#//api/name/volume) (output resistance) of this source. Valid value range is 0.0 to 1.0, inclusive. Currently, this value is not used since audio streams require packetized input/output formats.

Declared In

FMIceLinkAudioStream.h

– volume

Gets a value indicating the volume (output resistance) of this source. Valid value range is 0.0 to 1.0, inclusive. Currently, this value is not used since audio streams require packetized input/output formats.
- (double)volume

Discussion

Gets a value indicating the volume (output resistance) of this source. Valid value range is 0.0 to 1.0, inclusive. Currently, this value is not used since audio streams require packetized input/output formats.

Declared In

FMIceLinkAudioStream.h