Package io.agora.rtc2.video

Class CameraCapturerConfiguration

java.lang.Object

io.agora.rtc2.video.CameraCapturerConfiguration

public class CameraCapturerConfiguration
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CameraCapturerConfiguration.CAMERA_DIRECTION
static enum	CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE
static class	CameraCapturerConfiguration.CaptureFormat

Field Summary

Fields

Modifier and Type	Field	Description
CameraCapturerConfiguration.CAMERA_DIRECTION	cameraDirection	(Optional) The camera direction.
CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE	cameraFocalLengthType	(Optional) The camera focal length type.
String	cameraId	(Optional) The camera ID.
CameraCapturerConfiguration.CaptureFormat	captureFormat	(Optional) The format of the video frame.
Boolean	followEncodeDimensionRatio	(Optional) Whether to follow the video aspect ratio set in `setVideoEncoderConfiguration`: - `true`: (Default) Follow the set video aspect ratio.

Constructor Summary

Constructors

Constructor	Description
CameraCapturerConfiguration(CameraCapturerConfiguration.CAMERA_DIRECTION cameraDirection)	The camera capture configuration.
CameraCapturerConfiguration(CameraCapturerConfiguration.CAMERA_DIRECTION cameraDirection, CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE cameraFocalLengthType)
CameraCapturerConfiguration(CameraCapturerConfiguration.CAMERA_DIRECTION cameraDirection, CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE cameraFocalLengthType, CameraCapturerConfiguration.CaptureFormat captureFormat)
CameraCapturerConfiguration(CameraCapturerConfiguration.CAMERA_DIRECTION cameraDirection, CameraCapturerConfiguration.CaptureFormat captureFormat)	The camera capture configuration.
CameraCapturerConfiguration(CameraCapturerConfiguration.CaptureFormat captureFormat)	The camera capture configuration.

Method Summary

Modifier and Type	Method	Description
CameraCapturerConfiguration.CAMERA_DIRECTION	getCameraDirection()
CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE	getCameraFocalLengthType()
String	getCameraId()
CameraCapturerConfiguration.CaptureFormat	getCaptureFormat()
Boolean	isFollowEncodeDimensionRatio()
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

cameraDirection

public CameraCapturerConfiguration.CAMERA_DIRECTION cameraDirection

(Optional) The camera direction. See `CAMERA_DIRECTION`.

cameraId

public String cameraId

(Optional) The camera ID. The default value is the camera ID of the front camera. You can get the camera ID through the Android native system API, see `Camera.open()` and `CameraManager.getCameraIdList()` for details.

cameraFocalLengthType

public CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE cameraFocalLengthType

(Optional) The camera focal length type. See `CAMERA_FOCAL_LENGTH_TYPE`.

captureFormat

public CameraCapturerConfiguration.CaptureFormat captureFormat

(Optional) The format of the video frame. See `CaptureFormat`.

followEncodeDimensionRatio

public Boolean 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.

Constructor Details

CameraCapturerConfiguration

public CameraCapturerConfiguration(CameraCapturerConfiguration.CAMERA_DIRECTION cameraDirection)

The camera capture configuration.

Parameters:

cameraDirection - The camera direction. For details, see CAMERA_DIRECTION.

CameraCapturerConfiguration

public CameraCapturerConfiguration(CameraCapturerConfiguration.CAMERA_DIRECTION cameraDirection,
 CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE cameraFocalLengthType)

CameraCapturerConfiguration

public CameraCapturerConfiguration(CameraCapturerConfiguration.CaptureFormat captureFormat)

The camera capture configuration.

Parameters:

captureFormat - The camera capture format. For details, see CameraCapturerConfiguration.CaptureFormat.

CameraCapturerConfiguration

public CameraCapturerConfiguration(CameraCapturerConfiguration.CAMERA_DIRECTION cameraDirection,
 CameraCapturerConfiguration.CaptureFormat captureFormat)

The camera capture configuration.

Parameters:

cameraDirection - The camera direction. For details, see CAMERA_DIRECTION.

captureFormat - The camera capture format. For details, see CameraCapturerConfiguration.CaptureFormat.

CameraCapturerConfiguration

public CameraCapturerConfiguration(CameraCapturerConfiguration.CAMERA_DIRECTION cameraDirection,
 CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE cameraFocalLengthType,
 CameraCapturerConfiguration.CaptureFormat captureFormat)

Method Details

getCameraDirection

public CameraCapturerConfiguration.CAMERA_DIRECTION getCameraDirection()

getCameraId

public String getCameraId()

getCameraFocalLengthType

public CameraCapturerConfiguration.CAMERA_FOCAL_LENGTH_TYPE getCameraFocalLengthType()

getCaptureFormat

public CameraCapturerConfiguration.CaptureFormat getCaptureFormat()

isFollowEncodeDimensionRatio

public Boolean isFollowEncodeDimensionRatio()

toString

public String toString()

Overrides:

toString in class Object