On_appStateChanged

TrueConf7/5/26About 5 min

On_appStateChanged

Description

The notification indicating that the application state was changed.

The parameters related to the state change are also returned.

EventHandler<string> On_appStateChanged

Response example

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

Response Parameters

NameDescription
appStateApplication state. It can be as follows:
β€’ 0 β€” no connection with the server
β€’ 1 β€” TrueConf VideoSDK is trying to connect to the server
β€’ 2 β€” authorization is needed (as a user)
β€’ 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
extStatusThe 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
additionalStatusAdditional status of the current user as a string
embeddedHttpPortPort number used by the built-in HTTP server
desktopSharingField that contains information about desktop sharing
runningThe field indicating if content sharing has started
nameThe name of the screen which is being shared (unavailable when content sharing is off)
idUnique identifier of a window or screen being shared (unavailable when content sharing is off)
broadcastPictureField that contains information about a picture being shared
fileNameName of the picture being shared (unavailable when picture sharing is off)
fileIdUnique identifier of a file being shared on the built-in HTTP server (unavailable when picture sharing is off)
audioCaptureTestField showing whether a microphone test has been started (true or false)
requestsField that is available when requests are made
incomingPodiumRequestIncoming podium requests
outgoingPodiumRequestOutgoing podium requests
incomingPodiumInvitationIncoming podium invitations
outgoingPodiumInvitationOutgoing podium invitations
incomingRecordInbound requests for recording video and audio streams from TrueConf VideoSDK
outgoingRecordOutbound requests for recording audio and video streams
incomingJoinToMyConfInbound requests for joining the conference created by TrueConf VideoSDK
outgoingJoinToMyConfOutgoing invitations to the conference created by TrueConf VideoSDK
incomingP2PCallIncoming video call
outgoingP2PCallOutgoing video call
incomingGroupConfIncoming invitation to a group conference
outgoingGroupConfOutgoing invitation to a group conference
incomingPtzControlIncoming requests for PTZ camera control
outgoingPtzControlOutgoing PTZ camera control requests
friendlyNameThe name of the captured screen used for content sharing
sourceTypeThe type of the captured content:
β€’ 1 β€” desktop
β€’ 2 β€” application window
windowNameThe name of the captured application window (used for content sharing)
recordingA flag indicating the recording status of the conference on the server

See also

Last Updated: