Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WatermarkOptions

Agora watermark options. A class for setting the properties of watermark.

Hierarchy

  • WatermarkOptions

Index

Constructors

Properties

Constructors

constructor

  • new WatermarkOptions(params?: undefined | { positionInLandscapeMode?: Rectangle; positionInPortraitMode?: Rectangle; visibleInPreview?: undefined | false | true }): WatermarkOptions

  • Parameters

    • Optional params: undefined | { positionInLandscapeMode?: Rectangle; positionInPortraitMode?: Rectangle; visibleInPreview?: undefined | false | true }

    Returns WatermarkOptions

Properties

Optional positionInLandscapeMode

positionInLandscapeMode: Rectangle

The watermark position in the landscape mode.

Optional positionInPortraitMode

positionInPortraitMode: Rectangle

The watermark position in the portrait mode.

Optional visibleInPreview

visibleInPreview: undefined | false | true

Sets whether or not the watermark image is visible in the local video preview:

  • true: (Default) The watermark image is visible in preview.
  • false: The watermark image is not visible in preview.

Generated using TypeDoc