IVideoEffect class

@detail api @brief 高级视频特效，参看集成指南。

Inheritance

• Object
• PackClass
• IVideoEffect

Implementers

• VideoEffect

Constructors

IVideoEffect()

Properties

$instance → dynamic

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

$createInstance(List args) → dynamic

Factory method for creating instances

override

$destroy() → void

inherited

$init(List args) → void

inherited

android_setAlgoModelResourceFinder(int finder, int deleter) → Future<int?>

@platform android @hidden for internal use only @detail api @author zhushufan.ref @brief 设置视频特效算法模型地址，并初始化特效模块。 @param finder ResourceFinder 地址 @param deleter ResourceDeleter 地址 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1001: 特效 SDK 不支持该功能。 - –1002: 特效 SDK 版本不兼容。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。

appendEffectNodes(List<String> effectNodes) → Future<int?>

@hidden for internal use only @detail api @author zhushufan.ref @brief 叠加视频特效素材包。 @param effectNodes 特效素材包路径数组。 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1001: 特效 SDK 不支持该功能。 - –1002: 特效 SDK 版本不兼容。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。 @note 该接口会在 setEffectNodes{@link #IVideoEffect#setEffectNodes} 设置的特效基础上叠加特效。

applyStickerEffect(string tickerPath) → Future<int?>

@hidden for internal use only @detail api @author zhushufan.ref @brief 私有接口
设置贴纸的特效路径 @param effectNodes 特效素材包路径数。 @return - 0: 调用成功。 - < 0: 调用失败

disableFaceDetection() → Future<int?>

@detail api @author wangjunlin.3182 @brief 关闭人脸识别功能。 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1001: 特效 SDK 不支持该功能。 - –1002: 特效 SDK 版本不兼容。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。

disableVideoEffect() → Future<int?>

@detail api @author zhushufan.ref @brief 关闭视频特效。 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1001: 特效 SDK 不支持该功能。 - –1002: 特效 SDK 版本不兼容。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。 @note 调用 enableVideoEffect{@link #IVideoEffect#enableVideoEffect} 开启视频特效。

disableVirtualBackground() → Future<int?>

@detail api @author wangjunlin.3182 @brief 关闭虚拟背景。 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1001: 特效 SDK 不支持该功能。 - –1002: 特效 SDK 版本不兼容。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。 @note 调用 enableVirtualBackground{@link #IVideoEffect#enableVirtualBackground} 开启虚拟背景后，可以调用此接口关闭虚拟背景。

enableFaceDetection(IFaceDetectionObserver observer, int interval, string modelPath) → Future<int?>

@detail api @author wangjunlin.3182 @brief 开启人脸识别功能，并设置人脸检测结果回调观察者。
此观察者后，你会周期性收到 onFaceDetectResult{@link #IFaceDetectionObserver#onFaceDetectResult} 回调。 @param observer 人脸检测结果回调观察者，参看 IFaceDetectionObserver{@link #IFaceDetectionObserver}。 @param intervalMs 两次回调之间的最小时间间隔，必须大于 0，单位为毫秒。实际收到回调的时间间隔大于 interval_ms，小于 interval_ms+视频采集帧间隔。 @param faceModelPath 人脸检测算法模型文件路径，一般为 ttfacemodel 文件夹中 tt_face_vXXX.model 文件的绝对路径。 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1001: 特效 SDK 不支持该功能。 - –1002: 特效 SDK 版本不兼容。 - -1004: 初始化中，初始化完成后启动此功能。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。

enableVideoEffect() → Future<int?>

@detail api @author zhushufan.ref @brief 开启高级美颜、滤镜等视频特效。 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1001: 特效 SDK 不支持该功能。 - –1002: 特效 SDK 版本不兼容。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。 @note - 调用本方法前，必须先调用 initCVResource{@link #IVideoEffect#initCVResource} 进行初始化。 - 调用该方法后，特效不直接生效，你还需调用 setEffectNodes{@link #IVideoEffect#setEffectNodes} 设置视频特效素材包或调用 setColorFilter{@link #IVideoEffect#setColorFilter} 设置滤镜。 - 调用 disableVideoEffect{@link #IVideoEffect#disableVideoEffect} 关闭视频特效。

enableVirtualBackground(string modelPath, VirtualBackgroundSource source) → Future<int?>

@detail api @author zhushufan.ref @brief 将摄像头采集画面中的人像背景替换为指定图片或纯色背景。 @param backgroundStickerRes 背景贴纸特效素材绝对路径。 @param source 背景贴纸对象，参看 VirtualBackgroundSource{@link #VirtualBackgroundSource}。 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1001: 特效 SDK 不支持该功能。 - –1002: 特效 SDK 版本不兼容。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。 @note - 调用本方法前，必须先调用 initCVResource{@link #IVideoEffect#initCVResource} 进行初始化。 - 调用 disableVirtualBackground{@link #IVideoEffect#disableVirtualBackground} 关闭虚拟背景。

findOverrideIndices(List args, List<List<int>> indicesList) → List<int>

查找重载参数下标列表 @desc android 构造函数存在重载 此方法通过实际传入参数与构造函数参数列表集合的比对，来获取当前实际的需要使用的参数列表

inherited

fn2AndroidClass(Function callback, dynamic nativeClass(), String methodName) → dynamic

与 ts runtime 中的 fn2AndroidClass 功能一致 将 Dart 函数转换为 Android 回调类实例供 Android 侧使用

inherited

initCVResource(string licenseFile, string algoModelDir) → Future<int?>

@detail api @author zhushufan.ref @brief 检查视频特效证书，设置算法模型路径，并初始化特效模块。 @param licenseFile 证书文件的绝对路径，用于鉴权。 @param algoModelDir 算法模型绝对路径，即存放特效 SDK 所有算法模型的目录。 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1002: 特效 SDK 版本不兼容。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。 @note 鉴权时，会检查 CV 服务端时间和本地设备的时间差异。你必须保证本地系统时间和实际时间一致。

ios_getVideoEffectHandle() → Future

@platform ios @hidden for internal use only @detail api @author zhushufan.ref @brief 返回视频特效句柄。私有接口。

ios_setVideoEffectExpressionDetect(ByteRTCExpressionDetectConfig config) → Future<int?>

@platform ios @hidden for internal use only @detail api @author zhushufan.ref @brief 开启人像属性检测。 @param config 人像属性检测参数，参看 ByteRTCExpressionDetectConfig{@link #ByteRTCExpressionDetectConfig}。 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1001: 特效 SDK 不支持该功能。 - –1002: 特效 SDK 版本不兼容。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeEffectNodes(List<String> effectNodes) → Future<int?>

@hidden for internal use only @detail api @author zhushufan.ref @brief 移除指定的视频特效资源。 @param effectNodes 特效素材包路径数组。 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1001: 特效 SDK 不支持该功能。 - –1002: 特效 SDK 版本不兼容。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。 @note 移除 setEffectNodes{@link #IVideoEffect#SetEffectNodes} 或 appendEffectNodes{@link #IVideoEffect#appendEffectNodes} 设置的视频特效资源。

setColorFilter(string filterRes) → Future<int?>

@detail api @author zhushufan.ref @brief 设置颜色滤镜。 @param filterRes 滤镜资源包绝对路径。 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1001: 特效 SDK 不支持该功能。 - –1002: 特效 SDK 版本不兼容。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。 @note 调用 setColorFilterIntensity{@link #IVideoEffect#setColorFilterIntensity} 设置已启用颜色滤镜的强度。设置强度为 0 时即关闭颜色滤镜。

setColorFilterIntensity(float intensity) → Future<int?>

@detail api @author zhushufan.ref @brief 设置已启用颜色滤镜的强度。 @param intensity 滤镜强度。取值范围 0,1，超出范围时设置无效。
当设置滤镜强度为 0 时即关闭颜色滤镜。 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1001: 特效 SDK 不支持该功能。 - –1002: 特效 SDK 版本不兼容。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。

setEffectNodes(List<String>? effectNodes) → Future<int?>

@detail api @author zhushufan.ref @brief 设置视频特效素材包。 @param effectNodes 特效素材包绝对路径数组。
要取消当前视频特效，将此参数设置为 null。 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1001: 特效 SDK 不支持该功能。 - –1002: 特效 SDK 版本不兼容。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。 @note 调用本方法前，必须先调用 enableVideoEffect{@link #IVideoEffect#enableVideoEffect}。

toString() → String

A string representation of this object.

inherited

transformToPlatformConstructorArgs(List args, List<int> indices, Map<String, dynamic> typeMap, Map<String, dynamic> enumMap, Map<String, dynamic> classMap, String platformVar) → List

实例化参数处理 将 pack 过后的 enum / class 转成 android / ios 平台侧的 enum / class

inherited

updateEffectNode(string effectNode, string key, float value) → Future<int?>

@detail api @author zhushufan.ref @brief 设置特效强度。 @param effectNode 特效素材包绝对路径，参考素材包结构说明。 @param key 需要设置的素材 key 名称，参考素材 key 对应说明。 @param value 特效强度值，取值范围 0,1，超出范围时设置无效。 @return - 0: 调用成功。 - –1000: 未集成特效 SDK。 - –1001: 特效 SDK 不支持该功能。 - –1002: 特效 SDK 版本不兼容。 - < 0: 调用失败，错误码对应具体描述参看 错误码表。

updateInstance(dynamic instance) → void

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited