This section lists the APIs related to using extensions with the Agora SDK.
RtcEngineConfig
classRtcEngineConfig
classRtcEngineConfig
classIMediaExtensionObserver
classAgoraRtcEngineKit
classAgoraRtcEngineKit
classAgoraRtcEngineKit
classTo implement the BytePlus Effects extension in your app, pass in the corresponding key-value pair when calling setExtensionProperty
or setExtensionPropertyWithVendor
:
bef_effect_ai_check_license
licensePath
. String. The path of the license file.See Special effects handle license.
bef_effect_ai_init
strModelDir
: String. The path of the resource file.deviceName
: String. The device name. Generally you can enter an empty string ("").See Initialize special effects handle.
bef_effect_ai_composer_set_mode
mode
: Int.0
: Do not allow such coexistence.1
: Allow such coexistence.orderType
: Int. The rendering order of effects and stickers. For now you need to set it as 0
.See Set whether the overlay effects may coexist with stickers.
bef_effect_ai_set_orientation
orientation
. The parameter type is bef_ai_rotate_type
. You can set it to 0
(no rotation), 1
(rotate 90 degrees clockwise), 2
(rotate 180 degrees clockwise), or 3
(rotate 270 degrees clockwise.See Set the phone angle.
bef_effect_ai_composer_set_nodes
nodePaths
. A string array containing the paths of each effect resource.bef_effect_ai_composer_update_node
nodePath
: String. The path of the effect resource.nodeTag
: String. The key of the effect. See Functions of Resource Keys.value
: Float. The intensity of a single node for the combined effects.See Set the intensity of superimposed effects.
bef_effect_ai_set_effect
strPath
. String. The path of the effect resource.See Set stickers.
bef_effect_ai_set_color_filter_v2
strPath
. String. The path of the effect resource.See Set filters.
bef_effect_ai_set_intensity
fIntensity
. Float. The value ranges between [0.0, 1.0], where 0
means disabling the filter.See Set filter intensity.