AgoraVideoLayout Class Reference

Inherits <NSObject>.

Properties
NSString *_Nonnull	channelId
NSUInteger	uid
NSString *_Nullable	strUid
NSUInteger	videoState
NSUInteger	x
NSUInteger	y
NSUInteger	width
NSUInteger	height

Property Documentation

channelId

- (NSString* _Nonnull) channelId

readwritenonatomiccopy

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

uid

- (NSUInteger) uid

readwritenonatomicassign

User ID who published this sub-video stream.

strUid

- (NSString* _Nullable) strUid

readwritenonatomiccopy

Reserved for future use.

videoState

- (NSUInteger) videoState

readwritenonatomicassign

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.

x

- (NSUInteger) x

readwritenonatomicassign

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

- (NSUInteger) y

readwritenonatomicassign

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

- (NSUInteger) width

readwritenonatomicassign

Width (px) of the sub-video stream.

height

- (NSUInteger) height

readwritenonatomicassign

Heitht (px) of the sub-video stream.