AgoraMediaFilterEventDelegate - All

onExtensionError

Occurs when the extension runs incorrectly.

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

When calling enableExtensionWithVendor(YES) fails or the extension runs in error, the extension triggers this callback and reports the error code and reason.

Parameters

provider: The name of the extension provider.
extension: The name of the extension.
error: Error code. For details, see the extension documentation provided by the extension provider.
message: Reason. For details, see the extension documentation provided by the extension provider.

onEvent

The event callback of the extension.

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

To listen for events while the extension is running, you need to register this callback.

Parameters

provider: The name of the extension provider.
extension: The name of the extension.
key: The key of the extension.
value: The value of the extension key.

onExtensionStarted

Occurs when the extension is enabled.

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

After a successful call of enableExtensionWithVendor(YES), the extension triggers this callback.

Parameters

provider: The name of the extension provider.
extension: The name of the extension.

onExtensionStopped

Occurs when the extension is disabled.

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

After a successful call of enableExtensionWithVendor(NO), the extension triggers this callback.

Parameters

provider: The name of the extension provider.
extension: The name of the extension.