IVideoEffect class

Inheritance
  • Object
  • PackClass
  • IVideoEffect
Implementers

Constructors

IVideoEffect()

Properties

$instance → dynamic
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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 Sets the video effects resource finder path and initializes video effects. @param finder ResourceFinder path @param deleter ResourceDeleter path @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1001: This API is unavailable for your Effects SDK. - –1002: Your Effects SDK's version is incompatible. - < 0: Other error. See error code table for specific instructions.
appendEffectNodes(List<String> effectNodes) → Future<int?>
@hidden for internal use only @detail api @author zhushufan.ref @brief Appends video effects material package. @param effectNodes Array of effect material package paths. @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1001: This API is unavailable for your Effects SDK. - –1002: Your Effects SDK's version is incompatible. - < 0: Other error. See error code table for specific instructions. @note This API adds new video effect to the video effect you set with setEffectNodes{@link #IVideoEffect#setEffectNodes}.
applyStickerEffect(string tickerPath) → Future<int?>
@hidden for internal use only @detail api @author zhushufan.ref @brief Private method
Set video sticker effects material package. @param effectNodes Array of effect material package paths. @return - 0: Success - <0: Other errors
disableFaceDetection() → Future<int?>
@detail api @author wangjunlin.3182 @brief Stops face detection. @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1001: This API is unavailable for your Effects SDK. - –1002: Your Effects SDK's version is incompatible. - < 0: Other error. See error code table for specific instructions.
disableVideoEffect() → Future<int?>
@detail api @author zhushufan.ref @brief Disables video effects. @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1001: This API is unavailable for your Effects SDK. - –1002: Your Effects SDK's version is incompatible. - < 0: Other error. See error code table for specific instructions. @note Call enableVideoEffect{@link #IVideoEffect#enableVideoEffect} to enable video effects.
disableVirtualBackground() → Future<int?>
@detail api @author wangjunlin.3182 @brief Turns off the virtual background. @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1001: This API is unavailable for your Effects SDK. - –1002: Your Effects SDK's version is incompatible. - < 0: Other error. See error code table for specific instructions. @note After calling enableVirtualBackground{@link #IVideoEffect#enableVirtualBackground} to enable the virtual background function, you can call this API to turn it off.
enableFaceDetection(IFaceDetectionObserver observer, int interval, string modelPath) → Future<int?>
@detail api @author wangjunlin.3182 @brief Starts face detection and registers the observer for the result.
With this observer, you will receive onFaceDetectResult{@link #IFaceDetectionObserver#onFaceDetectResult} periodically. @param observer See IFaceDetectionObserver{@link #IFaceDetectionObserver}. @param intervalMs The minimum time interval between two callbacks in milliseconds. The value should be greater than 0. The actual time interval is between interval_ms and interval_ms+the time slot of a captured video frame. @param faceModelPath The absolute path of the face detection algorithm file. Typically it is the tt_face_vXXX.model file in the ttfacemodel folder. @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1001: This API is unavailable for your Effects SDK. - –1002: Your Effects SDK's version is incompatible. - -1004: Initializing. This function will be available when the initialization is completed. - < 0: Other error. See error code table for specific instructions.
enableVideoEffect() → Future<int?>
@detail api @author zhushufan.ref @brief Enables video effects including beauty and color filters. @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1001: This API is unavailable for your Effects SDK. - –1002: Your Effects SDK's version is incompatible. - < 0: Other error. See error code table for specific instructions. @note - You must call initCVResource{@link #IVideoEffect#initCVResource} before calling this API. - This API does not turn on video effects directly, you must call setEffectNodes{@link #IVideoEffect#setEffectNodes} or setColorFilter{@link #IVideoEffect#setColorFilter} next. - Call disableVideoEffect{@link #IVideoEffect#disableVideoEffect} to turn off video effects.
enableVirtualBackground(string modelPath, VirtualBackgroundSource source) → Future<int?>
@detail api @author zhushufan.ref @brief Sets the original background to a specified image or a solid color. @param backgroundStickerRes The absolute path of virtual background effects. @param source Virtual background source. See VirtualBackgroundSource{@link #VirtualBackgroundSource}. @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1001: This API is unavailable for your Effects SDK. - –1002: Your Effects SDK's version is incompatible. - < 0: Other error. See error code table for specific instructions. @note - You must call initCVResource{@link #IVideoEffect#initCVResource} before calling this API. - Call disableVirtualBackground{@link #IVideoEffect#disableVirtualBackground} to turn off the virtual background.
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 Checks video effect license, sets the video effect resource model path, and initializes video effect. @param licenseFile The absolute path of the license file for authorization. @param algoModelDir The absolute path of the Effects SDK's models file. @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1002: Your Effects SDK's version is incompatible. - < 0: Other error. See error code table for specific instructions. @note When validating the license, the difference of the timestamp of the CV server and the timestamp of the client is checked. You must not change the time of the client.
ios_getVideoEffectHandle() → Future
@platform ios @hidden for internal use only @detail api @author zhushufan.ref @brief Return video effect handle. Private method
ios_setVideoEffectExpressionDetect(ByteRTCExpressionDetectConfig config) → Future<int?>
@platform ios @hidden for internal use only @detail api @author zhushufan.ref @brief Sets the configuration for video effects expression detection. @param config Expression detection configuration. See ByteRTCExpressionDetectConfig{@link #ByteRTCExpressionDetectConfig}. @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1001: This API is unavailable for your Effects SDK. - –1002: Your Effects SDK's version is incompatible. - < 0: Other error. See error code table for specific instructions.
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 Removes the designated video effects material package. @param effectNodes Array of effect material package paths. @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1001: This API is unavailable for your Effects SDK. - –1002: Your Effects SDK's version is incompatible. - < 0: Other error. See error code table for specific instructions. @note Removes the designated video effects in setEffectNodes{@link #IVideoEffect#setEffectNodes} or appendEffectNodes{@link #IVideoEffect#appendEffectNodes}.
setColorFilter(string filterRes) → Future<int?>
@detail api @author zhushufan.ref @brief Sets the color filter. @param filterRes Filter effects package absolute path. @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1001: This API is unavailable for your Effects SDK. - –1002: Your Effects SDK's version is incompatible. - < 0: Other error. See error code table for specific instructions. @note Call setColorFilterIntensity{@link #IVideoEffect#setColorFilterIntensity} to set the intensity of the color filter enabled. Set the intensity to 0 to turn off color filter.
setColorFilterIntensity(float intensity) → Future<int?>
@detail api @author zhushufan.ref @brief Sets the intensity of the color filter enabled. @param intensity Filter intensity. The value range 0,1 is set to be invalid when the range is exceeded.
Set the intensity to 0 to turn off color filter. @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1001: This API is unavailable for your Effects SDK. - –1002: Your Effects SDK's version is incompatible. - < 0: Other error. See error code table for specific instructions.
setEffectNodes(List<String>? effectNodes) → Future<int?>
@detail api @author zhushufan.ref @brief Sets the video effects material package. @param effectNodes Array of effect material package paths.
To remove the current video effect, set it to null. @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1001: This API is unavailable for your Effects SDK. - –1002: Your Effects SDK's version is incompatible. - < 0: Other error. See error code table for specific instructions. @note You must call enableVideoEffect{@link #IVideoEffect#enableVideoEffect} before calling this API.
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 Sets the intensity of video effects. @param effectNode The absolute path of the effects resource package, see Resource Package Structure. @param key The name of the material key to be set, see Functions of Resource Keys for the value. @param value The intensity value that needs to be set, the value range 0,1, and the setting is invalid when it exceeds the range. @return - 0: Success. - –1000: The Effects SDK is not integrated. - –1001: This API is unavailable for your Effects SDK. - –1002: Your Effects SDK's version is incompatible. - < 0: Other error. See error code table for specific instructions.
updateInstance(dynamic instance) → void
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited