getSystemInfo

Description: Obtain system information.

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

Response example:

{
    "method": "getSystemInfo",
    "requestId" : "1",
    "authInfo": {
        "peerId": "user1@some.server",
        "peerDn": "User 1"
    },
    "fileInfo": {
        "major": 8,
        "minor": 0,
        "revision": 0,
        "build": 0
    },
    "productInfo": {
        "major": 8,
        "minor": 0,
        "revision": 0,
        "build": 0
    },
    "permissionsInfo": {
        "tariffName": "",
        "p2p": true,
        "createMulti": true,
        "symMaxNumber": 10,
        "asymMaxNumber": 10,
        "roleMaxNumber": 10,
        "rlMaxNumber": 4,
        "canUseSlideShow": true,
        "canUseDesktopSharing": true,
        "canChangeAddressBook": true,
        "canEditGroups": true,
        "canUseDialer": false
    },
    "bitrateLimits": {
        "max": 20480,
        "min": 32
    },
    "systemRating": {
        "videoQuality": {
            "send": "UHD",
            "receiveP2P": "UHD",
            "receiveGroup": "UHD"
        },
        "videoContentLevels": {
            "send": 66,
            "receiveP2P": 75,
            "receiveGroup": 91,
            "bench": 721919
        }
    },
    "cameraInfo": {
        "cameraFramerate": 0,
        "cameraHeight": 0,
        "cameraWidth": 0,
        "sendFormat": "",
        "format": 0,
        "sendFramerate": 0,
        "sendHeight": 0,
        "sendWidth": 0,
        "stereo": false
    },
    "result": true
}

Parameter description:

• authInfo - this parameter is present only if the moderated role-based conference TrueConf Room API is authorized on the videoconferencing server and contains the following fields:

  • peerId - unique user identifier (TrueConf ID)

  • peerDn — User display name

• fileInfo — the information about the executable file. The following fields are included:

  • major — major version number

  • minor — minor version number

  • revision— revision version number

  • build— build number

• productInfo — product information. The following fields are included:

  • major — major version number

  • minor — minor version number

  • revision— revision version number

  • build— build number

• permissionsInfo - information about the permissions available to TrueConf Room API, displayed only after authorization on the video conferencing server. It contains the following fields:

  • tariffName— the plan (subscription) name

  • p2p - a flag indicating if video calls are available

  • createMulti - a flag indicating whether the creation of group conferences is available

  • symMaxNumber - field containing the maximum possible number of participants in an all on screen group conference

  • asymMaxNumber - a field containing the maximum possible number of participants in a video lecture

  • roleMaxNumber - the field containing the maximum possible number of participants in a moderated role-based conference

  • rlMaxNumber - field containing the maximum possible number of presenters who can simultaneously be on the podium

  • canUseSlideShow - a flag indicating whether a slideshow can be used

  • canUseDesktopSharing - a flag indicating whether it's possible to use content sharing

  • canChangeAddressBook - flag indicating whether the address book can be modified

  • canEditGroups - a flag indicating whether groups can be modified

  • canUseDialer - a flag indicating whether tone dialing can be used (DTMF command support)

• bitrateLimits — information about bandwidth range. The following fields are included:

  • max — the maximum value of bandwidth

  • min — the minimum value of bandwidth

• systemRating — information about the system performance. The following fields are included:

  • videoQuality — information about the quality of incoming and outgoing video. The following fields are included:

    • send — Outgoing video quality

    • receiveP2P — the quality of incoming video in a point-to-point video call

    • receiveGroup — the resulting quality of incoming video in a group conference

  • videoContentLevels — information about the quality of incoming and outgoing video. The following fields are included:

    • send — Video encoding performance value

    • receiveP2P — Video decoding performance value

    • receiveGroup — Total video decoding performance value (for all incoming video feeds)

    • bench — Overall performance rating

• cameraInfo - a parameter that is present only if a video capture device has been selected and it is not in use by another application. It contains information such as:

  • cameraFramerate — camera frame rate

  • cameraHeight — the height of the captured image

  • cameraWidth — the width of the captured image

  • sendFormat — the format in which the frames are sent. The following values are possible:

    • VP8

    • VP9

    • H.265

    • H.264

    • H.263+

    • H.263

    • H.261

    • None

  • format — Video format. It can be as follows:

    • 0 — YUYV

    • 1 — YUY2

    • 2 — YVYU

    • 3 — MJPG

    • 4 — I420

    • 5 — IYUV

    • 6 — UYVY

    • 7 — HDYC

    • 8 — YV12

    • 9 — NV12

    • 10 — NV16

    • 11 — NV21

    • 12 — RGB32

    • 13 — RGB24

    • 14 — ARGB

    • 15 — BGRA

    • 16 — YUV444

    • 17 — H264

    • 18 — H264_ES

    • 19 — H265

    • 20 — VP80

    • 21 — VP90

    • 22 — STR0

    • 23 — I420_STR0

  • sendFramerate — the rate of sent frames

  • sendHeight — the height of sent frames

  • sendWidth — the width of sent frames

  • stereo — the stereo flag

• receivers - this parameter is present only if TrueConf Room API is in a conference with one or more participants, and it specifies the receiver parameters. It contains the following fields:

  • peerId - unique user identifier (TrueConf ID)

  • bitrate — Receiver bitrate

  • streamFormat — the format of the received frames. The following fields are included:

    • VP8

    • VP9

    • H.265

    • H.264

    • H.263+

    • H.263

    • H.261

    • None

  • frameRate — receiver frame rate

  • resolutionWidth — Receiver resolution width

  • resolutionHeight — Receiver resolution height

  • userVolume — the receive volume level

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

See also:

• getTariffRestrictions
• login
• tariffRestrictionsChanged