Live Events - Get

  • Referência
Service:
Media Services
API Version:
2022-11-01

Obter Evento em Direto
Obtém as propriedades de um evento em direto.

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

Parâmetros do URI

Name Em Necessário Tipo Description
accountName
 path True

string

O nome da conta dos Serviços de Multimédia.
liveEventName
 path True

string

O nome do evento em direto, o comprimento máximo é 32.

Regex pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
resourceGroupName
 path True

string

O nome do grupo de recursos na subscrição do Azure.
subscriptionId
 path True

string

O identificador exclusivo de uma subscrição do Microsoft Azure.
api-version
 query True

string

A versão da API a ser utilizada com o pedido de cliente.

Respostas

Name Tipo Description
200 OK

LiveEvent

OK. O pedido foi efetuada com êxito.
Other Status Codes

ErrorResponse

A resposta do erro de transmissão em fluxo que descreve o motivo pela qual a operação falhou.

Exemplos

Get a LiveEvent by name

Sample Request

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

Sample Response

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>"
    }
  }
}

Definições

Name Description
createdByType

O tipo de identidade que criou o recurso.
CrossSiteAccessPolicies

A política de acesso do cliente.
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta a erros
IPAccessControl

O controlo de acesso ao IP.
IPRange

O intervalo de endereços IP no esquema CIDR.
LiveEvent

O evento em direto.
LiveEventEncoding

Especifica o tipo de evento em direto e as definições de codificação opcionais para codificar eventos em direto.
LiveEventEncodingType

Tipo de evento em direto. Quando encodingType está definido como PassthroughBasic ou PassthroughStandard, o serviço simplesmente passa pelas camadas de áudio e vídeo recebidos para a saída. Quando encodingType está definido como Standard ou Premium1080p, um codificador em direto transcodifica o fluxo de entrada em múltiplas velocidades de transmissão ou camadas. Consulte https://go.microsoft.com/fwlink/?linkid=2095101 para obter mais informações. Esta propriedade não pode ser modificada após a criação do evento em direto.
LiveEventEndpoint

O ponto final do evento em direto.
LiveEventInput

A entrada do evento em direto.
LiveEventInputAccessControl

O controlo de acesso ao IP para a entrada de eventos em direto.
LiveEventInputProtocol

O protocolo de entrada do evento em direto. Isto é especificado no momento da criação e não pode ser atualizado.
LiveEventInputTrackSelection

Uma condição de seleção de controlo. Esta propriedade está reservada para utilização futura, qualquer valor definido nesta propriedade será ignorado.
LiveEventOutputTranscriptionTrack

Descreve uma faixa de transcrição na saída de um evento em direto, gerada com a transcrição de voz em texto. Esta propriedade está reservada para utilização futura, qualquer valor definido nesta propriedade será ignorado.
LiveEventPreview

Definições de pré-visualização de eventos em direto.
LiveEventPreviewAccessControl

O controlo de acesso ao IP para o ponto final de pré-visualização de eventos em direto.
LiveEventResourceState

O estado do recurso do evento em direto. Consulte https://go.microsoft.com/fwlink/?linkid=2139012 para obter mais informações.
LiveEventTimedMetadataEndpoint

O ponto final de inserção de metadados de eventos em direto.
LiveEventTranscription

Descreve as faixas de transcrição na saída de um evento em direto, geradas com a transcrição de voz em texto. Esta propriedade está reservada para utilização futura, qualquer valor definido nesta propriedade será ignorado.
StreamOptionsFlag

As opções a utilizar para o LiveEvent. Este valor é especificado no momento da criação e não pode ser atualizado. Os valores válidos para os valores de entrada de matriz são "Predefinição" e "LowLatency".
StretchMode

Especifica como o vídeo de entrada será redimensionado para se ajustar às resoluções de saída pretendidas. A predefinição é Nenhuma
systemData

Metadados relativos à criação e última modificação do recurso.

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

CrossSiteAccessPolicies

A política de acesso do cliente.

Name Tipo Description
clientAccessPolicy

string

O conteúdo do clientaccesspolicy.xml utilizado pelo Silverlight.
crossDomainPolicy

string

O conteúdo do crossdomain.xml utilizado pelo Silverlight.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Resposta a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

IPAccessControl

O controlo de acesso ao IP.

Name Tipo Description
allow

IPRange[]

A lista de permissões de IP.

IPRange

O intervalo de endereços IP no esquema CIDR.

Name Tipo Description
address

string

O endereço IP.
name

string

O nome amigável do intervalo de endereços IP.
subnetPrefixLength

integer

O comprimento do prefixo da máscara de sub-rede (veja Notação CIDR).

LiveEvent

O evento em direto.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

A localização geográfica onde reside o recurso
name

string

O nome do recurso
properties.created

string

A hora de criação do evento em direto
properties.crossSiteAccessPolicies

CrossSiteAccessPolicies

Políticas de acesso a eventos em direto entre sites.
properties.description

string

Uma descrição para o evento em direto.
properties.encoding

LiveEventEncoding

Definições de codificação para o evento em direto. Configura se um codificador em direto é utilizado para o evento em direto e as definições do codificador em direto, se for utilizado.
properties.hostnamePrefix

string

Quando useStaticHostname está definido como verdadeiro, hostnamePrefix especifica a primeira parte do nome de anfitrião atribuído à pré-visualização do evento em direto e ingerir pontos finais. O nome de anfitrião final seria uma combinação deste prefixo, o nome da conta do serviço de multimédia e um código abreviado para o datacenter dos Serviços de Multimédia do Azure.
properties.input

LiveEventInput

Definições de entrada de eventos em direto. Define como o evento em direto recebe entradas de um codificador de contribuição.
properties.lastModified

string

A hora da última modificação do evento em direto.
properties.preview

LiveEventPreview

Definições de pré-visualização de eventos em direto. A pré-visualização permite que os produtores de eventos em direto pré-visualizem o conteúdo de transmissão em fluxo em direto sem criar qualquer saída em direto.
properties.provisioningState

string

O estado de aprovisionamento do evento em direto.
properties.resourceState

LiveEventResourceState

O estado do recurso do evento em direto. Consulte https://go.microsoft.com/fwlink/?linkid=2139012 para obter mais informações.
properties.streamOptions

StreamOptionsFlag[]

As opções a utilizar para o LiveEvent. Este valor é especificado no momento da criação e não pode ser atualizado. Os valores válidos para os valores de entrada de matriz são "Predefinição" e "LowLatency".
properties.transcriptions

LiveEventTranscription[]

Definições de transcrição em direto para o evento em direto. Veja https://go.microsoft.com/fwlink/?linkid=2133742 para obter mais informações sobre a funcionalidade de transcrição em direto.
properties.useStaticHostname

boolean

Especifica se um nome de anfitrião estático seria atribuído à pré-visualização de eventos em direto e pontos finais de ingestão. Este valor só pode ser atualizado se o evento em direto estiver no estado Em Espera
systemData

systemData

Os metadados do sistema relacionados com este recurso.
tags

object

Etiquetas de recursos.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

LiveEventEncoding

Especifica o tipo de evento em direto e as definições de codificação opcionais para codificar eventos em direto.

Name Tipo Description
encodingType

LiveEventEncodingType

Tipo de evento em direto. Quando encodingType está definido como PassthroughBasic ou PassthroughStandard, o serviço simplesmente passa pelas camadas de áudio e vídeo recebidos para a saída. Quando encodingType está definido como Standard ou Premium1080p, um codificador em direto transcodifica o fluxo de entrada em múltiplas velocidades de transmissão ou camadas. Consulte https://go.microsoft.com/fwlink/?linkid=2095101 para obter mais informações. Esta propriedade não pode ser modificada após a criação do evento em direto.
keyFrameInterval

string

Utilize um valor de tempo ISO 8601 entre 0,5 e 20 segundos para especificar o comprimento do fragmento de saída para as faixas de vídeo e áudio de um evento em direto de codificação. Por exemplo, utilize PT2S para indicar 2 segundos. Para a faixa de vídeo, também define o intervalo de fotogramas da chave ou o comprimento de um GoP (grupo de imagens). Se este valor não estiver definido para um evento em direto de codificação, a duração do fragmento é predefinida para 2 segundos. Não é possível definir o valor para eventos em direto pass-through.
presetName

string

O nome predefinido de codificação opcional, utilizado quando encodingType não é Nenhum. Este valor é especificado no momento da criação e não pode ser atualizado. Se o encodingType estiver definido como Standard, o nome predefinido predefinido é "Default720p". Caso contrário, se o encodingType estiver definido como Premium1080p, a predefinição predefinida é "Default1080p".
stretchMode

StretchMode

Especifica como o vídeo de entrada será redimensionado para se ajustar às resoluções de saída pretendidas. A predefinição é Nenhuma

LiveEventEncodingType

Tipo de evento em direto. Quando encodingType está definido como PassthroughBasic ou PassthroughStandard, o serviço simplesmente passa pelas camadas de áudio e vídeo recebidos para a saída. Quando encodingType está definido como Standard ou Premium1080p, um codificador em direto transcodifica o fluxo de entrada em múltiplas velocidades de transmissão ou camadas. Consulte https://go.microsoft.com/fwlink/?linkid=2095101 para obter mais informações. Esta propriedade não pode ser modificada após a criação do evento em direto.

Name Tipo Description
None

string

Isto é o mesmo que PassthroughStandard. Veja a descrição abaixo. Este valor de enumeração está a ser preterido.
PassthroughBasic

string

O fluxo ingerido passa pelo evento em direto a partir do codificador de contribuição sem qualquer processamento adicional. No modo PassthroughBasic, a ingestão está limitada a até 5 Mbps e só é permitida uma saída em direto simultânea. A transcrição em direto não está disponível.
PassthroughStandard

string

O fluxo ingerido passa pelo evento em direto a partir do codificador de contribuição sem qualquer processamento adicional. A transcrição em direto está disponível. Os limites de velocidade de transmissão da ingestão são muito superiores e são permitidas até 3 saídas em direto simultâneas.
Premium1080p

string

Um codificador em direto de contribuição envia uma transmissão em fluxo de velocidade de transmissão única para o evento em direto e os Serviços de Multimédia criam vários fluxos de velocidade de transmissão. A saída não pode exceder os 1080p na resolução.
Standard

string

Um codificador em direto de contribuição envia uma transmissão em fluxo de velocidade de transmissão única para o evento em direto e os Serviços de Multimédia criam vários fluxos de velocidade de transmissão. A saída não pode exceder os 720p na resolução.

LiveEventEndpoint

O ponto final do evento em direto.

Name Tipo Description
protocol

string

O protocolo de ponto final.
url

string

O URL do ponto final.

LiveEventInput

A entrada do evento em direto.

Name Tipo Description
accessControl

LiveEventInputAccessControl

Controlo de acesso para entrada de eventos em direto.
accessToken

string

Um UUID no formato de cadeia para identificar exclusivamente o fluxo. Isto pode ser especificado no momento da criação, mas não pode ser atualizado. Se for omitido, o serviço irá gerar um valor exclusivo.
endpoints

LiveEventEndpoint[]

Os pontos finais de entrada para o evento em direto.
keyFrameIntervalDuration

string

ISO 8601 duração de tempo da duração do intervalo do fotograma chave da entrada. Este valor define a propriedade EXT-X-TARGETDURATION na saída HLS. Por exemplo, utilize PT2S para indicar 2 segundos. Deixe o valor vazio para codificar eventos em direto.
streamingProtocol

LiveEventInputProtocol

O protocolo de entrada do evento em direto. Isto é especificado no momento da criação e não pode ser atualizado.
timedMetadataEndpoints

LiveEventTimedMetadataEndpoint[]

Os pontos finais de metadados do evento em direto.

LiveEventInputAccessControl

O controlo de acesso ao IP para a entrada de eventos em direto.

Name Tipo Description
ip

IPAccessControl

As propriedades do controlo de acesso ao IP.

LiveEventInputProtocol

O protocolo de entrada do evento em direto. Isto é especificado no momento da criação e não pode ser atualizado.

Name Tipo Description
FragmentedMP4

string

A entrada de Transmissão em Fluxo Uniforme será enviada pelo codificador de contribuição para o evento em direto.
RTMP

string

A entrada RTMP será enviada pelo codificador de contribuição para o evento em direto.

LiveEventInputTrackSelection

Uma condição de seleção de controlo. Esta propriedade está reservada para utilização futura, qualquer valor definido nesta propriedade será ignorado.

Name Tipo Description
operation

string

A comparar a operação. Esta propriedade está reservada para utilização futura, qualquer valor definido nesta propriedade será ignorado.
property

string

Nome da propriedade a selecionar. Esta propriedade está reservada para utilização futura, qualquer valor definido nesta propriedade será ignorado.
value

string

Valor da propriedade a selecionar. Esta propriedade está reservada para utilização futura, qualquer valor definido nesta propriedade será ignorado.

LiveEventOutputTranscriptionTrack

Descreve uma faixa de transcrição na saída de um evento em direto, gerada com a transcrição de voz em texto. Esta propriedade está reservada para utilização futura, qualquer valor definido nesta propriedade será ignorado.

Name Tipo Description
trackName

string

O nome do registo de saída. Esta propriedade está reservada para utilização futura, qualquer valor definido nesta propriedade será ignorado.

LiveEventPreview

Definições de pré-visualização de eventos em direto.

Name Tipo Description
accessControl

LiveEventPreviewAccessControl

O controlo de acesso para a pré-visualização de eventos em direto.
alternativeMediaId

string

Um identificador de multimédia alternativo associado ao localizador de transmissão em fluxo criado para a pré-visualização. Este valor é especificado no momento da criação e não pode ser atualizado. O identificador pode ser utilizado no campo CustomLicenseAcquisitionUrlTemplate ou CustomKeyAcquisitionUrlTemplate da StreamingPolicy especificado no campo StreamingPolicyName.
endpoints

LiveEventEndpoint[]

Os pontos finais para pré-visualização. Não partilhe o URL de pré-visualização com a audiência do evento em direto.
previewLocator

string

O identificador do localizador de pré-visualização no formato Guid. Especificar isto no momento da criação permite que o autor da chamada saiba o URL do localizador de pré-visualização antes de o evento ser criado. Se for omitido, o serviço irá gerar um identificador aleatório. Este valor não pode ser atualizado depois de o evento em direto ser criado.
streamingPolicyName

string

O nome da política de transmissão em fluxo utilizada para a pré-visualização de eventos em direto. Este valor é especificado no momento da criação e não pode ser atualizado.

LiveEventPreviewAccessControl

O controlo de acesso ao IP para o ponto final de pré-visualização de eventos em direto.

Name Tipo Description
ip

IPAccessControl

As propriedades do controlo de acesso ao IP.

LiveEventResourceState

O estado do recurso do evento em direto. Consulte https://go.microsoft.com/fwlink/?linkid=2139012 para obter mais informações.

Name Tipo Description
Allocating

string

A ação alocar foi chamada no evento em direto e os recursos estão a ser aprovisionados para este evento em direto. Assim que a alocação for concluída com êxito, o evento em direto transitará para o estado StandBy.
Deleting

string

O evento em direto está a ser eliminado. Não ocorre nenhuma faturação neste estado transitório. Atualizações ou transmissão em fluxo não são permitidos durante este estado.
Running

string

Os recursos de eventos em direto foram alocados, os URLs de ingestão e pré-visualização foram gerados e é capaz de receber transmissões em direto. Neste momento, a faturação está ativa. Tem de chamar explicitamente Parar no recurso do evento em direto para parar a faturação adicional.
StandBy

string

Os recursos de eventos em direto foram aprovisionados e estão prontos para começar. A faturação ocorre neste estado. A maioria das propriedades ainda pode ser atualizada. No entanto, a ingestão ou a transmissão em fluxo não são permitidas durante este estado.
Starting

string

O evento em direto está a ser iniciado e os recursos estão a ser alocados. Não ocorre nenhuma faturação neste estado. Atualizações ou transmissão em fluxo não são permitidos durante este estado. Se ocorrer um erro, o evento em direto regressa ao estado Parado.
Stopped

string

Este é o estado inicial do evento em direto após a criação (a menos que o início automático tenha sido definido como verdadeiro.) Não ocorre nenhuma faturação neste estado. Neste estado, as propriedades do evento em direto podem ser atualizadas, mas a transmissão em fluxo não é permitida.
Stopping

string

O evento em direto está a ser parado e os recursos estão a ser desaprovisionados. Não ocorre nenhuma faturação neste estado transitório. Atualizações ou transmissão em fluxo não são permitidos durante este estado.

LiveEventTimedMetadataEndpoint

O ponto final de inserção de metadados de eventos em direto.

Name Tipo Description
url

string

O URL do ponto final de metadados.

LiveEventTranscription

Descreve as faixas de transcrição na saída de um evento em direto, geradas com a transcrição de voz em texto. Esta propriedade está reservada para utilização futura, qualquer valor definido nesta propriedade será ignorado.

Name Tipo Description
inputTrackSelection

LiveEventInputTrackSelection[]

Fornece um mecanismo para selecionar a faixa de áudio no feed dinâmico de entrada, ao qual a transcrição de voz em texto é aplicada. Esta propriedade está reservada para utilização futura, qualquer valor definido nesta propriedade será ignorado.
language

string

Especifica o idioma (região) a utilizar para a transcrição de voz em texto– deve corresponder ao idioma falado na faixa de áudio. O valor deve estar no formato BCP-47 (por exemplo, "en-US"). Veja https://go.microsoft.com/fwlink/?linkid=2133742 para obter mais informações sobre a funcionalidade de transcrição em direto e a lista de idiomas suportados.
outputTranscriptionTrack

LiveEventOutputTranscriptionTrack

Descreve uma faixa de transcrição na saída de um evento em direto, gerada com a transcrição de voz em texto. Esta propriedade está reservada para utilização futura, qualquer valor definido nesta propriedade será ignorado.

StreamOptionsFlag

As opções a utilizar para o LiveEvent. Este valor é especificado no momento da criação e não pode ser atualizado. Os valores válidos para os valores de entrada de matriz são "Predefinição" e "LowLatency".

Name Tipo Description
Default

string

Transmissão em fluxo em direto sem otimizações de latência especiais.
LowLatency

string

O evento em direto proporciona latência de ponto a ponto inferior ao reduzir as memórias intermédias internas.
LowLatencyV2

string

O evento em direto está otimizado para latência ponto a ponto. Esta opção só está disponível para codificar eventos em direto com entrada RTMP. As saídas podem ser transmitidas em fluxo com formatos HLS ou DASH. O comprimento de rebobinamento do DVR ou arquivo das saídas está limitado a 6 horas. Utilize a opção de fluxo "LowLatency" para todos os outros cenários.

StretchMode

Especifica como o vídeo de entrada será redimensionado para se ajustar às resoluções de saída pretendidas. A predefinição é Nenhuma

Name Tipo Description
AutoFit

string

Preencho a saída (com caixa de correio ou pilar) para respeitar a resolução de saída, garantindo ao mesmo tempo que a região de vídeo ativa na saída tem a mesma proporção que a entrada. Por exemplo, se a entrada for 1920x1080 e a predefinição de codificação pedir 1280x1280, a saída será a 1280x1280, que contém um retângulo interno de 1280x720 na proporção de 16:9 e as regiões da caixa do pilar com 280 píxeis de largura à esquerda e à direita.
AutoSize

string

Substitua a resolução de saída e altere-a para corresponder à proporção de apresentação da entrada, sem preenchimento. Por exemplo, se a entrada for 1920x1080 e a predefinição de codificação pedir 1280x1280, o valor na predefinição será substituído e o resultado será 1280x720, que mantém a proporção de entrada de 16:9.
None

string

Respeita estritamente a resolução de saída especificada na predefinição de codificação sem considerar a proporção de píxeis ou apresentar a proporção do vídeo de entrada.

systemData

Metadados relativos à criação e última modificação do recurso.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.