Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-media-pipelines ]

create-media-live-connector-pipeline

Описание

Создаёт конвейер подключения к потоковому медиа в совещании Amazon Chime SDK.

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

Синтаксис

  create-media-live-connector-pipeline
--sources <value>
--sinks <value>
[--client-request-token <value>]
[--tags <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]

Параметры

--sources (список)

Источники данных конвейера подключения к потоковому медиа.

(структура)

Объект конфигурации источника данных потоковой медиа-трансляции.

SourceType -> (строка)

Тип источника медиа конфигурации источника.

ChimeSdkMeetingLiveConnectorConfiguration -> (структура)

Настройки конфигурации конвейера подключения.

Arn -> (строка)

ARN совещания Chime SDK для объекта конфигурации.

MuxType -> (строка)

Тип мультиплексирования для объекта конфигурации.

CompositedVideo -> (структура)

Комбинированное видео конвейера медиа.

Layout -> (строка)

Настройка макета, например, GridView в объекте конфигурации.

Resolution -> (строка)

Настройка разрешения видео в объекте конфигурации. По умолчанию: HD 1280 x 720. FHD разрешение: 1920 x 1080.

GridViewConfiguration -> (структура)

Настройка конфигурации GridView.

ContentShareLayout -> (строка)

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

PresenterOnlyConfiguration -> (структура)

Определяет параметры конфигурации для видео-плитки только для ведущего.

PresenterPosition -> (строка)

Определяет позицию видео-плитки ведущего. По умолчанию: TopRight.

ActiveSpeakerOnlyConfiguration -> (структура)

Настройки конфигурации видео-плитки только для активного спикера.

ActiveSpeakerPosition -> (строка)

Позиция видео-плитки активного спикера.

HorizontalLayoutConfiguration -> (структура)

Настройки конфигурации для горизонтального макета.

TileOrder -> (строка)

Устанавливает автоматическое упорядочение видео-плиток.

TilePosition -> (строка)

Устанавливает позицию горизонтальных плиток.

TileCount -> (целое число)

Максимальное количество видео-плиток для отображения.

TileAspectRatio -> (строка)

Устанавливает соотношение сторон всех видео-плиток.

VerticalLayoutConfiguration -> (структура)

Настройки конфигурации для вертикального макета.

TileOrder -> (строка)

Устанавливает автоматическое упорядочение видео-плиток.

TilePosition -> (строка)

Устанавливает позицию вертикальных плиток.

TileCount -> (целое число)

Максимальное количество плиток для отображения.

TileAspectRatio -> (строка)

Устанавливает соотношение сторон видео-плиток, например, 16:9.

VideoAttribute -> (структура)

Настройки атрибутов для видео-плиток.

CornerRadius -> (целое число)

Устанавливает радиус углов всех видео-плиток.

BorderColor -> (строка)

Определяет цвет рамки всех видео-плиток.

HighlightColor -> (строка)

Определяет цвет выделения активной видео-плитки.

BorderThickness -> (целое число)

Определяет толщину рамки всех видео-плиток.

CanvasOrientation -> (строка)

Настройка ориентации, горизонтальная или вертикальная.

SourceConfiguration -> (структура)

Настройки конфигурации источника для объекта конфигурации конвейера медиа.

SelectedVideoStreams -> (структура)

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

AttendeeIds -> (список)

Идентификаторы участников выбранных для конвейера медиа потоков.

(строка)

ExternalUserIds -> (список)

Идентификаторы внешних пользователей выбранных для конвейера медиа потоков.

(строка)

JSON-синтаксис:

[
  {
    "SourceType": "ChimeSdkMeeting",
    "ChimeSdkMeetingLiveConnectorConfiguration": {
      "Arn": "string",
      "MuxType": "AudioWithCompositedVideo"|"AudioWithActiveSpeakerVideo",
      "CompositedVideo": {
        "Layout": "GridView",
        "Resolution": "HD"|"FHD",
        "GridViewConfiguration": {
          "ContentShareLayout": "PresenterOnly"|"Horizontal"|"Vertical"|"ActiveSpeakerOnly",
          "PresenterOnlyConfiguration": {
            "PresenterPosition": "TopLeft"|"TopRight"|"BottomLeft"|"BottomRight"
          },
          "ActiveSpeakerOnlyConfiguration": {
            "ActiveSpeakerPosition": "TopLeft"|"TopRight"|"BottomLeft"|"BottomRight"
          },
          "HorizontalLayoutConfiguration": {
            "TileOrder": "JoinSequence"|"SpeakerSequence",
            "TilePosition": "Top"|"Bottom",
            "TileCount": integer,
            "TileAspectRatio": "string"
          },
          "VerticalLayoutConfiguration": {
            "TileOrder": "JoinSequence"|"SpeakerSequence",
            "TilePosition": "Left"|"Right",
            "TileCount": integer,
            "TileAspectRatio": "string"
          },
          "VideoAttribute": {
            "CornerRadius": integer,
            "BorderColor": "Black"|"Blue"|"Red"|"Green"|"White"|"Yellow",
            "HighlightColor": "Black"|"Blue"|"Red"|"Green"|"White"|"Yellow",
            "BorderThickness": integer
          },
          "CanvasOrientation": "Landscape"|"Portrait"
        }
      },
      "SourceConfiguration": {
        "SelectedVideoStreams": {
          "AttendeeIds": ["string", ...],
          "ExternalUserIds": ["string", ...]
        }
      }
    }
  }
  ...
]

--sinks (список)

Стоки данных конвейера подключения к потоковому медиа.

(структура)

Настройки конфигурации стока конвейера медиа.

SinkType -> (строка)

Тип стока конфигурации.

RTMPConfiguration -> (структура)

Настройки конфигурации RTMP стока.

Url -> (строка)

URL конфигурации RTMP.

AudioChannels -> (строка)

Аудиоканалы, установленные для RTMP конфигурации.

AudioSampleRate -> (строка)

Частота дискретизации аудио для RTMP конфигурации. По умолчанию: 48000.

Краткая синтаксическая запись:

SinkType=string,RTMPConfiguration={Url=string,AudioChannels=string,AudioSampleRate=string} ...

JSON-синтаксис:

[
  {
    "SinkType": "RTMP",
    "RTMPConfiguration": {
      "Url": "string",
      "AudioChannels": "Stereo"|"Mono",
      "AudioSampleRate": "string"
    }
  }
  ...
]

--client-request-token (строка)

Токен, назначенный клиенту, который делает запрос.

--tags (список)

Теги, связанные с конвейером подключения к потоковому медиа.

(структура)

Ключ/значение, предоставляющие пользователям доступ к ресурсам совещания.

Key -> (строка)

Ключ тега.

Value -> (строка)

Значение тега.

Краткая синтаксическая запись:

Key=string,Value=string ...

JSON-синтаксис:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--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.

Вывод

MediaLiveConnectorPipeline -> (структура)

Новая конвейерная линия медиа-соединителя.

Источники -> (список)

Источники данных конвейера соединителя.

(структура)

Объект конфигурации источника данных потоковой медиа-конвейера.

SourceType -> (строка)

Тип источника медиа в конфигурации источника.

ChimeSdkMeetingLiveConnectorConfiguration -> (структура)

Настройки конфигурации конвейера соединителя.

Arn -> (строка)

Chime SDK ARN для собрания в объекте конфигурации.

MuxType -> (строка)

Тип мультиплексирования в объекте конфигурации.

CompositedVideo -> (структура)

Компонованное видео конвейера медиа.

Layout -> (строка)

Настройка макета, например, GridView в объекте конфигурации.

Resolution -> (строка)

Настройка разрешения видео в объекте конфигурации. По умолчанию: HD с 1280 x 720. Разрешение FHD: 1920 x 1080.

GridViewConfiguration -> (структура)

Настройка конфигурации GridView.

ContentShareLayout -> (строка)

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

PresenterOnlyConfiguration -> (структура)

Определяет параметры конфигурации для плитки видео только для докладчика.

PresenterPosition -> (строка)

Определяет положение плитки видео докладчика. По умолчанию: TopRight.

ActiveSpeakerOnlyConfiguration -> (структура)

Настройки конфигурации для плитки видео ActiveSpeakerOnly.

ActiveSpeakerPosition -> (строка)

Положение плитки видео ActiveSpeakerOnly.

HorizontalLayoutConfiguration -> (структура)

Настройки конфигурации для горизонтального макета.

TileOrder -> (строка)

Устанавливает автоматический порядок плиток видео.

TilePosition -> (строка)

Устанавливает положение горизонтальных плиток.

TileCount -> (целое число)

Максимальное количество отображаемых плиток видео.

TileAspectRatio -> (строка)

Указывает соотношение сторон всех плиток видео.

VerticalLayoutConfiguration -> (структура)

Настройки конфигурации для вертикального макета.

TileOrder -> (строка)

Устанавливает автоматический порядок плиток видео.

TilePosition -> (строка)

Устанавливает положение вертикальных плиток.

TileCount -> (целое число)

Максимальное количество отображаемых плиток.

TileAspectRatio -> (строка)

Устанавливает соотношение сторон плиток видео, например, 16:9.

VideoAttribute -> (структура)

Настройки атрибутов для плиток видео.

CornerRadius -> (целое число)

Устанавливает радиус уголков всех плиток видео.

BorderColor -> (строка)

Определяет цвет границы всех плиток видео.

HighlightColor -> (строка)

Определяет цвет выделения активной плитки видео.

BorderThickness -> (целое число)

Определяет толщину границы всех плиток видео.

CanvasOrientation -> (строка)

Настройка ориентации, горизонтальная или вертикальная.

SourceConfiguration -> (структура)

Настройки конфигурации источника объекта конфигурации медиа-конвейера.

SelectedVideoStreams -> (структура)

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

AttendeeIds -> (список)

Идентификаторы участников выбранных потоков для медиа-конвейера.

(строка)

ExternalUserIds -> (список)

Внешние идентификаторы пользователей выбранных потоков для медиа-конвейера.

(строка)

Стоки -> (список)

Стоки данных конвейера соединителя.

(структура)

Настройки конфигурации стока конвейера медиа.

SinkType -> (строка)

Тип стока в конфигурации стока.

RTMPConfiguration -> (структура)

Настройки конфигурации RTMP стока.

Url -> (строка)

URL конфигурации RTMP.

AudioChannels -> (строка)

Настроенные аудиоканалы для конфигурации RTMP.

AudioSampleRate -> (строка)

Настроенная частота дискретизации аудио для конфигурации RTMP. По умолчанию: 48000.

MediaPipelineId -> (строка)

Идентификатор конвейера соединителя.

MediaPipelineArn -> (строка)

ARN конвейера соединителя.

Status -> (строка)

Статус конвейера соединителя.

CreatedTimestamp -> (метка времени)

Время создания конвейера соединителя.

UpdatedTimestamp -> (метка времени)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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