RtcImage

Used to set watermark and background image properties.

typedef struct RtcImage {
  const char* url;
  int x;
  int y;
  int width;
  int height;
  int zOrder;
  double alpha;
} RtcImage;

Properties

url
HTTP/HTTPS URL of the image. Maximum length is 1024 bytes.
x
The x-coordinate of the image in the video frame (origin at top-left corner, in pixels).
y
The y-coordinate of the image in the video frame (origin at top-left corner, in pixels).
width
Width of the image in the video frame (in pixels).
height
Height of the image in the video frame (in pixels).
zOrder
Z-order index of the image.
  • When using a watermark array to add one or more watermarks, this must be set to a value in the range [1, 255], otherwise the SDK will return an error.
  • Optional in other cases, valid range is [0, 255], default is 0.
  • 0 means bottom layer, 255 means top layer.
alpha
Opacity of the image, range [0.0, 1.0]:
  • 0.0: Fully transparent.
  • 1.0: (Default) Fully opaque.