GetPlayInfo - ApsaraVideo VOD: Central de Documentação do Alibaba Cloud

Obtém a URL de reprodução de um arquivo de áudio ou vídeo. Você pode usar o ApsaraVideo Player ou um player de terceiros, como um player nativo, de código aberto ou personalizado, para reproduzir o conteúdo de mídia.

Descrição da operação

Antes de chamar esta operação, certifique-se de compreender totalmente os métodos de cobrança e os preços do ApsaraVideo VOD. O download ou a reprodução de vídeos diretamente a partir da URL de reprodução do VOD incorre em taxas de tráfego de saída. Se nenhum nome de domínio acelerado estiver configurado, consulte Cobrança de tráfego de saída. Se um nome de domínio acelerado estiver configurado, consulte Cobrança de serviços de aceleração. Se você ativou a aceleração de transferência de armazenamento, o download ou a reprodução de vídeos diretamente a partir da URL de reprodução do VOD também incorre em taxas de aceleração de download. Para mais informações sobre cobrança, consulte Cobrança de aceleração de transferência de armazenamento.
Apenas vídeos no estado Normal (o campo Status está definido como Normal) podem ser reproduzidos. Para mais informações sobre instruções e limites de reprodução para URLs de reprodução, consulte Reprodução de mídia.
Quando o tipo de armazenamento de ativos de mídia for armazenamento não padrão, você deve configurar o campo StorageClass no parâmetro PlayConfig de acordo. Para mais informações, consulte PlayConfig.
Se a reprodução do vídeo estiver anormal, você pode chamar a operação GetMezzanineInfo para verificar se as informações do arquivo de origem do vídeo estão corretas.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

vod:GetPlayInfo

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
VideoId	string	Não	O ID do áudio ou vídeo. Você pode especificar apenas um ID. Você pode obter o ID usando um dos seguintes métodos: Para arquivos de áudio ou vídeo enviados no console, faça login no console do ApsaraVideo VOD e escolha Ativos de Mídia > Áudio/Vídeo para visualizar o ID. Ao chamar a operação CreateUploadVideo para enviar um arquivo de áudio ou vídeo, o ID é o valor do parâmetro de resposta VideoId. Após o envio de um arquivo de áudio ou vídeo, você pode chamar a operação SearchMedia para consultar o ID. O ID é o valor do parâmetro de resposta VideoId.	93ab850b4f654b6e91d24d81d44****
Formats	string	Não	O formato do fluxo de mídia. Separe vários formatos com vírgulas (,). Valores válidos: mp4 m3u8 mp3 flv mpd Nota Por padrão, os fluxos de todos os formatos são obtidos. O formato mpd é gerado apenas quando o formato de contêiner dash é configurado no modelo de transcodificação. Para mais informações, consulte Contêiner: Formato de contêiner.	mp4,m3u8
AuthTimeout	integer	Não	O período de validade da URL de reprodução. Unidade: segundos. Quando OutputType está definido como cdn: A URL de reprodução expira periodicamente apenas se a autenticação de URL estiver ativada. Caso contrário, a URL permanece válida permanentemente. Para mais informações sobre como ativar e configurar a autenticação de URL, consulte Autenticação de URL. Valor mínimo: 1. Valor máximo: ilimitado. Valor padrão: Se este parâmetro não for especificado, o período de validade padrão configurado para a autenticação de URL será usado. Quando OutputType está definido como oss: A URL de reprodução expira periodicamente apenas se a permissão de armazenamento estiver definida como privada. Caso contrário, a URL permanece válida permanentemente. Valor mínimo: 1. Valor máximo: Para reduzir os riscos de segurança do servidor de origem, o valor máximo é 604800 (7 dias) quando o arquivo de áudio ou vídeo é armazenado em um bucket do VOD, e 129600 (36 horas) quando o arquivo é armazenado em um bucket do OSS de propriedade do usuário. Se o valor máximo não atender aos seus requisitos, você pode definir OutputType como cdn e configurar a autenticação de URL para definir um período de validade mais longo. Valor padrão: Se este parâmetro não for especificado, o valor será 3600.	1800
OutputType	string	Não	O tipo da URL de saída. Valores válidos: oss: a URL de retorno à origem. cdn (padrão): a URL acelerada.	cdn
StreamType	string	Não	O tipo do fluxo de mídia. Separe vários tipos com vírgulas (,). Valores válidos: video: vídeo. audio: áudio. Por padrão, os fluxos de todos os tipos são obtidos.	video
ReAuthInfo	string	Não	O parâmetro de reautenticação do CDN, que é uma string JSON. Quando a assinatura Tipo A da autenticação de URL está ativada, você pode usar este parâmetro para definir os campos uid e rand da URL autenticada. Para mais informações, consulte Assinatura Tipo A.	{"uid":"12345","rand":"abckljd"}
Definition	string	Não	A definição do fluxo de vídeo. Separe várias definições com vírgulas (,). Valores válidos: FD: fluente. LD: baixa definição. SD: definição padrão. HD: alta definição. OD: definição original. 2K: 2K. 4K: 4K. SQ: qualidade de áudio padrão. HQ: alta qualidade de áudio. AUTO: taxa de bits adaptável. Nota Por padrão, os fluxos de todas as definições são obtidos. Ao gerar uma marca d'água de rastreamento, este parâmetro é obrigatório e deve ser consistente com a definição configurada para a transcodificação da marca d'água de rastreamento. A definição AUTO é gerada apenas quando o empacotamento de transcodificação é configurado no modelo de transcodificação. Para mais informações, consulte PackageSetting: Configurações de empacotamento de transcodificação.	LD
ResultType	string	Não	O tipo dos dados retornados. Valores válidos: Single (padrão): retorna apenas o fluxo transcodificado mais recente para cada definição e formato. Multiple: retorna todos os fluxos transcodificados para cada definição e formato.	Single
PlayConfig	string	Não	As configurações personalizadas de reprodução. O valor é uma string JSON. Você pode especificar o nome de domínio para reprodução. Para mais informações sobre como construir o parâmetro, consulte PlayConfig. Nota Se PlayConfig não for especificado ou o campo PlayDomain em PlayConfig não for especificado, a operação usa o nome de domínio padrão configurado para o VOD. Se nenhum nome de domínio padrão estiver configurado, a operação consulta os nomes de domínio em ordem decrescente de tempo de modificação e usa o nome de domínio modificado mais recentemente como o nome de domínio de reprodução. Para evitar que um nome de domínio inesperado seja retornado, recomendamos que você configure um nome de domínio de reprodução padrão. Você pode fazer login no console do ApsaraVideo VOD e escolher Gerenciamento de Configuração > Configuração de Gerenciamento de Ativos de Mídia > Gerenciamento de Armazenamento > Gerenciar > Nomes de domínio que redirecionam o tráfego de retorno à origem para este endereço de armazenamento para configurar o nome de domínio de reprodução padrão. Quando o campo EncryptType em PlayConfig está definido como AliyunVoDEncryption, a URL de reprodução do fluxo criptografado privado não é retornada por padrão para garantir a segurança do vídeo. Para retornar a URL de reprodução do fluxo criptografado privado, você também deve definir o parâmetro ResultType como Multiple.	{"PlayDomain":"vod.test_domain","XForwardedFor":"yqCD7Fp1uqChoVj/sl/p5Q==","PreviewTime":"20","MtsHlsUriToken":"yqCD7Fp1uqChoVjslp5Q"}
AdditionType	string	Não	A URL dos dados de máscara de comentários ao vivo. Valor válido: danmu. Nota Este parâmetro entra em vigor apenas quando outputType está definido como cdn.	danmu
Trace	string	Não	As informações personalizadas de marca d'água digital. Quando DigitalWatermarkType está definido como TraceMark, você pode usar este parâmetro para definir as informações da marca d'água de rastreamento para o vídeo e retornar o fluxo de vídeo que contém as informações da marca d'água. Apenas letras em inglês, dígitos e caracteres chineses são suportados. São suportados no máximo 1.024 caracteres. Quando DigitalWatermarkType está definido como CopyrightMark, Trace corresponde ao Texto da Marca d'Água configurado quando o modelo de marca d'água é criado. Você pode usar este parâmetro para consultar e retornar o fluxo de vídeo com o texto da marca d'água especificado.	test mark
DigitalWatermarkType	string	Não	O tipo da marca d'água digital. Valores válidos: TraceMark: marca d'água de rastreamento. CopyrightMark: marca d'água de direitos autorais.	TraceMark
CodecName	string	Não	O codec.	H264
ReferenceId	string	Não	O ID personalizado. O ID deve ter de 6 a 64 caracteres e pode conter apenas letras minúsculas, letras maiúsculas, dígitos, hifens (-) e sublinhados (_). O ID deve ser exclusivo por usuário.	123-123

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	F552E596-967D-5500-842F-17E6364****
VideoBase	object	As informações básicas sobre o arquivo de áudio ou vídeo.
CreationTime	string	A hora em que o arquivo de áudio ou vídeo foi criado. A hora segue o formato aaaa-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2017-06-26T06:38:48Z
Status	string	O status do arquivo de áudio ou vídeo. Para mais informações sobre os valores válidos e descrições, consulte Status: Status de áudio e vídeo.	Normal
VideoId	string	O ID do arquivo de áudio ou vídeo.	93ab850b4f654b6e91d24d81d44****
CoverURL	string	A URL da miniatura do áudio ou vídeo. Nota Se você precisar obter a URL da miniatura em tempo real após o envio de um vídeo, poderá configurar os callbacks do VOD. Para mais informações, consulte Callbacks HTTP e Evento de conclusão de snapshot.	http://example.aliyundoc.com/sample.jpg?auth_key=2333232-atb****
Duration	string	A duração do arquivo de áudio ou vídeo. Unidade: segundos.	3.1667
Title	string	O título do arquivo de áudio ou vídeo.	Alibaba Cloud VOD
MediaType	string	O tipo do arquivo de mídia. Valores válidos: video: vídeo. audio: apenas áudio.	video
DanMuURL	string	A URL dos dados de máscara de comentários ao vivo.	http://example.aliyundoc.com/**?auth_key=abdf2123-6783232**
StorageClass	string	A classe de armazenamento do ativo de mídia. Valores válidos: Standard: Padrão. IA: Acesso Infrequente. Archive: Arquivo. ColdArchive: Arquivo Frio. SourceIA: Acesso Infrequente para arquivos mezzanine. SourceArchive: Arquivo para arquivos mezzanine. SourceColdArchive: Arquivo Frio para arquivos mezzanine. Changing: A classe de armazenamento do ativo de mídia está sendo alterada. SourceChanging: A classe de armazenamento do arquivo mezzanine está sendo alterada.	Standard
PlayInfoList	object
PlayInfo	array<object>	As informações de reprodução sobre o arquivo de áudio ou vídeo, que incluem informações de fluxo.
	object	Os detalhes do arquivo de áudio ou vídeo.
CreationTime	string	A hora em que o fluxo foi criado. A hora segue o formato aaaa-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2022-04-18T07:37:15Z
Status	string	O status do fluxo de mídia. Valores válidos: Normal: O fluxo está no estado normal. Este estado marca o fluxo transcodificado mais recente para cada definição e formato. Invisible: O fluxo está no estado invisível. Quando existem vários fluxos transcodificados duplicados para uma definição e formato, apenas o fluxo mais recente é marcado como normal, e os outros fluxos são marcados como invisíveis.	Normal
Specification	string	A especificação de saída de transcodificação de vídeo. Para mais informações sobre os valores válidos e descrições, consulte Especificações de saída: Especificação.	H264.LD
NarrowBandType	string	O tipo de transcodificação. Valores válidos: 0: transcodificação regular. 1.0: transcodificação Narrowband HD 1.0. 2.0: transcodificação Narrowband HD 2.0.	0
Height	integer	A altura do fluxo de mídia. Unidade: pixels.	640
Bitrate	string	A taxa de bits do fluxo de mídia. Unidade: Kbit/s. Nota Devido ao recurso de fatiamento dinâmico de arquivos m3u8, o cálculo da taxa de bits pode ser impreciso.	450.878
ModificationTime	string	A hora em que o fluxo foi atualizado. A hora segue o formato aaaa-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2022-04-20T06:32:19Z
WatermarkId	string	O ID do modelo de marca d'água associado ao fluxo de mídia.	dgfn26457856****
Encrypt	integer	Indica se o fluxo de mídia está criptografado. Valores válidos: 0: não. 1: sim.	1
Definition	string	A definição do fluxo de vídeo. Valores válidos: FD: fluente. LD: baixa definição. SD: definição padrão. HD: alta definição. OD: definição original. 2K: 2K. 4K: 4K. SQ: qualidade de áudio padrão. HQ: alta qualidade de áudio. AUTO: taxa de bits adaptável.	LD
EncryptType	string	O tipo de criptografia do fluxo de mídia. Valores válidos: AliyunVoDEncryption: criptografia de vídeo do Alibaba Cloud. HLSEncryption: criptografia HLS. Nota Se o tipo de criptografia for AliyunVoDEncryption, o fluxo só poderá ser reproduzido usando o ApsaraVideo Player SDK.	AliyunVoDEncryption
EncryptMode	string	O modo de criptografia do fluxo de mídia. Valores válidos: License: modo de descriptografia local. Nota Se o modo de criptografia for License, o fluxo só poderá ser reproduzido usando o ApsaraVideo Player SDK.	License
StreamType	string	O tipo do fluxo de mídia. Valores válidos: video para fluxos de vídeo e audio para fluxos apenas de áudio.	video
JobId	string	O ID do trabalho de transcodificação para o fluxo de mídia. Este ID identifica exclusivamente o fluxo de mídia.	80e9c6580e754a798c3c19c59b16****
Size	integer	O tamanho do fluxo de mídia. Unidade: bytes. Nota Devido ao recurso de fatiamento dinâmico de arquivos m3u8, o cálculo do tamanho do fluxo de mídia pode ser impreciso.	418112
Width	integer	A largura do fluxo de mídia. Unidade: pixels.	360
Fps	string	A taxa de quadros do fluxo de mídia. Unidade: quadros por segundo.	25
Duration	string	A duração do fluxo de mídia. Unidade: segundos.	9.0464
PlayURL	string	A URL de reprodução do fluxo de vídeo.	https://example.aliyundoc.com/d52ee123f331466aabf6ab32a93d**/a777f9e24e6e47a2a942467d5c38ea37-8ee8e04293c6657fdda282bc422704**.m3u8
Format	string	O formato do fluxo de mídia. Valores válidos para arquivos de vídeo: mp4 e m3u8. Valor válido para arquivos apenas de áudio: mp3.	m3u8
HDRType	string	O tipo de HDR do fluxo de mídia. Valores válidos: HDR HDR10 HLG DolbyVision HDRVivid SDR+	HLG
BitDepth	integer	A profundidade de bits de cor. O valor é um número inteiro.	8
JobType	integer	O tipo da marca d'água digital. Valores válidos: 1: marca d'água de rastreamento. 2: marca d'água de direitos autorais.	2
JobExt	string	As informações personalizadas da marca d'água da marca d'água de direitos autorais. Este campo é retornado apenas quando JobType está definido como 2.	CopyrightMarkTest
CodecName	string	O codec. Valores válidos: H264 H265	H264

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "F552E596-967D-5500-842F-17E6364****",
  "VideoBase": {
    "CreationTime": "2017-06-26T06:38:48Z",
    "Status": "Normal",
    "VideoId": "93ab850b4f654b6e91d24d81d44****",
    "CoverURL": "http://example.aliyundoc.com/sample.jpg?auth_key=2333232-atb****",
    "Duration": "3.1667",
    "Title": "Alibaba Cloud VOD",
    "MediaType": "video",
    "DanMuURL": "http://example.aliyundoc.com/****?auth_key=abdf2123-6783232****",
    "StorageClass": "Standard"
  },
  "PlayInfoList": {
    "PlayInfo": [
      {
        "CreationTime": "2022-04-18T07:37:15Z",
        "Status": "Normal",
        "Specification": "H264.LD",
        "NarrowBandType": "0",
        "Height": 640,
        "Bitrate": "450.878",
        "ModificationTime": "2022-04-20T06:32:19Z",
        "WatermarkId": "dgfn26457856****",
        "Encrypt": 1,
        "Definition": "LD",
        "EncryptType": "AliyunVoDEncryption",
        "EncryptMode": "License",
        "StreamType": "video",
        "JobId": "80e9c6580e754a798c3c19c59b16****",
        "Size": 418112,
        "Width": 360,
        "Fps": "25",
        "Duration": "9.0464",
        "PlayURL": "https://example.aliyundoc.com/d52ee123f331466aabf6ab32a93d****/a777f9e24e6e47a2a942467d5c38ea37-8ee8e04293c6657fdda282bc422704****.m3u8",
        "Format": "m3u8",
        "HDRType": "HLG",
        "BitDepth": 8,
        "JobType": 2,
        "JobExt": "CopyrightMarkTest",
        "CodecName": "H264"
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.