Spec-Zone.ru › AWS CLI v2

[ aws . kinesis-video-webrtc-storage ]

join-storage-session

Описание

Примечание

Перед использованием этого API необходимо вызвать API GetSignalingChannelEndpoint, чтобы запросить конечную точку WEBRTC. Затем укажите конечную точку и регион в запросе к API JoinStorageSession.

Подключиться к текущей односторонней видео- и/или многосторонней аудио-сессии WebRTC в качестве устройства, генерирующего видео, для входного канала. Если для канала нет существующей сессии, необходимо создать новую потоковую сессию, и должен быть предоставлен Amazon Resource Name (ARN) канала сигнализации.

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

Предупреждение

В настоящее время для передачи WebRTC необходимы как аудио-, так и видеодорожки.

Текущие требования:

  • Видеодорожка: H.264
  • Аудиодорожка: Opus

Полученное видео в потоке Kinesis Video будет иметь следующие параметры: видео H.264 и аудио AAC.

После того, как мастер-участник согласует соединение через WebRTC, сессия обработки медиаданных будет сохранена в потоке Kinesis Video. Затем несколько зрителей смогут воспроизводить медиаданные в реальном времени с помощью наших API для воспроизведения.

Вы также можете использовать существующие возможности Kinesis Video Streams, такие как HLS или DASH воспроизведение, генерацию изображений с помощью GetImages и многое другое с обработанными медиаданными WebRTC.

Примечание

Доставка изображений через S3 и уведомления в настоящее время не поддерживаются.

Примечание

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

Дополнительная информация

  • Идемпотентность - Это API не идемпотентное.
  • Поведение при повторных вызовах - Это считается новым вызовом API.
  • Одновременные вызовы - Допускаются одновременные вызовы. Предложение отправляется один раз на каждый вызов.

См. также: Документация AWS API

Синтаксис

  join-storage-session
--channel-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--channel-arn (строка)

Amazon Resource Name (ARN) канала сигнализации.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения перепишут значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. При предоставлении значения output он проверит входные данные команд и вернёт пример выходного JSON для этой команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI и не гарантируется обратная совместимость в сгенерированном каркасе JSON.

Глобальные параметры

--debug (логическое значение)

Включить отладку логирования.

--endpoint-url (строка)

Переопределить значение URL по умолчанию команды указанным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (логическое значение)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Набор сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная в base64 строка. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается в двоичный блок, fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла непосредственно, независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод страницы CLI.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

Нет

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API