TrueConf

# createConference

Описание: создание групповой конференции.

Получение положительного ответа ("result" : true) обозначает, что команда принята на выполнение. Результат придет отдельной нотификацией.

Успешное начало конференции можно определить:

  1. По изменению текущего статуса подключения на 5 в нотификации appStateChanged

  2. По нотификации conferenceCreated

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

{
    "method" : "createConference",
    "requestId" : "1",
    "title" : "Code review",
    "confType" : "role",
    "autoAccept" : false,
    "useWaitingRoom" : true,
    "muteCamOnJoin" : false,
    "muteMicOnJoin" : false,
    "castersCount" : 4,
    "inviteList" : [
        "user1@some.server",
        "user2@some.server",
        "user3@some.server"
    ]
}

  
        Copied!

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

{
    "method" : "createConference",
    "requestId" : "1",
    "result" : true
}

  
        Copied!

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

  • title - название конференции

  • castersCount - количество участников видеоселектора, которое одновременно может быть на трибуне (можно получить из команды getTariffRestrictions или нотификации tariffRestrictionsChanged)

  • useWaitingRoom - флаг, включающий комнату ожидания при старте конференции. Необязательный параметр. Если отсутствует, по умолчанию будет использовано значение false

  • muteCamOnJoin - флаг, задающий автоматический мьют устройства захвата видео участнику групповой конференции, который только к ней подключился. Необязательный параметр. Если отсутствует, по умолчанию будет использовано значение false

  • muteMicOnJoin - флаг, задающий автоматический мьют устройства захвата звука участнику групповой конференции, который только к ней подключился. Необязательный параметр. Если отсутствует, по умолчанию будет использовано значение false

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

  • autoAccept - флаг, задающий разрешение на автоприсоединение участников в конференцию

  • confType - тип конференции. Может быть:

    • symmetric - все на экране

    • asymmetric - видеоурок

    • role - видеоселектор

  • inviteList - массив строк с уникальными идентификаторами пользователей (TrueConf ID), которым будет разослано приглашение в конференцию. Возможные значения:

    • PeerId - поддерживается. Внутри приложения автоматически конвертируется в CallId и команда выполняется уже с ним. В этом случае приглашение получит пользователь на всех устройствах

    • CallId - поддерживается. Приглашение получит пользователь на всех устройствах

    • InstanceId - поддерживается. Приглашение получит пользователь на конкретном экземпляре приложения

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

Указывать в списке inviteList аккаунт, под которым авторизован VideoSDK/Room (то есть себя) не нужно, он автоматически будет добавлен первым участником в роли владельца.

См. также: