Agora Java API Reference for Android
Public Attributes | List of all members
agora::rtc::CameraCapturerConfiguration Struct Reference

The camera capturer preference. More...

#include <IAgoraRtcEngine.h>

Public Attributes

Optional< const char * > deviceId
 
Optional< bool > followEncodeDimensionRatio
 
VideoFormat format
 

Detailed Description

The camera capturer preference.

Member Data Documentation

◆ deviceId

Optional<const char *> agora::rtc::CameraCapturerConfiguration::deviceId

Camera direction settings (for Android/iOS only). See: #CAMERA_DIRECTION. The camera ID. The maximum length is MAX_DEVICE_ID_LENGTH_TYPE.

Note
This parameter is for Windows and macOS only.

◆ followEncodeDimensionRatio

Optional<bool> agora::rtc::CameraCapturerConfiguration::followEncodeDimensionRatio

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

  • true: (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 and onPreEncodeVideoFrame.
  • false: Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.

◆ format

VideoFormat agora::rtc::CameraCapturerConfiguration::format

(Optional) The format of the video frame. See VideoFormat.