WatermarkConfig

class WatermarkConfig implements AgoraSerializable {
  const WatermarkConfig(
      {this.id,
      this.type,
      this.buffer,
      this.timestamp,
      this.literal,
      this.imageUrl,
      this.options});

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

  @JsonKey(name: 'type')
  final WatermarkSourceType? type;

  @JsonKey(name: 'buffer')
  final WatermarkBuffer? buffer;

  @JsonKey(name: 'timestamp')
  final WatermarkTimestamp? timestamp;

  @JsonKey(name: 'literal')
  final WatermarkLiteral? literal;

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

  @JsonKey(name: 'options')
  final WatermarkOptions? options;

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

  @override
  Map<String, dynamic> toJson() => _$WatermarkConfigToJson(this);
}

Since: Available since v4.6.2.

Properties

id: The unique identifier of the watermark. It is recommended to use a UUID.
type: The type of watermark. See WatermarkSourceType.
buffer: The buffer of the watermark. See WatermarkBuffer.
timestamp: The timestamp of the watermark.
Note: (Linux only)
literal: The text content of the watermark.
Note: (Linux only)
imageUrl: The URL of the watermark image file. The default value is NULL.
options: The configuration options for the watermark. See WatermarkOptions.