插件

enableExtensionWithVendor

启用/禁用插件。

Objective-C

- (int)enableExtensionWithVendor:(NSString * __nonnull)provider extension:(NSString * __nonnull)extension enabled:(BOOL)enabled;
                

如需调用本方法，请在初始化 AgoraRtcEngineKit 对象后立即调用。

注：

• 如果要开启多个插件，需要多次调用该方法。

• 不同插件在 SDK 中处理数据的顺序由插件的开通顺序决定。即先开启的插件会先处理数据。

参数

参数名	描述
provider	提供插件的服务商名称。
extension	插件的名称。
enabled	是否启用插件： YES: 启用插件。 NO: 禁用插件。

返回值

• 0: 方法调用成功。

• < 0: 方法调用失败

  • -3: 该插件动态库没有被加载。声网推荐你检查该动态库是否存放在预期的位置或该动态库名是否正确。

所属接口类

• AgoraRtcEngineKit

getExtensionPropertyWithVendor [1/2]

获取插件的详细信息。

Objective-C

- (NSString * _Nullable)getExtensionPropertyWithVendor:(NSString * __nonnull)provider
                                             extension:(NSString * __nonnull)extension
                                                   key:(NSString * __nonnull)key;

参数

参数名	描述
provider	提供插件的服务商名称。
extension	插件的名称。
key	插件属性的 Key。

返回值

• 方法调用成功，则返回插件信息。

• 方法调用失败，则返回空字符串。

所属接口类

• AgoraRtcEngineKit

getExtensionPropertyWithVendor [2/2]

获取插件的详细信息。

Objective-C

- (NSString * _Nullable)getExtensionPropertyWithVendor:(NSString * __nonnull)provider
                                             extension:(NSString * __nonnull)extension
                                                   key:(NSString * __nonnull)key
                                            sourceType:(AgoraMediaSourceType)sourceType;

参数

参数名	描述
provider	提供插件的服务商名称。
extension	插件的名称。
key	插件属性的 Key。
sourceType	插件的媒体源类型。详见 AgoraMediaSourceType。

返回值

• 方法调用成功，则返回插件信息。

• 方法调用失败，则返回空字符串。

所属接口类

• AgoraRtcEngineKit

setExtensionPropertyWithVendor

设置插件的属性。

Objective-C

- (int)setExtensionPropertyWithVendor:(NSString * __nonnull)provider extension:(NSString * __nonnull)extension key:(NSString * __nonnull)key value:(NSString * __nonnull)value;

开启插件后，你可以调用该方法设置插件的属性。

参数

参数名	描述
provider	提供插件的服务商名称。
extension	插件的名称。
key	插件属性的 Key。
value	插件属性 Key 对应的值。

返回值

• 0: 方法调用成功。

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

所属接口类

• AgoraRtcEngineKit

setExtensionProviderPropertyWithVendor

设置插件服务商的属性。

Objective-C

- (int) setExtensionProviderPropertyWithVendor:(NSString * __nonnull)provider key:(NSString * __nonnull)key value:(NSString * __nonnull)value;

你可以调用该方法设置插件服务商的属性，并根据服务商的类型初始化相关参数。

注意：
该方法需要在 enableExtensionWithVendor 之后、且启用音频（enableAudio/enableLocalAudio）或启用视频（enableVideo/enableLocalVideo）之前调用。

参数

参数名	描述
provider	提供插件的服务商名称。
key	插件属性的 Key。
value	插件属性 Key 对应的值。

返回值

• 0: 方法调用成功。

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

所属接口类

• AgoraRtcEngineKit

onExtensionError

插件出错回调。

Objective-C

- (void)onExtensionError:(NSString * __nullable)provider
                 extension:(NSString * __nullable)extension
                     error:(int)error
                   message:(NSString * __nullable)message;

当调用 enableExtensionWithVendor(YES) 启用插件失败或者插件运行出错时， 插件会触发该回调并上报错误码和错误原因。

参数

参数名	描述
provider	提供插件的服务商名称。
extension	插件的名称。
error	错误码。详见插件服务商提供的插件文档。
message	错误原因。详见插件服务商提供的插件文档。

所属接口类

• AgoraMediaFilterEventDelegate

onEvent

插件事件回调。

Objective-C

- (void)onEvent:(NSString * __nullable)provider
      extension:(NSString * __nullable)extension
            key:(NSString * __nullable)key
          value:(NSString * __nullable)value;
@end

为监听插件事件，你需要注册该回调。

参数

参数名	描述
provider	提供插件的服务商名称。
extension	插件名称。
key	插件属性的 Key。
value	插件属性 Key 对应的值。

所属接口类

• AgoraMediaFilterEventDelegate

onExtensionStarted

插件启用回调。

Objective-C

- (void)onExtensionStarted:(NSString * __nullable)provider
                 extension:(NSString * __nullable)extension;

当调用 enableExtensionWithVendor(YES) 启用插件成功时，插件会触发该回调。

参数

参数名	描述
provider	提供插件的服务商名称。
extension	插件名称。

所属接口类

• AgoraMediaFilterEventDelegate

onExtensionStopped

插件禁用回调。

Objective-C

- (void)onExtensionStopped:(NSString * __nullable)provider
                 extension:(NSString * __nullable)extension;

当调用 enableExtensionWithVendor(NO) 禁用插件成功时，插件会触发该回调。

参数

参数名	描述
provider	提供插件的服务商名称。
extension	插件名称。

所属接口类

• AgoraMediaFilterEventDelegate