# getAppState
Description
Get information about the application state
void getAppState()
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
}
Response Parameters
Name | Description |
---|---|
appState | Application state. It can be as follows: • 0 - no connection with the server • 1 - TrueConf VideoSDK is trying to connect to the server • 2 - Login is required • 3 - TrueConf VideoSDK is connected to the server and logged in • 4 - TrueConf VideoSDK is waiting: either it is calling someone or it is being called by someone • 5 - TrueConf VideoSDK is in a conference • 6 - TrueConf VideoSDK 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 cvreated and that can be joined at request |
additionalStatus | Additional status of the current user as a string |
embeddedHttpPort | Port number used by the build-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. This 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-it 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 TrueConf VideoSDK |
outgoingRecord | Outbound requests for recording audio and video streams |
incomingJoinToMyConf | Inbound requests for joining the conference created by TrueConf VideoSDK |
outgoingJoinToMyConf | outgoing invitations to the conference created by TrueConf VideoSDK |
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 on of the following types: • 1 - desktop • 2 - application window |
windowName | The window name of the application captured for content sharing |
recording | A flag indicating the recording status of the conference on the server |
requestId | A unique request identifier |
result | A flag indicating whether the request was successful |
See also