ContentInspectConfig

Configuration of video screenshot and upload.

@JsonSerializable(explicitToJson: true, includeIfNull: false)
class ContentInspectConfig {
  const ContentInspectConfig(
      {this.extraInfo, this.serverConfig, this.modules, this.moduleCount});

  @JsonKey(name: 'extraInfo')
  final String? extraInfo;

  @JsonKey(name: 'serverConfig')
  final String? serverConfig;

  @JsonKey(name: 'modules')
  final List<ContentInspectModule>? modules;

  @JsonKey(name: 'moduleCount')
  final int? moduleCount;

  factory ContentInspectConfig.fromJson(Map<String, dynamic> json) =>
      _$ContentInspectConfigFromJson(json);

  Map<String, dynamic> toJson() => _$ContentInspectConfigToJson(this);
}

Parameters

extraInfo

Additional information on the video content (maximum length: 1024 Bytes).

The SDK sends the screenshots and additional information on the video content to the Agora server. Once the video screenshot and upload process is completed, the Agora server sends the additional information and the callback notification to your server.

serverConfig

(Optional) Server configuration related to uploading video screenshots via extensions from Agora Extensions Marketplace. This parameter only takes effect when type in ContentInspectModule is set to contentInspectImageModeration. If you want to use it, contact technical support.

modules

Functional module. See ContentInspectModule.

A maximum of 32 ContentInspectModule instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].

Attention: A function module can only be configured with one instance at most. Currently only the video screenshot and upload function is supported.

moduleCount

The number of functional modules, that is,the number of configured ContentInspectModule instances, must be the same as the number of instances configured in modules. The maximum number is 32.