Compartilhar via

Live Events - Get

  • Referência
Serviço:
Media Services
Versão da API:
2022-11-01

Obter evento ao vivo
Obtém propriedades de um evento ao vivo.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
accountName
 path True

string

O nome da conta dos Serviços de Mídia.
liveEventName
 path True

string

O nome do evento ao vivo, o comprimento máximo é 32.

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

string

O nome do grupo de recursos na assinatura do Azure.
subscriptionId
 path True

string

O identificador exclusivo para uma assinatura do Microsoft Azure.
api-version
 query True

string

A versão da API a ser usada com a solicitação do cliente.

Respostas

Nome Tipo Description
200 OK

LiveEvent

OK. A solicitação foi bem-sucedida.
Other Status Codes

ErrorResponse

A resposta de erro de streaming que descreve por que a operação falhou.

Exemplos

Get a LiveEvent by name

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

Nome Description
createdByType

O tipo de identidade que criou o recurso.
CrossSiteAccessPolicies

A política de acesso do cliente.
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
IPAccessControl

O controle de acesso ip.
IPRange

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

O evento ao vivo.
LiveEventEncoding

Especifica o tipo de evento ao vivo e as configurações de codificação opcionais para codificar eventos ao vivo.
LiveEventEncodingType

Tipo de evento ao vivo. Quando encodingType é definido como PassthroughBasic ou PassthroughStandard, o serviço simplesmente passa as camadas de áudio e vídeo de entrada para a saída. Quando encodingType é definido como Standard ou Premium1080p, um codificador dinâmico transcodifica o fluxo de entrada em várias taxas de bits ou camadas. Consulte https://go.microsoft.com/fwlink/?linkid=2095101 para obter mais informações. Essa propriedade não pode ser modificada após a criação do evento ao vivo.
LiveEventEndpoint

O ponto de extremidade do evento ao vivo.
LiveEventInput

A entrada de evento ao vivo.
LiveEventInputAccessControl

O controle de acesso ip para entrada de evento ao vivo.
LiveEventInputProtocol

O protocolo de entrada para o evento ao vivo. Isso é especificado no momento da criação e não pode ser atualizado.
LiveEventInputTrackSelection

Uma condição de seleção de faixa. Essa propriedade é reservada para uso futuro, qualquer valor definido nessa propriedade será ignorado.
LiveEventOutputTranscriptionTrack

Descreve uma faixa de transcrição na saída de um evento ao vivo, gerada usando a transcrição de fala em texto. Essa propriedade é reservada para uso futuro, qualquer valor definido nessa propriedade será ignorado.
LiveEventPreview

Configurações de visualização de eventos ao vivo.
LiveEventPreviewAccessControl

O controle de acesso ip para o ponto de extremidade de visualização de evento ao vivo.
LiveEventResourceState

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

O ponto de extremidade de inserção de metadados de evento ao vivo.
LiveEventTranscription

Descreve as faixas de transcrição na saída de um evento ao vivo, geradas usando a transcrição de conversão de fala em texto. Essa propriedade é reservada para uso futuro, qualquer valor definido nessa propriedade será ignorado.
StreamOptionsFlag

As opções a serem usadas para o LiveEvent. Esse valor é especificado no momento da criação e não pode ser atualizado. Os valores válidos para os valores de entrada da matriz são 'Default' e 'LowLatency'.
StretchMode

Especifica como o vídeo de entrada será redimensionado para se ajustar às resoluções de saída desejadas. O padrão é Nenhum
systemData

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

createdByType

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

CrossSiteAccessPolicies

A política de acesso do cliente.

Nome Tipo Description
clientAccessPolicy

string

O conteúdo de clientaccesspolicy.xml usado pelo Silverlight.
crossDomainPolicy

string

O conteúdo de crossdomain.xml usado pelo Silverlight.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome 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 de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

IPAccessControl

O controle de acesso ip.

Nome Tipo Description
allow

IPRange[]

A lista de permissões de IP.

IPRange

O intervalo de endereços IP no esquema CIDR.

Nome Tipo Description
address

string

O endereço IP.
name

string

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

integer

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

LiveEvent

O evento ao vivo.

Nome Tipo Description
id

string

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

string

A localização geográfica em que o recurso reside
name

string

O nome do recurso
properties.created

string

A hora de criação do evento ao vivo
properties.crossSiteAccessPolicies

CrossSiteAccessPolicies

Políticas de acesso entre sites de eventos ao vivo.
properties.description

string

Uma descrição para o evento ao vivo.
properties.encoding

LiveEventEncoding

Configurações de codificação para o evento ao vivo. Ele configura se um codificador dinâmico é usado para o evento ao vivo e configurações para o codificador dinâmico se ele for usado.
properties.hostnamePrefix

string

Quando useStaticHostname é definido como true, o hostnamePrefix especifica a primeira parte do nome do host atribuído à versão prévia do evento ao vivo e ingerir pontos de extremidade. O nome do host final seria uma combinação desse prefixo, o nome da conta do serviço de mídia e um código curto para os data centers dos Serviços de Mídia do Azure.
properties.input

LiveEventInput

Configurações de entrada de evento ao vivo. Ele define como o evento ao vivo recebe a entrada de um codificador de contribuição.
properties.lastModified

string

A última hora modificada do evento ao vivo.
properties.preview

LiveEventPreview

Configurações de visualização de eventos ao vivo. A versão prévia permite que os produtores de eventos ao vivo visualizem o conteúdo de transmissão ao vivo sem criar nenhuma saída ao vivo.
properties.provisioningState

string

O estado de provisionamento do evento ao vivo.
properties.resourceState

LiveEventResourceState

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

StreamOptionsFlag[]

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

LiveEventTranscription[]

Configurações de transcrição ao vivo para o evento ao vivo. Consulte https://go.microsoft.com/fwlink/?linkid=2133742 para obter mais informações sobre o recurso de transcrição ao vivo.
properties.useStaticHostname

boolean

Especifica se um nome de host estático seria atribuído à versão prévia do evento ao vivo e aos pontos de extremidade de ingestão. Esse valor só poderá ser atualizado se o evento ao vivo estiver em estado de espera
systemData

systemData

Os metadados do sistema relacionados a esse recurso.
tags

object

Marcas de recurso.
type

string

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

LiveEventEncoding

Especifica o tipo de evento ao vivo e as configurações de codificação opcionais para codificar eventos ao vivo.

Nome Tipo Description
encodingType

LiveEventEncodingType

Tipo de evento ao vivo. Quando encodingType é definido como PassthroughBasic ou PassthroughStandard, o serviço simplesmente passa as camadas de áudio e vídeo de entrada para a saída. Quando encodingType é definido como Standard ou Premium1080p, um codificador dinâmico transcodifica o fluxo de entrada em várias taxas de bits ou camadas. Consulte https://go.microsoft.com/fwlink/?linkid=2095101 para obter mais informações. Essa propriedade não pode ser modificada após a criação do evento ao vivo.
keyFrameInterval

string

Use 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 ao vivo de codificação. Por exemplo, use PT2S para indicar 2 segundos. Para a faixa de vídeo, ela também define o intervalo de quadro chave ou o comprimento de um GoP (grupo de imagens). Se esse valor não for definido para um evento ao vivo de codificação, a duração do fragmento será padronizada como 2 segundos. O valor não pode ser definido para eventos ao vivo de passagem.
presetName

string

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

StretchMode

Especifica como o vídeo de entrada será redimensionado para se ajustar às resoluções de saída desejadas. O padrão é Nenhum

LiveEventEncodingType

Tipo de evento ao vivo. Quando encodingType é definido como PassthroughBasic ou PassthroughStandard, o serviço simplesmente passa as camadas de áudio e vídeo de entrada para a saída. Quando encodingType é definido como Standard ou Premium1080p, um codificador dinâmico transcodifica o fluxo de entrada em várias taxas de bits ou camadas. Consulte https://go.microsoft.com/fwlink/?linkid=2095101 para obter mais informações. Essa propriedade não pode ser modificada após a criação do evento ao vivo.

Nome Tipo Description
None

string

Isso é o mesmo que PassthroughStandard, confira a descrição abaixo. Esse valor de enumeração está sendo preterido.
PassthroughBasic

string

O fluxo ingerido passa pelo evento ao vivo do codificador de contribuição sem nenhum processamento adicional. No modo PassthroughBasic, a ingestão é limitada a até 5 Mbps e apenas 1 saída dinâmica simultânea é permitida. A transcrição ao vivo não está disponível.
PassthroughStandard

string

O fluxo ingerido passa pelo evento ao vivo do codificador de contribuição sem nenhum processamento adicional. A transcrição ao vivo está disponível. Os limites de taxa de bits de ingestão são muito maiores e até três saídas dinâmicas simultâneas são permitidas.
Premium1080p

string

Um codificador ao vivo de contribuição envia uma única transmissão de taxa de bits para o evento ao vivo e os Serviços de Mídia criam vários fluxos de taxa de bits. A saída não pode exceder 1080p em resolução.
Standard

string

Um codificador ao vivo de contribuição envia uma única transmissão de taxa de bits para o evento ao vivo e os Serviços de Mídia criam vários fluxos de taxa de bits. A saída não pode exceder 720p em resolução.

LiveEventEndpoint

O ponto de extremidade do evento ao vivo.

Nome Tipo Description
protocol

string

O protocolo de ponto de extremidade.
url

string

A URL do ponto de extremidade.

LiveEventInput

A entrada de evento ao vivo.

Nome Tipo Description
accessControl

LiveEventInputAccessControl

Controle de acesso para entrada de evento ao vivo.
accessToken

string

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

LiveEventEndpoint[]

Os pontos de extremidade de entrada para o evento ao vivo.
keyFrameIntervalDuration

string

Duração do tempo ISO 8601 da duração do intervalo de quadros de chave da entrada. Esse valor define a propriedade EXT-X-TARGETDURATION na saída HLS. Por exemplo, use PT2S para indicar 2 segundos. Deixe o valor vazio para codificar eventos ao vivo.
streamingProtocol

LiveEventInputProtocol

O protocolo de entrada para o evento ao vivo. Isso é especificado no momento da criação e não pode ser atualizado.
timedMetadataEndpoints

LiveEventTimedMetadataEndpoint[]

Os pontos de extremidade de metadados para o evento ao vivo.

LiveEventInputAccessControl

O controle de acesso ip para entrada de evento ao vivo.

Nome Tipo Description
ip

IPAccessControl

As propriedades de controle de acesso ip.

LiveEventInputProtocol

O protocolo de entrada para o evento ao vivo. Isso é especificado no momento da criação e não pode ser atualizado.

Nome Tipo Description
FragmentedMP4

string

A entrada smooth streaming será enviada pelo codificador de contribuição para o evento ao vivo.
RTMP

string

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

LiveEventInputTrackSelection

Uma condição de seleção de faixa. Essa propriedade é reservada para uso futuro, qualquer valor definido nessa propriedade será ignorado.

Nome Tipo Description
operation

string

Comparando a operação. Essa propriedade é reservada para uso futuro, qualquer valor definido nessa propriedade será ignorado.
property

string

Nome da propriedade a ser selecionado. Essa propriedade é reservada para uso futuro, qualquer valor definido nessa propriedade será ignorado.
value

string

Valor da propriedade a ser selecionado. Essa propriedade é reservada para uso futuro, qualquer valor definido nessa propriedade será ignorado.

LiveEventOutputTranscriptionTrack

Descreve uma faixa de transcrição na saída de um evento ao vivo, gerada usando a transcrição de fala em texto. Essa propriedade é reservada para uso futuro, qualquer valor definido nessa propriedade será ignorado.

Nome Tipo Description
trackName

string

O nome da faixa de saída. Essa propriedade é reservada para uso futuro, qualquer valor definido nessa propriedade será ignorado.

LiveEventPreview

Configurações de visualização de eventos ao vivo.

Nome Tipo Description
accessControl

LiveEventPreviewAccessControl

O controle de acesso para visualização de eventos ao vivo.
alternativeMediaId

string

Um identificador de mídia alternativo associado ao localizador de streaming criado para a versão prévia. Esse valor é especificado no momento da criação e não pode ser atualizado. O identificador pode ser usado no CustomLicenseAcquisitionUrlTemplate ou no CustomKeyAcquisitionUrlTemplate do StreamingPolicy especificado no campo StreamingPolicyName.
endpoints

LiveEventEndpoint[]

Os pontos de extremidade para visualização. Não compartilhe a URL de visualização com o público do evento ao vivo.
previewLocator

string

O identificador do localizador de visualização no formato Guid. Especificar isso no momento da criação permite que o chamador conheça a URL do localizador de visualização antes que o evento seja criado. Se omitido, o serviço gerará um identificador aleatório. Esse valor não pode ser atualizado depois que o evento ao vivo é criado.
streamingPolicyName

string

O nome da política de streaming usada para a versão prévia do evento ao vivo. Esse valor é especificado no momento da criação e não pode ser atualizado.

LiveEventPreviewAccessControl

O controle de acesso ip para o ponto de extremidade de visualização de evento ao vivo.

Nome Tipo Description
ip

IPAccessControl

As propriedades de controle de acesso ip.

LiveEventResourceState

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

Nome Tipo Description
Allocating

string

A ação allocate foi chamada no evento ao vivo e os recursos estão sendo provisionados para este evento ao vivo. Depois que a alocação for concluída com êxito, o evento ao vivo fará a transição para o estado StandBy.
Deleting

string

O evento ao vivo está sendo excluído. Não haverá cobrança nesse estado transitório. Atualizações ou streaming não são permitidos durante esse estado.
Running

string

Os recursos do evento ao vivo foram alocados, as URLs de visualização e ingestão foram geradas e o evento ao vivo já pode receber transmissões ao vivo. Neste ponto, o faturamento está ativo. É necessário chamar explicitamente o recurso Parar no evento ao vivo para impedir cobranças adicionais.
StandBy

string

Os recursos de evento ao vivo foram provisionados e estão prontos para serem iniciados. Há cobrança nesse estado. A maioria das propriedades ainda pode ser atualizada, no entanto, a ingestão ou o streaming não é permitido durante esse estado.
Starting

string

O evento ao vivo está sendo iniciado e os recursos estão sendo alocados. Não há cobrança nesse estado. Atualizações ou streaming não são permitidos durante esse estado. Se ocorrer um erro, o evento ao vivo retornará ao estado Parado.
Stopped

string

Esse é o estado inicial do evento ao vivo após a criação (exceto se a inicialização automática estiver definida como true). Não há cobrança nesse estado. Nesse estado, as propriedades do evento ao vivo podem ser atualizadas, mas o streaming não é permitido.
Stopping

string

O evento ao vivo está sendo interrompido e os recursos estão sendo desprovisionados. Não haverá cobrança nesse estado transitório. Atualizações ou streaming não são permitidos durante esse estado.

LiveEventTimedMetadataEndpoint

O ponto de extremidade de inserção de metadados de evento ao vivo.

Nome Tipo Description
url

string

A URL do ponto de extremidade de metadados.

LiveEventTranscription

Descreve as faixas de transcrição na saída de um evento ao vivo, geradas usando a transcrição de conversão de fala em texto. Essa propriedade é reservada para uso futuro, qualquer valor definido nessa propriedade será ignorado.

Nome Tipo Description
inputTrackSelection

LiveEventInputTrackSelection[]

Fornece um mecanismo para selecionar a faixa de áudio no feed ao vivo de entrada, ao qual a transcrição de fala em texto é aplicada. Essa propriedade é reservada para uso futuro, qualquer valor definido nessa propriedade será ignorado.
language

string

Especifica o idioma (localidade) a ser usado para transcrição de fala em texto – ele deve corresponder ao idioma falado na faixa de áudio. O valor deve estar no formato BCP-47 (por exemplo, 'en-US'). Consulte https://go.microsoft.com/fwlink/?linkid=2133742 para obter mais informações sobre o recurso de transcrição ao vivo e a lista de idiomas com suporte.
outputTranscriptionTrack

LiveEventOutputTranscriptionTrack

Descreve uma faixa de transcrição na saída de um evento ao vivo, gerada usando a transcrição de fala em texto. Essa propriedade é reservada para uso futuro, qualquer valor definido nessa propriedade será ignorado.

StreamOptionsFlag

As opções a serem usadas para o LiveEvent. Esse valor é especificado no momento da criação e não pode ser atualizado. Os valores válidos para os valores de entrada da matriz são 'Default' e 'LowLatency'.

Nome Tipo Description
Default

string

Transmissão ao vivo sem otimizações de latência especiais.
LowLatency

string

O evento ao vivo fornece latência de ponta a ponta reduzindo seus buffers internos.
LowLatencyV2

string

O evento ao vivo é otimizado para latência de ponta a ponta. Essa opção só está disponível para codificar eventos ao vivo com entrada RTMP. As saídas podem ser transmitidas usando formatos HLS ou DASH. O comprimento de rebobinamento de arquivos ou DVR das saídas é limitado a 6 horas. Use 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 desejadas. O padrão é Nenhum

Nome Tipo Description
AutoFit

string

Remova a saída (com caixa de correio ou caixa de pilares) para honrar a resolução de saída, garantindo que a região de vídeo ativa na saída tenha a mesma taxa de proporção que a entrada. Por exemplo, se a entrada for 1920x1080 e a predefinição de codificação solicitar 1280x1280, a saída será em 1280x1280, que contém um retângulo interno de 1280x720 na proporção de proporção de 16:9 e regiões de caixa de pilar de 280 pixels de largura à esquerda e à direita.
AutoSize

string

Substitua a resolução de saída e altere-a para corresponder à taxa de proporção de exibição da entrada, sem preenchimento. Por exemplo, se a entrada for 1920x1080 e a predefinição de codificação solicitar 1280x1280, o valor na predefinição será substituído e a saída será 1280x720, o que mantém a taxa de 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 taxa de proporção de pixel ou a taxa de proporção de exibição do vídeo de entrada.

systemData

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

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