TrueConf

# getAppState

Description: get information about the application state.

Request example:

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

Response example:

{
    "method": "getAppState",
    "requestId" : "1",
    "embeddedHttpPort": 8766,
    "appState": 3,
    "extStatus": 2,
    "additionalStatus": "at lunch",
    "desktopSharing": {
        "running": true,
        "sourceType": 2,
        "id": 66910,
        "windowName": "WebSocket Test - Opera"
    },
    "broadcastPicture": {
        "running": false
    },
    "audioCaptureTest": false,
    "recording" : false,
    "result": true
}

Parameter description:

  • appState — Application state. It can be as follows:

    • 0 — no connection with the server

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

    • 2 — Login is required

    • 3 — VideoSDK/Room is connected to the server and logged in

    • 4 — VideoSDK/Room is waiting: either it is calling someone or it is being called by someone

    • 5 — VideoSDK/Room is in a conference

    • 6 — VideoSDK/Room is ending a conference

  • extStatus - the extended status of the current user, which can take one of the following values:

    • -1 — Invalid user

    • 0 — Offline user

    • 1 - user is offline but was recently active

    • 2 — Available user

    • 3 - user is available on the phone

    • 4 - user is available from the terminal

    • 5 - user is available but has set the status to do not disturb

    • 6 - user is away

    • 7 — Busy user

    • 8 - user is busy on the phone

    • 9 - user is busy at the terminal

    • 10 — A user is in a group conference that they created and that can be joined at request.

  • additionalStatus - additional status of the current user as a string

  • embeddedHttpPort — Port number used by the built-in HTTP server

  • desktopSharing — Field that contains information about desktop sharing

  • running — the field indicating if content sharing has started

  • name — the name of the screen which is being shared. The field is unavailable when content sharing is off.

  • id — Unique identifier of a window or screen being shared. The field is unavailable when content sharing is off

  • broadcastPicture — Field that contains information about a picture being shared

  • fileName — Name of the picture being shared. The field is unavailable when picture sharing is off.

  • fileId — Unique identifier of a file being shared on the built-in HTTP server. The field is unavailable when picture sharing is off.

  • audioCaptureTest — Field showing whether a microphone test has been started. It can be true or false

  • requests — Field that is available when requests are made

  • incomingPodiumRequest — Incoming podium requests

  • outgoingPodiumRequest — Outgoing podium requests

  • incomingPodiumInvitation — Incoming podium invitations

  • outgoingPodiumInvitation — Outgoing podium invitations

  • incomingRecord — inbound requests for recording video and audio streams from VideoSDK/Room

  • outgoingRecord — outbound requests for recording audio and video streams

  • incomingJoinToMyConf — inbound requests for joining the conference created by VideoSDK/Room

  • outgoingJoinToMyConf — outgoing invitations to the conference created by VideoSDK/Room

  • incomingP2PCall — Incoming video call

  • outgoingP2PCall — Outgoing video call

  • incomingGroupConf — Incoming invitation to a group conference

  • outgoingGroupConf — Outgoing invitation to a group conference

  • incomingPtzControl - incoming requests for PTZ camera control

  • outgoingPtzControl - outgoing PTZ camera control requests

  • friendlyName — the name of the captured screen that will be used for content sharing; the name will be presented in a human-readable format.

  • sourceType — the type of the captured content. It can be one of the following types:

    • 1— desktop

    • 2— application window

  • windowName — the window name of the application captured for content sharing

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

  • recording - a flag indicating the recording status of the conference on the server

See also: