Documentation
Video Call (Legacy)
Console 官网 Community Technical support
English
search-icon

Agora Web SDK API Reference

Overview AgoraRTC Client Stream Error codes Warning Codes

Configurations for the watermark image to put on top of the video in setLiveTranscoding.

Since
   3.0.0

Hierarchy

  • TranscodingWatermark

Index

Properties

Properties

Optional height

height: number

The height (pixel) of the watermark image.

Integer only. The value range is [0,10000]. The default value is 160.

url

url: string

The HTTP/HTTPS URL address of the image on the broadcasting video.

ASCII characters only. The maximum length of this parameter is 1024 bytes. Supports online PNG only.

Optional width

width: number

The width (pixel) of the watermark image.

Integer only. The value range is [0,10000]. The default value is 160.

Optional x

x: number

The horizontal distance (pixel) between the watermark image's top-left corner and the video's top-left corner.

Integer only. The value range is [0,10000]. The default value is 0.

Optional y

y: number

The vertical distance (pixel) between the watermark image's top-left corner and the video's top-left corner.

Integer only. The value range is [0,10000]. The default value is 0.