Труконф

# getConferenceParticipants

Описание: получить список участников конференции с информацией о них.

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

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

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

{
    "method": "getConferenceParticipants",
    "requestId" : "1",
    "confId": "00000080752eb399@some.server#vcs",
    "participants": [{
            "peerId": "user1@some.server/d8a9cda9",
            "peerDn": "สวัสดี ",
            "mic": 2,
            "video": 0,
            "slideShow": false,
            "leaderType": 1,
            "role": 2,
            "broadcast": true,
            "pinned": true
        },
        {
            "peerId": "user2@some.server/58f5dac7",
            "peerDn": "user2",
            "recordingMe": false,
            "recordingByMe": false,
            "mic": 1,
            "video": 0,
            "slideShow": false,
            "leaderType": 0,
            "role": 1,
            "broadcast": false,
            "pinned": false,
            "isInWaitingRoom": false,
        }
    ],
    "result": true
}

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

  • peerId - уникальный идентификатор пользователя (TrueConf ID)

  • peerDn - отображаемое имя пользователя

  • pinned - флаг, указывающий на закрепленность участника в режиме Автоматический выход на подиум по VAD. Присутствует только в видеоселекторе

  • confId - уникальный идентификатор текущей конференции

  • broadcast - флаг, обозначающий, вещает ли пользователь с трибуны. Присутствует только в видеоселекторе

  • role - роль участника. Присутствует только в видеоселекторе. Может быть:

    • 0 - без изменений

    • 1 - общая

    • 2 - владелец конференции

    • 3 - пользователь, который сам отправил запрос выхода на трибуну

    • 4 - пользователь, которого вызвали на трибуну

    • 5 - пользователь, использующий реплику

  • mic - флаг, обозначающий состояние микрофона. Может быть:

    • 0 - устройство отсутствует либо не выбрано

    • 1 - устройство выбрано, но замьючено (отключен захват звука)

    • 2 - устройство выбрано и включено

  • recordingMe - флаг, который указывает на то, записывает ли пользователь видеопоток и аудиопоток от VideoSDK/Room. Параметр может отсутствовать

  • recordingByMe - флаг, который указывает на то, записывает ли VideoSDK/Room видеопоток и аудиопоток от этого пользователя. Параметр может отсутствовать

  • video - флаг, обозначающий состояние камеры. Может быть:

    • 0 - устройство отсутствует либо не выбрано

    • 1 - устройство выбрано, но замьючено

    • 2 - устройство выбрано и включено

  • slideShow - флаг, который указывает на то, показывает ли этот участник слайдшоу

  • extraVideo - тип транслируемого изображения. Параметр может отсутствовать. Может принимать следующие значения:

    • 0 - трансляция с камеры

    • 1 - трансляция контента

    • 2 - трансляция с камеры, которую нельзя переключить на контент

  • audioReceiving - прием аудио от участника. Параметр может отсутствовать

  • videoReceiving - прием видео от участника. Параметр может отсутствовать

  • leaderType - тип участника. Отсутствует в видеозвонке. Может быть:

    • 0 - обычный

    • 1 - создатель конференции

    • 2 - оператор

    • 3 - ведущий

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

  • isInWaitingRoom - флаг, указывающий на то, находится ли участник конференции в комнате ожидания. Поле присутствует только если управляемый VideoSDK/Room - владелец или ведущий групповой конференции и текущий объект в массиве не VideoSDK/Room

См. также: