Compartir a través de

Live Events - Get

  • Referencia
Servicio:
Media Services
Versión de la API:
2022-11-01

Obtener evento en directo
Obtiene las propiedades de un evento en directo.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
accountName
 path True

string

Nombre de la cuenta de Media Services.
liveEventName
 path True

string

El nombre del evento en directo, la longitud máxima es 32.

Patrón de Regex: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
resourceGroupName
 path True

string

Nombre del grupo de recursos dentro de la suscripción de Azure.
subscriptionId
 path True

string

Identificador único de una suscripción de Microsoft Azure.
api-version
 query True

string

Versión de la API que se va a usar con la solicitud de cliente.

Respuestas

Nombre Tipo Description
200 OK

LiveEvent

Aceptar. La solicitud se ha realizado correctamente.
Other Status Codes

ErrorResponse

Respuesta de error de streaming que describe por qué se produjo un error en la operación.

Ejemplos

Get a LiveEvent by name

Solicitud de ejemplo

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

Respuesta de muestra

status code:
200 
{
  "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": {},
  "properties": {
    "description": "",
    "resourceState": "Stopped",
    "provisioningState": "Succeeded",
    "created": "2018-03-03T02:25:08.3474032Z",
    "lastModified": "2018-03-03T02:25:08.3474032Z",
    "useStaticHostname": false,
    "streamOptions": [
      "Default"
    ],
    "input": {
      "keyFrameIntervalDuration": "PT6S",
      "streamingProtocol": "FragmentedMP4",
      "accessToken": null,
      "endpoints": [
        {
          "protocol": "FragmentedMP4",
          "url": "http://clouddeployment.media-test.net/ingest.isml"
        }
      ],
      "timedMetadataEndpoints": []
    },
    "preview": {
      "previewLocator": "763f3ea4-d94f-441c-a634-c833f61a4e04",
      "streamingPolicyName": null,
      "accessControl": {
        "ip": {
          "allow": [
            {
              "name": "AllowAll",
              "address": "0.0.0.0",
              "subnetPrefixLength": 0
            }
          ]
        }
      },
      "endpoints": [
        {
          "protocol": "FragmentedMP4",
          "url": "https://testeventopito4idh2r-weibzmedia05.preview-ts051.channel.media-test.windows-int.net/763f3ea4-d94f-441c-a634-c833f61a4e04/preview.ism/manifest"
        }
      ]
    },
    "encoding": {
      "encodingType": "None",
      "presetName": null
    },
    "crossSiteAccessPolicies": {
      "clientAccessPolicy": "<access-policy><cross-domain-access><policy><allow-from http-methods=\"*\"><domain uri=\"http://*\"/></allow-from><grant-to><resource path=\"/\" include-subpaths=\"true\"/></grant-to></policy></cross-domain-access></access-policy>",
      "crossDomainPolicy": "<cross-domain-policy><allow-access-from domain=\"*\" secure=\"false\" /></cross-domain-policy>"
    }
  }
}

Definiciones

Nombre Description
createdByType

Tipo de identidad que creó el recurso.
CrossSiteAccessPolicies

Directiva de acceso de cliente.
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

Respuesta de error
IPAccessControl

Control de acceso IP.
IPRange

Intervalo de direcciones IP en el esquema CIDR.
LiveEvent

Evento en directo.
LiveEventEncoding

Especifica el tipo de evento en directo y la configuración de codificación opcional para codificar eventos en directo.
LiveEventEncodingType

Tipo de evento en directo. Cuando encodingType se establece en PassthroughBasic o PassthroughStandard, el servicio simplemente pasa a través de las capas de audio y vídeo entrantes a la salida. Cuando encodingType se establece en Standard o Premium1080p, un codificador en directo transcodifica la secuencia entrante en varias velocidades de bits o capas. Consulte https://go.microsoft.com/fwlink/?linkid=2095101 para obtener más información. Esta propiedad no se puede modificar después de crear el evento en directo.
LiveEventEndpoint

Punto de conexión del evento en directo.
LiveEventInput

Entrada del evento en directo.
LiveEventInputAccessControl

Control de acceso IP para la entrada de eventos en directo.
LiveEventInputProtocol

Protocolo de entrada para el evento en directo. Esto se especifica en el momento de la creación y no se puede actualizar.
LiveEventInputTrackSelection

Condición de selección de seguimiento. Esta propiedad está reservada para uso futuro, se omitirá cualquier valor establecido en esta propiedad.
LiveEventOutputTranscriptionTrack

Describe una pista de transcripción en la salida de un evento en directo, generado mediante la transcripción de voz a texto. Esta propiedad está reservada para uso futuro, se omitirá cualquier valor establecido en esta propiedad.
LiveEventPreview

Configuración de la versión preliminar del evento en directo.
LiveEventPreviewAccessControl

Control de acceso IP para el punto de conexión de vista previa del evento en directo.
LiveEventResourceState

Estado de recurso del evento en directo. Consulte https://go.microsoft.com/fwlink/?linkid=2139012 para obtener más información.
LiveEventTimedMetadataEndpoint

Punto de conexión de inserción de metadatos de eventos en directo.
LiveEventTranscription

Describe las pistas de transcripción en la salida de un evento en directo, generados mediante la transcripción de voz a texto. Esta propiedad está reservada para uso futuro, se omitirá cualquier valor establecido en esta propiedad.
StreamOptionsFlag

Las opciones que se van a usar para LiveEvent. Este valor se especifica en el momento de la creación y no se puede actualizar. Los valores válidos para los valores de entrada de matriz son "Default" y "LowLatency".
StretchMode

Especifica cómo se cambiará el tamaño del vídeo de entrada para ajustarse a las resoluciones de salida deseadas. El valor predeterminado es None
systemData

Metadatos relacionados con la creación y la última modificación del recurso.

createdByType

Tipo de identidad que creó el recurso.

Nombre Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

CrossSiteAccessPolicies

Directiva de acceso de cliente.

Nombre Tipo Description
clientAccessPolicy

string

Contenido de clientaccesspolicy.xml usado por Silverlight.
crossDomainPolicy

string

Contenido de crossdomain.xml usado por Silverlight.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Los detalles del error.
message

string

El mensaje de error.
target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

IPAccessControl

Control de acceso IP.

Nombre Tipo Description
allow

IPRange[]

Lista de direcciones IP permitidas.

IPRange

Intervalo de direcciones IP en el esquema CIDR.

Nombre Tipo Description
address

string

Dirección IP.
name

string

Nombre descriptivo del intervalo de direcciones IP.
subnetPrefixLength

integer

Longitud del prefijo de máscara de subred (consulte notación CIDR).

LiveEvent

Evento en directo.

Nombre Tipo Description
id

string

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

Ubicación geográfica donde reside el recurso
name

string

Nombre del recurso.
properties.created

string

Hora de creación del evento en directo
properties.crossSiteAccessPolicies

CrossSiteAccessPolicies

Directivas de acceso entre sitios de eventos en directo.
properties.description

string

Descripción del evento en directo.
properties.encoding

LiveEventEncoding

Configuración de codificación para el evento en directo. Configura si se usa un codificador en directo para el evento en directo y la configuración del codificador en directo si se usa.
properties.hostnamePrefix

string

Cuando useStaticHostname se establece en true, el hostnamePrefix especifica la primera parte del nombre de host asignado a la versión preliminar del evento en directo y los puntos de conexión de ingesta. El nombre de host final sería una combinación de este prefijo, el nombre de la cuenta de servicios multimedia y un código corto para el centro de datos de Azure Media Services.
properties.input

LiveEventInput

Configuración de entrada de eventos en directo. Define cómo el evento en directo recibe la entrada de un codificador de contribución.
properties.lastModified

string

Hora de la última modificación del evento en directo.
properties.preview

LiveEventPreview

Configuración de la versión preliminar del evento en directo. La versión preliminar permite a los productores de eventos en directo obtener una vista previa del contenido de streaming en vivo sin crear ninguna salida en directo.
properties.provisioningState

string

Estado de aprovisionamiento del evento en directo.
properties.resourceState

LiveEventResourceState

Estado de recurso del evento en directo. Consulte https://go.microsoft.com/fwlink/?linkid=2139012 para obtener más información.
properties.streamOptions

StreamOptionsFlag[]

Las opciones que se van a usar para LiveEvent. Este valor se especifica en el momento de la creación y no se puede actualizar. Los valores válidos para los valores de entrada de matriz son "Default" y "LowLatency".
properties.transcriptions

LiveEventTranscription[]

Configuración de transcripción en directo para el evento en directo. Consulte https://go.microsoft.com/fwlink/?linkid=2133742 para obtener más información sobre la característica de transcripción en vivo.
properties.useStaticHostname

boolean

Especifica si un nombre de host estático se asignaría a la versión preliminar del evento en directo y a los puntos de conexión de ingesta. Este valor solo se puede actualizar si el evento en directo está en estado en espera.
systemData

systemData

Metadatos del sistema relacionados con este recurso.
tags

object

Etiquetas del recurso.
type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

LiveEventEncoding

Especifica el tipo de evento en directo y la configuración de codificación opcional para codificar eventos en directo.

Nombre Tipo Description
encodingType

LiveEventEncodingType

Tipo de evento en directo. Cuando encodingType se establece en PassthroughBasic o PassthroughStandard, el servicio simplemente pasa a través de las capas de audio y vídeo entrantes a la salida. Cuando encodingType se establece en Standard o Premium1080p, un codificador en directo transcodifica la secuencia entrante en varias velocidades de bits o capas. Consulte https://go.microsoft.com/fwlink/?linkid=2095101 para obtener más información. Esta propiedad no se puede modificar después de crear el evento en directo.
keyFrameInterval

string

Use un valor de hora ISO 8601 entre 0,5 y 20 segundos para especificar la longitud del fragmento de salida para las pistas de vídeo y audio de un evento en directo de codificación. Por ejemplo, use PT2S para indicar 2 segundos. Para la pista de vídeo, también define el intervalo de fotograma clave o la longitud de un GoP (grupo de imágenes). Si este valor no se establece para un evento en directo de codificación, la duración del fragmento tiene como valor predeterminado 2 segundos. El valor no se puede establecer para eventos en directo de paso a través.
presetName

string

El nombre preestablecido de codificación opcional, que se usa cuando encodingType no es None. Este valor se especifica en el momento de la creación y no se puede actualizar. Si el valor de encodingType se establece en Standard, el nombre preestablecido predeterminado es "Default720p". De lo contrario, si el valor de encodingType está establecido en Premium1080p, el valor preestablecido predeterminado es "Default1080p".
stretchMode

StretchMode

Especifica cómo se cambiará el tamaño del vídeo de entrada para ajustarse a las resoluciones de salida deseadas. El valor predeterminado es None

LiveEventEncodingType

Tipo de evento en directo. Cuando encodingType se establece en PassthroughBasic o PassthroughStandard, el servicio simplemente pasa a través de las capas de audio y vídeo entrantes a la salida. Cuando encodingType se establece en Standard o Premium1080p, un codificador en directo transcodifica la secuencia entrante en varias velocidades de bits o capas. Consulte https://go.microsoft.com/fwlink/?linkid=2095101 para obtener más información. Esta propiedad no se puede modificar después de crear el evento en directo.

Nombre Tipo Description
None

string

Esto es lo mismo que PassthroughStandard, consulte la descripción siguiente. Este valor de enumeración está en desuso.
PassthroughBasic

string

La secuencia ingerida pasa a través del evento en directo desde el codificador de contribución sin ningún procesamiento adicional. En el modo PassthroughBasic, la ingesta se limita a hasta 5 Mbps y solo se permite 1 salida en vivo simultánea. La transcripción en vivo no está disponible.
PassthroughStandard

string

La secuencia ingerida pasa a través del evento en directo desde el codificador de contribución sin ningún procesamiento adicional. La transcripción en vivo está disponible. Los límites de velocidad de bits de ingesta son mucho mayores y se permiten hasta 3 salidas en vivo simultáneas.
Premium1080p

string

Un codificador en directo de contribución envía una secuencia de velocidad de bits única al evento en directo y Media Services crea varias secuencias de velocidad de bits. La salida no puede superar los 1080p en resolución.
Standard

string

Un codificador en directo de contribución envía una secuencia de velocidad de bits única al evento en directo y Media Services crea varias secuencias de velocidad de bits. La salida no puede superar los 720p en resolución.

LiveEventEndpoint

Punto de conexión del evento en directo.

Nombre Tipo Description
protocol

string

Protocolo de punto de conexión.
url

string

Dirección URL del punto de conexión.

LiveEventInput

Entrada del evento en directo.

Nombre Tipo Description
accessControl

LiveEventInputAccessControl

Control de acceso para la entrada de eventos en directo.
accessToken

string

UuID en forma de cadena para identificar de forma única la secuencia. Esto se puede especificar en el momento de la creación, pero no se puede actualizar. Si se omite, el servicio generará un valor único.
endpoints

LiveEventEndpoint[]

Puntos de conexión de entrada para el evento en directo.
keyFrameIntervalDuration

string

Duración de tiempo ISO 8601 del intervalo de fotograma clave de la entrada. Este valor establece la propiedad EXT-X-TARGETDURATION en la salida HLS. Por ejemplo, use PT2S para indicar 2 segundos. Deje el valor vacío para codificar eventos en directo.
streamingProtocol

LiveEventInputProtocol

Protocolo de entrada para el evento en directo. Esto se especifica en el momento de la creación y no se puede actualizar.
timedMetadataEndpoints

LiveEventTimedMetadataEndpoint[]

Puntos de conexión de metadatos para el evento en directo.

LiveEventInputAccessControl

Control de acceso IP para la entrada de eventos en directo.

Nombre Tipo Description
ip

IPAccessControl

Propiedades del control de acceso IP.

LiveEventInputProtocol

Protocolo de entrada para el evento en directo. Esto se especifica en el momento de la creación y no se puede actualizar.

Nombre Tipo Description
FragmentedMP4

string

La entrada de Smooth Streaming se enviará mediante el codificador de contribución al evento en directo.
RTMP

string

La entrada RTMP la enviará el codificador de contribución al evento en directo.

LiveEventInputTrackSelection

Condición de selección de seguimiento. Esta propiedad está reservada para uso futuro, se omitirá cualquier valor establecido en esta propiedad.

Nombre Tipo Description
operation

string

Operación de comparación. Esta propiedad está reservada para uso futuro, se omitirá cualquier valor establecido en esta propiedad.
property

string

Nombre de propiedad que se va a seleccionar. Esta propiedad está reservada para uso futuro, se omitirá cualquier valor establecido en esta propiedad.
value

string

Valor de propiedad que se va a seleccionar. Esta propiedad está reservada para uso futuro, se omitirá cualquier valor establecido en esta propiedad.

LiveEventOutputTranscriptionTrack

Describe una pista de transcripción en la salida de un evento en directo, generado mediante la transcripción de voz a texto. Esta propiedad está reservada para uso futuro, se omitirá cualquier valor establecido en esta propiedad.

Nombre Tipo Description
trackName

string

Nombre de la pista de salida. Esta propiedad está reservada para uso futuro, se omitirá cualquier valor establecido en esta propiedad.

LiveEventPreview

Configuración de la versión preliminar del evento en directo.

Nombre Tipo Description
accessControl

LiveEventPreviewAccessControl

Control de acceso para la versión preliminar de eventos en directo.
alternativeMediaId

string

Identificador de medios alternativo asociado al localizador de streaming creado para la versión preliminar. Este valor se especifica en el momento de la creación y no se puede actualizar. El identificador se puede usar en customLicenseAcquisitionUrlTemplate o customKeyAcquisitionUrlTemplate del objeto StreamingPolicy especificado en el campo StreamingPolicyName.
endpoints

LiveEventEndpoint[]

Puntos de conexión para la versión preliminar. No comparta la dirección URL de vista previa con el público del evento en directo.
previewLocator

string

Identificador del localizador de vista previa en formato Guid. Especificar esto en tiempo de creación permite al autor de la llamada conocer la dirección URL del localizador de vista previa antes de crear el evento. Si se omite, el servicio generará un identificador aleatorio. Este valor no se puede actualizar una vez creado el evento en directo.
streamingPolicyName

string

Nombre de la directiva de streaming usada para la versión preliminar del evento en directo. Este valor se especifica en el momento de la creación y no se puede actualizar.

LiveEventPreviewAccessControl

Control de acceso IP para el punto de conexión de vista previa del evento en directo.

Nombre Tipo Description
ip

IPAccessControl

Propiedades del control de acceso IP.

LiveEventResourceState

Estado de recurso del evento en directo. Consulte https://go.microsoft.com/fwlink/?linkid=2139012 para obtener más información.

Nombre Tipo Description
Allocating

string

Se llamó a la acción de asignación en el evento en directo y se aprovisionan recursos para este evento en directo. Una vez completada correctamente la asignación, el evento en directo pasará al estado StandBy.
Deleting

string

El evento en directo se eliminará. No se produce facturación en este estado transitorio. Durante este estado no se permite realizar actualizaciones ni streaming.
Running

string

Se han asignado los recursos del evento en directo, se han generado las direcciones URL de ingesta y visualización previa y puede recibir transmisiones en vivo. En este momento, la facturación está activa. Debe llamar explícitamente a Stop en el recurso del evento en directo para evitar que continúe la facturación.
StandBy

string

Los recursos de eventos en directo se han aprovisionado y están listos para iniciarse. La facturación comienza en este estado. La mayoría de las propiedades todavía se pueden actualizar, pero no se permite la ingesta ni la transmisión durante este estado.
Starting

string

Se está iniciando el evento en directo y se asignan recursos. No se produce ninguna facturación en este estado. Durante este estado no se permite realizar actualizaciones ni streaming. Si se produce un error, el evento en directo vuelve al estado Detenido.
Stopped

string

Este es el estado inicial del evento en directo después de su creación (a menos que haya establecido el inicio automático en true). No se produce ninguna facturación en este estado. En este estado, las propiedades del evento en directo se pueden actualizar, pero no se permite el streaming.
Stopping

string

El evento en directo se detendrá y los recursos se desaprovisionarán. No se produce facturación en este estado transitorio. Durante este estado no se permite realizar actualizaciones ni streaming.

LiveEventTimedMetadataEndpoint

Punto de conexión de inserción de metadatos de eventos en directo.

Nombre Tipo Description
url

string

Dirección URL del punto de conexión de metadatos.

LiveEventTranscription

Describe las pistas de transcripción en la salida de un evento en directo, generados mediante la transcripción de voz a texto. Esta propiedad está reservada para uso futuro, se omitirá cualquier valor establecido en esta propiedad.

Nombre Tipo Description
inputTrackSelection

LiveEventInputTrackSelection[]

Proporciona un mecanismo para seleccionar la pista de audio en la fuente en directo de entrada, a la que se aplica la transcripción de voz a texto. Esta propiedad está reservada para uso futuro, se omitirá cualquier valor establecido en esta propiedad.
language

string

Especifica el idioma (configuración regional) que se va a usar para la transcripción de voz a texto: debe coincidir con el idioma hablado en la pista de audio. El valor debe estar en formato BCP-47 (por ejemplo, "en-US"). Consulte https://go.microsoft.com/fwlink/?linkid=2133742 para obtener más información sobre la característica de transcripción en vivo y la lista de idiomas admitidos.
outputTranscriptionTrack

LiveEventOutputTranscriptionTrack

Describe una pista de transcripción en la salida de un evento en directo, generado mediante la transcripción de voz a texto. Esta propiedad está reservada para uso futuro, se omitirá cualquier valor establecido en esta propiedad.

StreamOptionsFlag

Las opciones que se van a usar para LiveEvent. Este valor se especifica en el momento de la creación y no se puede actualizar. Los valores válidos para los valores de entrada de matriz son "Default" y "LowLatency".

Nombre Tipo Description
Default

string

Streaming en vivo sin optimizaciones de latencia especiales.
LowLatency

string

El evento en directo proporciona una latencia de extremo a extremo inferior al reducir sus búferes internos.
LowLatencyV2

string

El evento en directo está optimizado para la latencia de un extremo a otro. Esta opción solo está disponible para codificar eventos en directo con entrada RTMP. Las salidas se pueden transmitir mediante formatos HLS o DASH. El archivo de salida o la longitud de rebobinado de DVR está limitado a 6 horas. Use la opción de flujo "LowLatency" para todos los demás escenarios.

StretchMode

Especifica cómo se cambiará el tamaño del vídeo de entrada para ajustarse a las resoluciones de salida deseadas. El valor predeterminado es None

Nombre Tipo Description
AutoFit

string

Rellene la salida (con cuadro de letras o cuadro de pilar) para respetar la resolución de salida, al tiempo que garantiza que la región de vídeo activa de la salida tenga la misma relación de aspecto que la entrada. Por ejemplo, si la entrada es 1920x1080 y el valor preestablecido de codificación solicita 1280x1280, la salida estará en 1280x1280, que contiene un rectángulo interno de 1280x720 en relación de aspecto de 16:9 y las regiones de cuadro de pilar de 280 píxeles de ancho a la izquierda y derecha.
AutoSize

string

Invalide la resolución de salida y cámbiela para que coincida con la relación de aspecto de visualización de la entrada, sin relleno. Por ejemplo, si la entrada es 1920x1080 y el valor preestablecido de codificación requiere 1280x1280, se invalida el valor en el valor preestablecido y la salida será de 1280x720, que mantiene la relación de aspecto de entrada de 16:9.
None

string

Respeta estrictamente la resolución de salida especificada en el valor preestablecido de codificación sin tener en cuenta la relación de aspecto de píxeles ni la relación de aspecto de visualización del vídeo de entrada.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre Tipo Description
createdAt

string

Marca de tiempo de creación de recursos (UTC).
createdBy

string

Identidad que creó el recurso.
createdByType

createdByType

Tipo de identidad que creó el recurso.
lastModifiedAt

string

Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy

string

Identidad que modificó por última vez el recurso.
lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.