On_videoMatrixChanged

TrueConf7/5/26About 3 min

On_videoMatrixChanged

Description

The notification displayed when the layout is changed

EventHandler<string> On_videoMatrixChanged

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"],
    "event": "videoMatrixChanged",
    "method": "event"
}

Response Parameters

NameDescription
peerIdThe 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
selfViewModeThe 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|
|top|Y-coordinate|
|peerDn|User display name. The field is unavailable when TrueConf VideoSDK needs to log in to the server|
|title|Title of slideshow sent by user. The field is available only for SlideShowSlot|
|top|Y-coordinate|
|width|Width|
|height|Height|
|mainWindowWidth|Width of a video are for video slots|
|mainWindowHeight|Height of a video area for video slots|
|left|X-coordinate|
|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 shown.
• 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, unique user identifier|
|monitorDisplayName|Monitor name|
|monitorIdx|Monitor index (used in the API)|
|monitorIsPrimary|Monitor priority|
|hiddenVideoSlots|The list of video slots removed from the layout|
|type|The type of content displayed in the video slot. It can be as follows:
• 0 - The video in the slot is sourced from the camera
• 1 - Video in the slot is the user's captured desktop
• 2 - Video in the slot is a captured application window, capture card, or slideshow |

See also

Last Updated: