FMIceLinkAudioMixer Class Reference

Inherits from FMIceLinkAudioPipe : FMIceLinkMediaPipe : FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Conforms to FMIceLinkIAudioReframer
Declared in FMIceLinkAudioMixer.h
FMIceLinkAudioMixer.m

Overview

A mixer that mixes multiple audio inputs into a single output.

+ audioMixerWithConfig:

Initializes a new instance of the FMIceLinkAudioMixer class.
+ (FMIceLinkAudioMixer *)audioMixerWithConfig:(FMIceLinkAudioConfig *)config

Parameters

config

The configuration.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

+ audioMixerWithConfig:latency:

Initializes a new instance of the FMIceLinkAudioMixer class.
+ (FMIceLinkAudioMixer *)audioMixerWithConfig:(FMIceLinkAudioConfig *)config latency:(int)latency

Parameters

config

The configuration.
latency

The latency in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

+ audioMixerWithConfig:latency:frameDuration:

Initializes a new instance of the FMIceLinkAudioMixer class.
+ (FMIceLinkAudioMixer *)audioMixerWithConfig:(FMIceLinkAudioConfig *)config latency:(int)latency frameDuration:(int)frameDuration

Parameters

config

The configuration.
latency

The latency in milliseconds.
frameDuration

The output frame duration in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

+ audioMixerWithFormat:

Initializes a new instance of the FMIceLinkAudioMixer class.
+ (FMIceLinkAudioMixer *)audioMixerWithFormat:(FMIceLinkAudioFormat *)format

Parameters

format

The format.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

+ audioMixerWithFormat:latency:

Initializes a new instance of the FMIceLinkAudioMixer class.
+ (FMIceLinkAudioMixer *)audioMixerWithFormat:(FMIceLinkAudioFormat *)format latency:(int)latency

Parameters

format

The format.
latency

The latency in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

+ audioMixerWithFormat:latency:frameDuration:

Initializes a new instance of the FMIceLinkAudioMixer class.
+ (FMIceLinkAudioMixer *)audioMixerWithFormat:(FMIceLinkAudioFormat *)format latency:(int)latency frameDuration:(int)frameDuration

Parameters

format

The format.
latency

The latency in milliseconds.
frameDuration

The output frame duration in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

+ audioMixerWithInput:

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

Parameters

input

The input.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

+ audioMixerWithInput:latency:

Initializes a new instance of the FMIceLinkAudioMixer class.
+ (FMIceLinkAudioMixer *)audioMixerWithInput:(NSObject<FMIceLinkIAudioOutput> *)input latency:(int)latency

Parameters

input

The input.
latency

The latency in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

+ audioMixerWithInput:latency:frameDuration:

Initializes a new instance of the FMIceLinkAudioMixer class.
+ (FMIceLinkAudioMixer *)audioMixerWithInput:(NSObject<FMIceLinkIAudioOutput> *)input latency:(int)latency frameDuration:(int)frameDuration

Parameters

input

The input.
latency

The latency in milliseconds.
frameDuration

The output frame duration in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

+ audioMixerWithInputs:

Initializes a new instance of the FMIceLinkAudioMixer class.
+ (FMIceLinkAudioMixer *)audioMixerWithInputs:(NSMutableArray *)inputs

Parameters

inputs

The inputs.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

+ audioMixerWithInputs:latency:

Initializes a new instance of the FMIceLinkAudioMixer class.
+ (FMIceLinkAudioMixer *)audioMixerWithInputs:(NSMutableArray *)inputs latency:(int)latency

Parameters

inputs

The inputs.
latency

The latency in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

+ audioMixerWithInputs:latency:frameDuration:

Initializes a new instance of the FMIceLinkAudioMixer class.
+ (FMIceLinkAudioMixer *)audioMixerWithInputs:(NSMutableArray *)inputs latency:(int)latency frameDuration:(int)frameDuration

Parameters

inputs

The inputs.
latency

The latency in milliseconds.
frameDuration

The output frame duration in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

– clockRate

Gets the clock rate in Hz.
- (int)clockRate

Discussion

Gets the clock rate in Hz.

Declared In

FMIceLinkAudioMixer.h

– disableTimestampReset

Gets whether the timestamp should be reset using the wall clock after FMIceLinkAudioMixer#[timestampResetInterval](#//api/name/timestampResetInterval) milliseconds elapse between frames.
- (bool)disableTimestampReset

Discussion

Gets whether the timestamp should be reset using the wall clock after FMIceLinkAudioMixer#[timestampResetInterval](#//api/name/timestampResetInterval) milliseconds elapse between frames.

Declared In

FMIceLinkAudioMixer.h

– doDestroy

Destroys this instance.
- (void)doDestroy

Discussion

Destroys this instance.

Declared In

FMIceLinkAudioMixer.h

– doProcessFrame:inputBuffer:

Processes a frame.
- (void)doProcessFrame:(FMIceLinkAudioFrame *)frame inputBuffer:(FMIceLinkAudioBuffer *)inputBuffer

Parameters

frame

The frame.
inputBuffer

The input buffer.

Discussion

Processes a frame.

Declared In

FMIceLinkAudioMixer.h

– forceTimestampReset

Gets whether the timestamp should be reset before the next frame is processed.
- (bool)forceTimestampReset

Discussion

Gets whether the timestamp should be reset before the next frame is processed.

Declared In

FMIceLinkAudioMixer.h

– frameDuration

Gets the frame duration in milliseconds. Defaults to 20.
- (int)frameDuration

Discussion

Gets the frame duration in milliseconds. Defaults to 20.

Declared In

FMIceLinkAudioMixer.h

– initWithConfig:

Initializes a new instance of the FMIceLinkAudioMixer class.
- (instancetype)initWithConfig:(FMIceLinkAudioConfig *)config

Parameters

config

The configuration.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

– initWithConfig:latency:

Initializes a new instance of the FMIceLinkAudioMixer class.
- (instancetype)initWithConfig:(FMIceLinkAudioConfig *)config latency:(int)latency

Parameters

config

The configuration.
latency

The latency in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

– initWithConfig:latency:frameDuration:

Initializes a new instance of the FMIceLinkAudioMixer class.
- (instancetype)initWithConfig:(FMIceLinkAudioConfig *)config latency:(int)latency frameDuration:(int)frameDuration

Parameters

config

The configuration.
latency

The latency in milliseconds.
frameDuration

The output frame duration in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

– initWithFormat:

Initializes a new instance of the FMIceLinkAudioMixer class.
- (instancetype)initWithFormat:(FMIceLinkAudioFormat *)format

Parameters

format

The format.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

– initWithFormat:latency:

Initializes a new instance of the FMIceLinkAudioMixer class.
- (instancetype)initWithFormat:(FMIceLinkAudioFormat *)format latency:(int)latency

Parameters

format

The format.
latency

The latency in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

– initWithFormat:latency:frameDuration:

Initializes a new instance of the FMIceLinkAudioMixer class.
- (instancetype)initWithFormat:(FMIceLinkAudioFormat *)format latency:(int)latency frameDuration:(int)frameDuration

Parameters

format

The format.
latency

The latency in milliseconds.
frameDuration

The output frame duration in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

– initWithInput:

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

Parameters

input

The input.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

– initWithInput:latency:

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

Parameters

input

The input.
latency

The latency in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

– initWithInput:latency:frameDuration:

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

Parameters

input

The input.
latency

The latency in milliseconds.
frameDuration

The output frame duration in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

– initWithInputs:

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

Parameters

inputs

The inputs.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

– initWithInputs:latency:

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

Parameters

inputs

The inputs.
latency

The latency in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

– initWithInputs:latency:frameDuration:

Initializes a new instance of the FMIceLinkAudioMixer class.
- (instancetype)initWithInputs:(NSMutableArray *)inputs latency:(int)latency frameDuration:(int)frameDuration

Parameters

inputs

The inputs.
latency

The latency in milliseconds.
frameDuration

The output frame duration in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioMixer class.

Declared In

FMIceLinkAudioMixer.h

– label

Gets a label that identifies this class.
- (NSString *)label

Discussion

Gets a label that identifies this class.

Declared In

FMIceLinkAudioMixer.h

– latency

Gets the latency.
- (int)latency

Discussion

Gets the latency.

Declared In

FMIceLinkAudioMixer.h

– setDisableTimestampReset:

Sets whether the timestamp should be reset using the wall clock after FMIceLinkAudioMixer#[timestampResetInterval](#//api/name/timestampResetInterval) milliseconds elapse between frames.
- (void)setDisableTimestampReset:(bool)value

Discussion

Sets whether the timestamp should be reset using the wall clock after FMIceLinkAudioMixer#[timestampResetInterval](#//api/name/timestampResetInterval) milliseconds elapse between frames.

Declared In

FMIceLinkAudioMixer.h

– setForceTimestampReset:

Sets whether the timestamp should be reset before the next frame is processed.
- (void)setForceTimestampReset:(bool)value

Discussion

Sets whether the timestamp should be reset before the next frame is processed.

Declared In

FMIceLinkAudioMixer.h

– setSynchronizationSource:

Sets the synchronization source.
- (void)setSynchronizationSource:(long long)value

Discussion

Sets the synchronization source.

Declared In

FMIceLinkAudioMixer.h

– setTimestampResetInterval:

Sets the amount of time in milliseconds between audio frames that will trigger a reset of the timestamp to the wall clock. Defaults to 1000.
- (void)setTimestampResetInterval:(int)value

Discussion

Sets the amount of time in milliseconds between audio frames that will trigger a reset of the timestamp to the wall clock. Defaults to 1000.

Declared In

FMIceLinkAudioMixer.h

– synchronizationSource

Gets the synchronization source.
- (long long)synchronizationSource

Discussion

Gets the synchronization source.

Declared In

FMIceLinkAudioMixer.h

– timestampResetInterval

Gets the amount of time in milliseconds between audio frames that will trigger a reset of the timestamp to the wall clock. Defaults to 1000.
- (int)timestampResetInterval

Discussion

Gets the amount of time in milliseconds between audio frames that will trigger a reset of the timestamp to the wall clock. Defaults to 1000.

Declared In

FMIceLinkAudioMixer.h