视频增强
setBeautyEffectOptions
设置美颜效果选项。
TypeScript
abstract setBeautyEffectOptions(
enabled: boolean,
options: BeautyOptions,
type?: MediaSourceType
): number;
开启本地美颜功能，并设置美颜效果选项。
调用时机
请在 enableVideo 或 startPreview 之后调用该方法。
调用限制
- 该方法依赖于视频增强动态库
libagora_clear_vision_extension.dll，如果删除该动态库会导致无法正常开启该功能。 - 该功能对设备性能要求较高，调用该方法时 SDK 会自动对当前设备能力进行检查。
参数
- enabled
- 是否开启美颜功能：
true: 开启美颜功能。false:（默认）关闭美颜功能。
- options
- 美颜选项，详细定义见 BeautyOptions。
- type
- 插件的媒体源类型。详见 MediaSourceType。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- -4：当前设备不支持该功能，可能的原因有：
- 当前设备能力不满足美颜的使用要求，建议更换性能更高的设备。
- -4：当前设备不支持该功能，可能的原因有：
setColorEnhanceOptions
设置色彩增强功能。
TypeScript
abstract setColorEnhanceOptions(
enabled: boolean,
options: ColorEnhanceOptions,
type?: MediaSourceType
): number;
详情
摄像头采集到的视频画面可能存在色彩失真的现象。色彩增强功能可以通过智能调节饱和度和对比度等视频特性，提升视频色彩丰富度和色彩还原度，最终使视频画面更生动。
你可以调用该方法开启色彩增强功能并设置色彩增强的效果。
注意
- 请在 enableVideo 后调用该方法。
- 色彩增强对设备性能有一定要求。开启色彩增强后，如果设备出现严重发烫等问题，建议你将色彩增强等级修改为消耗性能较少的等级或关闭色彩增强功能。
- 该方法和 setExtensionProperty 均可开启色彩增强功能：
- 当你使用 SDK 采集视频时，建议使用该方法（该方法只可对 SDK 采集的视频起作用）。
- 当你使用外部的视频源实现自定义视频采集，或者将外部视频源发送给 SDK 时，建议使用 setExtensionProperty 方法。
- 该方法依赖于视频增强动态库
libagora_clear_vision_extension.dll，如果删除该动态库会导致无法正常开启该功能。
参数
- enabled
- 是否开启色彩增强功能：
true：开启色彩增强功能。false：（默认）关闭色彩增强功能。
- options
- 色彩增强选项，用于设置色彩增强的效果。详见 ColorEnhanceOptions。
- type
- 媒体源类型，详见 MediaSourceType。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setLowlightEnhanceOptions
设置暗光增强功能。
TypeScript
abstract setLowlightEnhanceOptions(
enabled: boolean,
options: LowlightEnhanceOptions,
type?: MediaSourceType
): number;
详情
暗光增强功能可以在光线亮度偏低（如背光、阴天、暗场景）和亮度不均匀的环境下自适应调整视频画面的亮度值，恢复或凸显图像的细节信息，最终提升视频图像的整体视觉效果。
你可以调用该方法开启暗光增强功能并设置暗光增强的效果。
注意
- 请在 enableVideo 后调用该方法。
- 暗光增强对设备性能有一定要求。开启暗光增强后，如果设备出现严重发烫等问题，建议你将暗光增强等级修改为消耗性能较少的等级或关闭暗光增强功能。
- 该方法和 setExtensionProperty 均可开启暗光增强功能：
- 当你使用 SDK 采集视频时，建议使用该方法（该方法只可对 SDK 采集的视频起作用）。
- 当你使用外部的视频源实现自定义视频采集，或者将外部视频源发送给 SDK 时，建议使用 setExtensionProperty 方法。
- 该方法依赖于视频增强动态库
libagora_clear_vision_extension.dll，如果删除该动态库会导致无法正常开启该功能。
参数
- enabled
- 是否开启暗光增强功能：
true: 开启暗光增强功能。false:（默认）关闭暗光增强功能。
- options
- 暗光增强选项，用于设置暗光增强的效果。详见 LowlightEnhanceOptions。
- type
- 媒体源类型，详见 MediaSourceType。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setVideoDenoiserOptions
设置视频降噪功能。
TypeScript
abstract setVideoDenoiserOptions(
enabled: boolean,
options: VideoDenoiserOptions,
type?: MediaSourceType
): number;
详情
采光不足的环境和低端视频采集设备会使视频图像含有明显的噪声，影响视频画质。在实时互动场景下，视频噪声还会在编码过程中占用码流资源并降低编码效率。
你可以调用该方法开启视频降噪功能并设置视频降噪的效果。
注意
- 请在 enableVideo 后调用该方法。
- 视频降噪对设备性能有一定要求。开启视频降噪后，如果设备出现严重发烫等问题，建议你将视频降噪等级修改为消耗性能较少的等级或关闭视频降噪功能。
- 该方法和 setExtensionProperty 均可开启视频降噪功能：
- 当你使用 SDK 采集视频时，建议使用该方法（该方法只可对 SDK 采集的视频起作用）。
- 当你使用外部的视频源实现自定义视频采集，或者将外部视频源发送给 SDK 时，建议使用 setExtensionProperty 方法。
- 该方法依赖于视频增强动态库
libagora_clear_vision_extension.dll，如果删除该动态库会导致无法正常开启该功能。
参数
- enabled
- 是否开启视频降噪功能：
true: 开启视频降噪功能。false:（默认）关闭视频降噪功能。
- options
- 视频降噪选项，用于设置视频降噪的效果。详见 VideoDenoiserOptions。
- type
- 媒体源类型，详见 MediaSourceType。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。