文档中心
视频通话 (Legacy)
Console 官网 社区 技术支持
简体中文
search-icon

React Native API Reference

概览 RtcEngine RtcEngineEvents RtcChannel RtcChannelEvents 警告码 错误码

声网图像属性。用于设置直播视频的水印和背景图片的属性。

Hierarchy

  • AgoraImage

Index

Constructors

Properties

Constructors

constructor

  • new AgoraImage(url: string, params?: undefined | { alpha?: undefined | number; height?: undefined | number; width?: undefined | number; x?: undefined | number; y?: undefined | number; zOrder?: undefined | number }): AgoraImage

  • Parameters

    • url: string
    • Optional params: undefined | { alpha?: undefined | number; height?: undefined | number; width?: undefined | number; x?: undefined | number; y?: undefined | number; zOrder?: undefined | number }

    Returns AgoraImage

Properties

Optional alpha

alpha: undefined | number

水印或背景图片的透明度。取值范围为 [0.0,1.0]：

  • 0.0：完全透明。
  • 1.0：（默认）完全不透明。
since

v3.6.2

Optional height

height: undefined | number

图片在视频帧上的高度。

url

url: string

直播视频上图片的 HTTP/HTTPS 地址，字符长度不得超过 1024 字节。

Optional width

width: undefined | number

图片在视频帧上的宽度。

Optional x

x: undefined | number

图片左上角在视频帧上的横轴坐标。

Optional y

y: undefined | number

图片左上角在视频帧上的纵轴坐标。

Optional zOrder

zOrder: undefined | number

水印或背景图片的图层编号。

使用水印数组添加单张或多张水印时，必须向 zOrder 传值，取值范围为 [1,255]，否则 SDK 会报错。 其余情况，zOrder 可选传值，取值范围为 [0,255]，0 为默认值。0 代表图层的最下层，255 代表图层的最上层。

since

v3.6.2