O protocolo de pesquisa de mídia é um protocolo de busca em tempo real que integra recuperação, filtragem, classificação e paginação. Use este protocolo para consultar informações sobre ativos de mídia, como vídeos, áudios e imagens no ApsaraVideo VOD. Este tópico descreve a sintaxe do protocolo de pesquisa de ativos de mídia no ApsaraVideo VOD. Utilize o protocolo em conjunto com a operação SearchMedia. Configure o parâmetro Match para consultar ativos de mídia com base em campos de retorno, campos de correspondência exata, campos de correspondência difusa, campos de consulta de múltiplos valores, campos de consulta de intervalo e campos de ordenação.
Sintaxe
Os campos de ativos de mídia dividem-se nas seguintes categorias, conforme as regras de sintaxe do protocolo de pesquisa: campos de retorno, campos de correspondência exata, campos de correspondência difusa, campos de consulta de múltiplos valores, campos de consulta de intervalo e campos de ordenação. Para obter mais informações sobre todos os campos de ativos de mídia compatíveis com o ApsaraVideo VOD e as regras de sintaxe aplicáveis, consulte Informações sobre ativos de mídia.
Ao chamar a operação SearchMedia para consultar informações de ativos de mídia, aplique a codificação URL na instrução de consulta. Além disso, utilize sinais de pontuação de byte único, como sinais de igual (=), aspas duplas ("), aspas simples (') e parênteses () na instrução de consulta. Para mais detalhes sobre caracteres especiais definidos no protocolo de pesquisa de ativos de mídia, consulte Caracteres especiais.
Caso utilize outros métodos de consulta para um campo que aceita correspondência exata e difusa, os resultados retornados seguirão os métodos suportados por esse campo. Por exemplo, se um campo oferecer suporte apenas à correspondência difusa, os resultados obtidos por meio de consultas de múltiplos valores também serão retornados com base na correspondência difusa.
A tabela a seguir descreve a sintaxe definida no protocolo de pesquisa de ativos de mídia e fornece exemplos de busca.
|
Categoria |
Descrição |
Sintaxe |
Exemplo |
|
Campo de retorno |
Define os campos a incluir nos resultados da pesquisa. Por padrão, apenas o ID, o horário de criação e o tipo de cada ativo de mídia são retornados. |
field1,field2 |
|
|
Campo de correspondência exata |
Busca os ativos de mídia cujo valor de um campo específico corresponde exatamente ao termo pesquisado. |
field = value |
|
|
Campo de correspondência difusa |
Recupera informações sobre ativos de mídia cujo valor em um campo especificado contém os caracteres ou strings indicados. |
field in ('value1','value2') or field = 'value' |
|
|
Campo de consulta de múltiplos valores |
Localiza ativos de mídia que correspondem a qualquer um dos valores de um campo especificado. Se os campos usados na consulta suportarem apenas correspondência difusa, os resultados também serão retornados com base nesse método. |
field in ('value1','value2') |
|
|
Campo de consulta de intervalo |
Identifica ativos de mídia cujo valor de um campo específico está dentro de um intervalo aberto ou fechado definido. |
field = (value1,value2) |
|
|
Campos de ordenação |
Determina os campos e a ordem (ascendente ou descendente) para classificar os resultados da pesquisa. Múltiplos campos de ordenação aparecem da esquerda para a direita, seguindo a prioridade decrescente. |
SortBy = field:Desc |
Caracteres especiais
|
Caractere |
Descrição |
Sintaxe |
|
and |
Conecta duas condições de filtro para buscar ativos de mídia que atendam a ambas simultaneamente. |
field1 = 'value' and field2 = 'value' |
|
or |
Une duas condições de filtro para recuperar ativos de mídia que satisfaçam pelo menos uma delas. Ao usar o operador OR na instrução de consulta, envolva as condições entre parênteses (). |
(field1 = 'value1' or field2 = 'value2') |
|
( ) |
Delimita um intervalo aberto ou fechado especificado para uma consulta de intervalo. |
field = ('value1','value2') |
|
( ) |
Agrupa múltiplas condições de filtro com relação OR. |
(field1 = 'value1' or field2 = 'value2') |
|
' ' |
Envolve valores de campo do tipo STRING. |
field = 'value' |
|
, |
Separa múltiplos valores de campo em uma consulta de múltiplos valores. Utilize vírgulas (,) para essa separação. |
field in ('value1','value2') |
|
( ) [ ] |
Define um intervalo aberto ou fechado para consultas de intervalo. Permite incluir ou excluir os limites esquerdo e direito do intervalo. |
field = ['value1','value2'] |
|
in |
Especifique múltiplos valores para um campo em uma consulta de múltiplos valores, buscando ativos de mídia que correspondam a qualquer um desses valores. |
field in ('value1','value2') |
Informações sobre ativos de mídia
O ApsaraVideo VOD permite consultar informações sobre arquivos de vídeo, áudio e imagem especificados, além de ativos de mídia auxiliares. As tabelas a seguir descrevem as regras de sintaxe aplicáveis aos diversos campos de ativos de mídia. O símbolo √ indica que o campo é suportado, enquanto × indica que não há suporte.
Especifique no máximo três valores para consultas de múltiplos valores. Valores excedentes serão ignorados.
Cada string para correspondência difusa pode ter até 60 caracteres.
Se não for possível obter uma correspondência precisa na pesquisa difusa usando o campo Title combinado com outro campo, verifique se há erros de formato na sua instrução. Exemplo de pesquisa difusa:
(Title = 'Test' and Description = 'Description').Quando os campos suportam apenas correspondência difusa, os resultados das consultas de múltiplos valores também seguem essa lógica de correspondência.
Vídeo: informações sobre um vídeo
|
Campo |
Tipo |
Descrição |
Usado como campo de retorno |
Usado para correspondência exata |
Usado para correspondência difusa |
Usado para consulta de múltiplos valores |
Usado para consulta de intervalo |
Usado como campo de ordenação |
|
VideoId |
String |
O ID do vídeo. |
✓ |
✓ |
× |
✓ |
× |
× |
|
AppId |
String |
O ID do aplicativo. |
✓ |
× |
× |
✓ |
× |
× |
|
CateId |
Long |
O ID da categoria à qual o vídeo pertence. |
✓ |
✓ |
× |
× |
× |
× |
|
CateName |
String |
O nome da categoria à qual o vídeo pertence. |
✓ |
× |
× |
× |
× |
× |
|
StorageLocation |
String |
A região onde o vídeo está armazenado. |
✓ |
✓ |
× |
✓ |
× |
× |
|
Title |
String |
O título do vídeo. |
✓ |
× |
✓ |
× |
× |
× |
|
Tags |
String |
As tags do vídeo. |
✓ |
× |
✓ |
✓ |
× |
× |
|
Description |
String |
A descrição do vídeo. |
✓ |
× |
✓ |
× |
× |
× |
|
Status |
String |
✓ |
× |
× |
✓ |
× |
× |
|
|
MediaSource |
String |
✓ |
× |
× |
✓ |
× |
× |
|
|
PreprocessStatus |
String |
✓ |
× |
× |
✓ |
× |
× |
|
|
Size |
Long |
O tamanho do vídeo. |
✓ |
× |
× |
× |
✓ |
× |
|
Duration |
Float |
A duração do vídeo. |
✓ |
× |
× |
× |
✓ |
× |
|
CreationTime |
String |
O horário de criação do vídeo. |
✓ |
× |
× |
× |
✓ |
✓ |
|
ModificationTime |
String |
O horário da última atualização do vídeo. |
✓ |
× |
× |
× |
✓ |
✓ |
|
CoverURL |
String |
A URL da miniatura. |
✓ |
× |
× |
× |
× |
× |
|
Snapshots |
String[] |
A lista de snapshots automáticos. |
✓ |
× |
× |
× |
× |
× |
|
SpriteSnapshots |
String[] |
A lista de sprites de imagem. |
✓ |
× |
× |
× |
× |
× |
|
DownloadSwitch |
String |
✓ |
× |
× |
× |
× |
× |
|
|
TranscodeMode |
String |
✓ |
× |
× |
× |
× |
× |
|
|
StorageClass |
String |
✓ |
× |
× |
✓ |
× |
× |
Áudio: informações sobre um arquivo de áudio
|
Campo |
Tipo |
Descrição |
Usado como campo de retorno |
Usado para correspondência exata |
Usado para correspondência difusa |
Usado para consulta de múltiplos valores |
Usado para consulta de intervalo |
Usado como campo de ordenação |
|
AudioId |
String |
O ID do áudio. |
✓ |
✓ |
× |
× |
× |
× |
|
AppId |
String |
O ID do aplicativo. |
✓ |
× |
× |
✓ |
× |
× |
|
CateId |
Long |
O ID da categoria à qual o áudio pertence. |
✓ |
✓ |
× |
× |
× |
× |
|
CateName |
String |
O nome da categoria à qual o áudio pertence. |
✓ |
× |
× |
× |
× |
× |
|
StorageLocation |
String |
A região onde o áudio está armazenado. |
✓ |
× |
× |
✓ |
× |
× |
|
Title |
String |
O título do áudio. |
✓ |
× |
✓ |
× |
× |
× |
|
Tags |
String |
As tags do áudio. |
✓ |
× |
✓ |
✓ |
× |
× |
|
Description |
String |
A descrição do áudio. |
✓ |
× |
✓ |
× |
× |
× |
|
Status |
String |
✓ |
× |
× |
✓ |
× |
× |
|
|
MediaSource |
String |
✓ |
× |
× |
✓ |
× |
× |
|
|
PreprocessStatus |
String |
✓ |
× |
× |
✓ |
× |
× |
|
|
Size |
Long |
O tamanho do áudio. |
✓ |
× |
× |
× |
✓ |
× |
|
Duration |
Float |
A duração do áudio. |
✓ |
× |
× |
× |
✓ |
× |
|
CreationTime |
String |
O horário de criação do áudio. |
✓ |
× |
× |
× |
✓ |
✓ |
|
ModificationTime |
String |
O horário da última atualização do áudio. |
✓ |
× |
× |
× |
✓ |
✓ |
|
CoverURL |
String |
A URL da miniatura. |
✓ |
× |
× |
× |
× |
× |
|
Snapshots |
String[] |
A lista de snapshots automáticos. |
✓ |
× |
× |
× |
× |
× |
|
SpriteSnapshots |
String[] |
A lista de sprites de imagem. |
✓ |
× |
× |
× |
× |
× |
|
DownloadSwitch |
String |
✓ |
× |
× |
× |
× |
× |
|
|
TranscodeMode |
String |
✓ |
× |
× |
× |
× |
× |
|
|
StorageClass |
String |
✓ |
× |
× |
✓ |
× |
× |
Imagem: informações sobre uma imagem
|
Campo |
Tipo |
Descrição |
Usado como campo de retorno |
Usado para correspondência exata |
Usado para correspondência difusa |
Usado para consulta de múltiplos valores |
Usado para consulta de intervalo |
Usado como campo de ordenação |
|
ImageId |
String |
O ID da imagem. |
✓ |
✓ |
× |
× |
× |
× |
|
AppId |
String |
O ID do aplicativo. |
✓ |
× |
× |
✓ |
× |
× |
|
CateId |
Long |
O ID da categoria à qual a imagem pertence. |
✓ |
✓ |
× |
× |
× |
× |
|
CateName |
String |
O nome da categoria à qual a imagem pertence. |
✓ |
× |
× |
× |
× |
× |
|
StorageLocation |
String |
A região onde a imagem está armazenada. |
✓ |
✓ |
× |
✓ |
× |
× |
|
FileName |
String |
O nome do arquivo da imagem. |
✓ |
× |
✓ |
× |
× |
× |
|
Title |
String |
O título da imagem. |
✓ |
× |
✓ |
× |
× |
× |
|
Tags |
String |
As tags da imagem. |
✓ |
× |
✓ |
✓ |
× |
× |
|
Description |
String |
A descrição da imagem. |
✓ |
× |
✓ |
× |
× |
× |
|
Status |
String |
✓ |
× |
× |
✓ |
× |
× |
|
|
CreationTime |
String |
O horário de criação da imagem. |
✓ |
× |
× |
× |
✓ |
✓ |
|
ModificationTime |
String |
O horário da última atualização da imagem. |
✓ |
× |
× |
× |
✓ |
✓ |
|
URL |
String |
A URL da imagem. |
✓ |
× |
× |
× |
× |
× |
AttachedMedia: informações sobre um ativo de mídia auxiliar
|
Campo |
Tipo |
Descrição |
Usado como campo de retorno |
Usado para correspondência exata |
Usado para correspondência difusa |
Usado para consulta de múltiplos valores |
Usado para consulta de intervalo |
Usado como campo de ordenação |
|
MediaId |
String |
O ID do ativo de mídia auxiliar. |
✓ |
✓ |
× |
× |
× |
× |
|
AppIdString |
String |
O ID do aplicativo. |
✓ |
× |
× |
✓ |
× |
× |
|
CateId |
Long |
O ID da categoria à qual o ativo de mídia auxiliar pertence. |
× |
✓ |
× |
× |
× |
× |
|
Categories |
Category[] |
A lista de IDs de categoria. |
✓ |
× |
× |
× |
× |
× |
|
StorageLocation |
String |
A região onde o ativo de mídia auxiliar está armazenado. |
✓ |
✓ |
× |
✓ |
× |
× |
|
FileName |
String |
O nome do arquivo do ativo de mídia auxiliar. |
✓ |
× |
✓ |
× |
× |
× |
|
Title |
String |
O título do ativo de mídia auxiliar. |
✓ |
× |
✓ |
× |
× |
× |
|
Tags |
String |
As tags do ativo de mídia auxiliar. |
✓ |
× |
✓ |
✓ |
× |
× |
|
Description |
String |
A descrição do ativo de mídia auxiliar. |
✓ |
× |
✓ |
× |
× |
× |
|
Status |
String |
✓ |
× |
× |
✓ |
× |
× |
|
|
CreationTime |
String |
O horário de criação do ativo de mídia auxiliar. |
✓ |
× |
× |
× |
✓ |
✓ |
|
ModificationTime |
String |
O horário da última atualização do ativo de mídia auxiliar. |
✓ |
× |
× |
× |
✓ |
✓ |
|
URL |
String |
A URL do ativo de mídia auxiliar. |
✓ |
× |
× |
× |
× |
× |
|
BusinessType |
String |
O tipo de negócio. |
✓ |
✓ |
× |
× |
× |
× |
Descrição dos parâmetros
PreprocessStatus: o status de pré-processamento de um ativo de mídia
Apenas ativos de mídia pré-processados podem ser utilizados para transmissão ao vivo em um estúdio de produção.
|
Valor |
Descrição |
Observações |
|
UnPreprocess |
O ativo de mídia não foi pré-processado. |
Estado inicial. |
|
Preprocessing |
O ativo de mídia está em pré-processamento. |
- |
|
PreprocessSucceed |
O pré-processamento foi concluído com sucesso. |
- |
|
PreprocessFailed |
Falha no pré-processamento. |
- |
DownloadSwitch: se o download offline está ativado para um ativo de mídia
Um ativo de mídia só pode ser baixado no modo offline quando o download offline estiver ativado.
|
Valor |
Descrição |
Observações |
|
on |
O download offline está ativado. |
Estado inicial. O ativo de mídia pode ser baixado no modo offline. |
|
off |
O download offline está desativado. |
Se o download offline estiver desativado, o ativo de mídia não poderá ser baixado no modo offline. |
MediaSource: a origem de um ativo de mídia
|
Valor |
Descrição |
Observações |
|
general |
O ativo de mídia foi enviado para o ApsaraVideo VOD pelo console. |
Modo de upload simples. |
|
short_video |
O envio do ativo para o ApsaraVideo VOD ocorreu via SDK de vídeo curto. |
Para mais informações, consulte Visão geral. |
|
editing |
O ativo foi carregado no ApsaraVideo VOD mediante a criação de uma tarefa de produção de vídeo. |
Para mais detalhes, veja ProduceEditingProjectVideo. |
|
live |
O ativo de mídia foi enviado ao ApsaraVideo VOD como uma gravação ao vivo. |
Nenhuma. |
TranscodeMode: o modo de transcodificação de um ativo de mídia
Após o envio de um ativo de mídia para o ApsaraVideo VOD, a reprodução só é possível depois do processamento. Os métodos de processamento variam conforme os modos de transcodificação.
|
Valor |
Descrição |
Observações |
|
FastTranscode |
Transcodificação padrão. |
Modo padrão. O ativo de mídia é transcodificado imediatamente após o envio para o ApsaraVideo VOD. A reprodução só é permitida após a transcodificação. |
|
NoTranscode |
Distribuição sem transcodificação |
Ativos de mídia nos formatos MP4, FLV, M3U8, MP3 e WEBM podem ser reproduzidos instantaneamente após o envio para o ApsaraVideo VOD, sem necessidade de transcodificação. |
|
AsyncTranscode |
Distribuição imediata e transcodificação pós-upload |
Após o envio para o ApsaraVideo VOD, o ativo de mídia pode ser reproduzido imediatamente e transcodificado de forma assíncrona. |
StorageClass: a classe de armazenamento de um ativo de mídia
|
Valor |
Descrição |
Observações |
|
Standard |
Classe de armazenamento Standard |
Todos os recursos de mídia, incluindo arquivos source e fluxos transcodificados, são armazenados como objetos Standard. Recursos como snapshots não são armazenados como objetos Standard. |
|
IA |
Classe de armazenamento de acesso pouco frequente (IA) |
Todos os recursos de mídia, incluindo arquivos source e fluxos transcodificados, são armazenados como objetos IA. Recursos como snapshots não são armazenados como objetos IA. |
|
Archive |
Classe de armazenamento Archive |
Todos os recursos de mídia, incluindo arquivos source e fluxos transcodificados, são armazenados como objetos Archive. Recursos como snapshots não são armazenados como objetos Archive. |
|
ColdArchive |
Classe de armazenamento Cold Archive |
Todos os recursos de mídia, incluindo arquivos source e fluxos transcodificados, são armazenados como objetos Cold Archive. Recursos como snapshots não são armazenados como objetos Cold Archive. |
|
SourceIA |
Armazenamento IA para arquivos source |
Apenas os arquivos source são objetos IA. Outros recursos além dos arquivos source são armazenados como objetos Standard. |
|
SourceArchive |
Armazenamento Archive para arquivos source |
Somente os arquivos source são objetos Archive. Recursos distintos dos arquivos source permanecem como objetos Standard. |
|
SourceColdArchive |
Armazenamento Cold Archive para arquivos source |
Exclusivamente os arquivos source são objetos Cold Archive. Demais recursos são mantidos como objetos Standard. |
|
Changing |
Alteração da classe de armazenamento de recursos de mídia |
A classe de armazenamento dos recursos de mídia está sendo modificada. |
|
SourceChanging |
Alteração da classe de armazenamento do arquivo source |
A classe de armazenamento do arquivo source está em processo de mudança. |