Dev Center
Interactive Live Streaming Premium
Agora.io Community
English
search-icon
Agora Web SDK API Reference
Overview AgoraRTC Client Stream Error codes Warning Codes

Adds a watermark image to the CDN (Content Delivery Network) live stream in setLiveTranscoding.

Since
   3.0.0

Hierarchy

  • TranscodingWatermark

Index

Properties

Properties

Optional height

height: number

The height 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. Only supports online PNG files.

Optional width

width: number

The width of the watermark image.

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

Optional x

x: number

The position of the image on the upper left of the broadcasting video on the horizontal axis.

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

Optional y

y: number

The position of the image on the upper left of the broadcasting video on the vertical axis.

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

score