meet::VideoCanvas

Summary

Public types

AssignmentProtocol enum

Public attributes

assignment_protocol = AssignmentProtocol::kRelevant
AssignmentProtocol
The protocol that governs how the backend should assign a video feed to this canvas.
dimensions
The dimensions for this video canvas.
id = 0
int32_t
An identifier for the video canvas.

Public types

AssignmentProtocol

 meet::VideoCanvas::AssignmentProtocol

Public attributes

assignment_protocol

AssignmentProtocol meet::VideoCanvas::assignment_protocol = AssignmentProtocol::kRelevant

The protocol that governs how the backend should assign a video feed to this canvas.

dimensions

CanvasDimensions meet::VideoCanvas::dimensions

The dimensions for this video canvas.

Failure to provide this will result in an error.

id

int32_t meet::VideoCanvas::id = 0

An identifier for the video canvas.

This is required and must be unique within the containing LayoutModel. Clients should prudently reuse VideoCanvas IDs. This allows the backend to keep assigning video streams to the same canvas as much as possible.