插件
- Flutter
更新时间不可用
enableExtension
启用/禁用插件。
Future<void> enableExtension(
{required String provider,
required String extension,
bool enable = true,
MediaSourceType type = MediaSourceType.unknownMediaSource});注：
- 如果要开启多个插件，需要多次调用该方法。
- 该方法调用成功后，无法再加载其他插件。
调用时机
建议你在加入频道后调用该方法。
相关回调
频道内调用该方法成功时会触发插件启用回调 onExtensionStartedWithContext 或插件禁用回调 onExtensionStoppedWithContext。
参数
| 参数名 | 描述 |
|---|---|
provider | |
extension | |
enable | |
type | 插件的媒体源类型。详见 MediaSourceType。 |
返回值
方法成功调用时，无返回值；方法调用失败时，会抛出 AgoraRtcException 异常，你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
getExtensionProperty
获取插件的详细信息。
Future<String> getExtensionProperty(
{required String provider,
required String extension,
required String key,
required int bufLen,
MediaSourceType type = MediaSourceType.unknownMediaSource});调用时机
加入频道前后均可调用。
参数
| 参数名 | 描述 |
|---|---|
provider | |
extension | |
key | |
type | 插件的媒体源类型。详见 MediaSourceType。 |
bufLen |
返回值
- 方法调用成功，则返回插件信息。
- 方法调用失败，则返回空字符串。
所属接口类
loadExtensionProvider
加载插件。
Future<void> loadExtensionProvider(
{required String path, bool unloadAfterUse = false});该方法用于将 SDK 外部插件（例如云市场插件和 SDK 拓展插件）添加到 SDK 中。
注： 如果要加载多个插件，需要多次调用该方法。 该方法仅适用于 Windows 和 Android。
调用时机
请在初始化 RtcEngine 后立即调用该方法。
参数
| 参数名 | 描述 |
|---|---|
path | |
unloadAfterUse |
返回值
方法成功调用时，无返回值；方法调用失败时，会抛出 AgoraRtcException 异常，你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
registerExtension
注册插件。
Future<void> registerExtension(
{required String provider,
required String extension,
MediaSourceType type = MediaSourceType.unknownMediaSource});对于 SDK 外部的插件（例如云市场插件和 SDK 拓展插件），加载插件后，你需要调用该方法注册插件。SDK 内部插件（包含在 SDK 包中的插件）在初始化 RtcEngine 后会自动加载并注册，无需调用该方法。
注：
- 如果要注册多个插件，需要多次调用该方法。
- 不同插件在 SDK 中处理数据的顺序由插件的注册顺序决定。即先注册的插件会先处理数据。
调用时机
- 建议你在初始化 RtcEngine 后、加入频道前调用该方法。
- 对于视频相关插件（例如美颜插件），需要在启用视频模块（enableVideo/enableLocalVideo）之前调用该方法。
- 调用该方法前，需要先调用 loadExtensionProvider 加载插件。
参数
| 参数名 | 描述 |
|---|---|
provider | |
extension | |
type | 插件的媒体源类型。详见 MediaSourceType。 |
返回值
方法成功调用时，无返回值；方法调用失败时，会抛出 AgoraRtcException 异常，你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
setExtensionProperty
设置插件的属性。
Future<void> setExtensionProperty(
{required String provider,
required String extension,
required String key,
required String value,
MediaSourceType type = MediaSourceType.unknownMediaSource});开启插件后，你可以调用该方法设置插件的属性。
注： 如果要设置多个插件的属性，需要多次调用该方法。
调用时机
请在调用 enableExtension 开启插件后调用该方法。
相关回调
调用该方法后，可能会触发插件事件回调 onExtensionEventWithContext，具体触发逻辑与插件本身相关。
参数
| 参数名 | 描述 |
|---|---|
provider | |
extension | |
key | |
value | |
type | 插件的媒体源类型。详见 MediaSourceType。 |
返回值
方法成功调用时，无返回值；方法调用失败时，会抛出 AgoraRtcException 异常，你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
setExtensionProviderProperty
设置插件服务商的属性。
Future<void> setExtensionProviderProperty(
{required String provider, required String key, required String value});你可以调用该方法设置插件服务商的属性，并根据服务商的类型初始化相关参数。
注： 如果要设置多个插件服务商的属性，需要多次调用该方法。
调用时机
请在调用 registerExtension 之后、enableExtension 之前调用该方法。
参数
返回值
方法成功调用时，无返回值；方法调用失败时，会抛出 AgoraRtcException 异常，你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
onExtensionErrorWithContext
插件出错回调。
final void Function(ExtensionContext context, int error, String message)?
onExtensionErrorWithContext;启用插件失败或者插件运行出错时，插件会触发该回调并报告错误码和错误原因。
参数
| 参数名 | 描述 |
|---|---|
context | 插件上下文信息，详见 ExtensionContext。 |
error | |
message |
所属接口类
onExtensionEventWithContext
插件事件回调。
final void Function(ExtensionContext context, String key, String value)?
onExtensionEventWithContext;为监听插件事件，你需要注册该回调。
参数
| 参数名 | 描述 |
|---|---|
context | 插件上下文信息，详见 ExtensionContext。 |
key | |
value |
所属接口类
onExtensionStartedWithContext
插件已启用成功回调。
final void Function(ExtensionContext context)? onExtensionStartedWithContext;成功启用插件后会触发该回调。
参数
| 参数名 | 描述 |
|---|---|
context | 插件上下文信息，详见 ExtensionContext。 |
所属接口类
onExtensionStoppedWithContext
插件已禁用回调。
final void Function(ExtensionContext context)? onExtensionStoppedWithContext;成功禁用插件后会触发该回调。
参数
| 参数名 | 描述 |
|---|---|
context | 插件上下文信息，详见 ExtensionContext。 |