Поделиться через

Live Events - List

  • Ссылка
Служба:
Media Services
Версия API:
2022-11-01

Перечисление трансляций
Списки все трансляции в учетной записи.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents?api-version=2022-11-01

Параметры URI

Имя В Обязательно Тип Описание
accountName
 path True

string

Имя учетной записи Служб мультимедиа.
resourceGroupName
 path True

string

Имя группы ресурсов в подписке Azure.
subscriptionId
 path True

string

Уникальный идентификатор подписки Microsoft Azure.
api-version
 query True

string

Версия API, которая будет использоваться с клиентским запросом.

Ответы

Имя Тип Описание
200 OK

LiveEventListResult

Все в порядке. Запрос выполнен успешно.
Other Status Codes

ErrorResponse

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

Примеры

List all LiveEvents

Образец запроса

GET https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveEvents?api-version=2022-11-01

Пример ответа

Код состояния:
200 
{
  "value": [
    {
      "name": "myLiveEvent1",
      "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1",
      "type": "Microsoft.Media/mediaservices/liveevents",
      "location": "West US",
      "tags": {
        "tag1": "value1",
        "tag2": "value2"
      },
      "properties": {
        "description": "test event 1",
        "resourceState": "Stopped",
        "provisioningState": "Succeeded",
        "created": "2018-03-03T02:25:08.5564064Z",
        "lastModified": "2018-03-03T02:25:08.5564064Z",
        "useStaticHostname": false,
        "streamOptions": [],
        "input": {
          "keyFrameIntervalDuration": "PT6S",
          "streamingProtocol": "RTMP",
          "accessToken": "<accessToken>",
          "endpoints": [
            {
              "protocol": "RTMP",
              "url": "rtmp://clouddeployment.media-test.net:1935/live/de153bb0814542d9b7e2339ce9430dc4"
            },
            {
              "protocol": "RTMP",
              "url": "rtmp://clouddeployment.media-test.net:1936/live/de153bb0814542d9b7e2339ce9430dc4"
            },
            {
              "protocol": "RTMP",
              "url": "rtmps://clouddeployment.media-test.net:2935/live/de153bb0814542d9b7e2339ce9430dc4"
            },
            {
              "protocol": "RTMP",
              "url": "rtmps://clouddeployment.media-test.net:2936/live/de153bb0814542d9b7e2339ce9430dc4"
            }
          ],
          "timedMetadataEndpoints": [
            {
              "url": "https://clouddeployment.media-test.net/de153bb0814542d9b7e2339ce9430dc4/ingest.isml/eventdata"
            }
          ]
        },
        "preview": {
          "previewLocator": "a220e223-faf8-4e03-b9a9-2c2432f48025",
          "streamingPolicyName": null,
          "accessControl": {
            "ip": {
              "allow": [
                {
                  "name": "AllowAll",
                  "address": "0.0.0.0",
                  "subnetPrefixLength": 0
                }
              ]
            }
          },
          "endpoints": [
            {
              "protocol": "FragmentedMP4",
              "url": "https://myliveevent1-slitestmedia10.preview-usso.channel.mediaservices.windows.net/a220e223-faf8-4e03-b9a9-2c2432f48025/preview.ism/manifest"
            }
          ]
        },
        "encoding": {
          "encodingType": "None",
          "presetName": null
        },
        "crossSiteAccessPolicies": {
          "clientAccessPolicy": null,
          "crossDomainPolicy": null
        }
      }
    }
  ]
}

Определения

Имя Описание
createdByType

Тип удостоверения, создавшего ресурс.
CrossSiteAccessPolicies

Политика клиентского доступа.
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Сообщение об ошибке
IPAccessControl

Управление доступом по IP-адресу.
IPRange

Диапазон IP-адресов в схеме CIDR.
LiveEvent

Трансляция.
LiveEventEncoding

Указывает тип трансляции и необязательные параметры кодирования для кодирования динамических событий.
LiveEventEncodingType

Тип трансляции. Если для encodingType задано значение PassthroughBasic или PassthroughStandard, служба просто проходит через входящие уровни видео и аудио в выходные данные. Если для encodingType задано значение Standard или Premium1080p, динамический кодировщик перекодирует входящий поток на несколько скоростей или слоев. Подробнее см. в разделе https://go.microsoft.com/fwlink/?linkid=2095101. Это свойство нельзя изменить после создания трансляции.
LiveEventEndpoint

Конечная точка трансляции.
LiveEventInput

Входные данные трансляции.
LiveEventInputAccessControl

Управление доступом по IP-адресу для ввода трансляции.
LiveEventInputProtocol

Входной протокол для трансляции. Он указывается во время создания и не может быть обновлен.
LiveEventInputTrackSelection

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

LiveEventListResult
LiveEventOutputTranscriptionTrack

Описывает дорожку транскрибирования в выходных данных трансляции, созданной с помощью транскрибирования речи в текст. Это свойство зарезервировано для использования в будущем. Любое значение, заданное для этого свойства, будет игнорироваться.
LiveEventPreview

Параметры предварительного просмотра трансляций.
LiveEventPreviewAccessControl

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

Состояние ресурса трансляции. Подробнее см. в разделе https://go.microsoft.com/fwlink/?linkid=2139012.
LiveEventTimedMetadataEndpoint

Конечная точка вставки метаданных трансляции.
LiveEventTranscription

Описывает дорожки транскрибирования в выходных данных трансляции, созданные с помощью транскрибирования речи в текст. Это свойство зарезервировано для использования в будущем. Любое значение, заданное для этого свойства, будет игнорироваться.
StreamOptionsFlag

Параметры, используемые для события LiveEvent. Это значение указывается во время создания и не может быть обновлено. Допустимые значения для входных значений массива: Default и LowLatency.
StretchMode

Указывает, как будет изменен размер входного видео в соответствии с требуемыми разрешениями вывода. Значение по умолчанию — Нет.
systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

CrossSiteAccessPolicies

Политика клиентского доступа.

Имя Тип Описание
clientAccessPolicy

string

Содержимое clientaccesspolicy.xml, используемое Silverlight.
crossDomainPolicy

string

Содержимое crossdomain.xml, используемое Silverlight.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

IPAccessControl

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

Имя Тип Описание
allow

IPRange[]

Список разрешенных IP-адресов.

IPRange

Диапазон IP-адресов в схеме CIDR.

Имя Тип Описание
address

string

IP-адрес.
name

string

Понятное имя диапазона IP-адресов.
subnetPrefixLength

integer

Длина префикса маски подсети (см. нотацию CIDR).

LiveEvent

Трансляция.

Имя Тип Описание
id

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

Географическое расположение, в котором находится ресурс
name

string

Имя ресурса.
properties.created

string

Время создания трансляции
properties.crossSiteAccessPolicies

CrossSiteAccessPolicies

Политики доступа к трансляциям между сайтами.
properties.description

string

Описание трансляции.
properties.encoding

LiveEventEncoding

Параметры кодирования для трансляции. Он определяет, используется ли динамический кодировщик для трансляции, и параметры динамического кодировщика, если он используется.
properties.hostnamePrefix

string

Если параметр useStaticHostname имеет значение true, в параметре hostnamePrefix указывается первая часть имени узла, назначенная конечным точкам предварительного просмотра и приема трансляций. Последняя часть имени узла представляет собой сочетание этого префикса, имя учетной записи службы мультимедиа и короткий код для центра обработки данных Службы мультимедиа Azure.
properties.input

LiveEventInput

Параметры ввода трансляции. Он определяет, как трансляция получает входные данные от кодировщика вкладов.
properties.lastModified

string

Время последнего изменения трансляции.
properties.preview

LiveEventPreview

Параметры предварительного просмотра трансляций. Предварительная версия позволяет производителям трансляций просматривать содержимое потоковой трансляции без создания выходных данных.
properties.provisioningState

string

Состояние подготовки трансляции.
properties.resourceState

LiveEventResourceState

Состояние ресурса трансляции. Подробнее см. в разделе https://go.microsoft.com/fwlink/?linkid=2139012.
properties.streamOptions

StreamOptionsFlag[]

Параметры, используемые для события LiveEvent. Это значение указывается во время создания и не может быть обновлено. Допустимые значения для входных значений массива: Default и LowLatency.
properties.transcriptions

LiveEventTranscription[]

Параметры динамического транскрибирования для трансляции. Дополнительные сведения о функции динамического транскрибирования см https://go.microsoft.com/fwlink/?linkid=2133742 . в этой статье.
properties.useStaticHostname

boolean

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

systemData

Системные метаданные, относящиеся к этому ресурсу.
tags

object

Теги ресурсов.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

LiveEventEncoding

Указывает тип трансляции и необязательные параметры кодирования для кодирования динамических событий.

Имя Тип Описание
encodingType

LiveEventEncodingType

Тип трансляции. Если для encodingType задано значение PassthroughBasic или PassthroughStandard, служба просто проходит через входящие уровни видео и аудио в выходные данные. Если для encodingType задано значение Standard или Premium1080p, динамический кодировщик перекодирует входящий поток на несколько скоростей или слоев. Подробнее см. в разделе https://go.microsoft.com/fwlink/?linkid=2095101. Это свойство нельзя изменить после создания трансляции.
keyFrameInterval

string

Используйте значение времени ISO 8601 от 0,5 до 20 секунд, чтобы указать длину выходного фрагмента для видео- и аудиодорожек трансляции кодирования. Например, используйте PT2S, чтобы указать 2 секунды. Для видеодорожки он также определяет интервал ключевого кадра или длину GoP (группы изображений). Если это значение не задано для трансляции кодирования, длительность фрагмента по умолчанию составляет 2 секунды. Значение не может быть задано для трансляций сквозной передачи.
presetName

string

Необязательное имя предустановки кодирования, используемое, если encodingType не равно None. Это значение указывается во время создания и не может быть обновлено. Если для encodingType задано значение Standard, то по умолчанию используется имя предустановки Default720p. В противном случае, если для encodingType задано значение Premium1080p, предустановка по умолчанию — Default1080p.
stretchMode

StretchMode

Указывает, как будет изменен размер входного видео в соответствии с требуемыми разрешениями вывода. Значение по умолчанию — Нет.

LiveEventEncodingType

Тип трансляции. Если для encodingType задано значение PassthroughBasic или PassthroughStandard, служба просто проходит через входящие уровни видео и аудио в выходные данные. Если для encodingType задано значение Standard или Premium1080p, динамический кодировщик перекодирует входящий поток на несколько скоростей или слоев. Подробнее см. в разделе https://go.microsoft.com/fwlink/?linkid=2095101. Это свойство нельзя изменить после создания трансляции.

Имя Тип Описание
None

string

Это то же самое, что и PassthroughStandard, см. описание ниже. Это значение перечисления является устаревшим.
PassthroughBasic

string

Полученный поток проходит через трансляцию из кодировщика вкладов без дальнейшей обработки. В режиме PassthroughBasic прием ограничен 5 Мбит/с и допускается только 1 одновременный динамический вывод. Динамическое транскрибирование недоступно.
PassthroughStandard

string

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

string

Динамический кодировщик вкладов отправляет поток с одной скоростью в динамическое событие, а Службы мультимедиа создают несколько потоков скорости. Разрешение выходных данных не может превышать 1080p.
Standard

string

Динамический кодировщик вкладов отправляет поток с одной скоростью в динамическое событие, а Службы мультимедиа создают несколько потоков скорости. Разрешение выходных данных не может превышать 720p.

LiveEventEndpoint

Конечная точка трансляции.

Имя Тип Описание
protocol

string

Протокол конечной точки.
url

string

URL-адрес конечной точки.

LiveEventInput

Входные данные трансляции.

Имя Тип Описание
accessControl

LiveEventInputAccessControl

Управление доступом для ввода трансляции.
accessToken

string

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

LiveEventEndpoint[]

Входные конечные точки для трансляции.
keyFrameIntervalDuration

string

Iso 8601: длительность интервала ключевого кадра входных данных. Это значение задает свойство EXT-X-TARGETDURATION в выходных данных HLS. Например, используйте PT2S, чтобы указать 2 секунды. Оставьте значение пустым для кодирования трансляций.
streamingProtocol

LiveEventInputProtocol

Входной протокол для трансляции. Он указывается во время создания и не может быть обновлен.
timedMetadataEndpoints

LiveEventTimedMetadataEndpoint[]

Конечные точки метаданных для трансляции.

LiveEventInputAccessControl

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

Имя Тип Описание
ip

IPAccessControl

Свойства управления доступом по IP-адресу.

LiveEventInputProtocol

Входной протокол для трансляции. Он указывается во время создания и не может быть обновлен.

Имя Тип Описание
FragmentedMP4

string

Входные данные Smooth Streaming будут отправлены кодировщиком вкладов в трансляцию.
RTMP

string

Входные данные RTMP будут отправляться кодировщиком вкладов в трансляцию.

LiveEventInputTrackSelection

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

Имя Тип Описание
operation

string

Операция сравнения. Это свойство зарезервировано для использования в будущем. Любое значение, заданное для этого свойства, будет игнорироваться.
property

string

Имя свойства для выбора. Это свойство зарезервировано для использования в будущем. Любое значение, заданное для этого свойства, будет игнорироваться.
value

string

Значение свойства для выбора. Это свойство зарезервировано для использования в будущем. Любое значение, заданное для этого свойства, будет игнорироваться.

LiveEventListResult

LiveEventListResult

Имя Тип Описание
@odata.count

integer

Число результатов.
@odata.nextLink

string

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

LiveEvent[]

Результат операции перечисления динамических событий.

LiveEventOutputTranscriptionTrack

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

Имя Тип Описание
trackName

string

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

LiveEventPreview

Параметры предварительного просмотра трансляций.

Имя Тип Описание
accessControl

LiveEventPreviewAccessControl

Управление доступом для предварительного просмотра трансляции.
alternativeMediaId

string

Альтернативный идентификатор мультимедиа, связанный с указателем потоковой передачи, созданным для предварительной версии. Это значение указывается во время создания и не может быть обновлено. Идентификатор можно использовать в CustomLicenseAcquisitionUrlTemplate или CustomKeyAcquisitionUrlTemplate объекта StreamingPolicy, указанного в поле StreamingPolicy.
endpoints

LiveEventEndpoint[]

Конечные точки для предварительной версии. Не делитесь URL-адресом предварительного просмотра с аудиторией трансляции.
previewLocator

string

Идентификатор указателя предварительного просмотра в формате Guid. Если указать этот параметр во время создания, вызывающий объект может узнать URL-адрес указателя предварительного просмотра перед созданием события. Если этот параметр опущен, служба создаст случайный идентификатор. Это значение не может быть обновлено после создания трансляции.
streamingPolicyName

string

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

LiveEventPreviewAccessControl

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

Имя Тип Описание
ip

IPAccessControl

Свойства управления доступом по IP-адресу.

LiveEventResourceState

Состояние ресурса трансляции. Подробнее см. в разделе https://go.microsoft.com/fwlink/?linkid=2139012.

Имя Тип Описание
Allocating

string

Действие выделения было вызвано для трансляции, и ресурсы подготавливаются для этого трансляции. После успешного завершения выделения трансляция перейдет в состояние StandBy.
Deleting

string

Трансляция удаляется. В этом переходном состоянии оплата не начисляется. В этом состоянии обновление и потоковая передача запрещены.
Running

string

Ресурсы для трансляции успешно выделены, URL-адреса приема и предварительного просмотра созданы, все готово к получению прямых трансляций. На этом этапе начисление оплаты активно. Чтобы остановить начисление платы, нужно явно вызвать функцию Stop (Остановить) для ресурса трансляции.
StandBy

string

Ресурсы трансляции подготовлены и готовы к запуску. В этом состоянии начисляется плата. Большинство свойств еще можно изменить, но в этом состоянии прием и потоковая передача запрещены.
Starting

string

Запускается трансляция и выделяются ресурсы. В этом состоянии начисление оплаты не происходит. В этом состоянии обновление и потоковая передача запрещены. Если возникает ошибка, трансляция возвращается в состояние "Остановлена".
Stopped

string

Это начальное состояние трансляции после ее создания, если не было указано значение true для параметра autostart. В этом состоянии плата не начисляется. В этом состоянии свойства трансляции можно обновить, но потоковая передача запрещена.
Stopping

string

Трансляция останавливается и выделенные ресурсы освобождаются. В этом переходном состоянии оплата не начисляется. В этом состоянии обновление и потоковая передача запрещены.

LiveEventTimedMetadataEndpoint

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

Имя Тип Описание
url

string

URL-адрес конечной точки метаданных.

LiveEventTranscription

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

Имя Тип Описание
inputTrackSelection

LiveEventInputTrackSelection[]

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

string

Указывает язык (языковой стандарт), используемый для транскрибирования речи в текст. Он должен соответствовать языку речи в звуковой дорожке. Значение должно быть в формате BCP-47 (например, en-US). Дополнительные сведения о функции транскрибирования в реальном времени и списке поддерживаемых языков см https://go.microsoft.com/fwlink/?linkid=2133742 . в этой статье.
outputTranscriptionTrack

LiveEventOutputTranscriptionTrack

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

StreamOptionsFlag

Параметры, используемые для события LiveEvent. Это значение указывается во время создания и не может быть обновлено. Допустимые значения для входных значений массива: Default и LowLatency.

Имя Тип Описание
Default

string

Потоковая трансляция без специальной оптимизации задержки.
LowLatency

string

Трансляция обеспечивает более низкую сквозную задержку, уменьшая внутренние буферы.
LowLatencyV2

string

Трансляция оптимизирована для сквозной задержки. Этот параметр доступен только для кодирования динамических событий с помощью входных данных RTMP. Выходные данные можно передавать в потоковую передачу в форматах HLS или DASH. Длина перемотки архива или DVR выходных данных ограничена 6 часами. Используйте параметр потока LowLatency для всех остальных сценариев.

StretchMode

Указывает, как будет изменен размер входного видео в соответствии с требуемыми разрешениями вывода. Значение по умолчанию — Нет.

Имя Тип Описание
AutoFit

string

Заполните выходные данные (с помощью поля "Буквы" или "Столбик"), чтобы учитывать разрешение выходных данных, при этом убедитесь, что активная область видео в выходных данных имеет то же соотношение сторон, что и входные данные. Например, если входные данные равны 1920 x 1080, а предустановка кодировки запрашивает 1280x1280, то выходные данные будут иметь размер 1280x1280, который содержит внутренний прямоугольник 1280x720 с пропорциями 16:9, а столбец в ширину 280 пикселей слева и справа.
AutoSize

string

Переопределите разрешение выходных данных и измените его в соответствии с пропорциями отображения входных данных без заполнения. Например, если разрешение исходного видео составляет 1920×1080, а в предустановках кодирования задано 1280×1280, предустановленное значение будет изменено, а разрешение выходного видео составит 1280×720, что соответствует пропорциям входного видео, равным 16:9.
None

string

Строго учитывает разрешение выходных данных, указанное в предустановке кодирования, без учета пропорций пикселей или пропорций отображения входного видео.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).
createdBy

string

Удостоверение, создающее ресурс.
createdByType

createdByType

Тип удостоверения, создавшего ресурс.
lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)
lastModifiedBy

string

Удостоверение, которое в последний раз изменял ресурс.
lastModifiedByType

createdByType

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