Package io.agora.rtc2.video
Class WatermarkOptions
java.lang.Object
io.agora.rtc2.video.WatermarkOptions
- Since:
- 4.6.0
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionThe watermark position in the landscape mode.The watermark position in the portrait mode.booleanSets whether or not the watermark image is visible in the local video preview: - true: (Default) The watermark image is visible in preview.int -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint[]int[]intboolean
-
Field Details
-
visibleInPreview
public boolean visibleInPreviewSets 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. -
positionInLandscapeMode
The watermark position in the landscape mode. SeeRectangle. See details for the landscape mode in the advanced guide *Rotate the Video*. -
positionInPortraitMode
The watermark position in the portrait mode. SeeRectangle. See details for the portrait mode in the advanced guide *Rotate the Video*. -
zOrder
public int zOrder- Since:
- 4.6.0
-
-
Constructor Details
-
WatermarkOptions
public WatermarkOptions()
-
-
Method Details
-
getPositionInLandscapeMode
public int[] getPositionInLandscapeMode()- Returns:
- An integer array of four elements representing the x, y, width, and height of the watermark rectangle.
- Since:
- 4.6.0
-
getPositionInPortraitMode
public int[] getPositionInPortraitMode()- Returns:
- An integer array of four elements representing the x, y, width, and height of the watermark rectangle.
- Since:
- 4.6.0
-
isVisibleInPreview
public boolean isVisibleInPreview()- Returns:
- true: The watermark is visible in preview; false: The watermark is not visible in preview.
- Since:
- 4.6.0
-
getzOrder
public int getzOrder()- Returns:
- The z-order index of the watermark image.
- Since:
- 4.6.0
-