getSystemInfo

Description

Obtain system information

void getSystemInfo()

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
}

Response Parameters

Name	Description
authInfo	A parameter that is only present if a moderated TrueConf VideoSDK is authorized on the video conferencing server and contains field such as: • peerId - TrueConf ID, unique user identifier • 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 VideoSDK, is displayed only after its 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 - A 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 - A field containing the maximum possible number of participants in a moderated role-based conference • rlMaxNumber - A 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 - A 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 bandiwdth • 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 qualty ⠀⠀• receiveP2P - Point-to-point video call incoming video quality ⠀⠀• receiveGroup - resulting incoming video quality in a group cohference) ⠀⠀• videoContentLevels - Information about the quality of incoming and outgoing video. The following fields are included: ⠀⠀• send - Video encoding performance ⠀⠀• receiveP2P - Video decoding perofrmance ⠀⠀• receiveGroup - Total video decoding preformance ⠀⠀• bench - Overall performance
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 capture 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.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 included only if TrueConf VideoSDK is in a conference with at least one participant. It describes the parameters of receivers. The following fields are included: • peerId - TrueConf ID, unique user identifier • 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
result	A flag indicating whether the request was successful

See also

• getTariffRestrictions
• login
• On_tariffRestrictionsChanged