Video SDK v3.7.1 API Reference for Unity
Public Attributes | List of all members
agora_gaming_rtc.RtcImage Struct Reference

Public Attributes

string url
 
int x
 
int y
 
int width
 
int height
 
int zOrder
 
double alpha
 

Detailed Description

Image properties.

The properties of the watermark and background images.

Member Data Documentation

◆ url

string agora_gaming_rtc.RtcImage.url

HTTP/HTTPS URL address of the image on the broadcasting video. The maximum length of this parameter is 1024 bytes.

◆ x

int agora_gaming_rtc.RtcImage.x

Horizontal position of the image from the upper left of the broadcasting video.

◆ y

int agora_gaming_rtc.RtcImage.y

Vertical position of the image from the upper left of the broadcasting video.

◆ width

int agora_gaming_rtc.RtcImage.width

Width of the image on the broadcasting video.

◆ height

int agora_gaming_rtc.RtcImage.height

Height of the image on the broadcasting video.

◆ zOrder

int agora_gaming_rtc.RtcImage.zOrder

The layer number of the watermark or background image. The value range is [0,255]:

  • 0: (Default) Bottom layer.
  • 255: Top layer.
Since
v3.6.1.1

◆ alpha

double agora_gaming_rtc.RtcImage.alpha

The transparency of the watermark or background image. The value range is [0.0,1.0]:

  • 0.0: Completely transparent
  • 1.0: (Default) Opaque
Since
v3.6.1.1

The documentation for this struct was generated from the following file: