FMIceLinkVpxEncoder Class Reference
| Inherits from | FMIceLinkVideoEncoder : FMIceLinkVideoPipe : FMIceLinkMediaPipe : FMIceLinkDynamic : FMIceLinkSerializable : NSObject | 
|---|---|
| Declared in | FMIceLinkVpxEncoder.h FMIceLinkVpxEncoder.m  | 
– bitrate
	
Gets encoder bitrate.  Getting this value retrieves the current bitrate, whereas
setting it sets the target bitrate for the encoder.
- (int)bitrateDiscussion
Gets encoder bitrate.  Getting this value retrieves the current bitrate, whereas
setting it sets the target bitrate for the encoder.
Declared In
FMIceLinkVpxEncoder.h
– codec
	
Gets the current codec.
			- (FMIceLinkVpxCodec)codecDiscussion
Gets the current codec.
			Declared In
FMIceLinkVpxEncoder.h
– codecConfig
	
Gets the encoder configuration.
			- (FMIceLinkVpxEncoderConfig *)codecConfigDiscussion
Gets the encoder configuration.
			Declared In
FMIceLinkVpxEncoder.h
– doDestroy
	
Destroys this instance.
			- (void)doDestroyDiscussion
Destroys this instance.
			Declared In
FMIceLinkVpxEncoder.h
– doProcessFrame:inputBuffer:
	
Processes a frame.
			- (void)doProcessFrame:(FMIceLinkVideoFrame *)frame inputBuffer:(FMIceLinkVideoBuffer *)inputBufferParameters
frame | 
						The frame.  | 
					
|---|---|
inputBuffer | 
						The input buffer.  | 
					
Discussion
Processes a frame.
			Declared In
FMIceLinkVpxEncoder.h
+ encoderWithOutputFormat:
	
Initializes a new instance of the FMIceLinkVpxEncoder class.
			+ (FMIceLinkVpxEncoder *)encoderWithOutputFormat:(FMIceLinkVideoFormat *)outputFormatParameters
outputFormat | 
						The output format.  | 
					
|---|
Discussion
Initializes a new instance of the FMIceLinkVpxEncoder class.
			Declared In
FMIceLinkVpxEncoder.h
– forceKeyFrame
	
Gets a value indicating whether a keyframe should be forced.
			- (bool)forceKeyFrameDiscussion
Gets a value indicating whether a keyframe should be forced.
			Declared In
FMIceLinkVpxEncoder.h
– initWithOutputFormat:
	
Initializes a new instance of the FMIceLinkVpxEncoder class.
			- (instancetype)initWithOutputFormat:(FMIceLinkVideoFormat *)outputFormatParameters
outputFormat | 
						The output format.  | 
					
|---|
Discussion
Initializes a new instance of the FMIceLinkVpxEncoder class.
			Declared In
FMIceLinkVpxEncoder.h
– isKeyFrameWithBuffer:
	
Determines whether the [buffer] contains a Key Frame.
			- (bool)isKeyFrameWithBuffer:(FMIceLinkDataBuffer *)bufferParameters
buffer | 
						The buffer.  | 
					
|---|
Discussion
Determines whether the [buffer] contains a Key Frame.
			Declared In
FMIceLinkVpxEncoder.h
– maxOutputBitrate
	
Gets the maximum [bitrate](#//api/name/bitrate) this encoder will produce, based on the
encoder's target [bitrate](#//api/name/bitrate) and the MaxInputBitrate of its' sinks.
			- (int)maxOutputBitrateDiscussion
Gets the maximum [bitrate](#//api/name/bitrate) this encoder will produce, based on the
encoder's target [bitrate](#//api/name/bitrate) and the MaxInputBitrate of its' sinks.
			Declared In
FMIceLinkVpxEncoder.h
– quality
	
Gets the target output quality.
- (double)qualityDiscussion
Gets the target output quality.
Declared In
FMIceLinkVpxEncoder.h
– setBitrate:
	
Sets 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.
- (void)setBitrate:(int)valueDiscussion
Sets 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.
Declared In
FMIceLinkVpxEncoder.h
– setCodecConfig:
	
Sets the encoder configuration.
			- (int)setCodecConfig:(FMIceLinkVpxEncoderConfig *)configReturn Value
0 on success, non-zero on failure.
Discussion
Sets the encoder configuration.
			Declared In
FMIceLinkVpxEncoder.h
– setForceKeyFrame:
	
Sets a value indicating whether a keyframe should be forced.
			- (void)setForceKeyFrame:(bool)valueDiscussion
Sets a value indicating whether a keyframe should be forced.
			Declared In
FMIceLinkVpxEncoder.h