FMIceLinkAudioSource Class Reference

Inherits from FMIceLinkMediaSource : FMIceLinkMediaSourceBase : FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Conforms to *
<
>
FMIceLinkAudioBuffer
FMIceLinkAudioBufferCollection
FMIceLinkAudioFormat
FMIceLinkAudioFrame
FMIceLinkAudioSource
FMIceLinkIAudioInput
FMIceLinkIAudioInputCollection
FMIceLinkIAudioOutput
NSObject
Declared in FMIceLinkAudioSource.h
FMIceLinkAudioSource.m

Overview

An audio source.

+ audioSourceWithOutputFormat:

Initializes a new instance of the FMIceLinkAudioSource class.
+ (FMIceLinkAudioSource *)audioSourceWithOutputFormat:(FMIceLinkAudioFormat *)outputFormat

Parameters

outputFormat

The output format.

Discussion

Initializes a new instance of the FMIceLinkAudioSource class.

Declared In

FMIceLinkAudioSource.h

+ audioSourceWithOutputFormat:frameDuration:

Initializes a new instance of the FMIceLinkAudioSource class.
+ (FMIceLinkAudioSource *)audioSourceWithOutputFormat:(FMIceLinkAudioFormat *)outputFormat frameDuration:(int)frameDuration

Parameters

outputFormat

The output format.
frameDuration

The frame duration in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioSource class.

Declared In

FMIceLinkAudioSource.h

– calculateDurationFloatWithDataLength:

Calculates the duration of an audio chunk given its data length (the number of bytes) and assuming that the clock rate and channel count match the output format.
- (int)calculateDurationFloatWithDataLength:(int)dataLength

Parameters

dataLength

The length of the audio chunk.

Discussion

Calculates the duration of an audio chunk given its data length (the number of bytes) and assuming that the clock rate and channel count match the output format.

Declared In

FMIceLinkAudioSource.h

+ calculateDurationFloatWithDataLength:clockRate:channelCount:

Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count.
+ (int)calculateDurationFloatWithDataLength:(int)dataLength clockRate:(int)clockRate channelCount:(int)channelCount

Parameters

dataLength

The length of the audio chunk.
clockRate

The clock rate.
channelCount

The channel count.

Discussion

Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count.

Declared In

FMIceLinkAudioSource.h

– calculateDurationWithDataLength:

Calculates the duration of an audio chunk given its data length (the number of bytes) and assuming that the clock rate and channel count match the output format.
- (int)calculateDurationWithDataLength:(int)dataLength

Parameters

dataLength

The length of the audio chunk.

Discussion

Calculates the duration of an audio chunk given its data length (the number of bytes) and assuming that the clock rate and channel count match the output format.

Declared In

FMIceLinkAudioSource.h

+ calculateDurationWithDataLength:clockRate:channelCount:

Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count.
+ (int)calculateDurationWithDataLength:(int)dataLength clockRate:(int)clockRate channelCount:(int)channelCount

Parameters

dataLength

The length of the audio chunk.
clockRate

The clock rate.
channelCount

The channel count.

Discussion

Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count.

Declared In

FMIceLinkAudioSource.h

+ calculateDurationWithDataLength:config:

Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count.
+ (int)calculateDurationWithDataLength:(int)dataLength config:(FMIceLinkAudioConfig *)config

Parameters

dataLength

The length of the audio chunk.
config

The configuration. @return

Discussion

Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count.

Declared In

FMIceLinkAudioSource.h

– clockRate

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

Discussion

Gets the clock rate in Hz.

Declared In

FMIceLinkAudioSource.h

– config

Gets the output configuration.
- (FMIceLinkAudioConfig *)config

Discussion

Gets the output configuration.

Declared In

FMIceLinkAudioSource.h

– createInputCollectionWithOutput:

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

Parameters

output

The output.

Discussion

Creates an input collection.

Declared In

FMIceLinkAudioSource.h

– disableTimestampReset

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

Discussion

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

Declared In

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

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

FMIceLinkAudioSource.h

– initWithOutputFormat:

Initializes a new instance of the FMIceLinkAudioSource class.
- (instancetype)initWithOutputFormat:(FMIceLinkAudioFormat *)outputFormat

Parameters

outputFormat

The output format.

Discussion

Initializes a new instance of the FMIceLinkAudioSource class.

Declared In

FMIceLinkAudioSource.h

– initWithOutputFormat:frameDuration:

Initializes a new instance of the FMIceLinkAudioSource class.
- (instancetype)initWithOutputFormat:(FMIceLinkAudioFormat *)outputFormat frameDuration:(int)frameDuration

Parameters

outputFormat

The output format.
frameDuration

The frame duration in milliseconds.

Discussion

Initializes a new instance of the FMIceLinkAudioSource class.

Declared In

FMIceLinkAudioSource.h

– raiseFrame:

Raises a frame.
- (void)raiseFrame:(FMIceLinkAudioFrame *)frame

Parameters

frame

The frame.

Discussion

Raises a frame.

Declared In

FMIceLinkAudioSource.h

– setDisableTimestampReset:

Sets whether the timestamp should be reset using the wall clock after FMIceLinkAudioSource#[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 FMIceLinkAudioSource#[timestampResetInterval](#//api/name/timestampResetInterval) milliseconds elapse between frames.

Declared In

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

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

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

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

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

FMIceLinkAudioSource.h