# WatermarkOptions (/zh-CN/api-reference/rtc/flutter/class-watermarkoptions)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="class_watermarkoptions__prototype"></a>

```dart
@JsonSerializable(explicitToJson: true, includeIfNull: false)
class WatermarkOptions {
  const WatermarkOptions(
      {this.visibleInPreview,
      this.positionInLandscapeMode,
      this.positionInPortraitMode,
      this.watermarkRatio,
      this.mode, this.zOrder});

  @JsonKey(name: 'visibleInPreview')
  final bool? visibleInPreview;

  @JsonKey(name: 'positionInLandscapeMode')
  final Rectangle? positionInLandscapeMode;

  @JsonKey(name: 'positionInPortraitMode')
  final Rectangle? positionInPortraitMode;

  @JsonKey(name: 'watermarkRatio')
  final WatermarkRatio? watermarkRatio;

  @JsonKey(name: 'mode')
  final WatermarkFitMode? mode;

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

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

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

<a id="class_watermarkoptions__detailed_desc"></a>

用于设置要添加的水印图像的相关配置项。

<a id="class_watermarkoptions__parameters"></a>

## 属性 [#属性]

<ParameterList>
<a id="visibleinpreview"></a>
<Parameter name="visibleInPreview">

水印是否在本地预览视图中可见：

- true: （默认）水印在本地预览视图中可见。
- false: 水印在本地预览视图中不可见。

</Parameter>
<a id="positioninlandscapemode"></a>
<Parameter name="positionInLandscapeMode">

水印的适配模式为 fitModeCoverPosition 时，用于设置横屏模式下水印图片的区域。详见 [Rectangle](/zh-CN/api-reference/rtc/flutter/class-rectangle)。

</Parameter>
<a id="positioninportraitmode"></a>
<Parameter name="positionInPortraitMode">

水印的适配模式为 fitModeCoverPosition 时，用于设置竖屏模式下水印图片的区域。详见 [Rectangle](/zh-CN/api-reference/rtc/flutter/class-rectangle)。

</Parameter>
<a id="watermarkratio"></a>
<Parameter name="watermarkRatio">

水印的适配模式为 fitModeUseImageRatio 时，该参数可设置缩放模式下的水印坐标。详见 [WatermarkRatio](/zh-CN/api-reference/rtc/flutter/class-watermarkratio)。

</Parameter>
<a id="mode"></a>
<Parameter name="mode">

水印的适配模式。详见 [WatermarkFitMode](/zh-CN/api-reference/rtc/flutter/enum-watermarkfitmode)。

</Parameter>
<a id="zorder"></a>
<Parameter name="zOrder">

水印图像的图层顺序，默认值为 0。

</Parameter>
</ParameterList>