通知
本站点除 Legacy 产品与方案外，已迁移至 声网新文档中心 ，当前页面不再维护
Documentation
All
Console 官网 Community Technical support
English
search-icon

Agora Web SDK API Reference

Overview AgoraRTC AgoraRTCClient LocalTrack RemoteTrack Error codes

Configurations for the watermark and background images to put on top of the video in LiveStreamingTranscodingConfig.

Hierarchy

  • LiveStreamingTranscodingImage

Index

Properties

Properties

Optional alpha

alpha: undefined | number

The transparency level of the image.

The value range is [0.0,1.0]:

  • 0.0: Completely transparent.
  • 1.0: (Default) Opaque.

Optional height

height: undefined | number

The height (pixel) of the image.

The default value is 160.

url

url: string

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

Supports online PNG only.

Optional width

width: undefined | number

The width (pixel) of the image.

The default value is 160.

Optional x

x: undefined | number

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

The default value is 0.

Optional y

y: undefined | number

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

The default value is 0.