create-stage

Описание

Создаёт новую сцену (и необязательно токены участников).

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

Синтаксис

  create-stage
[--name <value>]
[--participant-token-configurations <value>]
[--tags <value>]
[--auto-participant-recording-configuration <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]

Параметры

--name (строка)

Необязательное имя, которое можно указать для создаваемой сцены.

--participant-token-configurations (список)

Массив объектов конфигурации токенов участников, которые нужно прикрепить к новой сцене.

(структура)

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

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

Длительность (в минутах), по истечении которой соответствующий токен участника истекает. По умолчанию: 720 (12 часов).

userId -> (строка)

Присвоенное клиентом имя для облегчения идентификации токена; это можно использовать для связи участника с пользователем в собственных системах клиента. Может содержать текст в кодировке UTF-8. Это поле доступно всем участникам сцены и не должно использоваться для идентификации личности, конфиденциальной или чувствительной информации.

attributes -> (отображение)

Атрибуты, предоставленные приложением, для кодирования в соответствующем токене участника и прикрепления к сцене. Ключи и значения отображения могут содержать текст в кодировке UTF-8. Максимальная длина этого поля составляет 1 КБ в общей сложности. Это поле доступно всем участникам сцены и не должно использоваться для идентификации личности, конфиденциальной или чувствительной информации.

key -> (строка)

value -> (строка)

capabilities -> (список)

Набор возможностей, которые пользователь может выполнить в сцене.

(строка)

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

duration=integer,userId=string,attributes={KeyName1=string,KeyName2=string},capabilities=string,string ...

Синтаксис JSON:

[
  {
    "duration": integer,
    "userId": "string",
    "attributes": {"string": "string"
      ...},
    "capabilities": ["PUBLISH"|"SUBSCRIBE", ...]
  }
  ...
]

--tags (отображение)

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

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--auto-participant-recording-configuration (структура)

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

storageConfigurationArn -> (строка)

ARN ресурса StorageConfiguration, который необходимо использовать для индивидуальной записи участника. По умолчанию: "" (пустая строка, конфигурация хранения не указана). Индивидуальная запись участника не может быть начата, если конфигурация хранения не указана при создании или обновлении сцены. Чтобы отключить индивидуальную запись участника, установите это значение на ""; другие поля в этом объекте будут сброшены до своих значений по умолчанию при отправке "".

mediaTypes -> (список)

Типы медиа, которые нужно записывать. По умолчанию: AUDIO_VIDEO.

(строка)

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

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

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

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

storage -> (список)

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

(строка)

recordingMode -> (строка)

Режим записи миниатюр. По умолчанию: DISABLED.

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

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

Значение по умолчанию равно 0, что отключает объединение.

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

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

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

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

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

storageConfigurationArn=string,mediaTypes=string,string,thumbnailConfiguration={targetIntervalSeconds=integer,storage=[string,string],recordingMode=string},recordingReconnectWindowSeconds=integer,hlsConfiguration={targetSegmentDurationSeconds=integer}

Синтаксис JSON:

{
  "storageConfigurationArn": "string",
  "mediaTypes": ["AUDIO_VIDEO"|"AUDIO_ONLY"|"NONE", ...],
  "thumbnailConfiguration": {
    "targetIntervalSeconds": integer,
    "storage": ["SEQUENTIAL"|"LATEST", ...],
    "recordingMode": "INTERVAL"|"DISABLED"
  },
  "recordingReconnectWindowSeconds": integer,
  "hlsConfiguration": {
    "targetSegmentDurationSeconds": integer
  }
}

--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
текст
таблица
yaml
yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

вкл
выкл
авто

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

Примеры

Примечание

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

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

Пример 1: Создание сцены

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

aws ivs-realtime create-stage \
    --name stage1 \
    --participant-token-configurations userId=alice

Вывод:

{
    "participantTokens": [
        {
            "participantId": "ABCDEfghij01234KLMN5678",
            "token": "a1b2c3d4567890ab",
            "userId": "alice"
        }
    ],
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "autoParticipantRecordingConfiguration": {
            "storageConfigurationArn": "",
            "mediaTypes": [
                "AUDIO_VIDEO"
            ],
            "thumbnailConfiguration": {
                "targetIntervalSeconds": 60,
                "storage": [
                    "SEQUENTIAL"
                ],
                "recordingMode": "DISABLED"
            },
            "recordingReconnectWindowSeconds": 0,
            "hlsConfiguration": {
                "targetSegmentDurationSeconds": 6
            }
        },
        "endpoints": {
            "events": "wss://global.events.live-video.net",
            "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
            "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
            "whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net"
        },
        "name": "stage1",
        "tags": {}
    }
}

Дополнительную информацию см. в разделе Включение нескольких хостов в трансляции Amazon IVS в Руководстве пользователя Amazon IVS Low-Latency Streaming.

Пример 2: Создание сцены и настройка индивидуальной записи участника

Следующий create-stage пример создаёт сцену и настраивает индивидуальную запись участника.

aws ivs-realtime create-stage \
    --name stage1 \
    --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \
        "hlsConfiguration": {"targetSegmentDurationSeconds": 5}}'

Вывод:

{
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "autoParticipantRecordingConfiguration": {
            "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh"
            "mediaTypes": [
                "AUDIO_VIDEO"
            ],
            "thumbnailConfiguration": {
                "targetIntervalSeconds": 60,
                "storage": [
                    "SEQUENTIAL"
                ],
                "recordingMode": "DISABLED"
            },
            "recordingReconnectWindowSeconds": 100,
            "hlsConfiguration": {
                "targetSegmentDurationSeconds": 5
            }
        },
        "endpoints": {
            "events": "wss://global.events.live-video.net",
            "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
            "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
            "whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net"
        },
        "name": "stage1",
        "tags": {}
    }
}

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

Следующий create-stage пример создаёт сцену и настраивает индивидуальную запись участника с включённой записью миниатюр.

aws ivs-realtime create-stage \
    --name stage1 \
    --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", \
        "thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}}'

Вывод:

{
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "autoParticipantRecordingConfiguration": {
            "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
            "mediaTypes": [
                "AUDIO_VIDEO"
            ],
            "thumbnailConfiguration": {
                "targetIntervalSeconds": 60,
                "storage": [
                    "SEQUENTIAL"
                ],
                "recordingMode": "INTERVAL"
            },
            "recordingReconnectWindowSeconds": 0,
            "hlsConfiguration": {
                "targetSegmentDurationSeconds": 6
            }
        },
        "endpoints": {
            "events": "wss://global.events.live-video.net",
            "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
            "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
            "whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net"
        },
        "name": "stage1",
        "tags": {}
    }
}

Вывод

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

Созданная сцена.

arn -> (строка)

ARN сцены.

name -> (строка)

Имя сцены.

activeSessionId -> (строка)

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

tags -> (карта)

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

key -> (строка)

value -> (строка)

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

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

storageConfigurationArn -> (строка)

ARN ресурса StorageConfiguration, используемого для записи отдельных участников. По умолчанию: "" (пустая строка, конфигурация хранения не указана). Запись отдельных участников не может быть запущена, если конфигурация хранения не указана при создании или обновлении сцены. Чтобы отключить запись отдельных участников, установите это значение в "" ; другие поля в этом объекте будут сброшены до значений по умолчанию при отправке "" .

mediaTypes -> (список)

Типы медиа, которые должны быть записаны. По умолчанию: AUDIO_VIDEO .

(строка)

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

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

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

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

storage -> (список)

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

(строка)

recordingMode -> (строка)

Режим записи миниатюр. По умолчанию: DISABLED.

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

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

Значение по умолчанию равно 0, что отключает слияние.

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

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

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

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

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

Сводная информация о различных конечных точках для сцены.

events -> (строка)

Конечная точка событий.

whip -> (строка)

Конечная точка, используемая для потоковой передачи IVS в реальном времени с использованием протокола WHIP.

rtmp -> (строка)

Конечная точка, используемая для потоковой передачи IVS в реальном времени с использованием протокола RTMP.

rtmps -> (строка)

Конечная точка, используемая для потоковой передачи IVS в реальном времени с использованием протокола RTMPS.

participantTokens -> (список)

Токены участников, прикрепленные к сцене. Они соответствуют participants в запросе.

(структура)

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

Важно: Обращайтесь с токенами как с неструктурированными данными; то есть не создавайте функциональность на основе содержимого токенов. Формат токенов может измениться в будущем.

participantId -> (строка)

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

token -> (строка)

Выпущенный клиентский токен, зашифрованный.

userId -> (строка)

Присвоенное клиентом имя для облегчения идентификации токена; его можно использовать для связи участника с пользователем в собственных системах клиента. Это может быть любой текст в кодировке UTF-8. Это поле доступно всем участникам сцены и не должно использоваться для персональной идентификации, конфиденциальной или чувствительной информации.

attributes -> (карта)

Примененные приложением атрибуты для кодирования в токен и прикрепления к сцене. Это поле доступно всем участникам сцены и не должно использоваться для персональной идентификации, конфиденциальной или чувствительной информации.

key -> (строка)

value -> (строка)

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

Продолжительность (в минутах), после которой токен участника истекает. По умолчанию: 720 (12 часов).

capabilities -> (список)

Набор возможностей, которые пользователь имеет право выполнять в сцене.

(строка)

expirationTime -> (временная метка)

Временная метка ISO 8601 (возвращается как строка) для истечения срока действия этого токена.