视频增强

getFaceShapeAreaOptions:

获取美型部位选项。

Objective-C

- (AgoraFaceShapeAreaOptions * _Nullable)getFaceShapeAreaOptions:(AgoraFaceShapeArea) area sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(getFaceShapeAreaOptions(_:sourceType:));

自从

v4.5.0

调用该方法可以获取美型部位当前设置的参数信息。

适用场景

用户在 App 中打开美型部位和修饰力度菜单时，你可以调用该方法获取当前的美型部位选项，然后根据结果刷新用户界面中的菜单，并更新 UI。

调用时机

请在 enableVideo 之后调用该方法。

调用限制

无。

参数

area

美型部位。详见 AgoraFaceShapeArea。

sourceType

效果应用的媒体源类型。详见 AgoraMediaSourceType。

注意

在该方法中，该参数仅支持以下两种设置：

• 使用摄像头采集本地视频时，请保持默认值 AgoraMediaSourceTypePrimaryCamera。
• 如果要使用自定义采集的视频，将该参数设置为 AgoraMediaSourceTypeCustomVideo。

返回值

• 方法调用成功，返回 AgoraFaceShapeAreaOptions 对象。
• 方法调用失败，返回 nil。

所属接口类

• AgoraRtcEngineKit

getFaceShapeAreaOptions:sourceType:

获取美型部位选项。

Objective-C

- (AgoraFaceShapeAreaOptions * _Nullable)getFaceShapeAreaOptions:(AgoraFaceShapeArea) area NS_SWIFT_NAME(getFaceShapeAreaOptions(_:));

自从

v4.5.0

调用该方法可以获取美型部位当前设置的参数信息。

适用场景

用户在 App 中打开美型部位和修饰力度菜单时，你可以调用该方法获取当前的美型部位选项，然后根据结果刷新用户界面中的菜单，并更新 UI。

调用时机

请在 enableVideo 之后调用该方法。

调用限制

无。

参数

area

美型部位。详见 AgoraFaceShapeArea。

sourceType

效果应用的媒体源类型。详见 AgoraMediaSourceType。

注意

在该方法中，该参数仅支持以下两种设置：

• 使用摄像头采集本地视频时，请保持默认值 AgoraMediaSourceTypePrimaryCamera。
• 如果要使用自定义采集的视频，将该参数设置为 AgoraMediaSourceTypeCustomVideo。

返回值

• 方法调用成功，返回 AgoraFaceShapeAreaOptions 对象。
• 方法调用失败，返回 nil。

所属接口类

• AgoraRtcEngineKit

getFaceShapeBeautyOptions

获取美型效果选项。

Objective-C

- (AgoraFaceShapeBeautyOptions * _Nullable)getFaceShapeBeautyOptions:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(getFaceShapeBeautyOptions(_:));

自从

v4.5.0

调用该方法可以获取美型效果当前设置的参数信息。

适用场景

用户在 App 中打开美型风格和风格强度菜单时，你可以调用该方法获取当前的美型效果选项，然后根据结果刷新用户界面中的菜单，并更新 UI。

调用时机

请在 enableVideo 之后调用该方法。

调用限制

无。

参数

sourceType

效果应用的媒体源类型。详见 AgoraMediaSourceType。

注意

在该方法中，该参数仅支持以下两种设置：

• 使用摄像头采集本地视频时，请保持默认值 AgoraMediaSourceTypePrimaryCamera。
• 如果要使用自定义采集的视频，将该参数设置为 AgoraMediaSourceTypeCustomVideo。

返回值

• 方法调用成功，返回 AgoraFaceShapeBeautyOptions 对象。
• 方法调用失败，返回 nil。

所属接口类

• AgoraRtcEngineKit

getFaceShapeBeautyOptions

获取美型效果选项。

- (AgoraFaceShapeBeautyOptions * Nullable)getFaceShapeBeautyOptions:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(getFaceShapeBeautyOptions(:));

自从

v4.5.0

调用该方法可以获取美型效果当前设置的参数信息。

适用场景

用户在 App 中打开美型风格和风格强度菜单时，你可以调用该方法获取当前的美型效果选项，然后根据结果刷新用户界面中的菜单，并更新 UI。

调用时机

请在 enableVideo 之后调用该方法。

调用限制

无。

参数

sourceType

效果应用的媒体源类型。详见 AgoraMediaSourceType。

注意

在该方法中，该参数仅支持以下两种设置：

• 使用摄像头采集本地视频时，请保持默认值 AgoraMediaSourceTypePrimaryCamera。
• 如果要使用自定义采集的视频，将该参数设置为 AgoraMediaSourceTypeCustomVideo。

返回值

• 方法调用成功，返回 AgoraFaceShapeBeautyOptions 对象。
• 方法调用失败，返回 nil。

setBeautyEffectOptions:options:

设置美颜效果选项。

Objective-C

- (int)setBeautyEffectOptions:(BOOL)enable options:(AgoraBeautyOptions* _Nullable)options;

开启本地美颜功能，并设置美颜效果选项。

调用时机

请在 enableVideo 或 startPreview: 之后调用该方法。

调用限制

• 该方法依赖于视频增强动态库 AgoraClearVisionExtension.framework，如果删除该动态库会导致无法正常开启该功能。
• 该功能对设备性能要求较高，调用该方法时 SDK 会自动对当前设备能力进行检查。

参数

enable

是否开启美颜功能：

• YES: 开启美颜功能。
• NO:（默认）关闭美颜功能。

options

美颜选项，详细定义见 AgoraBeautyOptions。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。
  • -4：当前设备不支持该功能，可能的原因有：
    • 当前设备能力不满足美颜的使用要求，建议更换性能更高的设备。

所属接口类

• AgoraRtcEngineKit

setBeautyEffectOptions:options:sourceType:

设置美颜效果选项并指定媒体源。

Objective-C

- (int)setBeautyEffectOptions:(BOOL)enable options:(AgoraBeautyOptions* _Nullable)options sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(setBeautyEffectOptions(_:options:sourceType:));

开启本地美颜功能，并设置美颜效果选项和效果应用的媒体源。

该方法和 setBeautyEffectOptions:options: 均可用于设置美颜效果选项，区别在于该方法支持在设置美颜效果选项时指定应用美颜的媒体源。

调用时机

请在 enableVideo 或 startPreview: 之后调用该方法。

参数

enable

是否开启美颜功能：

• YES: 开启美颜功能。
• NO:（默认）关闭美颜功能。

options

美颜选项，详细定义见 AgoraBeautyOptions。

sourceType

效果应用的媒体源类型。详见 AgoraMediaSourceType。

注意

在该方法中，该参数仅支持以下两种设置：

• 默认值为 AgoraMediaSourceTypePrimaryCamera。
• 如果要使用自定义采集的视频，将该参数设置为 AgoraMediaSourceTypeCustomVideo。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。
  • -4：当前设备不支持该功能，可能的原因有：
    • 当前设备能力不满足美颜的使用要求，建议更换性能更高的设备。

所属接口类

• AgoraRtcEngineKit

setColorEnhanceOptions:options:

设置色彩增强功能。

Objective-C

- (int)setColorEnhanceOptions:(BOOL)enable options:(AgoraColorEnhanceOptions* _Nullable)options NS_SWIFT_NAME(setColorEnhanceOptions(_:options:));

详情

摄像头采集到的视频画面可能存在色彩失真的现象。色彩增强功能可以通过智能调节饱和度和对比度等视频特性，提升视频色彩丰富度和色彩还原度，最终使视频画面更生动。

你可以调用该方法开启色彩增强功能并设置色彩增强的效果。

注意

• 请在 enableVideo 后调用该方法。
• 色彩增强对设备性能有一定要求。开启色彩增强后，如果设备出现严重发烫等问题，建议你将色彩增强等级修改为消耗性能较少的等级或关闭色彩增强功能。
• 该方法依赖于视频增强动态库 AgoraClearVisionExtension.framework，如果删除该动态库会导致无法正常开启该功能。

参数

enable

是否开启色彩增强功能：

• YES：开启色彩增强功能。
• NO：（默认）关闭色彩增强功能。

options

色彩增强选项，用于设置色彩增强的效果。详见 AgoraColorEnhanceOptions。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcEngineKit

setColorEnhanceOptions:options:sourceType:

设置色彩增强功能并指定媒体源。

Objective-C

- (int)setColorEnhanceOptions:(BOOL)enable options:(AgoraColorEnhanceOptions* _Nullable)options sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(setColorEnhanceOptions(_:options:sourceType:));

详情

摄像头采集到的视频画面可能存在色彩失真的现象。色彩增强功能可以通过智能调节饱和度和对比度等视频特性，提升视频色彩丰富度和色彩还原度，最终使视频画面更生动。

该方法和 setColorEnhanceOptions:options: 均可用于设置色彩增强功功能，区别在于该方法支持在设色彩增强功能时指定应用色彩增强的媒体源。

注意

• 请在 enableVideo 后调用该方法。
• 色彩增强对设备性能有一定要求。开启色彩增强后，如果设备出现严重发烫等问题，建议你将色彩增强等级修改为消耗性能较少的等级或关闭色彩增强功能。
• 该方法依赖于视频增强动态库 AgoraClearVisionExtension.framework，如果删除该动态库会导致无法正常开启该功能。

参数

enable

是否开启色彩增强功能：

• YES：开启色彩增强功能。
• NO：（默认）关闭色彩增强功能。

options

色彩增强选项，用于设置色彩增强的效果。详见 AgoraColorEnhanceOptions。

sourceType

效果应用的媒体源类型。详见 AgoraMediaSourceType。

注意

在该方法中，该参数仅支持以下两种设置：

• 默认值为 AgoraMediaSourceTypePrimaryCamera。
• 如果要使用自定义采集的视频，将该参数设置为 AgoraMediaSourceTypeCustomVideo。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcEngineKit

setFaceShapeAreaOptions:

设置美型部位选项并指定媒体源。

Objective-C

- (int)setFaceShapeAreaOptions:(AgoraFaceShapeAreaOptions* _Nullable)options sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(setFaceShapeAreaOptions(_:sourceType:));

自从

v4.5.0

如果在 setFaceShapeBeautyOptions:options: 方法中实现的预设美型效果达不到预期，你可以通过该方法设置美型部位选项，对人脸的各个部位单独微调，实现更加精细的美型效果。详见实现高级美颜。

该方法和 setFaceShapeAreaOptions:sourceType: 均可用于设置美型部位选项，区别在于该方法支持指定应用美型效果的媒体源。

警告

美型属于增值服务，计费方式详见计费策略。

调用时机

请在 setFaceShapeBeautyOptions:options: 或 setFaceShapeBeautyOptions:options:sourceType: 之后调用该方法。

调用限制

• 该方法依赖于视频增强动态库 AgoraClearVisionExtension.framework，如果删除该动态库会导致无法正常开启该功能。
• 该功能对设备性能要求较高，调用该方法时 SDK 会自动对当前设备能力进行检查。

参数

options

美型部位选项，详见 AgoraFaceShapeAreaOptions。

sourceType

效果应用的媒体源类型。详见 AgoraMediaSourceType。

注意

在该方法中，该参数仅支持以下两种设置：

• 使用摄像头采集本地视频时，请保持默认值 AgoraMediaSourceTypePrimaryCamera。
• 如果要使用自定义采集的视频，将该参数设置为 AgoraMediaSourceTypeCustomVideo。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。
  • -4：当前设备不支持该功能，可能的原因有：
    • 当前设备能力不满足美颜的使用要求，建议更换性能更高的设备。

所属接口类

• AgoraRtcEngineKit

setFaceShapeAreaOptions:

设置美型部位选项。

- (int)setFaceShapeAreaOptions:(AgoraFaceShapeAreaOptions* Nullable)options sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(setFaceShapeAreaOptions(:sourceType:));

自从

v4.5.0

如果在 setFaceShapeBeautyOptions:options: 方法中实现的预设美型效果达不到预期，你可以通过该方法设置美型部位选项，对人脸的各个部位单独微调，实现更加精细的美型效果。详见实现高级美颜。

警告

美型属于增值服务，计费方式详见计费策略。

调用时机

请在调用 setFaceShapeBeautyOptions:options: 或 setFaceShapeBeautyOptions:options: 之后调用该方法。

调用限制

• 该方法依赖于视频增强动态库 AgoraClearVisionExtension.framework，如果删除该动态库会导致无法正常开启该功能。
• 该功能对设备性能要求较高，调用该方法时 SDK 会自动对当前设备能力进行检查。

参数

options

美型部位选项，详见 AgoraFaceShapeAreaOptions。

sourceType

效果应用的媒体源类型。详见 AgoraMediaSourceType。

注意

在该方法中，该参数仅支持以下两种设置：

• 使用摄像头采集本地视频时，请保持默认值 AgoraMediaSourceTypePrimaryCamera。
• 如果要使用自定义采集的视频，将该参数设置为 AgoraMediaSourceTypeCustomVideo。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。
  • -4：当前设备不支持该功能，可能的原因有：
    • 当前设备能力不满足美颜的使用要求，建议更换性能更高的设备。

setFaceShapeBeautyOptions:options:

设置美型效果选项并指定媒体源。

Objective-C

- (int)setFaceShapeBeautyOptions:(BOOL)enable options:(AgoraFaceShapeBeautyOptions* _Nullable)options sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(setFaceShapeBeautyOptions(_:options:sourceType:));

自从

v4.5.0

调用该方法可对人脸各部位进行修饰，使用预设的参数一次性实现瘦脸、大眼、瘦鼻等微整形效果，支持微调整体的修饰力度。详见实现高级美颜。

该方法和 setFaceShapeBeautyOptions:options:sourceType: 均可用于设置美型效果选项，区别在于该方法支持指定应用美型效果的媒体源。

警告

美型属于增值服务，计费方式详见计费策略。

调用时机

请在 enableVideo 之后调用该方法。

调用限制

• 该方法依赖于视频增强动态库 AgoraClearVisionExtension.framework，如果删除该动态库会导致无法正常开启该功能。
• 该功能对设备性能要求较高，调用该方法时 SDK 会自动对当前设备能力进行检查。

参数

enable

是否开启美型效果：

• YES: 开启美型功能。
• NO:（默认）关闭美型功能。

options

美型风格选项，详见 AgoraFaceShapeBeautyOptions。

sourceType

效果应用的媒体源类型。详见 AgoraMediaSourceType。

注意

在该方法中，该参数仅支持以下两种设置：

• 使用摄像头采集本地视频时，请保持默认值 AgoraMediaSourceTypePrimaryCamera。
• 如果要使用自定义采集的视频，将该参数设置为 AgoraMediaSourceTypeCustomVideo。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。
  • -4：当前设备不支持该功能，可能的原因有：
    • 当前设备能力不满足美颜的使用要求，建议更换性能更高的设备。

所属接口类

• AgoraRtcEngineKit

setFaceShapeBeautyOptions:options:sourceType:

设置美型效果选项。

Objective-C

- (int)setFaceShapeBeautyOptions:(BOOL)enable options:(AgoraFaceShapeBeautyOptions* _Nullable)options NS_SWIFT_NAME(setFaceShapeBeautyOptions(_:options:));

自从

v4.5.0

调用该方法可对脸部指定部位进行调整，从而实现瘦脸、大眼、瘦鼻等微整形效果。详见实现高级美颜。

警告

美型属于增值服务，计费方式详见计费策略。

调用时机

请在 enableVideo 之后调用该方法。

调用限制

• 该方法依赖于视频增强动态库 AgoraClearVisionExtension.framework，如果删除该动态库会导致无法正常开启该功能。
• 该功能对设备性能要求较高，调用该方法时 SDK 会自动对当前设备能力进行检查。

参数

enable

是否开启美型效果：

• YES: 开启美型功能。
• NO:（默认）关闭美型功能。

options

美型风格选项，详见 AgoraFaceShapeBeautyOptions。

sourceType

效果应用的媒体源类型。详见 AgoraMediaSourceType。

注意

在该方法中，该参数仅支持以下两种设置：

• 使用摄像头采集本地视频时，请保持默认值 AgoraMediaSourceTypePrimaryCamera。
• 如果要使用自定义采集的视频，将该参数设置为 AgoraMediaSourceTypeCustomVideo。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。
  • -4：当前设备不支持该功能，可能的原因有：
    • 当前设备能力不满足美颜的使用要求，建议更换性能更高的设备。

所属接口类

• AgoraRtcEngineKit

setFilterEffectOptions:options:sourceType:

设置滤镜效果选项并指定媒体源。

Objective-C

- (int)setFilterEffectOptions:(BOOL)enable options:(AgoraFilterEffectOptions* _Nullable)options sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(setFilterEffectOptions(_:options:sourceType:));

自从

v4.5.0

该方法和 setBeautyEffectOptions:options:sourceType: 均可用于设置滤镜效果选项，区别在于该方法支持在设置滤镜效果选项时指定应用滤镜的媒体源。

调用时机

请在 enableVideo 之后调用该方法。

调用限制

• 该方法依赖于视频增强动态库 AgoraClearVisionExtension.framework，如果删除该动态库会导致无法正常开启该功能。
• 该功能对设备性能要求较高，调用该方法时 SDK 会自动对当前设备能力进行检查。

参数

enable

是否开启滤镜效果：

• YES: 开启滤镜功能。
• NO:（默认）关闭滤镜功能。

options

滤镜选项，详见 AgoraFilterEffectOptions。

sourceType

效果应用的媒体源类型。详见 AgoraMediaSourceType。

注意

在该方法中，该参数仅支持以下两种设置：

• 使用摄像头采集本地视频时，请保持默认值 AgoraMediaSourceTypePrimaryCamera。
• 如果要使用自定义采集的视频，将该参数设置为 AgoraMediaSourceTypeCustomVideo。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcEngineKit

setFilterEffectOptions:options:

设置滤镜效果选项。

Objective-C

- (int)setFilterEffectOptions:(BOOL)enable options:(AgoraFilterEffectOptions* _Nullable)options  NS_SWIFT_NAME(setFilterEffectOptions(_:options:));

自从

v4.5.0

调用时机

请在 enableVideo 之后调用该方法。

调用限制

• 该方法依赖于视频增强动态库 AgoraClearVisionExtension.framework，如果删除该动态库会导致无法正常开启该功能。
• 该功能对设备性能要求较高，调用该方法时 SDK 会自动对当前设备能力进行检查。

参数

enable

是否开启滤镜效果：

• YES: 开启滤镜功能。
• NO:（默认）关闭滤镜功能。

options

滤镜选项，详见 AgoraFilterEffectOptions。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcEngineKit

setLowlightEnhanceOptions:options:

设置暗光增强功能。

Objective-C

- (int)setLowlightEnhanceOptions:(BOOL)enable options:(AgoraLowlightEnhanceOptions* _Nullable)options NS_SWIFT_NAME(setLowlightEnhanceOptions(_:options:));

你可以调用该方法开启暗光增强功能并设置暗光增强的效果。

适用场景

暗光增强功能可以在光线亮度偏低（如背光、阴天、暗场景）和亮度不均匀的环境下自适应调整视频画面的亮度值，恢复或凸显图像的细节信息，最终提升视频图像的整体视觉效果。

调用时机

请在 enableVideo 后调用该方法。

调用限制

• 该方法依赖于视频增强动态库 AgoraClearVisionExtension.framework，如果删除该动态库会导致无法正常开启该功能。
• 暗光增强对设备性能有一定要求。开启暗光增强后，如果设备出现严重发烫等问题，建议你将暗光增强等级修改为消耗性能较少的等级或关闭暗光增强功能。
• 如果要实现优先画质 (AgoraLowlightEnhanceLevelQuality) 的暗光增强，需要先调用 setVideoDenoiserOptions:options: 实现视频降噪，具体对应关系如下：
  • 暗光增强为自动模式 (AgoraLowlightEnhanceModeAuto) 时，视频降噪需设置为优先画质 (AgoraVideoDenoiserLevelHighQuality)、自动模式 (AgoraVideoDenoiserModeAuto)。
  • 暗光增强为手动模式 (AgoraLowlightEnhanceModeManual) 时，视频降噪需设置为优先画质 (AgoraVideoDenoiserLevelHighQuality)、手动模式 (AgoraVideoDenoiserModeManual)。

参数

enable

是否开启暗光增强功能：

• YES: 开启暗光增强功能。
• NO:（默认）关闭暗光增强功能。

options

暗光增强选项，用于设置暗光增强的效果。详见 AgoraLowlightEnhanceOptions。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcEngineKit

setLowlightEnhanceOptions:options:sourceType:

设置暗光增强功能并指定媒体源。

Objective-C

- (int)setLowlightEnhanceOptions:(BOOL)enable options:(AgoraLowlightEnhanceOptions* _Nullable)options sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(setLowlightEnhanceOptions(_:options:sourceType:));

该方法和 setLowlightEnhanceOptions:options: 均可用于设置暗光增强功能，区别在于该方法支持在设置暗光增强功能时指定应用暗光增强的媒体源。

适用场景

采光不足的环境和低端视频采集设备会使视频图像含有明显的噪声，影响视频画质。在实时互动场景下，视频噪声还会在编码过程中占用码流资源并降低编码效率。

调用时机

请在 enableVideo 后调用该方法。

调用限制

• 该方法依赖于视频增强动态库 AgoraClearVisionExtension.framework，如果删除该动态库会导致无法正常开启该功能。
• 视频降噪对设备性能有一定要求。开启视频降噪后，如果设备出现严重发烫等问题，建议你将视频降噪等级修改为消耗性能较少的等级或关闭视频降噪功能。

参数

enable

是否开启暗光增强功能：

• YES: 开启暗光增强功能。
• NO:（默认）关闭暗光增强功能。

options

暗光增强选项，用于设置暗光增强的效果。详见 AgoraLowlightEnhanceOptions。

sourceType

效果应用的媒体源类型。详见 AgoraMediaSourceType。

注意

在该方法中，该参数仅支持以下两种设置：

• 默认值为 AgoraMediaSourceTypePrimaryCamera。
• 如果要使用自定义采集的视频，将该参数设置为 AgoraMediaSourceTypeCustomVideo。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcEngineKit

setVideoDenoiserOptions:options:

设置视频降噪功能。

Objective-C

- (int)setVideoDenoiserOptions:(BOOL)enable options:(AgoraVideoDenoiserOptions* _Nullable)options NS_SWIFT_NAME(setVideoDenoiserOptions(_:options:));

你可以调用该方法开启视频降噪功能并设置视频降噪的效果。

信息

如果该方法实现的降噪强度无法满足你的需求，声网推荐你调用 setBeautyEffectOptions:options: 方法启用美颜磨皮功能，以获得更好的视频降噪效果。强效降噪效果的 AgoraBeautyOptions 推荐设置如下：

• lighteningContrastLevel：AgoraLighteningContrastNormal
• lighteningLevel：0.0
• smoothnessLevel：0.5
• rednessLevel：0.0
• sharpnessLevel：0.1

适用场景

采光不足的环境和低端视频采集设备会使视频图像含有明显的噪声，影响视频画质。在实时互动场景下，视频噪声还会在编码过程中占用码流资源并降低编码效率。

调用时机

请在 enableVideo 后调用该方法。

调用限制

• 该方法依赖于视频增强动态库 AgoraClearVisionExtension.framework，如果删除该动态库会导致无法正常开启该功能。
• 视频降噪对设备性能有一定要求。开启视频降噪后，如果设备出现严重发烫等问题，建议你将视频降噪等级修改为消耗性能较少的等级或关闭视频降噪功能。

参数

enable

是否开启视频降噪功能：

• YES : 开启视频降噪功能。
• NO :（默认）关闭视频降噪功能。

options

视频降噪选项，用于设置视频降噪的效果。详见 AgoraVideoDenoiserOptions。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcEngineKit

setVideoDenoiserOptions:options:sourceType:

设置视频降噪功能并指定媒体源。

Objective-C

- (int)setVideoDenoiserOptions:(BOOL)enable options:(AgoraVideoDenoiserOptions* _Nullable)options sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(setVideoDenoiserOptions(_:options:sourceType:));

你可以调用该方法开启视频降噪功能并设置视频降噪的效果。

该方法和 setVideoDenoiserOptions:options: 均可用于设置视频降噪功能，区别在于该方法支持在设置视频降噪功能时指定应用视频降噪功能的媒体源。

信息

如果该方法实现的降噪强度无法满足你的需求，声网推荐你调用 setBeautyEffectOptions:options: 方法启用美颜磨皮功能，以获得更好的视频降噪效果。强效降噪效果的 AgoraBeautyOptions 推荐设置如下：

• lighteningContrastLevel：AgoraLighteningContrastNormal
• lighteningLevel：0.0
• smoothnessLevel：0.5
• rednessLevel：0.0
• sharpnessLevel：0.1

适用场景

采光不足的环境和低端视频采集设备会使视频图像含有明显的噪声，影响视频画质。在实时互动场景下，视频噪声还会在编码过程中占用码流资源并降低编码效率。

调用时机

请在 enableVideo 后调用该方法。

调用限制

• 该方法依赖于视频增强动态库 AgoraClearVisionExtension.framework，如果删除该动态库会导致无法正常开启该功能。
• 视频降噪对设备性能有一定要求。开启视频降噪后，如果设备出现严重发烫等问题，建议你将视频降噪等级修改为消耗性能较少的等级或关闭视频降噪功能。

参数

enable

是否开启视频降噪功能：

• YES : 开启视频降噪功能。
• NO :（默认）关闭视频降噪功能。

options

视频降噪选项，用于设置视频降噪的效果。详见 AgoraVideoDenoiserOptions。

sourceType

效果应用的媒体源类型。详见 AgoraMediaSourceType。

注意

在该方法中，该参数仅支持以下两种设置：

• 默认值为 AgoraMediaSourceTypePrimaryCamera。
• 如果要使用自定义采集的视频，将该参数设置为 AgoraMediaSourceTypeCustomVideo。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

• AgoraRtcEngineKit