AgoraCameraCapturerConfiguration Class Reference
Inherits from | NSObject |
---|---|
Declared in | AgoraObjects.h |
preference
This preference will balance the performance and preview quality by adjusting camera output frame size. See AgoraCameraCaptureOutputPreference.
@property (assign, nonatomic) AgoraCameraCaptureOutputPreference preference
Declared In
AgoraObjects.h
captureWidth
The width (px) of the video image captured by the local camera. To
customize the width of the video image, set preference as
AgoraCameraCaptureOutputPreferenceManual(3)
first, and then use this parameter.
@property (assign, nonatomic) int captureWidth
Availability
v3.3.0
Declared In
AgoraObjects.h
captureHeight
The height (px) of the video image captured by the local camera. To
customize the height of the video image, set preference as
AgoraCameraCaptureOutputPreferenceManual(3)
first, and then use this parameter.
@property (assign, nonatomic) int captureHeight
Availability
v3.3.0
Declared In
AgoraObjects.h
cameraDirection
The camera direction. See AgoraCameraDirection:
@property (assign, nonatomic) AgoraCameraDirection cameraDirection
Discussion
- AgoraCameraDirectionRear: The rear camera.
- AgoraCameraDirectionFront: The front camera.
Note: This method applies to iOS only.
Declared In
AgoraObjects.h
– initWithSize:facing:
Sets the local camera capture behavior.
- (instancetype _Nonnull)initWithSize:(CGSize)size facing:(AgoraCameraDirection)facing
Parameters
size |
The size of the video image captured by the local camera. |
---|---|
facing |
The camera direction. See AgoraCameraDirection. |
Return Value
An initialized AgoraCameraCapturerConfiguration object.
Discussion
Before calling this method, ensure that you have called
setCameraCapturerConfiguration
to set the camera capture configuration as AgoraCameraCaptureOutputPreferenceManual(3)
.
Note: This method applies to iOS only.
Declared In
AgoraObjects.h
– initWithWidth:height:facing:
Sets the local camera capture behavior.
- (instancetype _Nonnull)initWithWidth:(NSInteger)width height:(NSInteger)height facing:(AgoraCameraDirection)facing
Parameters
width |
The width (px) of the video image captured by the local camera. |
---|---|
height |
The height (px) of the video image captured by the local camera. |
facing |
The camera direction. See AgoraCameraDirection. |
Return Value
An initialized AgoraCameraCapturerConfiguration object.
Discussion
Before calling this method, ensure that you have called
setCameraCapturerConfiguration
to set the camera capture configuration as AgoraCameraCaptureOutputPreferenceManual(3)
.
Note: This method applies to iOS only.
Declared In
AgoraObjects.h
– initWithSize:
Sets the local camera capture behavior.
- (instancetype _Nonnull)initWithSize:(CGSize)size
Parameters
size |
The size of the video image captured by the local camera. |
---|
Return Value
An initialized AgoraCameraCapturerConfiguration
object.
Discussion
Before calling this method, ensure that you have called
setCameraCapturerConfiguration
to set the camera capture configuration as AgoraCameraCaptureOutputPreferenceManual(3)
.
Note: This method applies to macOS only.
Declared In
AgoraObjects.h
– initWithWidth:height:
Sets the local camera capture behavior.
- (instancetype _Nonnull)initWithWidth:(NSInteger)width height:(NSInteger)height
Parameters
width |
The width (px) of the video image captured by the local camera. |
---|---|
height |
The height (px) of the video image captured by the local camera. |
Return Value
An initialized AgoraCameraCapturerConfiguration
object.
Discussion
Before calling this method, ensure that you have called
setCameraCapturerConfiguration
to set the camera capture configuration as AgoraCameraCaptureOutputPreferenceManual(3)
.
Note: This method applies to macOS only.
Declared In
AgoraObjects.h