TrueConf

# getAppState

Описание: получить информацию о состоянии приложения.

Пример запроса:

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

  
        Copied!

Пример ответа:

{
    "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
}

  
        Copied!

Описание параметров:

  • appState - состояние приложения, которое может быть следующим:

    • 0 - нет подключения к серверу

    • 1 - VideoSDK/Room пытается подключиться к серверу

    • 2 - нужно залогиниться

    • 3 - VideoSDK/Room подключен к серверу и залогинен

    • 4 - VideoSDK/Room находится в ожидании: либо он звонит кому-то, либо звонят ему

    • 5 - VideoSDK/Room находится в конференции

    • 6 - VideoSDK/Room завершает конференцию

  • extStatus - расширенный статус текущего пользователя, который может принимать одно из следующих значений:

    • -1 - невалидный пользователь

    • 0 - пользователь оффлайн

    • 1 - пользователь оффлайн, но был недавно активен

    • 2 - пользователь доступен

    • 3 - пользователь доступен с телефона

    • 4 - пользователь доступен с терминала

    • 5 - пользователь доступен, но установил статус не беспокоить

    • 6 - пользователь отошёл

    • 7 - пользователь занят

    • 8 - пользователь занят с телефона

    • 9 - пользователь занят с терминала

    • 10 - пользователь находится в групповой конференции, которую создал он сам и в неё можно попроситься

  • additionalStatus - дополнительный статус текущего пользователя в виде строки

  • embeddedHttpPort - номер порта, который слушает встроенный http сервер

  • desktopSharing - поле, которое содержит информацию о показе контента

  • running - поле, указывающее информацию о том, запущен ли функционал показа картинки или захват окна

  • name - системное имя рабочего стола, который вещается. Поле отсутствует при выключенном показе контента

  • id - уникальный идентификатор окна или экрана, которое вещается. Поле отсутствует при выключенном показе контента

  • broadcastPicture - поле, которое содержит информацию о вещании картинки

  • fileName - имя картинки, которая показывается. Поле отсутствует при выключенном показе картинки

  • fileId - уникальный идентификатор файла на вcтроенном http сервере, который показывается. Поле отсутствует при выключенном показе картинки

  • audioCaptureTest - поле, которое указывает на то, запущен ли тест микрофона. Может быть равен true или false

  • requests - поле, которое присутствует когда есть запросы

  • incomingPodiumRequest - входящие запросы на трибуну

  • outgoingPodiumRequest - исходящие запросы на трибуну

  • incomingPodiumInvitation - входящие приглашения на трибуну

  • outgoingPodiumInvitation - исходящие приглашения на трибуну

  • incomingRecord - входящие запросы на запись видеопотока и аудиопотока VideoSDK/Room

  • outgoingRecord - исходящие запросы на запись видеопотока и аудиопотока

  • incomingJoinToMyConf - входящие запросы на участие в созданной VideoSDK/Room конференции

  • outgoingJoinToMyConf - исходящие приглашения на участие в созданной VideoSDK/Room конференции

  • incomingP2PCall - входящий видеозвонок

  • outgoingP2PCall - исходящий видеозвонок

  • incomingGroupConf - входящее приглашение в групповую конференцию

  • outgoingGroupConf - исходящий запрос в групповую конференцию

  • incomingPtzControl - входящие запросы на управление ptz камерой

  • outgoingPtzControl - иcходящие запросы на управление ptz камерой

  • friendlyName - имя захватываемого экрана для показа контента, оформленное в читабельном виде

  • sourceType - тип захватываемого контента. Может быть:

    • 1 - рабочий стол

    • 2 - окно приложения

  • windowName - имя окна захватываемого приложения для показа контента

  • requestId - уникальный идентификатор запроса. Детальнее с ним можно ознакомиться здесь

  • recording - флаг, указывающий на состояние записи конференции на сервере

См. также: