Agora RTC Objective-C API Reference  Refactor
Properties
AgoraCameraCapturerConfiguration Class Reference

Inherits <NSObject>.

Properties

NSString *_Nullable deviceId
 
CGSize dimensions
 
int frameRate
 
BOOL followEncodeDimensionRatio
 

Property Documentation

◆ deviceId

- (NSString* _Nullable) deviceId
readwritenonatomiccopy

The camera direction. See AgoraCameraDirection:

  • AgoraCameraDirectionRear: The rear camera.
  • AgoraCameraDirectionFront: The front camera. (macOS only) The camera ID.

◆ dimensions

- (CGSize) dimensions
readwritenonatomicassign

(Optional) The dimension (px) of the video frame. The default value is 960 × 540.

◆ frameRate

- (int) frameRate
readwritenonatomicassign

(Optional) The frame rate (fps) of the video frame. The default value is 15.

◆ followEncodeDimensionRatio

- (BOOL) followEncodeDimensionRatio
readwritenonatomicassign

(Optional) Whether to follow the video aspect ratio set in setVideoEncoderConfiguration::

  • YES: (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in onCaptureVideoFrame:sourceType: and onPreEncodeVideoFrame:sourceType:.
  • NO: Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.