Dev Center
Interactive Live Streaming Premium
Agora.io Community
English
search-icon
Agora React Native API Reference
Overview RtcEngine RtcEngineEvents RtcChannel RtcChannelEvents Warning Codes Error Codes

Agora image properties. A class for setting the properties of the watermark and background images.

Hierarchy

  • AgoraImage

Index

Constructors

Properties

Constructors

constructor

  • new AgoraImage(url: string, x: number, y: number, width: number, height: number): AgoraImage

  • Parameters

    • url: string
    • x: number
    • y: number
    • width: number
    • height: number

    Returns AgoraImage

Properties

height

height: number

Height of the image on the broadcasting video.

url

url: string

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

width

width: number

Width of the image on the broadcasting video.

x

x: number

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

y

y: number

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

score