FMLiveSwitchOpusEncoderConfig Class Reference

Configuration for the Opus encoder. More...

Instance Methods

(FMLiveSwitchOpusApplicationType *) - application
 Gets a value that maps to "OPUS_SET_APPLICATION". More...
 
(FMLiveSwitchOpusBandwidth *) - bandwidth
 Gets a value that maps to "OPUS_SET_BANDWIDTH". More...
 
(int) - complexity
 Gets a value that maps to "OPUS_SET_COMPLEXITY". More...
 
(FMLiveSwitchOpusEncoderConfig *) - deepCopy
 Gets a deep copy of this configuration. More...
 
(int) - dtx
 Gets a value that maps to "OPUS_SET_DTX". More...
 
(FMLiveSwitchOpusExpertFrameDuration *) - expertFrameDuration
 Gets a value that maps to "OPUS_SET_EXPERT_FRAME_DURATION". More...
 
(int) - forceChannels
 Gets a value that maps to "OPUS_SET_FORCE_CHANNELS". More...
 
(bool) - forwardErrorCorrection
 Gets a value that maps to "OPUS_SET_INBAND_FEC". More...
 
(instancetype) - init
 Creates a new copy of the Opus encoder configurations with default values. More...
 
(bool) - isPredictionDisabled
 Gets a value that maps to "OPUS_SET_PREDICTION_DISABLED". More...
 
(bool) - isVbr
 Gets a value that maps to "OPUS_SET_VBR". More...
 
(FMLiveSwitchOpusBandwidth *) - maxBandwidth
 Gets a value that maps to "OPUS_SET_MAX_BANDWIDTH". More...
 
(int) - packetLossPercent
 Gets a value that maps to "OPUS_SET_PACKET_LOSS_PERC". More...
 
(void) - setApplication:
 Sets a value that maps to "OPUS_SET_APPLICATION". More...
 
(void) - setBandwidth:
 Sets a value that maps to "OPUS_SET_BANDWIDTH". More...
 
(void) - setComplexity:
 Sets a value that maps to "OPUS_SET_COMPLEXITY". More...
 
(void) - setDtx:
 Sets a value that maps to "OPUS_SET_DTX". More...
 
(void) - setExpertFrameDuration:
 Sets a value that maps to "OPUS_SET_EXPERT_FRAME_DURATION". More...
 
(void) - setForceChannels:
 Sets a value that maps to "OPUS_SET_FORCE_CHANNELS". More...
 
(void) - setForwardErrorCorrection:
 Sets a value that maps to "OPUS_SET_INBAND_FEC". More...
 
(void) - setIsPredictionDisabled:
 Sets a value that maps to "OPUS_SET_PREDICTION_DISABLED". More...
 
(void) - setIsVbr:
 Sets a value that maps to "OPUS_SET_VBR". More...
 
(void) - setMaxBandwidth:
 Sets a value that maps to "OPUS_SET_MAX_BANDWIDTH". More...
 
(void) - setPacketLossPercent:
 Sets a value that maps to "OPUS_SET_PACKET_LOSS_PERC". More...
 
(void) - setSignal:
 Sets a value that maps to "OPUS_SET_SIGNAL". More...
 
(void) - setUseConstrainedVBR:
 Sets a value that maps to "OPUS_SET_VBR_CONSTRAINT". More...
 
(FMLiveSwitchOpusSignal *) - signal
 Gets a value that maps to "OPUS_SET_SIGNAL". More...
 
(bool) - useConstrainedVBR
 Gets a value that maps to "OPUS_SET_VBR_CONSTRAINT". More...
 

Class Methods

(int) + auto
 Gets the integral value that maps to the Opus "OPUS_AUTO" constant. More...
 
(FMLiveSwitchOpusEncoderConfig *) + encoderConfig
 Creates a new copy of the Opus encoder configurations with default values. More...
 

Detailed Description

Configuration for the Opus encoder.

Properties map to Opus controls. http://www.opus-codec.org/

Method Documentation

◆ application

Gets a value that maps to "OPUS_SET_APPLICATION".

◆ auto

+ (int) auto

Gets the integral value that maps to the Opus "OPUS_AUTO" constant.

Several int configuration properties can be set to this value.

◆ bandwidth

- (FMLiveSwitchOpusBandwidth*) bandwidth

Gets a value that maps to "OPUS_SET_BANDWIDTH".

◆ complexity

- (int) complexity

Gets a value that maps to "OPUS_SET_COMPLEXITY".

◆ deepCopy

Gets a deep copy of this configuration.

◆ dtx

- (int) dtx

Gets a value that maps to "OPUS_SET_DTX".

◆ encoderConfig

+ (FMLiveSwitchOpusEncoderConfig*) encoderConfig

Creates a new copy of the Opus encoder configurations with default values.

◆ expertFrameDuration

- (FMLiveSwitchOpusExpertFrameDuration*) expertFrameDuration

Gets a value that maps to "OPUS_SET_EXPERT_FRAME_DURATION".

◆ forceChannels

- (int) forceChannels

Gets a value that maps to "OPUS_SET_FORCE_CHANNELS".

◆ forwardErrorCorrection

- (bool) forwardErrorCorrection

Gets a value that maps to "OPUS_SET_INBAND_FEC".

◆ init

- (instancetype) init

Creates a new copy of the Opus encoder configurations with default values.

◆ isPredictionDisabled

- (bool) isPredictionDisabled

Gets a value that maps to "OPUS_SET_PREDICTION_DISABLED".

◆ isVbr

- (bool) isVbr

Gets a value that maps to "OPUS_SET_VBR".

◆ maxBandwidth

- (FMLiveSwitchOpusBandwidth*) maxBandwidth

Gets a value that maps to "OPUS_SET_MAX_BANDWIDTH".

◆ packetLossPercent

- (int) packetLossPercent

Gets a value that maps to "OPUS_SET_PACKET_LOSS_PERC".

◆ setApplication:

- (void) setApplication: (FMLiveSwitchOpusApplicationType *)  value

Sets a value that maps to "OPUS_SET_APPLICATION".

◆ setBandwidth:

- (void) setBandwidth: (FMLiveSwitchOpusBandwidth *)  value

Sets a value that maps to "OPUS_SET_BANDWIDTH".

◆ setComplexity:

- (void) setComplexity: (int)  value

Sets a value that maps to "OPUS_SET_COMPLEXITY".

◆ setDtx:

- (void) setDtx: (int)  value

Sets a value that maps to "OPUS_SET_DTX".

◆ setExpertFrameDuration:

- (void) setExpertFrameDuration: (FMLiveSwitchOpusExpertFrameDuration *)  value

Sets a value that maps to "OPUS_SET_EXPERT_FRAME_DURATION".

◆ setForceChannels:

- (void) setForceChannels: (int)  value

Sets a value that maps to "OPUS_SET_FORCE_CHANNELS".

◆ setForwardErrorCorrection:

- (void) setForwardErrorCorrection: (bool)  value

Sets a value that maps to "OPUS_SET_INBAND_FEC".

◆ setIsPredictionDisabled:

- (void) setIsPredictionDisabled: (bool)  value

Sets a value that maps to "OPUS_SET_PREDICTION_DISABLED".

◆ setIsVbr:

- (void) setIsVbr: (bool)  value

Sets a value that maps to "OPUS_SET_VBR".

◆ setMaxBandwidth:

- (void) setMaxBandwidth: (FMLiveSwitchOpusBandwidth *)  value

Sets a value that maps to "OPUS_SET_MAX_BANDWIDTH".

◆ setPacketLossPercent:

- (void) setPacketLossPercent: (int)  value

Sets a value that maps to "OPUS_SET_PACKET_LOSS_PERC".

◆ setSignal:

- (void) setSignal: (FMLiveSwitchOpusSignal *)  value

Sets a value that maps to "OPUS_SET_SIGNAL".

◆ setUseConstrainedVBR:

- (void) setUseConstrainedVBR: (bool)  value

Sets a value that maps to "OPUS_SET_VBR_CONSTRAINT".

◆ signal

Gets a value that maps to "OPUS_SET_SIGNAL".

◆ useConstrainedVBR

- (bool) useConstrainedVBR

Gets a value that maps to "OPUS_SET_VBR_CONSTRAINT".