Agora RTC Objective-C API Reference  Refactor
Data Fields
VideoLayout Struct Reference

Data Fields

const char * channelId
 
rtc::uid_t uid
 
user_id_t strUid
 
uint32_t x
 
uint32_t y
 
uint32_t width
 
uint32_t height
 
uint32_t videoState
 

Constructor & Destructor Documentation

◆ VideoLayout()

VideoLayout ( )
inline

Field Documentation

◆ channelId

const char* channelId

The channel name to which the sub-video stream belongs.

◆ uid

User ID who published this sub-video stream.

◆ strUid

user_id_t strUid

Reserved for future use.

◆ x

uint32_t x

X-coordinate (px) of the sub-video stream on the mixing canvas. The relative lateral displacement of the top left corner of the video for video mixing to the origin (the top left corner of the canvas).

◆ y

uint32_t y

Y-coordinate (px) of the sub-video stream on the mixing canvas. The relative longitudinal displacement of the top left corner of the captured video to the origin (the top left corner of the canvas).

◆ width

uint32_t width

Width (px) of the sub-video stream.

◆ height

uint32_t height

Heitht (px) of the sub-video stream.

◆ videoState

uint32_t videoState

Status of the sub-video stream on the video mixing canvas.

  • 0: Normal. The sub-video stream has been rendered onto the mixing canvas.
  • 1: Placeholder image. The sub-video stream has no video frames and is displayed as a placeholder on the mixing canvas.
  • 2: Black image. The sub-video stream is replaced by a black image.