getVideoMatrix

TrueConfAbout 3 min

getVideoMatrix

Description: Obtain information about the current layout.

Request example:

{
    "method" : "getVideoMatrix",
    "requestId" : "1"
}

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" : 2
    }],
    "hiddenVideoSlots": ["user4@some.server", "user5@some.server"],
    "method": "getVideoMatrix",
    "requestId" : "1",
    "result": true
}

Parameter 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 - a unique identifier of the user TrueConf ID, from whom the video is being shown. #self:0 - always denotes the video slot with the camera. TrueConf Room API

    • 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 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 - a unique identifier for the user TrueConf ID (similar to peerId)

    • monitorDisplayName — Monitor name

    • monitorIdx — Monitor index (used in the API)

    • monitorIsPrimary — Monitor priority

  • hiddenVideoSlots — the list of video slots removed from the layout

  • requestId - a unique request identifier. You can find more details about it here.

  • type - specifies the type of video displayed in the video slot. It can be one of the following types:

    • 0 - video in the slot is obtained from the camera

    • 1 - video in the slot - user's captured desktop

    • 2 - the video in the slot is a captured application window, capture card, or slideshow

See also: