Agora Java API Reference for Android
Public Member Functions | Public Attributes | List of all members
io.agora.rte.media.layout.AgoraRteLayout Class Reference

Public Member Functions

 AgoraRteLayout (AgoraRteLayoutType type, String id, int x, int y, int width, int height, int zOrder, float alpha, boolean mirror, String imagePath)
 
int getHeight ()
 
int getWidth ()
 
boolean isMirror ()
 
float getAlpha ()
 
int getX ()
 
int getY ()
 
int getZOrder ()
 
AgoraRteLayoutType getLayoutType ()
 
String getImagePath ()
 

Public Attributes

AgoraRteLayoutType layoutType
 
String id
 
int x = 0
 
int y = 0
 
int width = 0
 
int height = 0
 
int zOrder = 0
 
float alpha
 
boolean mirror
 
String imagePath
 

Member Data Documentation

◆ layoutType

AgoraRteLayoutType io.agora.rte.media.layout.AgoraRteLayout.layoutType

layout type to tell which tar.

◆ id

String io.agora.rte.media.layout.AgoraRteLayout.id

The unique id where we apply layout setting to. The Id will be automaticaly created if it doesn't exist.

◆ x

int io.agora.rte.media.layout.AgoraRteLayout.x = 0

The horizontal position of the top left corner of the video frame. (pixel)

◆ y

int io.agora.rte.media.layout.AgoraRteLayout.y = 0

The vertical position of the top left corner of the video frame. (pixel)

◆ width

int io.agora.rte.media.layout.AgoraRteLayout.width = 0

The width of the video frame. (pixel)

◆ height

int io.agora.rte.media.layout.AgoraRteLayout.height = 0

The height of the video frame. (pixel)

◆ zOrder

int io.agora.rte.media.layout.AgoraRteLayout.zOrder = 0

The layer of the video frame that ranges from 1 to 100:

  • 1: (Default) The lowest layer.
  • 100: The highest layer.

◆ alpha

float io.agora.rte.media.layout.AgoraRteLayout.alpha

The transparency of the video frame. 0 means the region is transparent, and 1 means the region is opaque

◆ mirror

boolean io.agora.rte.media.layout.AgoraRteLayout.mirror

mirror of the source video frame (only valid for camera streams)

◆ imagePath

String io.agora.rte.media.layout.AgoraRteLayout.imagePath

Local image file path.

  1. When layout type is Image, the image will be mixed with layer settings.
  2. When layout type is track, the image is only valid for remote track which will display the image when remote track is muted.