ActiveFence Video Content Moderation

The following figure shows the ActiveFence workflow to moderate content sent by a specific user to a channel:

This page shows you how to integrate and use the ActiveFence content detection and moderation extension in your app.

Prerequisites

The development environment requirements are as follows:

• Android Studio 4.1 or later.
• A physical device (not an emulator) running Android 5.0 or later.
• Implemented the SDK quickstart.
• If you use RTC SDK tokens, ensure that you are using AccessToken2 to enable ActiveFence video content moderation.

Project setup

In order to configure ActiveFence:

1. Set up your ActiveFence account.

   • In Agora Extensions Marketplace, select ActiveFence, then click Activate Your Account; or contact extensions.marketplace@agora.io to activate the extension.
   • Follow the activation email instructions to activate your ActiveFence account.

2. Configure your ActiveFence API key.

   • In ActiveFence, open Account Settings.
   • Click Data Management > ActiveFence API Keys and create a key.
   • Save the key securely and share the key information with Agora so the services can be connected.

3. Connect your app to your ActiveFence account.

   • Email support@agora.io and provide your company name, company email, Agora App ID, and ActiveFence API key.

4. Customize your callback fields.

   • In ActiveFence, open Account Settings > Moderation Capabilities > Custom Fields.
   • Add editable fields for cname, requestId, sid, source, timestamp, and uid.

   Title & Key	Type	Meaning
   cname	Text	RTC channel name
   requestId	Text	Request ID of the screenshot
   sid	Text	Session ID
   source	Text	Source of screenshot (agora)
   timestamp	Number	Timestamp, for example 20230614050206430
   uid	Number	User ID (unique in a channel)

   

The editable fields are:

5. Configure action webhooks and workflows in ActiveFence.
6. Invite users and start moderating content in ActiveFence.

Integrate the extension

Now that ActiveFence is activated, set up your webhook receiver and then enable content inspection in your SDK project.

Set up your webhook

To react to content moderation callbacks, create a server that receives and interprets the webhook data. For example:

1. Open agora-activefence-kicker and deploy the server with its one-click flow.
2. Add the deployment link plus /kick/ to the webhook URL for the desired event in ActiveFence.

Initialize ContentInspectConfig

Set up the inspect config inside ContentInspectModule. If you use a string UID to join the channel and want to receive it in the webhook callback, pass the string UID to extraInfo inside ContentInspectConfig.

val contentInspectModule = ContentInspectModule()
contentInspectModule.type = ContentInspectConfig.CONTENT_INSPECT_TYPE_IMAGE_MODERATION
contentInspectModule.interval = 5
val contentInspectConfig = ContentInspectConfig()
contentInspectConfig.modules[0] = contentInspectModule
contentInspectConfig.moduleCount = 1
contentInspectConfig.extraInfo = "YourExtraInfo"

Apply ContentInspectConfig

Enable content inspection after joining a channel and after the local video is published and played. If you need support for taking screenshots for multiple video streams and uploading them, use enableContentInspectEx.

val returnVal = agoraEngine?.enableContentInspect(true, contentInspectConfig)
val returnValEx = agoraEngine?.enableContentInspectEx(enabled, config = config, connection = connection)

Catch banning events

To know when your local user is banned from the scene, use the connection state callback:

override fun onConnectionStateChanged(state: Int, reason: Int) {
  super.onConnectionStateChanged(state, reason)
  if (
    state == Constants.CONNECTION_STATE_FAILED &&
    reason == Constants.CONNECTION_CHANGED_BANNED_BY_SERVER
  ) {
    showMessage("Stream banned by the server")
  }
}

Reference

• Agora Content Inspect Moderation Showcase
• Multi-channel methods
• ActiveFence documentation
• Channel Management REST API

The following figure shows the ActiveFence workflow to moderate content sent by a specific user to a channel:

This page shows you how to integrate and use the ActiveFence content detection and moderation extension in your app.

Prerequisites

• Xcode 9.0 or later.
• A physical device (not an emulator) running iOS 9.0 or later.
• Implemented the SDK quickstart.
• If you use RTC SDK tokens, ensure that you are using AccessToken2 to enable ActiveFence video content moderation.

Project setup

Complete the same ActiveFence account, API key, webhook, and workflow configuration described in the Android section.

Integrate the extension

Set up your webhook

Create a server that receives and interprets the webhook data, for example with agora-activefence-kicker.

Initialize AgoraContentInspectConfig

Set up the inspect config inside ContentInspectManager. If you use a string UID to join the channel and want to receive it in the webhook callback, pass the string UID to extraInfo inside AgoraContentInspectConfig.

var inspectConfig: AgoraContentInspectConfig = {
  let module = AgoraContentInspectModule()
  module.type = .imageModeration
  module.interval = 5

  let config = AgoraContentInspectConfig()
  config.modules = [module]
  config.extraInfo = "YourExtraInfo"
  return config
}()

Apply AgoraContentInspectConfig

Enable content inspection after joining a channel and after the local video is published and played. To support taking screenshots for multiple video streams and uploading them, use enableContentInspectEx.

self.agoraEngine.enableContentInspect(true, config: self.inspectConfig)
self.agoraEngine.enableContentInspectEx(enabled, config: config, connection: connection)

Catch banning events

func rtcEngine(
  _ engine: AgoraRtcEngineKit,
  connectionChangedTo state: AgoraConnectionState,
  reason: AgoraConnectionChangedReason
) {
  if state == .failed, reason == .reasonBannedByServer {
    isBanned = true
  }
}

Reference

• Agora Content Inspect Moderation Showcase
• ActiveFence documentation

ActiveFence provides trust and safety solutions to protect online platforms and their users from malicious behavior and content. The following figure shows the ActiveFence moderation workflow for channel content:

Prerequisites

• A supported browser.
• Implemented the SDK quickstart.
• Completed the ActiveFence account, API key, webhook, and workflow configuration described above.

Integrate the extension

Set up an event listener to check status

agoraEngine.on("image-moderation-connection-state-change", (cur, prev) => {
  console.log("AF status:", "prev", prev, "cur", cur);
});

Enable image moderation

If you use a string UID to join the channel and want to receive it in the webhook callback, pass the string UID as extraInfo.

agoraEngine
  .setImageModeration(true, "YourExtraInfo", { interval: 1000 })
  .then((e) => console.log("AF enabled", e));

Show an alert when the current user is kicked

agoraEngine.on("connection-state-change", (cur, prev, reason) => {
  console.log("connection:", "prev", prev, "cur", cur, "reason:", reason);
  if (reason === ConnectionDisconnectedReason.UID_BANNED) {
    if (confirm("You are kicked from this channel, reload?")) {
      window.location.reload();
    }
  }
});

Reference

• ActiveFence sample web project
• ActiveFence documentation

Prerequisites

• Flutter 2.0.0 or higher.
• Dart 2.15.1 or higher.
• A Flutter editor such as Android Studio, IntelliJ, or VS Code.
• Implemented the SDK quickstart.

Integrate the extension

Initialize ContentInspectConfig

const contentInspectModule = ContentInspectModule(
  type: ContentInspectType.contentInspectModeration,
  interval: 5,
);
const contentInspectConfig = ContentInspectConfig(
  modules: [contentInspectModule],
  moduleCount: 1,
  extraInfo: 'YourExtraInfo',
);

Apply ContentInspectConfig

var returnVal = await agoraEngine.enableContentInspect(
  enabled: true,
  config: contentInspectConfig,
);

Catch banning events

agoraEngine.registerEventHandler(RtcEngineEventHandler(
  onConnectionStateChanged: (connection, state, reason) {
    if (
      state == ConnectionStateType.connectionStateFailed &&
      reason == ConnectionChangedReasonType.connectionChangedBannedByServer
    ) {
      debugPrint('Stream banned by the server');
    }
  },
));

Prerequisites

• React Native 0.60 or later.
• Node 10 or later.
• Implemented the SDK quickstart.

Integrate the extension

Initialize ContentInspectConfig

const contentInspectModule: ContentInspectModule = {
  type: ContentInspectType.ContentInspectModeration,
  interval: 5,
};
const contentInspectConfig: ContentInspectConfig = {
  modules: [contentInspectModule],
  moduleCount: 1,
  extraInfo: 'YourExtraInfo',
};

Apply ContentInspectConfig

const returnVal = agoraEngine?.enableContentInspect(true, contentInspectConfig);

Catch banning events

agoraEngine?.addListener(
  'onConnectionStateChanged',
  (connection, state, reason) => {
    if (
      state === ConnectionStateType.ConnectionStateFailed &&
      reason === ConnectionChangedReasonType.ConnectionChangedBannedByServer
    ) {
      console.log('Stream banned by the server');
    }
  },
);