TrueConf

# getConnected

Description: Retrieve information about the server and the status of the connection to it.

Request example:

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

Response example:

{
    "method": "getConnected",
    "requestId" : "1",
    "state": 2,
    "serverInfo": {
        "server": "192.168.0.103",
        "service": false,
        "port": 4307,
        "domain": "some.server.net"
    },
    "result": true
}

Parameter description:

  • state - connection status:

    • 0 — VideoSDK/Room is not connected to the server

    • 1 — VideoSDK/Room is trying to connect to the server

    • 2 — VideoSDK/Room is connected to the server

  • serverInfo — information about the server to which VideoSDK/Room is connected to or is trying to connect. If VideoSDK/Room is not connected to the server and is not trying to connect, this information will not be available.

  • server — IP or domain name of the server to which VideoSDK/Room is connected. If VideoSDK/Room is not connected and is not trying to connect, this information will not be included

  • service — Connection type:

    • true — connection to TrueConf Online cloud service

    • false— connection to TrueConf Server

  • port — server port

  • domain — server domain

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

See also: