BackgroundImage

rn-agora-docs › "types" › BackgroundImage

The background image added to the CDN live publishing stream. Once a background image is added, the audience of the CDN live publishing stream can see it.

Hierarchy

• BackgroundImage

Index

Properties

• height
• url
• width
• x
• y

Properties

height

• height: number

Defined in types.ts:143

Height of the image on the broadcasting video.

---

url

• url: string

Defined in types.ts:135

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

---

width

• width: number

Defined in types.ts:141

Width of the image on the broadcasting video.

---

x

• x: number

Defined in types.ts:137

Position of the image on the upper left of the broadcasting video on the horizontal axis.

---

y

• y: number

Defined in types.ts:139

Position of the image on the upper left of the broadcasting video on the vertical axis.