INTEGRITY Документация

Встреча

Встреча представляет собой многоразовая виртуальная комната куда можно войти и взаимодействовать в реальном времени.

Ей можно назначить заголовок и конфигурацию функций, а затем добавить участников, которым разрешено присоединяться. Сама Meeting не "начинается" и не "заканчивается", она просто существует.

Поскольку у Meetings нет привязки к конкретной дате или времени, вы можете создавать их заранее или непосредственно в момент, когда пользователям нужно присоединиться.

На следующей схеме показана структура встречи:

---
title: Meeting
---
flowchart TB
  accTitle: Meeting blueprint
  accDescr: Diagram showing blueprint of a Meeting

  subgraph details [ ]
      direction LR
      subgraph feat ["<b>Features</b>"]
          feat-content["Chat<br>...<br>Recording<br>...<br>Transcriptions"]
      end
      subgraph config ["<b>Configuration</b>"]
          config-content["record_on_start<br>...<br>persist_chat<br>...<br>ai_config"]
      end
  end

  subgraph participants ["<b>Participants</b>"]
      direction LR
      subgraph participants-row2 [ ]
          direction TB
          P3["<br>Participant 3
          <br>
          "]
          P4["<br>Participant 4
          <br>
          "]
      end
      subgraph participants-row1 [ ]
          direction TB
          P1["<br>Participant 1
          <br>
          "]
          P2["<br>Participant 2
          <br>
          "]
      end
  end

  style participants-row1 fill:none,stroke:none
  style participants-row2 fill:none,stroke:none
  style details fill:none,stroke:none

Сессия

Сессия представляет собой активный экземпляр Meeting. Она запускается автоматически, когда к встрече присоединяется первый участник, и завершается вскоре после того, как её покидает последний участник. Session наследует все настройки (например, функции и название) от родительской Meeting.

Поскольку Meeting является постоянным, у него может быть множество разных Sessions с течением времени.

Пример: Представьте встречу как регулярно повторяющийся еженедельный стендап.

Встреча представляет собой постоянное «стендап-событие», существующее в вашей системе.

Каждую неделю, когда участники присоединяются к стендапу этой недели, new Session создаётся: этот Session представляет фактическую текущую встречу standup этой недели.

Примечание: Это различие важно для тарификации. Плата взимается по каждому участнику только за время активного Session, а не за время простаивающей встречи.

Вы можете получить сведения о ваших сессиях из RealtimeKit Dashboard или с помощью Sessions API конечные точки.

Сессии в RealtimeKit Dashboard

Терминология сессий

Waiting Room

A зал ожидания позволяет участникам присоединиться к встрече, не входя сразу в текущую сессию. Это даёт организаторам полный контроль над кто может войти, когда они входят, а также как организовано управление ходом встречи.

Организаторы также могут настраивать особое поведение при переходе пользователей из зала ожидания на встречу.

Эти параметры позволяют точно настроить порядок предоставления доступа: от строгого контроля допуска до более плавного входа участников после подключения организатора, а также любое сочетание этих подходов.

Сцена

Встречи можно настроить с помощью виртуальная сцена, который помогает управлять тем, кто активно участвует с аудио и видео во время сессий с большим количеством участников.

Когда участник на сцене, они видны в сетке и могут транслировать своё аудио и видео всем участникам встречи. Участники, которые со сцены не может публиковать медиа, но при этом может в полной мере участвовать благодаря таким функциям, как чат, опросы, Вопросы и ответы, а также плагины, что делает работу более интерактивной, не перегружая раскладку видео в реальном времени.

Участники также могут запрос на выход на сцену, что позволяет им сигнализировать о желании высказаться или начать презентацию. Хосты сохраняют полный контроль в любой момент: они могут подтверждает или отклоняет запросы, либо напрямую приглашать участников на сцену или удалять их со сцены по необходимости.

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

Connected Meetings

Connected Meetings позволяют создавать связанные пространства для встреч, между которыми участники могут переключаться в ходе сессии. Это удобно для воркшопов, занятий, параллельных обсуждений и любых сценариев, когда основная встреча делится на более мелкие группы, а затем снова объединяется.

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

Создание встречи

Вы создаёте и управляете встречами RealtimeKit, как правило, из своего бэкенда, с помощью Meetings API. Чтобы создать встречу, отправьте POST запрос к Создание встречи конечная точка.

Предварительные требования API

Убедитесь, что у вас есть следующие значения для этого запроса API:

Если у вас их ещё нет, ознакомьтесь с Начало работы руководство.

curl https://api.cloudflare.com/client/v4/accounts/{ACCOUNT_ID}/realtime/kit/{APP_ID}/meetings \
  --request POST \
  --header "Authorization: Bearer <CLOUDFLARE_API_TOKEN>" \
  --header "Content-Type: application/json" \
  --data '{
    "title": "My First Cloudflare RealtimeKit meeting"
    }'

Успешный ответ включает уникальный id для созданной встречи. Сохраните этот ID: он потребуется для всех дальнейших операций с этой встречей, например для добавления участников или её отключения.

Полный список доступных параметров конфигурации см. в API создания встречи.

Дальнейшие шаги

После знакомства со встречами и сессиями вы можете перейти к следующим шагам: