start-composition

Описание

Запускает композицию со сцены на основе конфигурации, предоставленной в запросе.

Композиция — это временный ресурс, который существует после успешного выполнения этой операции. Композиция останавливается и ресурс удаляется:

Когда вызывается StopComposition.
После тайм-аута в 1 минуту, когда все участники отключены от сцены.
После тайм-аута в 1 минуту, если на сцене нет участников при вызове StartComposition.
Когда трансляция в канал IVS завершается неудачей и все попытки повторного подключения исчерпаны.
Когда трансляция отключена и все попытки повторного подключения исчерпаны.

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

Синтаксис

  start-composition
--stage-arn <value>
[--idempotency-token <value>]
[--layout <value>]
--destinations <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]

Параметры

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

ARN сцены, используемой для композиции.

--idempotency-token (строка)

Маркер идемпотентности.

--layout (структура)

Объект макета для настройки параметров композиции.

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

Настройка, относящаяся к макету сетки. По умолчанию: макет сетки.

featuredParticipantAttribute -> (строка)

Имя этого атрибута определяет выделенный слот. Участник с этим атрибутом, установленным в значение "true" (как строка) в ParticipantTokenConfiguration, размещается в выделенном слоте. По умолчанию: "" (нет выделенного участника).

omitStoppedVideo -> (булево)

Определяет, следует ли пропускать участников со остановленным видео в композиции. По умолчанию: false.

videoAspectRatio -> (строка)

Устанавливает режим отображения участников, не являющихся выделенными, для управления соотношением сторон видеоплиток. VIDEO — 16:9, SQUARE — 1:1 и PORTRAIT — 3:4. По умолчанию: VIDEO.

videoFillMode -> (строка)

Определяет, как содержимое видео подходит к плитке участника: FILL (растянуто), COVER (обрезано) или CONTAIN (обрезано с заполнением). Если не установлено, videoFillMode по умолчанию устанавливается на режим заполнения COVER для участников в сетке и на режим заполнения CONTAIN для выделенных участников.

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

Указывает интервал между плитками участников в пикселях. По умолчанию: 2.

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

Настройка, относящаяся к макету PiP.

featuredParticipantAttribute -> (строка)

omitStoppedVideo -> (булево)

Определяет, следует ли пропускать участников со остановленным видео в композиции. По умолчанию: false.

videoFillMode -> (строка)

Определяет, как содержимое видео подходит к плитке участника: FILL (растянуто), COVER (обрезано) или CONTAIN (обрезано с заполнением). По умолчанию: COVER.

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

Указывает интервал между плитками участников в пикселях. По умолчанию: 0.

pipParticipantAttribute -> (строка)

Указывает участника для окна PiP. Участник с этим атрибутом, установленным в значение "true" (как строка) в ParticipantTokenConfiguration, размещается в слоте PiP. По умолчанию: "" (нет участника PiP).

pipBehavior -> (строка)

Определяет поведение PiP, когда все участники покинули сцену: STATIC (сохраняет исходное положение/размер) или DYNAMIC (расширяется до полной композиции). По умолчанию: STATIC.

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

Устанавливает смещение положения окна PiP в пикселях от ближайших краев, определяемых PipPosition. По умолчанию: 0.

pipPosition -> (строка)

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

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

Указывает ширину окна PiP в пикселях. Если это значение не задано явно, значение pipWidth будет основано на размерах композиции и соотношении сторон видео участника.

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

Указывает высоту окна PiP в пикселях. Если это значение не задано явно, значение pipHeight будет основано на размерах композиции и соотношении сторон видео участника.

Сокращенный синтаксис:

grid={featuredParticipantAttribute=string,omitStoppedVideo=boolean,videoAspectRatio=string,videoFillMode=string,gridGap=integer},pip={featuredParticipantAttribute=string,omitStoppedVideo=boolean,videoFillMode=string,gridGap=integer,pipParticipantAttribute=string,pipBehavior=string,pipOffset=integer,pipPosition=string,pipWidth=integer,pipHeight=integer}

Синтаксис JSON:

{
  "grid": {
    "featuredParticipantAttribute": "string",
    "omitStoppedVideo": true|false,
    "videoAspectRatio": "AUTO"|"VIDEO"|"SQUARE"|"PORTRAIT",
    "videoFillMode": "FILL"|"COVER"|"CONTAIN",
    "gridGap": integer
  },
  "pip": {
    "featuredParticipantAttribute": "string",
    "omitStoppedVideo": true|false,
    "videoFillMode": "FILL"|"COVER"|"CONTAIN",
    "gridGap": integer,
    "pipParticipantAttribute": "string",
    "pipBehavior": "STATIC"|"DYNAMIC",
    "pipOffset": integer,
    "pipPosition": "TOP_LEFT"|"TOP_RIGHT"|"BOTTOM_LEFT"|"BOTTOM_RIGHT",
    "pipWidth": integer,
    "pipHeight": integer
  }
}

--destinations (список)

Массив конфигурации назначения.

(структура)

Сложный тип данных, определяющий объекты конфигурации назначения.

name -> (строка)

Имя, которое можно указать для облегчения идентификации назначения.

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

Канал IVS, используемый для трансляции, для композиции на стороне сервера. Должен быть указан либо channel, либо s3.

channelArn -> (строка)

ARN канала, используемого для трансляции. Ресурсы канала и сцены должны находиться в одном аккаунте AWS и регионе. Канал должен быть в автономном режиме (не транслировать).

encoderConfigurationArn -> (строка)

ARN ресурса EncoderConfiguration. Ресурсы конфигурации кодера и сцены должны находиться в одном аккаунте AWS и регионе.

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

Конфигурация хранилища S3, используемая для записи видеоданных. Должен быть указан либо channel, либо s3.

storageConfigurationArn -> (строка)

ARN конфигурации хранилища, где будут храниться записанные видео.

encoderConfigurationArns -> (список)

ARN ресурсов EncoderConfiguration. Ресурсы конфигурации кодера и сцены должны находиться в одном аккаунте AWS и регионе.

(строка)

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

Массив карт, каждая в формате string:string (key:value). Это необязательное пользовательское определение, в настоящее время используется только для указания формата записи для хранения записи в Amazon S3.

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

Объект конфигурации HLS для получения информации о том, как будет настроена запись.

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

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

format -> (строка)

Формат записи для хранения записи в Amazon S3.

thumbnailConfigurations -> (список)

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

(структура)

Объект, представляющий конфигурацию миниатюр записанного видео для композиции.

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

Целевой интервал генерации миниатюр в секундах. По умолчанию: 60.

storage -> (список)

Указывает формат, в котором записываются миниатюры. SEQUENTIAL записывает все сгенерированные миниатюры последовательно в каталог media/thumbnails/(width)x(height), где (width) и (height) — ширина и высота миниатюры. LATEST сохраняет последнюю миниатюру в media/latest_thumbnail/(width)x(height)/thumb.jpg и перезаписывает ее с интервалом, указанным targetIntervalSeconds. Можно включить как SEQUENTIAL, так и LATEST. По умолчанию: SEQUENTIAL.

(строка)

Синтаксис JSON:

[
  {
    "name": "string",
    "channel": {
      "channelArn": "string",
      "encoderConfigurationArn": "string"
    },
    "s3": {
      "storageConfigurationArn": "string",
      "encoderConfigurationArns": ["string", ...],
      "recordingConfiguration": {
        "hlsConfiguration": {
          "targetSegmentDurationSeconds": integer
        },
        "format": "HLS"
      },
      "thumbnailConfigurations": [
        {
          "targetIntervalSeconds": integer,
          "storage": ["SEQUENTIAL"|"LATEST", ...]
        }
        ...
      ]
    }
  }
  ...
]

--tags (словарь)

Теги, прикрепленные к ресурсу. Массив карт, каждая в формате string:string (key:value). Подробности см. в лучших практиках и стратегиях в Тегирование ресурсов AWS и Редактор тегов, включая ограничения, которые применяются к тегам, и «Пределы и требования к именованию тегов»; Amazon IVS не имеет ограничений по тегам, кроме тех, которые там описаны.

key -> (строка)

value -> (строка)

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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 (boolean)

Включить отладку регистрации.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

json
text
table
yaml
yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/окружения.

--version (string)

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

--color (string)

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

on
off
auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл с набором сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/окружения.

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

Чтобы использовать следующие примеры, у вас должна быть установлена и настроена AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, характерные для Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. использование кавычек со строками в Руководстве пользователя AWS CLI.

Пример 1: Запуск композиции с настройками макета по умолчанию

Следующий start-composition пример запускает композицию для указанной стадии, которая будет транслироваться в указанные места.

aws ivs-realtime start-composition \
    --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
    --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
        {"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
        "recordingConfiguration": {"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}, \
        "storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]'

Вывод:

{
    "composition": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "state": "STARTING"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS",
                            "hlsConfiguration": {
                                "targetSegmentDurationSeconds": 5
                            }
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
                    }
                },
                "detail": {
                    "s3": {
                        "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
                    }
                },
                "id": "GHFabcgefABC",
                "state": "STARTING"
            }
        ],
        "layout": {
            "grid": {
                "featuredParticipantAttribute": ""
                "gridGap": 2,
                "omitStoppedVideo": false,
                "videoAspectRatio": "VIDEO",
                "videoFillMode": ""
            }
        },
        "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
        "startTime": "2023-10-16T23:24:00+00:00",
        "state": "STARTING",
        "tags": {}
    }
}

Для получения дополнительной информации см. IVS Composite Recording | Real-Time Streaming в Руководстве пользователя Amazon IVS Real-Time Streaming.

Пример 2: Запуск композиции с макетом PiP

Следующий start-composition пример запускает композицию для указанной стадии, которая будет транслироваться в указанные места с использованием макета PiP.

aws ivs-realtime start-composition \
    --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
    --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
        {"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
        "storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]' \
    --layout pip='{featuredParticipantAttribute="abcdefg"}'

Вывод:

{
    "composition": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "state": "STARTING"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS",
                            "hlsConfiguration": {
                                "targetSegmentDurationSeconds": 2
                            }
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
                    }
                },
                "detail": {
                    "s3": {
                        "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
                    }
                },
                "id": "GHFabcgefABC",
                "state": "STARTING"
            }
        ],
        "layout": {
            "pip": {
                "featuredParticipantAttribute": "abcdefg",
                "gridGap": 0,
                "omitStoppedVideo": false,
                "pipBehavior": "STATIC",
                "pipOffset": 0,
                "pipParticipantAttribute": "",
                "pipPosition": "BOTTOM_RIGHT",
                "videoFillMode": "COVER"
            }
        },
        "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
        "startTime": "2023-10-16T23:24:00+00:00",
        "state": "STARTING",
        "tags": {}
    }
}

Пример 3: Запуск композиции с включённой записью миниатюр

Следующий start-composition пример запускает композицию для указанной стадии, которая будет транслироваться в указанные места с включённой записью миниатюр.

aws ivs-realtime start-composition \
    --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
    --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
        {"s3": {"encoderConfigurationArns": ["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
        "storageConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE", \
        "thumbnailConfigurations": [{"storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}]}}]'

Вывод:

{
    "composition": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "state": "STARTING"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS",
                            "hlsConfiguration": {
                                "targetSegmentDurationSeconds": 2
                            }
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
                        "thumbnailConfigurations": [
                           {
                              "targetIntervalSeconds": 60,
                              "storage": [
                                  "SEQUENTIAL"
                              ]
                           }
                        ]
                    }
                },
                "detail": {
                    "s3": {
                        "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
                    }
                },
                "id": "GHFabcgefABC",
                "state": "STARTING"
            }
        ],
        "layout": {
            "grid": {
                "featuredParticipantAttribute": ""
                "gridGap": 2,
                "omitStoppedVideo": false,
                "videoAspectRatio": "VIDEO",
                "videoFillMode": ""
            }
        },
        "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
        "startTime": "2023-10-16T23:24:00+00:00",
        "state": "STARTING",
        "tags": {}
    }
}

Вывод

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

Созданная композиция.

arn -> (строка)

ARN ресурса композиции.

stageArn -> (строка)

ARN этапа, используемого в качестве входных данных

state -> (строка)

Состояние композиции.

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

Объект макета для настройки параметров композиции.

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

Настройка, связанная с макетом сетки. По умолчанию: макет сетки.

featuredParticipantAttribute -> (строка)

Имя этого атрибута идентифицирует выделенное место. Участник с этим атрибутом, установленным в значение "true" (как строка) в ParticipantTokenConfiguration, размещается в выделенном месте. По умолчанию: "" (нет выделенного участника).

omitStoppedVideo -> (булево)

Определяет, следует ли исключать участников с остановленным видео в композиции. По умолчанию: false.

videoAspectRatio -> (строка)

Устанавливает режим отображения участника, не выделенного для отображения, для управления соотношением сторон видеоплиток. VIDEO — 16:9, SQUARE — 1:1, и PORTRAIT — 3:4. По умолчанию: VIDEO.

videoFillMode -> (строка)

Определяет, как содержимое видео помещается в плитку участника: FILL (растягивание), COVER (обрезка) или CONTAIN (обрезка по ширине). Если не задано, videoFillMode по умолчанию использует режим заполнения COVER для участников в сетке и CONTAIN для выделенного участника.

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

Указывает интервал между плитками участников в пикселях. По умолчанию: 2.

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

Настройка, связанная с макетом PiP.

featuredParticipantAttribute -> (строка)

omitStoppedVideo -> (булево)

Определяет, следует ли исключать участников с остановленным видео в композиции. По умолчанию: false.

videoFillMode -> (строка)

Определяет, как содержимое видео помещается в плитку участника: FILL (растягивание), COVER (обрезка) или CONTAIN (обрезка по ширине). По умолчанию: COVER.

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

Указывает интервал между плитками участников в пикселях. По умолчанию: 0.

pipParticipantAttribute -> (строка)

pipBehavior -> (строка)

Определяет поведение PiP, когда все участники покинули встречу: STATIC (сохраняет исходное положение/размер) или DYNAMIC (расширяется до полной композиции). По умолчанию: STATIC.

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

Устанавливает смещение окна PiP в пикселях от ближайших краев, определяемых PipPosition. По умолчанию: 0.

pipPosition -> (строка)

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

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

Указывает ширину окна PiP в пикселях. Если это не установлено явно, значение pipWidth будет зависеть от размера композиции и соотношения сторон видео участника.

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

Указывает высоту окна PiP в пикселях. Если это не установлено явно, значение pipHeight будет зависеть от размера композиции и соотношения сторон видео участника.

destinations -> (список)

Массив объектов Destination. Композиция может содержать один пункт назначения (channel или s3) или два (один channel и один s3).

(структура)

Объект, определяющий состояние пункта назначения.

id -> (строка)

Уникальный идентификатор этого пункта назначения, назначенный IVS.

state -> (строка)

Состояние пункта назначения композиции.

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

UTC-время начала пункта назначения. Это отметка времени в формате ISO 8601; обратите внимание, что она возвращается как строка.

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

UTC-время окончания пункта назначения. Это отметка времени в формате ISO 8601; обратите внимание, что она возвращается как строка.

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

Настройка, используемая для создания этого пункта назначения.

name -> (строка)

Имя, которое можно указать для лучшей идентификации пункта назначения.

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

Канал IVS, используемый для вещания, для композиции на стороне сервера. Должен быть указан либо channel, либо s3.

channelArn -> (строка)

ARN канала для вещания. Ресурсы канала и этапа должны находиться в одной учетной записи AWS и регионе. Канал должен быть в автономном режиме (не транслировать).

encoderConfigurationArn -> (строка)

ARN ресурса EncoderConfiguration. Ресурсы конфигурации кодера и этапа должны находиться в одной учетной записи AWS и регионе.

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

Конфигурация хранилища S3, используемая для записи данных видео. Должен быть указан либо channel, либо s3.

storageConfigurationArn -> (строка)

ARN StorageConfiguration, где будут храниться записанные видео.

encoderConfigurationArns -> (список)

ARN ресурсов EncoderConfiguration. Ресурсы конфигурации кодера и этапа должны находиться в одной учетной записи AWS и регионе.

(строка)

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

Массив карт, каждая из которых имеет вид string:string (key:value). Это необязательная настройка клиента, в настоящее время используется только для указания формата записи для хранения записи в Amazon S3.

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

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

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

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

format -> (строка)

Формат записи для хранения записи в Amazon S3.

thumbnailConfigurations -> (список)

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

(структура)

Объект, представляющий конфигурацию миниатюр для записанного видео для композиции.

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

Целевой интервал генерации миниатюр в секундах. По умолчанию: 60.

storage -> (список)

Указывает формат, в котором записываются миниатюры. SEQUENTIAL записывает все сгенерированные миниатюры в порядке следования в каталог media/thumbnails/(ширина)x(высота), где (ширина) и (высота) — ширина и высота миниатюры. LATEST сохраняет последнюю миниатюру в media/latest_thumbnail/(ширина)x(высота)/thumb.jpg и перезаписывает ее с интервалом, указанным в targetIntervalSeconds. Можно включить как SEQUENTIAL, так и LATEST. По умолчанию: SEQUENTIAL.

(строка)

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

Необязательные детали, касающиеся состояния пункта назначения.

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

Объект деталей S3 для возвращения информации о пункте назначения S3.

recordingPrefix -> (строка)

Префикс ведра S3, под которым хранится запись.

tags -> (карта)

Теги, прикрепленные к ресурсу. Массив карт, каждая из которых имеет вид string:string (key:value). См. лучшие практики и стратегии в разделе Тегирование ресурсов AWS и редактор тегов для получения подробной информации, включая ограничения, которые применяются к тегам, и «Пределы и требования к именованию тегов»; Amazon IVS не накладывает никаких ограничений на теги, кроме тех, которые документированы там.

key -> (строка)

value -> (строка)

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

UTC-время начала композиции. Это отметка времени в формате ISO 8601; обратите внимание, что она возвращается как строка.

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

UTC-время окончания композиции. Это отметка времени в формате ISO 8601; обратите внимание, что она возвращается как строка.

END_OF_DOCUMENT_MARKER