# getVideoMatrix
Description
Obtain information about the current layout
void getVideoMatrix()
Response example
{
"matrixType": 1,
"mainWindowWidth": 1920,
"mainWindowHeight": 1080,
"selfViewMode": 2,
"participants": [{
"peerId": "#self:0",
"peerDn": "Display Name 1",
"left": 0,
"top": 720,
"width": 640,
"height": 360,
"type" : 0
}, {
"peerId": "user2@some.server",
"peerDn": "Display Name 2",
"left": 0,
"top": 0,
"width": 1920,
"height": 1080,
"type" : 0
}],
"externVideoSlots": [{
"callId": "SlideShowSlot",
"peerDn": "Display Name 3",
"monitorDisplayName": "Generic PnP Monitor",
"monitorIdx": 1,
"monitorIsPrimary": false,
"type" : 0
}],
"hiddenVideoSlots": ["user4@some.server", "user5@some.server"],
"method": "getVideoMatrix",
"requestId" : "1",
"result": true
}
Response Parameters
| Name | Description |
|---|---|
| selfViewMode | The self-view mode. The following options are possible: • 1 - The self-view video is displayed over the layout • 2 - The self-view video is within the layout |
| participants | Video slot list • peerId - The unique identifier (TrueConf ID) of a user who is sending the video stream. #self:0 always refers to the video slot with the TrueConf VideoSDK camera • peerDn - User display name • title - Title of slideshow sent by user. The field is available only for SlideShowSlot • top - y-coordinate • left - x-coordinate • width - Width • height - Height |
| mainWindowWidth | Width of a video area for video slots |
| mainWindowHeight | Height of a video area for video slots |
| matrixType | Type of allocation matrix. The matrix can be the following types: • 0 - Show only one window. If there are more windows in the list, the first one will be show • 1 - All windows are the same size • 2 - One window is large (in the upper left corner), other smaller windows are placed around the large one • 3 - One large window (in the center at the top), other smaller windows are placed at the bottom • 4 - One window is large (in the left corner), other smaller windows are placed to the right of the large one • 5 - One window is large (in the center at the top), other smaller windows are placed at the bottom and can overlap the larger one within reasonable limits |
| externVideoSlots | List of video slots that are displayed on separate monitors • callId - TrueConf ID, the unique identifier of a user • monitorDisplayName - monitorName • monitorIdx - Monitor index (used in the API) • monitorIsPrimary - Monitor priority |
| hiddenVideoSlots | The list of video slots removed from the layout |
| type | The ype of content displayed in the video slot. It can be • 0 - The video in the slot is sourced from the camera • 1 - The video in the slot is the user's captured desktop • 2 - The video in the slot is a captured application window, capture card, or slideshow |
| requestId | A unique request identifier |
| result | A flag indicating whether the request was successful |
See also