Spec-Zone.ru › AWS CLI v2

[ aws . kinesis-video-media ]

get-media

Описание

Используйте этот API для получения медиа-контента из потока Kinesis video. В запросе вы указываете имя потока или Amazon Resource Name (ARN) потока, а также начальный фрагмент. Kinesis Video Streams затем возвращает поток фрагментов в порядке номера фрагмента.

Примечание

Сначала необходимо вызвать API GetDataEndpoint, чтобы получить конечную точку. Затем отправьте запросы GetMedia на эту конечную точку, используя параметр –endpoint-url.

При размещении медиаданных (фрагментов) в потоке Kinesis Video Streams сохраняет каждый входящий фрагмент и связанные метаданные в так называемом «фрагменте». Дополнительную информацию см. в разделе PutMedia. API GetMedia возвращает поток этих фрагментов, начиная с фрагмента, который вы указали в запросе.

При использовании API GetMedia применяются следующие ограничения:

  • Клиент может вызвать GetMedia не более пяти раз в секунду на поток.
  • Kinesis Video Streams отправляет медиаданные со скоростью до 25 мегабайт в секунду (или 200 мегабит в секунду) во время сессии GetMedia.

Примечание

Если после вызова API Kinesis Video Streams возникает ошибка, помимо кода HTTP-статуса и тела ответа, она содержит следующую информацию:

  • Заголовок HTTP x-amz-ErrorType – содержит более конкретный тип ошибки в дополнение к тому, что предоставляет код HTTP-статуса.
  • Заголовок HTTP x-amz-RequestId – если вы хотите сообщить о проблеме в AWS, служба поддержки может лучше диагностировать проблему, если у нее есть идентификатор запроса.

И код HTTP-статуса, и заголовок ErrorType могут использоваться для принятия программистских решений о том, можно ли повторить попытку при ошибках и при каких условиях, а также для получения информации о действиях, которые программист может предпринять, чтобы успешно повторить попытку.

Дополнительную информацию см. в разделе Ошибки в конце этой темы, а также в разделе Общие ошибки.

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

Синтаксис

  get-media
[--stream-name <value>]
[--stream-arn <value>]
--start-selector <value>
<outfile>
[--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]

Параметры

--stream-name (строка)

Имя потока Kinesis video, из которого вы хотите получить медиаконтент. Если вы не указываете streamName, вы должны указать streamARN.

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

ARN потока, из которого вы хотите получить медиаконтент. Если вы не указываете streamARN, вы должны указать streamName.

--start-selector (структура)

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

StartSelectorType -> (строка)

Идентифицирует фрагмент в потоке Kinesis video, с которого вы хотите начать получение данных.

  • NOW - Начать с последнего фрагмента в потоке.
  • EARLIEST - Начать с самого раннего доступного фрагмента в потоке.
  • FRAGMENT_NUMBER - Начать с фрагмента после определенного фрагмента. Вы также должны указать параметр AfterFragmentNumber.
  • PRODUCER_TIMESTAMP или SERVER_TIMESTAMP - Начать с фрагмента, содержащего фрагмент с указанным временем производителя или сервера. Вы указываете время, добавив StartTimestamp.
  • CONTINUATION_TOKEN - Чтение с использованием указанного маркера продолжения.

Примечание

Если вы выберете NOW, EARLIEST или CONTINUATION_TOKEN в качестве startSelectorType, вы не предоставляете никакой дополнительной информации в startSelector.

AfterFragmentNumber -> (строка)

Указывает номер фрагмента, с которого API GetMedia должен начать возвращать фрагменты.

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

Значение метки времени. Это значение необходимо, если вы выберете PRODUCER_TIMESTAMP или SERVER_TIMESTAMP в качестве startSelectorType. Затем API GetMedia начинает с фрагмента, содержащего фрагмент с указанным временем.

ContinuationToken -> (строка)

Маркер продолжения, который Kinesis Video Streams вернул в предыдущем ответе GetMedia. Затем API GetMedia начинается с фрагмента, идентифицированного маркером продолжения.

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

StartSelectorType=string,AfterFragmentNumber=string,StartTimestamp=timestamp,ContinuationToken=string

Синтаксис JSON:

{
  "StartSelectorType": "FRAGMENT_NUMBER"|"SERVER_TIMESTAMP"|"PRODUCER_TIMESTAMP"|"NOW"|"EARLIEST"|"CONTINUATION_TOKEN",
  "AfterFragmentNumber": "string",
  "StartTimestamp": timestamp,
  "ContinuationToken": "string"
}

outfile (строка) Имя файла, в который будет сохранён контент

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

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

Включить отладку.

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

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

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

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

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

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

--output (строка)

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

  • json
  • text
  • таблица
  • yaml
  • yaml-stream

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

Вывод

ContentType -> (строка)

Тип содержимого запрошенного медиа.

Payload -> (потоковый блок)

Возвращаемый Kinesis Video Streams пакет представляет собой последовательность фрагментов из указанного потока. Информация о фрагментах см. в . Фрагменты, которые возвращает Kinesis Video Streams в вызове GetMedia, также включают следующие дополнительные теги Matroska (MKV):

  • AWS_KINESISVIDEO_CONTINUATION_TOKEN (строка UTF-8) - В случае завершения вызова GetMedia вы можете использовать этот маркер продолжения в следующем запросе, чтобы получить следующий фрагмент, где завершился последний запрос.
  • AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (строка UTF-8) - Приложения клиентов могут использовать это значение тега для определения того, насколько фрагмент, возвращенный в ответе, отстает от последнего фрагмента в потоке.
  • AWS_KINESISVIDEO_FRAGMENT_NUMBER - Номер фрагмента, возвращенного во фрагменте.
  • AWS_KINESISVIDEO_SERVER_TIMESTAMP - Метка времени сервера фрагмента.
  • AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Метка времени производителя фрагмента.

Следующие теги будут присутствовать, если возникнет ошибка:

  • AWS_KINESISVIDEO_ERROR_CODE - Строковое описание ошибки, которая привела к остановке GetMedia.
  • AWS_KINESISVIDEO_ERROR_ID: Код ошибки в виде целого числа.

Коды ошибок следующие:

  • 3002 - Ошибка записи в поток
  • 4000 - Запрашиваемый фрагмент не найден
  • 4500 - Отказ в доступе к ключу KMS потока
  • 4501 - Ключ KMS потока отключен
  • 4502 - Ошибка проверки ключа KMS потока
  • 4503 - Указанный в потоке ключ KMS недоступен
  • 4504 - Неправильное использование указанного в потоке ключа KMS
  • 4505 - Неправильное состояние указанного в потоке ключа KMS
  • 4506 - Невозможно найти указанный в потоке ключ KMS
  • 5000 - Внутренняя ошибка

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

Spec-Zone.ru

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