FMIceLinkAudioPipe Class Reference

Inherits from	FMIceLinkMediaPipe : FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Conforms to	* < > FMIceLinkAudioBuffer FMIceLinkAudioBufferCollection FMIceLinkAudioFormat FMIceLinkAudioFrame FMIceLinkAudioPipe FMIceLinkIAudioInput FMIceLinkIAudioInputCollection FMIceLinkIAudioOutput FMIceLinkIAudioOutputCollection NSObject
Declared in	FMIceLinkAudioPipe.h FMIceLinkAudioPipe.m

Overview

An audio pipe.

`+ audioPipeWithInputFormat:outputFormat:`

Initializes a new instance of the FMIceLinkAudioPipe class.

+ (FMIceLinkAudioPipe *)audioPipeWithInputFormat:(FMIceLinkAudioFormat *)inputFormat outputFormat:(FMIceLinkAudioFormat *)outputFormat

Parameters

`inputFormat`	The input format.
`outputFormat`	The output format.

Discussion

Initializes a new instance of the FMIceLinkAudioPipe class.

Declared In

FMIceLinkAudioPipe.h

`+ audioPipeWithOutputFormat:`

Initializes a new instance of the FMIceLinkAudioPipe class.

+ (FMIceLinkAudioPipe *)audioPipeWithOutputFormat:(FMIceLinkAudioFormat *)outputFormat

Parameters

`outputFormat`	The output format.

Discussion

Initializes a new instance of the FMIceLinkAudioPipe class.

Declared In

FMIceLinkAudioPipe.h

`– config`

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

- (FMIceLinkAudioConfig *)config

Discussion

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

Declared In

FMIceLinkAudioPipe.h

`– createInputCollectionWithOutput:`

Creates an input collection.

- (FMIceLinkIAudioInputCollection *)createInputCollectionWithOutput:(NSObject<FMIceLinkIAudioOutput> *)output

Parameters

`output`	The output.

Discussion

Creates an input collection.

Declared In

FMIceLinkAudioPipe.h

`– createOutputCollectionWithInput:`

Creates an output collection.

- (FMIceLinkIAudioOutputCollection *)createOutputCollectionWithInput:(NSObject<FMIceLinkIAudioInput> *)input

Parameters

`input`	The input.

Discussion

Creates an output collection.

Declared In

FMIceLinkAudioPipe.h

`– gain`

Gets a value indicating the gain (input amplification) of this sink. Any value greater than or equal to 0.0 is acceptable.

- (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.

Declared In

FMIceLinkAudioPipe.h

`– initWithInputFormat:outputFormat:`

Initializes a new instance of the FMIceLinkAudioPipe class.

- (instancetype)initWithInputFormat:(FMIceLinkAudioFormat *)inputFormat outputFormat:(FMIceLinkAudioFormat *)outputFormat

Parameters

`inputFormat`	The input format.
`outputFormat`	The output format.

Discussion

Initializes a new instance of the FMIceLinkAudioPipe class.

Declared In

FMIceLinkAudioPipe.h

`– initWithOutputFormat:`

Initializes a new instance of the FMIceLinkAudioPipe class.

- (instancetype)initWithOutputFormat:(FMIceLinkAudioFormat *)outputFormat

Parameters

`outputFormat`	The output format.

Discussion

Initializes a new instance of the FMIceLinkAudioPipe class.

Declared In

FMIceLinkAudioPipe.h

`– inputConfig`

Gets the input configuration.

- (FMIceLinkAudioConfig *)inputConfig

Discussion

Gets the input configuration.

Declared In

FMIceLinkAudioPipe.h

`– outputConfig`

Gets the output configuration.

- (FMIceLinkAudioConfig *)outputConfig

Discussion

Gets the output configuration.

Declared In

FMIceLinkAudioPipe.h

`– processFrame:`

Processes a frame.

- (bool)processFrame:(FMIceLinkAudioFrame *)frame

Parameters

`frame`	The frame. @return

Discussion

Processes a frame.

Declared In

FMIceLinkAudioPipe.h

`– raiseFrame:`

Raises a frame.

- (void)raiseFrame:(FMIceLinkAudioFrame *)frame

Parameters

`frame`	The frame.

Discussion

Raises a frame.

Declared In

FMIceLinkAudioPipe.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.

- (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.

Declared In

FMIceLinkAudioPipe.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.

- (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.

Declared In

FMIceLinkAudioPipe.h

`– volume`

Gets a value indicating the volume (output resistance) of this source. Valid value range is 0.0 to 1.0, inclusive.

- (double)volume

Discussion

Gets a value indicating the volume (output resistance) of this source. Valid value range is 0.0 to 1.0, inclusive.

Declared In

FMIceLinkAudioPipe.h