FMIceLinkOpusEncoder Class Reference

Inherits from FMIceLinkAudioEncoder : FMIceLinkAudioPipe : FMIceLinkMediaPipe : FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Declared in FMIceLinkOpusEncoder.h
FMIceLinkOpusEncoder.m

Overview

A libopus-based [encoder](#//api/name/encoder).

– bitrate

Gets [encoder](#//api/name/encoder) bitrate. Getting this value retrieves the current bitrate, whereas setting it sets the target bitrate for the [encoder](#//api/name/encoder).

The bitrate in kbps.

- (int)bitrate

Discussion

Gets [encoder](#//api/name/encoder) bitrate. Getting this value retrieves the current bitrate, whereas setting it sets the target bitrate for the [encoder](#//api/name/encoder).

The bitrate in kbps.

Declared In

FMIceLinkOpusEncoder.h

– codecConfig

Gets a copy of the [encoder](#//api/name/encoder) codec's config.
- (FMIceLinkOpusEncoderConfig *)codecConfig

Discussion

Gets a copy of the [encoder](#//api/name/encoder) codec's config.

Declared In

FMIceLinkOpusEncoder.h

– disableFec

Gets a value indicating whether FEC is disabled.
- (bool)disableFec

Discussion

Gets a value indicating whether FEC is disabled.

Declared In

FMIceLinkOpusEncoder.h

– doDestroy

Destroys this instance.
- (void)doDestroy

Discussion

Destroys this instance.

Declared In

FMIceLinkOpusEncoder.h

– doProcessControlFrames:

Processes the control frames.
- (void)doProcessControlFrames:(NSMutableArray *)controlFrames

Parameters

controlFrames

The control frames.

Discussion

Processes the control frames.

Declared In

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

FMIceLinkOpusEncoder.h

– doProcessSdpMediaDescription:isOffer:isLocalDescription:

Processes a SDP media description.
- (FMIceLinkError *)doProcessSdpMediaDescription:(FMIceLinkSdpMediaDescription *)mediaDescription isOffer:(bool)isOffer isLocalDescription:(bool)isLocalDescription

Parameters

mediaDescription

The media description.
isOffer

if set to true [is offer].
isLocalDescription

if set to true [is local description].

Discussion

Processes a SDP media description.

Declared In

FMIceLinkOpusEncoder.h

+ encoder

Initializes a new instance of the FMIceLinkOpusEncoder class.
+ (FMIceLinkOpusEncoder *)encoder

Discussion

Initializes a new instance of the FMIceLinkOpusEncoder class.

Declared In

FMIceLinkOpusEncoder.h

+ encoderWithConfig:

Initializes a new instance of the FMIceLinkOpusEncoder class.
+ (FMIceLinkOpusEncoder *)encoderWithConfig:(FMIceLinkAudioConfig *)config

Parameters

config

The configuration.

Discussion

Initializes a new instance of the FMIceLinkOpusEncoder class.

Declared In

FMIceLinkOpusEncoder.h

+ encoderWithInput:

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

Parameters

input

The input.

Discussion

Initializes a new instance of the FMIceLinkOpusEncoder class.

Declared In

FMIceLinkOpusEncoder.h

– init

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

Discussion

Initializes a new instance of the FMIceLinkOpusEncoder class.

Declared In

FMIceLinkOpusEncoder.h

– initWithConfig:

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

Parameters

config

The configuration.

Discussion

Initializes a new instance of the FMIceLinkOpusEncoder class.

Declared In

FMIceLinkOpusEncoder.h

– initWithInput:

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

Parameters

input

The input.

Discussion

Initializes a new instance of the FMIceLinkOpusEncoder class.

Declared In

FMIceLinkOpusEncoder.h

– label

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

Discussion

Gets a label that identifies this class.

Declared In

FMIceLinkOpusEncoder.h

– maxOutputBitrate

Gets the maximum [bitrate](#//api/name/bitrate) this [encoder](#//api/name/encoder) will produce, based on the encoder's target [bitrate](#//api/name/bitrate) and the MaxInputBitrate of its' sinks.
- (int)maxOutputBitrate

Discussion

Gets the maximum [bitrate](#//api/name/bitrate) this [encoder](#//api/name/encoder) will produce, based on the encoder's target [bitrate](#//api/name/bitrate) and the MaxInputBitrate of its' sinks.

Declared In

FMIceLinkOpusEncoder.h

– percentLossToTriggerFEC

Gets the loss percentage (0-100) before forward error correction (FEC) is activated (only if supported by the remote peer). Affects encoded data only.
- (int)percentLossToTriggerFEC

Discussion

Gets the loss percentage (0-100) before forward error correction (FEC) is activated (only if supported by the remote peer). Affects encoded data only.

Declared In

FMIceLinkOpusEncoder.h

– quality

Gets the quality.
- (double)quality

Discussion

Gets the quality.

Declared In

FMIceLinkOpusEncoder.h

– setBitrate:

Sets [encoder](#//api/name/encoder) [bitrate](#//api/name/bitrate). Getting this value retrieves the current [bitrate](#//api/name/bitrate), whereas setting it sets the target [bitrate](#//api/name/bitrate) for the [encoder](#//api/name/encoder).

The bitrate in kbps.

- (void)setBitrate:(int)value

Discussion

Sets [encoder](#//api/name/encoder) [bitrate](#//api/name/bitrate). Getting this value retrieves the current [bitrate](#//api/name/bitrate), whereas setting it sets the target [bitrate](#//api/name/bitrate) for the [encoder](#//api/name/encoder).

The bitrate in kbps.

Declared In

FMIceLinkOpusEncoder.h

– setCodecConfig:

Sets the [encoder](#//api/name/encoder) configuration.
- (int)setCodecConfig:(FMIceLinkOpusEncoderConfig *)config

Return Value

0 on success, non-zero on failure.

Discussion

Sets the [encoder](#//api/name/encoder) configuration.

Declared In

FMIceLinkOpusEncoder.h

– setDisableFec:

Sets a value indicating whether FEC is disabled.
- (void)setDisableFec:(bool)value

Discussion

Sets a value indicating whether FEC is disabled.

Declared In

FMIceLinkOpusEncoder.h

– setPercentLossToTriggerFEC:

Sets the loss percentage (0-100) before forward error correction (FEC) is activated (only if supported by the remote peer). Affects encoded data only.
- (void)setPercentLossToTriggerFEC:(int)value

Discussion

Sets the loss percentage (0-100) before forward error correction (FEC) is activated (only if supported by the remote peer). Affects encoded data only.

Declared In

FMIceLinkOpusEncoder.h

– setQuality:

Sets the [quality](#//api/name/quality).
- (void)setQuality:(double)value

Discussion

Sets the [quality](#//api/name/quality).

Declared In

FMIceLinkOpusEncoder.h