Agora C++ API Reference for All Platforms
agora::rtc::LowLightEnhanceOptions Struct Reference

#include <IAgoraRtcEngine.h>

Public Types

enum  LOW_LIGHT_ENHANCE_MODE { LOW_LIGHT_ENHANCE_AUTO = 0 , LOW_LIGHT_ENHANCE_MANUAL }
 
enum  LOW_LIGHT_ENHANCE_LEVEL { LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY = 0 , LOW_LIGHT_ENHANCE_LEVEL_FAST }
 

Public Member Functions

 LowLightEnhanceOptions (LOW_LIGHT_ENHANCE_MODE lowlightMode, LOW_LIGHT_ENHANCE_LEVEL lowlightLevel)
 
 LowLightEnhanceOptions ()
 

Public Attributes

LOW_LIGHT_ENHANCE_MODE mode
 
LOW_LIGHT_ENHANCE_LEVEL level
 

Detailed Description

The low-light enhancement options.

Since
v3.6.2

Member Enumeration Documentation

◆ LOW_LIGHT_ENHANCE_MODE

The low-light enhancement mode.

Enumerator
LOW_LIGHT_ENHANCE_AUTO 

0: (Default) Automatic mode. The SDK automatically enables or disables the low-light enhancement feature according to the ambient light to compensate for the lighting level or prevent overexposure, as necessary.

LOW_LIGHT_ENHANCE_MANUAL 

Manual mode. Users need to enable or disable the low-light enhancement feature manually.

◆ LOW_LIGHT_ENHANCE_LEVEL

The low-light enhancement level.

Enumerator
LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY 

0: (Default) Promotes video quality during low-light enhancement. It processes the brightness, details, and noise of the video image. The performance consumption is moderate, the processing speed is moderate, and the overall video quality is optimal.

LOW_LIGHT_ENHANCE_LEVEL_FAST 

Promotes performance during low-light enhancement. It processes the brightness and details of the video image. The processing speed is faster.

Constructor & Destructor Documentation

◆ LowLightEnhanceOptions() [1/2]

agora::rtc::LowLightEnhanceOptions::LowLightEnhanceOptions ( LOW_LIGHT_ENHANCE_MODE  lowlightMode,
LOW_LIGHT_ENHANCE_LEVEL  lowlightLevel 
)
inline

◆ LowLightEnhanceOptions() [2/2]

agora::rtc::LowLightEnhanceOptions::LowLightEnhanceOptions ( )
inline

Member Data Documentation

◆ mode

LOW_LIGHT_ENHANCE_MODE agora::rtc::LowLightEnhanceOptions::mode

The low-light enhancement mode. See LOW_LIGHT_ENHANCE_MODE.

◆ level

LOW_LIGHT_ENHANCE_LEVEL agora::rtc::LowLightEnhanceOptions::level

The low-light enhancement level. See LOW_LIGHT_ENHANCE_LEVEL.