Este tópico descreve os tipos de dados básicos da API do ApsaraVideo VOD.
Informações básicas de ativos de mídia
Video: informações de áudio e vídeo
|
Nome |
Tipo |
Descrição |
|
VideoId |
String |
O ID do áudio ou vídeo. |
|
Title |
String |
O título do áudio ou vídeo. |
|
Description |
String |
A descrição do áudio ou vídeo. |
|
Duration |
Float |
A duração do áudio ou vídeo. Unidade: segundos. |
|
CoverURL |
String |
A URL da miniatura do áudio ou vídeo. |
|
String |
O status do áudio ou vídeo. Para mais informações, consulte Status: o status de um arquivo de áudio ou vídeo. |
|
|
CreationTime |
String |
A hora em que o áudio ou vídeo foi criado. A hora deve estar em UTC. |
|
Size |
Long |
O tamanho do arquivo source. Unidade: bytes. |
|
Snapshots |
String[] |
As URLs dos snapshots do vídeo. |
|
CateId |
Long |
O ID da categoria do áudio ou vídeo. |
|
CateName |
String |
O nome da categoria do áudio ou vídeo. |
|
Tags |
String |
As tags do áudio ou vídeo. Separe várias tags com vírgulas (,). |
|
TemplateGroupId |
String |
O ID do grupo de modelos de transcodificação usado para transcodificar arquivos de áudio ou vídeo. |
|
StorageLocation |
String |
O endereço de armazenamento do arquivo de áudio ou vídeo. |
|
String |
O ID do aplicativo. |
Status: Status de áudio e vídeo
Valor | Descrição | Observações |
Uploading | Fazendo upload |
|
UploadFail | Falha no upload |
|
UploadSucc | Upload concluído |
|
Transcoding | Transcodificando | Arquivos de mídia neste status estão sendo transcodificados. Se um vídeo estiver passando pela transcodificação inicial, nenhum stream de reprodução válido estará disponível, e você não pode chamar operações da API para obter URLs de reprodução. Você pode determinar o status da transcodificação usando as notificações de evento Single Definition Transcoding Complete ou Transcode complete. |
TranscodeFail | Falha na transcodificação | Falhas na transcodificação geralmente são causadas por erros no arquivo source. Você pode obter a mensagem de erro na notificação de evento Single Definition Transcoding Complete ou Transcode complete. Para mais informações sobre como solucionar problemas de falhas de transcodificação, consulte FAQ sobre transcodificação. |
Checking | Em revisão |
Nota Note que o status Reviewing aqui descreve o status do arquivo de áudio ou vídeo (visível na coluna Status em ApsaraVideo VOD console > Media Assets > Audio/Video). Isso difere do status Reviewing para moderação assistida por máquina (visível em ApsaraVideo VOD console > Review Management > Video Review). O status Reviewing de moderação assistida por máquina descreve apenas o status do trabalho de revisão por máquina, enquanto o status Reviewing do arquivo de áudio ou vídeo descreve os status dos trabalhos de revisão assistida por máquina e manual. |
Blocked | Bloqueado |
|
Normal | Normal |
|
ProduceFail | Falha na síntese | Isso indica que a produção do corte de vídeo falhou. Ao usar a edição online do ApsaraVideo VOD para a produção de cortes de vídeo, certifique-se de que todos os ativos de mídia usados estejam no status Normal. Caso contrário, a produção do vídeo pode falhar. |
ImageInfo: Informações da imagem
|
Nome |
Tipo |
Descrição |
|
ImageId |
String |
O ID da imagem. |
|
URL |
String |
A URL da imagem. Se um nome de domínio acelerado estiver configurado, uma URL do CDN será retornada. Caso contrário, uma URL do Object Storage Service (OSS) será retornada. |
|
Title |
String |
O título da imagem. |
|
Tags |
String |
As tags da imagem. |
|
ImageType |
String |
O tipo da imagem. |
|
CateId |
Long |
O ID da categoria. |
|
CateName |
String |
O nome da categoria. |
|
Description |
String |
Descrição. |
|
StorageLocation |
String |
Endereço de armazenamento. |
|
Mezzanine |
As informações source sobre a imagem. |
|
|
CreationTime |
String |
A hora em que a imagem foi criada. A hora está em UTC. |
|
String |
O status da imagem. Para mais informações, consulte Status: o status de uma imagem. |
|
|
String |
O ID do aplicativo. |
Status: o status de uma imagem
|
Valor |
Descrição |
Observações |
|
Uploading |
Fazendo upload |
Este é o status inicial da imagem, indicando que ela está sendo enviada. Se suas imagens permanecerem neste status por um longo período, consulte Por que meus arquivos enviados estão sempre no status de upload?. |
|
UploadFail |
Falha ao enviar a imagem. |
Os uploads podem falhar devido a problemas de rede ou corrupção do arquivo source. Tente novamente ou envie um arquivo source diferente. |
|
Normal |
Normal |
Upload da imagem bem-sucedido. |
AttachedMediaInfo: as informações sobre um ativo de mídia auxiliar
|
Nome |
Tipo |
Descrição |
|
MediaId |
String |
O ID do ativo de mídia auxiliar. |
|
URL |
String |
A URL do ativo de mídia auxiliar. Se um nome de domínio para CDN for especificado, uma URL do CDN será retornada. Caso contrário, uma URL do OSS será retornada. |
|
Title |
String |
Título. |
|
Tags |
String |
Tag. |
|
Type |
String |
O tipo do ativo de mídia auxiliar. |
|
Categories |
Category[] |
As categorias. |
|
Description |
String |
Descrição |
|
StorageLocation |
String |
Endereço de armazenamento. |
|
CreationTime |
String |
A hora em que o ativo de mídia auxiliar foi criado. A hora deve estar em UTC. |
|
ModificationTime |
String |
A hora em que o ativo de mídia auxiliar foi modificado pela última vez. A hora deve estar em UTC. |
|
String |
O status do ativo de mídia auxiliar. Para mais informações, consulte Status: Status do ativo de mídia auxiliar. |
|
|
String |
O ID do aplicativo. |
Status: o status de um ativo de mídia auxiliar
|
Valor |
Descrição |
Explicação |
|
Uploading |
Fazendo upload |
O status inicial. O ativo de mídia auxiliar está sendo enviado. |
|
Normal |
Normal |
O ativo de mídia auxiliar foi enviado com sucesso. |
|
UploadFail |
Falha |
O upload do ativo de mídia auxiliar falhou. |
Informações do arquivo de recursos de mídia
Mezzanine: Informações do arquivo source de áudio e vídeo
Nome | Tipo | Descrição |
VideoId | String | O ID do vídeo. |
FileName | String | O nome do arquivo. |
Duration | String | A duração do arquivo em segundos. |
Status | String | O status do arquivo source. Para mais informações, consulte Status: Status de um arquivo source de áudio ou vídeo. |
CreationTime | String | A hora em que o arquivo foi criado. A hora está em UTC. |
Height | Long | A altura do arquivo em pixels (px). |
Width | Long | A largura do arquivo em pixels (px). |
Fps | String | A taxa de quadros do arquivo em quadros por segundo (fps). |
FileURL | String | A URL do arquivo. |
Bitrate | String | A taxa de bits do arquivo em Kbps. |
Size | Long | O tamanho do arquivo em bytes. |
OutputType | String | O tipo do arquivo de saída. Valores válidos:
|
VideoStreamList | Uma lista de informações de stream de vídeo. | |
AudioStreamList | Uma lista de informações de stream de áudio. |
VideoStream: Informações do stream de vídeo
|
Nome |
Tipo |
Descrição |
|
Index |
String |
O número ordinal do stream de vídeo. Isso identifica a posição do stream de vídeo no stream de mídia. |
|
CodecName |
String |
O nome curto do formato de codificação. |
|
CodecLongName |
String |
O nome longo do formato de codificação. |
|
Profile |
String |
O perfil do codec. |
|
CodecTimeBase |
String |
A base de tempo do codec. |
|
CodecTagString |
String |
O texto da tag do formato de codificação. |
|
CodecTag |
String |
A tag do formato de codificação. |
|
Width |
Long |
A largura da resolução do vídeo. |
|
Height |
Long |
A altura da resolução do vídeo. |
|
HasBFrames |
String |
Indica se o stream possui B-frames. |
|
Sar |
String |
Proporção de aspecto da amostra do sinal codificado. |
|
Dar |
String |
A proporção de aspecto de exibição (DAR). |
|
PixFmt |
String |
O formato de pixel. |
|
Level |
String |
O nível de codificação. |
|
Fps |
String |
A taxa de quadros de destino. |
|
AvgFPS |
String |
A taxa média de quadros. |
|
Timebase |
String |
A base de tempo. |
|
StartTime |
String |
A hora de início. |
|
Duration |
String |
A duração. |
|
NumFrames |
String |
O número total de quadros. |
|
Lang |
String |
O idioma. |
|
Rotate |
String |
O ângulo de rotação do vídeo. O valor deve estar no intervalo de [0, 360). |
AudioStream: Informações do stream de áudio
|
Nome |
Tipo |
Descrição |
|
Index |
String |
O número ordinal do stream de áudio. Isso identifica a posição do stream de áudio no stream de mídia. |
|
CodecName |
String |
O nome curto do formato de codificação. |
|
CodecLongName |
String |
O nome longo do formato de codificação. |
|
CodecTimeBase |
String |
A base de tempo do codec. |
|
CodecTagString |
String |
O texto da tag do formato de codificação. |
|
CodecTag |
String |
A tag do formato de codificação. |
|
SampleFmt |
String |
O formato de amostragem. |
|
SampleRate |
String |
A taxa de amostragem. |
|
Channels |
String |
O número de canais de som. |
|
ChannelLayout |
String |
O layout dos canais de som. |
|
Timebase |
String |
A base de tempo. |
|
StartTime |
String |
A hora de início. |
|
Duration |
String |
A duração. |
|
Bitrate |
String |
A taxa de bits. |
|
NumFrames |
String |
O número total de quadros. |
|
Lang |
String |
O idioma. |
Status: Status de um arquivo source de áudio ou vídeo
|
Valor |
Descrição |
Observações |
|
Uploading |
Fazendo upload |
O estado inicial do arquivo. Indica que o arquivo está sendo enviado. |
|
Normal |
Normal |
O arquivo foi enviado com sucesso. |
|
UploadFail |
Falha |
O upload do arquivo falhou. |
|
Deleted |
Excluído |
O arquivo foi excluído. |
Mezzanine: Informações do arquivo source da imagem
|
Nome |
Tipo |
Descrição |
|
FileURL |
String |
A URL do OSS da imagem. |
|
OriginalFileName |
String |
O nome do arquivo enviado. |
|
FileSize |
Long |
O tamanho do arquivo em bytes. |
|
Width |
Integer |
A largura da imagem em pixels (px). |
|
Height |
Integer |
A altura da imagem em pixels (px). |
Envie vários arquivos de mídia em lote com base em URLs
URLUploadInfo: as informações sobre um trabalho de upload baseado em URL
|
Nome |
Tipo |
Descrição |
|
JobId |
String |
O ID do trabalho de upload. |
|
UploadURL |
String |
A URL do arquivo a ser enviado. |
|
MediaId |
String |
O ID do arquivo a ser enviado. |
|
FileSize |
String |
O tamanho do arquivo a ser enviado. Unidade: bytes. |
|
String |
O status do trabalho de upload baseado em URL. Para mais informações sobre este parâmetro, consulte Status: o status de um trabalho de upload baseado em URL. |
|
|
CreationTime |
String |
A hora em que o trabalho foi criado. |
|
CompleteTime |
Long |
A hora em que o trabalho foi concluído. |
|
UserData |
String |
Um campo definido pelo usuário. |
|
ErrorCode |
String |
Código de erro |
|
ErrorMessage |
String |
Mensagem de erro. |
Status: o status de um trabalho de upload baseado em URL
|
Valor |
Descrição |
|
PENDING |
O trabalho de upload foi enviado e está aguardando processamento. |
|
PROCESSING |
Você pode iniciar o processamento da tarefa. |
|
DOWNLOADING |
O arquivo está sendo baixado. |
|
DOWNLOAD_SUCCESS |
O arquivo foi baixado. |
|
DOWNLOAD_FAIL |
O download do arquivo falhou. |
|
UPLOADING |
O arquivo está sendo enviado. |
|
UPLOAD_SUCCESS |
O arquivo foi enviado. |
|
UPLOAD_FAIL |
O upload do arquivo falhou. |
|
SUCCESS |
O trabalho de upload foi bem-sucedido e o callback foi concluído. |
Reprodução de vídeo e áudio
VideoBase: Informações básicas do vídeo
Nome | Tipo | Descrição |
VideoId | String | ID do vídeo |
Title | String | Título do vídeo |
Duration | String | A duração do vídeo em segundos. |
CoverURL | String | Miniatura do vídeo. |
String | O status do arquivo de vídeo ou áudio. | |
CreationTime | String | A hora em que o arquivo de vídeo ou áudio foi criado. A hora está em UTC. |
MediaType | MediaType | O tipo do arquivo de mídia. Valores válidos:
|
Por padrão, a operação da API de reprodução retorna uma URL acelerada por CDN. Se um nome de domínio não estiver configurado, a operação da API retorna uma URL de origem do OSS. Nesse caso, apenas URLs de arquivos MP4 podem ser usadas para reprodução.
PlayInfo: Informações de reprodução para um stream de mídia
Nome | Tipo | Descrição |
Bitrate | String | A taxa de bits do stream de mídia, em Kbps. |
Definition | String | A definição do stream de mídia. Valores válidos:
|
Specification | String | As especificações de saída para transcodificação de vídeo e áudio. Para mais informações, consulte Especificações de saída. |
Duration | String | A duração do stream de mídia, em segundos. |
Encrypt | Long | Indica se o stream de mídia é criptografado. Valores válidos:
|
EncryptType | String | O tipo de criptografia do stream de mídia. Valores válidos:
|
PlayURL | String | A URL de reprodução do stream de mídia. |
Format | String | O formato do stream de mídia. Se o arquivo de mídia for um vídeo, os valores válidos são:
Se o arquivo de mídia for apenas de áudio, o valor válido é mp3. |
Fps | String | A taxa de quadros do stream de mídia, em quadros por segundo (fps). |
Size | Long | O tamanho do stream de mídia, em bytes. |
Width | Long | A largura do stream de mídia, em pixels (px). |
Height | Long | A altura do stream de mídia, em pixels (px). |
StreamType | String | O tipo do stream de mídia.
|
JobId | String | O ID do trabalho de transcodificação para o stream de mídia. Este ID é o identificador exclusivo do stream de mídia. |
WatermarkId | String | O ID da marca d'água associada ao stream de mídia. |
Status | String | O status do stream de mídia. Valores válidos:
|
NarrowBandType | String | O tipo de Narrowband HD. Valores válidos:
Este parâmetro só tem efeito quando uma definição do modelo de transcodificação integrado Narrowband HD 1.0 é configurada. Para mais informações, consulte TranscodeTemplate: Configurações do modelo de transcodificação. |
CreationTime | String | A hora em que o stream foi criado. A hora está em UTC. |
ModificationTime | String | A hora em que o stream foi atualizado pela última vez. A hora está em UTC. |
VideoMeta: Metadados do vídeo
|
Nome |
Tipo |
Descrição |
|
VideoId |
String |
O ID do vídeo. |
|
Title |
String |
O título do vídeo. |
|
Duration |
Float |
A duração do vídeo, em segundos. |
|
CoverURL |
String |
Miniatura do vídeo. |
|
String |
O status do vídeo. |
Consultar ativos de mídia
Media: informações sobre um ativo de mídia
Nome | Tipo | Descrição |
MediaId | String | O ID do ativo de mídia. |
CreationTime | String | A hora de criação do ativo de mídia. O horário deve estar em UTC. |
MediaType | String | O tipo do ativo de mídia. Valores válidos:
|
Video | As informações sobre o vídeo. | |
Audio | As informações sobre o áudio. | |
Image | As informações sobre a imagem. | |
AttachedMedia | As informações sobre o ativo de mídia auxiliar. |
Categorias de ativos de mídia
Category: classificação de ativos de mídia
|
Nome |
Tipo |
Descrição |
|
CateId |
Long |
O ID da categoria. |
|
CateName |
String |
O nome da categoria. O valor pode ter até 64 bytes e deve ser codificado no formato UTF-8. |
|
ParentId |
Long |
O ID da categoria pai. O ID da categoria pai de uma categoria de nível 1 é -1. |
|
Level |
Long |
O nível da categoria. O valor 0 indica uma categoria de nível 1. |
Live to VOD
LiveRecordVideo: informações sobre a gravação de Live to VOD
|
Nome |
Tipo |
Descrição |
|
StreamName |
String |
O nome da transmissão ao vivo. |
|
DomainName |
String |
O nome do domínio. |
|
AppName |
String |
O nome do aplicativo. |
|
PlaylistId |
String |
O ID da lista de reprodução. |
|
RecordStartTime |
String |
A hora de início da gravação. |
|
RecordEndTime |
String |
A hora de término da gravação. |
|
Video |
Video |
As informações do vídeo. |
Edição online
EditingProject: projeto de edição online
|
Nome |
Tipo |
Descrição |
|
ProjectId |
String |
O ID do projeto de edição online. |
|
Title |
String |
O título do projeto de edição online. |
|
CreationTime |
String |
A hora de criação do projeto de edição online. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e é exibido em UTC. Por exemplo, o valor 2017-01-11T12:00:00Z indica 20:00:00 de 11 de janeiro de 2017, no horário de Pequim (UTC+8). |
|
ModifiedTime |
String |
A hora da última modificação do projeto de edição online. O horário está em UTC, no formato yyyy-MM-ddTHH:mm:ssZ. Por exemplo, 2017-01-11T12:00:00Z (que corresponde a 20:00:00 de 11 de janeiro de 2017, UTC+8). |
|
Status |
String |
O status do projeto de edição online. |
|
Description |
String |
A descrição do projeto de edição online. |
|
Timeline |
String |
A linha do tempo do projeto de edição online. O valor é uma string JSON. |
|
Duration |
String |
A duração total do projeto de edição online. Deve ser igual à duração total da linha do tempo. |
|
CoverURL |
String |
A URL da miniatura do projeto de edição online. |
ProjectStatus: status do projeto de edição online
|
Valor |
Descrição |
Observações |
|
Normal |
Rascunho |
Este é o status inicial de um projeto de edição online. |
|
Producing |
Renderizando |
Nenhuma. |
|
Produced |
A produção do vídeo foi bem-sucedida. |
Nenhuma. |
|
ProduceFailed |
Falha na síntese. |
Nenhuma. |
Material: informações de material para um projeto de edição online
Este tipo refere-se amplamente a materiais, incluindo tanto os materiais do módulo Material Management quanto os vídeos da Media Library.
|
Nome |
Tipo |
Descrição |
|
MaterialId |
String |
O ID do material. |
|
Title |
String |
O título do material. |
|
Description |
String |
A descrição do material. |
|
Duration |
Float |
A duração do material em segundos. O valor tem precisão de quatro casas decimais. |
|
CoverURL |
String |
A URL da miniatura do material. |
|
Status |
String |
O status do material. |
|
CreationTime |
String |
A hora de criação do material. O horário é exibido em UTC. |
|
Size |
Long |
O tamanho do arquivo de origem em bytes. |
|
CateId |
Long |
O ID da categoria do material. |
|
CateName |
String |
O nome da categoria do material. |
|
Tags |
String |
As tags do material. Separe várias tags com vírgula (,). |
|
Snapshots |
String[] |
Uma matriz de URLs de snapshots do material. |
|
Sprites |
String[] |
Uma matriz de URLs de sprites do material. |
ProduceConfig: configuração de produção de vídeo
Nome | Tipo | Descrição |
TemplateGroupId | String | O ID do grupo de modelos de transcodificação usado para transcodificar os arquivos de vídeo produzidos. Os vídeos produzidos servem como arquivos de origem para a transcodificação. Esse processo é semelhante à transcodificação executada após a conclusão do upload de um arquivo. Este campo é opcional. Se estiver vazio, o grupo de modelos padrão das configurações de transcodificação será usado. Se especificado, o grupo de modelos informado será utilizado. Para visualizar o ID do grupo de modelos, acesse Transcoding Settings no console do ApsaraVideo VOD. |
TemplateId | String | O ID do modelo de composição usado para a composição de vídeo e geração de arquivos de origem para recursos de mídia. Este campo é opcional. Se o valor estiver vazio, o modelo de edição online integrado será usado para a composição. Se o destino da composição for um arquivo de vídeo, o formato de codificação do modelo integrado é H.264 e o formato do contêiner é MP4. Se você tiver outros requisitos para especificar parâmetros de composição (como composição de imagem animada, legendagem inteligente, edição rápida M3U8 ou suporte a parâmetros de composição personalizados), envie um ticket para fazer a solicitação. |
Width | Integer | A largura do vídeo de saída, em pixels. Este parâmetro é opcional. Por padrão, a resolução do vídeo de saída é definida usando a largura e a altura máximas de todos os arquivos de origem na linha do tempo. Por exemplo, se uma linha do tempo contiver três arquivos de origem com resoluções de 1280 × 720 pixels, 1920 × 1080 pixels e 720 × 1280 pixels, a resolução do vídeo de saída será de 1920 × 1280 pixels. |
Height | Integer | A altura do vídeo de saída, em pixels. Este parâmetro é opcional. Por padrão, a resolução de saída é definida usando a largura e a altura máximas de todos os arquivos de origem na linha do tempo. Por exemplo, se uma linha do tempo usar três arquivos de origem com resoluções de 1280×720, 1920×1080 e 720×1280, a resolução do vídeo de saída será de 1920×1280. |
Bitrate | Integer | A taxa de bits do vídeo produzido. Unidade: Kbit/s. Este parâmetro é opcional. O valor padrão é a taxa de bits máxima dos arquivos de origem especificados em Timeline. Por exemplo, se você especificar três materiais para Timeline e as taxas de bits dos arquivos de origem forem 400, 600 e 800 Kbit/s, a taxa de bits padrão do vídeo produzido será de 800 Kbit/s. |
StorageLocation | String | O endereço de armazenamento do arquivo. Este parâmetro é obrigatório para regiões diferentes de China (Shanghai). |
MediaMetadata: metadados do vídeo produzido
|
Nome |
Tipo |
Descrição |
|
Title |
String |
O título do vídeo produzido. O valor pode ter até 128 bytes e deve ser codificado em UTF-8. |
|
Description |
String |
A descrição do vídeo produzido. O valor pode ter até 1.024 bytes e deve ser codificado em UTF-8. |
|
CoverURL |
String |
A URL da miniatura personalizada do vídeo produzido. |
|
CateId |
String |
O ID da categoria do vídeo produzido. Faça login no console do ApsaraVideo VOD. No painel de navegação à esquerda, escolha Configuration Management > Media Management > Categories. |
|
Tags |
String |
As tags do vídeo produzido. Cada nome de tag pode ter até 32 bytes. Você pode especificar no máximo 16 tags. Separe várias tags com vírgulas (,). A string deve ser codificada no formato UTF-8. |
Edição online - Timeline (para o novo editor)
Os recursos de edição online variam de acordo com a região. Antes de usar este recurso, confirme se a região do seu service o suporta. Para mais informações, consulte Regiões do service. Para descrições de parâmetros relacionadas aos tipos de dados de edição online no editor legado, consulte Tipos de dados de edição online (para o editor legado).
Timeline: informações da linha do tempo
A linha do tempo é o resultado do arranjo de ativos de mídia e da aplicação de efeitos com base na sua visão criativa para o vídeo. Ela contém principalmente três tipos de objetos: trilhas, ativos de mídia e efeitos.
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
VideoTracks |
Não. Se VideoTracks estiver vazio, AudioTracks não deve estar vazio. |
Lista de trilhas de vídeo. A ordem de empilhamento de várias trilhas segue a ordem dos elementos do array. Por exemplo, a camada do primeiro elemento do array aparece na parte inferior, a camada do segundo elemento aparece acima dela, e assim por diante. |
|
|
AudioTracks |
Não. Se AudioTracks estiver vazio, VideoTracks não deve estar vazio. |
Lista de trilhas de áudio. |
|
|
SubtitleTracks |
Não |
Lista de trilhas de legendas. |
|
|
EffectTracks |
Não |
Lista de trilhas de efeitos. |
VideoTrack: informações da trilha de vídeo
O VideoTrack organiza ativos de mídia baseados em imagem, incluindo materiais de vídeo e imagem.
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
Type |
String |
Não |
O padrão é uma trilha de vídeo padrão. Quando Type=Effect, a trilha atual funciona como uma trilha de efeitos. Nesse caso, VideoTrackClips pode conter EffectTrackItem. |
|
MainTrack |
Boolean |
Não |
Especifica se a trilha atual é a trilha principal. O padrão é False. |
|
VideoTrackClips |
Sim |
Lista de clipes de mídia da trilha de vídeo. |
AudioTrack: informações da trilha de áudio
O AudioTrack organiza ativos de mídia baseados em áudio, incluindo arquivos apenas de áudio e vídeos com fluxos de áudio.
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
MainTrack |
Boolean |
Não |
Especifica se a trilha atual é a trilha principal. O padrão é False. |
|
AudioTrackClips |
Sim |
Lista de clipes de mídia da trilha de áudio. |
SubtitleTrack: informações da trilha de legendas
O SubtitleTrack organiza legendas, incluindo textos de letreiro e arquivos de legendas externas.
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
SubtitleTrackClips |
Sim |
Lista de clipes de mídia da trilha de legendas. |
EffectTrack: informações da trilha de efeitos
O EffectTrack adiciona efeitos globais a todo o vídeo e suporta filtros e VFX.
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
EffectTrackItems |
Sim |
Lista de itens da trilha de efeitos. |
VideoTrackClip: informações de mídia da trilha de vídeo
O VideoTrackClip inclui ativos de mídia de vídeo e de imagem.
In, Out, TimelineIn e TimelineOut marcam os pontos inicial e final do clipe de origem e seu posicionamento na linha do tempo. Por exemplo, para posicionar o segmento de 5 a 10 segundos de um vídeo na posição de 15 a 20 segundos na linha do tempo, defina In=5, Out=10, TimelineIn=15 e TimelineOut=20.
Nome | Tipo | Obrigatório | Descrição |
MediaId | String | Não | ID de mídia do clipe da trilha de vídeo. Em alguns contextos, também é chamado de VideoId (para vídeo/áudio) ou ImageId (para imagens). |
Type | String | Não | Tipo de clipe de mídia. O padrão é Video. Valores válidos:
|
X | Float | Não | Distância horizontal do canto superior esquerdo da imagem ou vídeo ao canto superior esquerdo do vídeo de saída. Suporta valores de porcentagem ou pixels. Um valor entre [0–0,9999] representa uma porcentagem da largura do vídeo de saída. Um número inteiro ≥2 representa pixels absolutos. |
Y | Float | Não | Distância vertical do canto superior esquerdo da imagem ou vídeo ao canto superior esquerdo do vídeo de saída. Suporta valores de porcentagem ou pixels. Um valor entre [0–0,9999] representa uma porcentagem da altura do vídeo de saída. Um número inteiro ≥2 representa pixels absolutos. |
Width | Float | Não | Largura da imagem no vídeo de saída. Suporta valores de porcentagem ou pixels. Um valor entre [0–0,9999] representa uma porcentagem da largura do vídeo de saída. Um número inteiro ≥2 representa pixels absolutos. |
Height | Float | Não | Altura da imagem no vídeo de saída. Suporta valores de porcentagem ou pixels. Um valor entre [0–0,9999] representa uma porcentagem da altura do vídeo de saída. Um número inteiro ≥2 representa pixels absolutos. |
AdaptMode | String | Não | Modo de dimensionamento de vídeo. O padrão é Fill. Este modo só entra em vigor quando Width e Height são definidos para a trilha de vídeo. Nesse caso, Width e Height definem as dimensões da área de destino, e o vídeo é dimensionado de forma adaptativa dentro dessa área.
|
In | Float | Não | Tempo inicial do clipe em relação à mídia de origem. Aplica-se apenas a fontes de áudio/vídeo. Unidade: segundos, com precisão de quatro casas decimais. O padrão é 0 se não for especificado. |
Out | Float | Não | Tempo final do clipe em relação à mídia de origem. Aplica-se apenas a fontes de áudio/vídeo. Unidade: segundos, com precisão de quatro casas decimais. O padrão é a duração total da origem se não for especificado. |
MaxOut | Float | Não | Tempo final máximo do clipe em relação à mídia de origem. Se definido, o ponto Out real torna-se o menor valor entre a duração da origem ou MaxOut. Aplica-se apenas a fontes de áudio/vídeo. Unidade: segundos, com precisão de quatro casas decimais. Se Out for especificado, MaxOut será ignorado. |
Duration | Float | Não | Duração do clipe. Geralmente usado para fontes de imagem. Unidade: segundos, com precisão de quatro casas decimais. |
DyncFrames | Int | Não | Taxa de quadros para imagens animadas. Aplica-se apenas quando a origem é uma imagem animada. Exemplo: Usar adesivos GIF |
TimelineIn | Float | Não | Tempo inicial do clipe na linha do tempo. Unidade: segundos, com precisão de quatro casas decimais. Se não for especificado, TimelineIn é calculado automaticamente com base no posicionamento sequencial. |
TimelineOut | Float | Não | Tempo final do clipe na linha do tempo. Unidade: segundos, com precisão de quatro casas decimais. Se não for especificado, TimelineOut é calculado automaticamente com base no posicionamento sequencial. |
Speed | Float | Não | Velocidade de reprodução do clipe de vídeo. Intervalo válido: 0,1–100. Por exemplo, Speed=2 reproduz o clipe na velocidade dupla, reduzindo sua Duration pela metade na saída final. Exemplo: Ajustar velocidade de áudio/vídeo |
MaskVideoUrl | String | Não | URL do vídeo de máscara. Geralmente é um vídeo com canal alfa, usado para adicionar efeitos de transparência ao vídeo original. Apenas URLs públicas do OSS são suportadas. |
Effects | Effect[] | Não | Lista de efeitos aplicados ao clipe. |
AudioTrackClip: informações de mídia da trilha de áudio
O AudioTrackClip inclui arquivos apenas de áudio e vídeos que contêm fluxos de áudio.
In, Out, TimelineIn e TimelineOut marcam os pontos inicial e final do clipe de origem e seu posicionamento na linha do tempo. Por exemplo, para posicionar o segmento de 5 a 10 segundos de um vídeo na posição de 15 a 20 segundos na linha do tempo, defina In=5, Out=10, TimelineIn=15 e TimelineOut=20.
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
MediaId |
String |
Não |
ID de mídia do clipe da trilha de áudio. |
|
In |
Float |
Não |
Tempo inicial do clipe em relação à mídia de origem. Unidade: segundos, com precisão de quatro casas decimais. O padrão é 0 se não for especificado. |
|
Out |
Float |
Não |
Tempo final do clipe em relação à mídia de origem. Unidade: segundos, com precisão de quatro casas decimais. O padrão é a duração total da origem se não for especificado. |
|
TimelineIn |
Float |
Não |
Tempo inicial do clipe na linha do tempo. Unidade: segundos, com precisão de quatro casas decimais. Se não for especificado, TimelineIn é calculado automaticamente com base no posicionamento sequencial. |
|
TimelineOut |
Float |
Não |
Tempo final do clipe na linha do tempo. Unidade: segundos, com precisão de quatro casas decimais. Se não for especificado, TimelineOut é calculado automaticamente com base no posicionamento sequencial. |
|
Speed |
Float |
Não |
Velocidade de reprodução do clipe de áudio. Intervalo válido: 0,1–100. Por exemplo, Speed=2 reproduz o clipe na velocidade dupla, reduzindo sua Duration pela metade na saída final. Exemplo: Ajustar velocidade de áudio/vídeo |
|
Effects |
Effect[] |
Não |
Lista de efeitos aplicados ao clipe. |
|
LoopMode |
Boolean |
Não |
Comportamento de reprodução em loop do clipe na linha do tempo. True ativa a reprodução em loop. False (padrão) desativa o loop. Exemplo: Reprodução de áudio em loop |
SubtitleTrackClip: informações de mídia da trilha de legendas
O SubtitleTrackClip inclui ativos de mídia de legendas.
Nome | Tipo | Obrigatório | Descrição |
Type | String | Sim | Tipo de mídia de legenda. Valores válidos:
|
SubType | String | Não | Subtipo de mídia de legenda. Valores válidos:
Ignore este campo quando Type for Text. |
FileURL | String | Não | URL do OSS do arquivo de legenda. Obrigatório quando Type for Subtitle. Formato: https://your-bucket.oss-cn-shanghai.aliyuncs.com/your-object.srt Exemplo: Editar diretamente usando um arquivo de legenda Nota FileURL suporta apenas URLs públicas do OSS. Não há suporte para URLs aceleradas do OSS, URLs de CDN e outras URLs HTTP. |
X | Float | Não | Quando Type for Text, distância horizontal do canto superior esquerdo do texto ao canto superior esquerdo do vídeo de saída. Suporta valores de porcentagem ou pixels. Um valor entre [0–0,9999] representa uma porcentagem da largura do vídeo de saída. Um número inteiro >=2 representa pixels absolutos. |
Y | Float | Não | Quando Type for Text, distância vertical do canto superior esquerdo do texto ao canto superior esquerdo do vídeo de saída. Suporta valores de porcentagem ou pixels. Um valor entre [0–0,9999] representa uma porcentagem da altura do vídeo de saída. Um número inteiro >=2 representa pixels absolutos. |
TimelineIn | Float | Não | Quando Type for Text, tempo inicial do texto na linha do tempo. Unidade: segundos, com precisão de quatro casas decimais. Se não for especificado, TimelineIn é calculado automaticamente com base no posicionamento sequencial. |
TimelineOut | Float | Não | Quando Type for Text, tempo final do texto na linha do tempo. Unidade: segundos, com precisão de quatro casas decimais. Se não for especificado, TimelineOut é calculado automaticamente com base no posicionamento sequencial. |
Content | String | Não | Quando Type for Text, obrigatório. Especifica o conteúdo do texto. |
Font | String | Não | Quando Type for Text, especifica a fonte. O padrão é SimSun. Para a lista completa de fontes suportadas, consulte Lista de fontes. |
FontSize | Int | Não | Quando o tipo de legenda for texto de letreiro, especifica o tamanho da fonte. |
FontColor | String | Não | Quando Type for Text, especifica a cor da fonte em formato hexadecimal (# seguido de dígitos hexadecimais). Exemplo: #ffffff. |
FontColorOpacity | String | Não | Quando Type for Text, especifica a transparência da fonte. Intervalo válido: 0–1. O padrão é 1 (opaco). 0 significa totalmente transparente. |
FontFace | Não | Quando Type for Text, especifica o estilo da fonte. | |
Spacing | Int | Não | Quando Type for Text, especifica o espaçamento entre caracteres. Unidade: pixels. O padrão é 0. |
Angle | Float | Não | Quando Type for Text, especifica o ângulo de rotação no sentido anti-horário. Unidade: graus. O padrão é 0. |
BorderStyle | Int | Não | Especifica o estilo de borda e sombra para texto de letreiro. Valores válidos: 1 ou 3. 1 = borda + sombra. 3 = caixa de fundo opaca. O padrão é 1. |
Outline | Int | Não | Quando Type for Text, especifica a largura do traço. Unidade: pixels. O padrão é 0. |
OutlineColour | String | Não | Quando Type for Text, especifica a cor do traço em formato hexadecimal (# seguido de dígitos hexadecimais). Exemplo: #ffffff. |
Shadow | Int | Não | Quando Type for Text, especifica a profundidade da sombra. Unidade: pixels. O padrão é 0. |
BackColour | String | Não | Quando Type for Text, especifica a cor da sombra em formato hexadecimal (# seguido de dígitos hexadecimais). Exemplo: #ffffff. |
Alignment | String | Não | Quando Type for Text, especifica o alinhamento do texto. O padrão é TopLeft. Valores válidos:
|
AdaptMode | String | Não | Especifica como o texto de letreiro se adapta quando excede a largura do vídeo ou o TextWidth especificado. Valores válidos:
|
TextWidth | Integer | Não | Largura da caixa de texto da legenda. Entra em vigor apenas quando AdaptMode é definido. A quebra de linha ou o dimensionamento automático usa essa largura. Se não for especificado, a largura do vídeo é usada. Unidade: pixels. |
FontUrl | String | Não | Quando Type for Text, suporta arquivos de fonte personalizados do seu bucket do OSS. Formatos suportados: ttf, otf, woff. Exemplo: https://your-bucket.oss-cn-shanghai.aliyuncs.com/example-font.ttf |
EffectColorStyle | String | Não | Quando Type for Text, especifica o estilo de word art. Para estilos e efeitos de word art, consulte Exemplos de efeitos de word art. |
AaiMotionInEffect | String | Não | Quando Type for Text, especifica o efeito de animação de entrada. Para tipos e exemplos de efeitos de entrada, consulte Efeitos de entrada. |
AaiMotionIn | Float | Não | Quando Type for Text, especifica a duração do efeito de entrada. Unidade: segundos, com precisão de quatro casas decimais. O padrão é 0,5 segundos se não for especificado. Se a duração total do texto for menor que 0,5 segundos, a duração de entrada será igual à duração total menos a duração de saída. |
AaiMotionOutEffect | String | Não | Quando o tipo de legenda for letreiro, especifica o efeito de entrada para o texto de letreiro. Para os tipos e efeitos de entradas de legendas, consulte Efeitos de entrada. |
AaiMotionOut | Float | Não | Quando Type for Text, especifica a duração do efeito de saída. Unidade: segundos, com precisão de quatro casas decimais. O padrão é 0,5 segundos se não for especificado. Se a duração total do texto for menor que 0,5 segundos, a duração de saída será igual à duração total do texto. |
AaiMotionLoopEffect | String | Não | Quando Type for Text, especifica o efeito de animação em loop. Não pode ser usado junto com efeitos de entrada ou saída. Para tipos e exemplos de efeitos em loop, consulte Efeitos em loop. |
Ratio | Float | Não | Quando Type for Text, especifica a velocidade de reprodução do efeito em loop. Precisão de quatro casas decimais. O padrão é 1 se não for especificado. Valores maiores que 1 aceleram o loop. Valores menores que 1 o desaceleram. |
EffectTrackItem: informações do item da trilha de efeitos
O EffectTrackItem inclui efeitos de VFX e filtros.
Nome | Tipo | Obrigatório | Descrição |
Type | String | Sim | Tipo de item da trilha de efeitos. Valores válidos: VFX, Filter. |
SubType | String | Sim | Subtipo de item da trilha de efeitos. Para tipos de efeitos suportados e exemplos, consulte Exemplos de efeitos especiais e Exemplos de efeitos de filtro. |
TimelineIn | Float | Não | Tempo inicial do efeito na linha do tempo. Unidade: segundos, com precisão de quatro casas decimais. O padrão é 0 se não for especificado. |
TimelineOut | Float | Não | Tempo final do efeito na linha do tempo. Unidade: segundos, com precisão de quatro casas decimais. O padrão é o tempo final do vídeo se não for especificado. |
Duration | Float | Não | Duração do efeito na linha do tempo. Unidade: segundos, com precisão de quatro casas decimais. O padrão é a duração do vídeo se não for especificado. Nota Apenas um entre Duration ou TimelineOut entra em vigor. |
X | Float | Não | Aplica-se apenas quando SubType for mosaic_rect ou blur. Distância horizontal do canto superior esquerdo da área de efeito ao canto superior esquerdo do vídeo de saída. Suporta valores de porcentagem ou pixels. Um valor entre [0–0,9999] representa uma porcentagem da largura do vídeo de saída. Um número inteiro ≥2 representa pixels absolutos. |
Y | Float | Não | Aplica-se apenas quando SubType for mosaic_rect ou blur. Distância vertical do canto superior esquerdo da área de efeito ao canto superior esquerdo do vídeo de saída. Suporta valores de porcentagem ou pixels. Um valor entre [0–0,9999] representa uma porcentagem da altura do vídeo de saída. Um número inteiro ≥2 representa pixels absolutos. |
Width | Float | Não | Aplica-se apenas quando SubType for mosaic_rect ou blur. Largura da área de efeito no vídeo de saída. Suporta valores de porcentagem ou pixels. Um valor entre [0–0,9999] representa uma porcentagem da largura do vídeo de saída. Um número inteiro ≥2 representa pixels absolutos. |
Height | Float | Não | Aplica-se apenas quando SubType for mosaic_rect ou blur. Altura da área de efeito no vídeo de saída. Suporta valores de porcentagem ou pixels. Um valor entre [0–0,9999] representa uma porcentagem da altura do vídeo de saída. Um número inteiro ≥2 representa pixels absolutos. |
FontFace: estilo da fonte
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
Bold |
Boolean |
Não |
Negrito. |
|
Italic |
Boolean |
Não |
Itálico. |
|
Underline |
Boolean |
Não |
Sublinhado. |
Effect: informações do efeito
Diferentes tipos de efeito possuem propriedades exclusivas, mas também compartilham atributos comuns.
Para descrições detalhadas das propriedades individuais do Effect, consulte Referência de configuração de efeitos.
As propriedades comuns do Effect são as seguintes:
Nome | Tipo | Obrigatório | Descrição |
Type | String | Sim | Tipo de efeito. Valores válidos:
|
SubType | String | Não | Subtipo de efeito.
|
Snapshots de vídeo e imagens dinâmicas
SnapshotJob: Informações do job de snapshot
|
Nome |
Tipo |
Descrição |
|
JobId |
String |
O ID do job. |
VodTemplateInfo: Informações do modelo de snapshot
Nome | Tipo | Descrição |
Name | String | O nome do modelo. |
VodTemplateId | String | O ID do modelo. |
TemplateType | String | O tipo de modelo. Valores válidos:
|
IsDefault | String | Indica se esta é a marca d'água padrão. Valores válidos:
|
TemplateConfig | JSON | A configuração detalhada do modelo. O valor é uma string JSON.
|
CreationTime | String | O horário em que o modelo foi criado. O horário está no formato UTC. |
ModifyTime | String | O horário da última modificação do modelo. O horário está no formato UTC. |
MediaSnapshot: Dados de snapshot de mídia
|
Nome |
Tipo |
Descrição |
|
JobId |
String |
O ID do job de snapshot. |
|
CreationTime |
String |
O horário em que o job de snapshot foi criado. O horário está em UTC. |
|
Total |
Long |
O número total de snapshots. |
|
Regular |
String |
A regra para geração de URLs de snapshot. |
|
Snapshots |
Snapshot[] |
Os dados do snapshot. |
Snapshot: Informações do snapshot
|
Nome |
Tipo |
Descrição |
|
Index |
String |
O valor do índice do snapshot. |
|
Url |
String |
A URL do snapshot. |
DynamicImage: Informações da imagem dinâmica
|
Nome |
Tipo |
Descrição |
|
VideoId |
String |
O ID do vídeo. |
|
DynamicImageId |
String |
O ID da imagem dinâmica. |
|
FileURL |
String |
A URL do arquivo da imagem dinâmica. |
|
Width |
String |
A largura da imagem dinâmica. |
|
Height |
String |
A altura da imagem dinâmica. |
|
Duration |
String |
A duração da imagem dinâmica. |
|
Format |
String |
O formato da imagem dinâmica. Os valores válidos são |
|
FileSize |
String |
O tamanho do arquivo da imagem dinâmica. |
|
Fps |
String |
A taxa de quadros da imagem dinâmica. |
Marcas d'água
WatermarkInfo: Informações sobre uma marca d'água
Nome | Tipo | Obrigatório | Descrição |
CreationTime | String | Sim | O horário em que a marca d'água foi adicionada. |
Name | String | Sim | O nome da marca d'água. |
IsDefault | String | Sim | Indica se a marca d'água é a padrão. Valores válidos:
|
Type | String | Sim | O tipo da marca d'água. Valores válidos:
|
WatermarkId | String | Sim | O ID da marca d'água. |
FileUrl | String | Não | A URL do OSS ou URL do CDN do arquivo da marca d'água. Este parâmetro não se aplica a marcas d'água de texto. |
WatermarkConfig | Sim | As configurações de posição e efeito da marca d'água de texto ou imagem. O valor deve ser uma string JSON. |
Transcodificação de áudio e vídeo
TranscodeJob: informações sobre um job de transcodificação
|
Nome |
Tipo |
Descrição |
|
JobId |
String |
O ID do job de transcodificação. |
TranscodeTemplateGroup: informações sobre um grupo de modelos de transcodificação
Nome | Tipo | Obrigatório | Descrição |
Name | String | Sim | Nome do grupo de modelos. |
TranscodeTemplateGroupId | String | Sim | O ID do grupo de modelos de transcodificação. |
IsDefault | String | Sim | Indica se este é o grupo de modelos padrão. Valores válidos:
|
CreationTime | String | Sim | O horário de criação do grupo de modelos. |
ModifyTime | String | Sim | O horário da última modificação do grupo de modelos. |
TranscodeTemplateList | Sim | A lista de configurações do modelo de transcodificação. |
TranscodeTemplate: configuração do modelo de transcodificação
Nome | Tipo | Obrigatório | Descrição |
Type | String | Não | O tipo de modelo. Valores válidos:
Valor padrão: Normal. |
Video | Sim | A configuração de transcodificação para o fluxo de vídeo. O valor deve ser uma string JSON. | |
Audio | Sim | A configuração de transcodificação para o fluxo de áudio. O valor deve ser uma string JSON. | |
Definition | String | Sim | A definição de um modelo de transcodificação comum. Valores válidos:
Nota
A definição de um modelo de transcodificação Narrowband HD 1.0. Valores válidos:
Nota
|
Container | Sim | O formato de contêiner usado para encapsular fluxos de áudio e vídeo. O valor deve ser uma string JSON. | |
MuxConfig | Não | A configuração de segmento para transcodificação. Especifique este parâmetro se o formato do contêiner for HLS. O valor deve ser uma string JSON. | |
TransConfig | Não | A configuração de transcodificação condicional. Use este parâmetro para aplicar lógica básica com base na taxa de bits e na resolução do vídeo de origem antes de gerar o vídeo transcodificado. O valor deve ser uma string JSON. | |
TranscodeFileRegular | String | Não | O caminho personalizado para armazenar arquivos de saída. Nota
Exemplo de configuração {MediaId}/watermark-{PlayDefinition}: Durante a transcodificação, o ApsaraVideo VOD substitui {MediaId} pelo ID do vídeo (por exemplo, 8ff5cc93f6da4079a47a77bf71d) e {PlayDefinition} pela definição (por exemplo, fd). Exemplo de saída 8ff5cc93f6da4079a47a77bf71d/watermark-fd.mp4 (o ApsaraVideo VOD anexa automaticamente a extensão do arquivo, como .mp4, .m3u8 ou .flv). |
Clip | Não | A configuração de corte de vídeo. O valor deve ser uma string JSON. Por exemplo, defina este parâmetro para extrair 5 segundos de conteúdo de um vídeo para gerar um novo vídeo. | |
Rotate | String | Não | O ângulo de rotação do vídeo. Valores válidos: [0,360]. Por exemplo, definir este parâmetro como 180 inverte a imagem do vídeo de cabeça para baixo. |
EncryptSetting | Não | A configuração de criptografia para transcodificação. | |
PackageSetting | Não | A configuração de empacotamento. Apenas o empacotamento de taxa de bits adaptável HLS e o empacotamento DASH são suportados. O valor deve ser uma string JSON. | |
SubtitleList | Não | A configuração de legendas. O valor deve ser uma string JSON. | |
WatermarkIds | String[] | Não | Os IDs das marcas d'água associadas. Você pode associar até quatro IDs de marca d'água. USER_DEFAULT_WATERMARK representa o ID da marca d'água padrão. |
TranscodeTemplateId | String | Não | O ID do modelo de transcodificação. Especifique este parâmetro ao modificar um modelo. |
TemplateName | String | Não | O nome do modelo de transcodificação. Especifique este parâmetro ao criar um modelo. |
Exemplo do parâmetro TranscodeTemplate
{
"Method":"dynamic",
"IntegratedLoudnessTarget":"-6",
"TruePeak":"-1",
"LoudnessRangeTarget":"8"
}
Video: configuração de transcodificação de fluxo de vídeo
Se você não tiver requisitos especiais, defina apenas Codec, Bitrate, Height, Width e Remove=false.
Recomendamos definir apenas Width ou Height para o vídeo de saída. Isso garante que a proporção corresponda ao vídeo de origem.
Nome | Tipo | Obrigatório | Descrição |
Codec | String | Sim | O formato de codificação de vídeo: H.264 ou H.265. |
Remove | String | Sim | Indica se o fluxo de vídeo deve ser removido. Valores válidos:
Valor padrão: false. |
Bitrate | String | Não | A taxa de bits de destino para o vídeo de saída. Se você não especificar este parâmetro, a taxa de bits será calculada usando o parâmetro Crf. Unidade: Kbps. Valores válidos: [10,50000]. |
Height | String | Não | A altura do vídeo de saída. O valor deve ser um múltiplo de 2. Se você não especificar este parâmetro, a altura do arquivo de origem será usada. Unidade: pixels. Valores válidos: [128,4096]. |
Width | String | Não | A largura do vídeo de saída. O valor deve ser um múltiplo de 2. Se você não especificar este parâmetro, a largura do arquivo de origem será usada. Unidade: pixels. Valores válidos: [128,4096]. |
Fps | String | Não | A taxa de quadros do vídeo de saída. Se você não especificar este parâmetro, a taxa de quadros do arquivo de origem será usada. Unidade: FPS. Valores válidos: (0,60]. |
Gop | String | Não | A distância entre quadros-chave adjacentes. Unidade: quadros. Valores válidos: [1,100000]. |
LongShortMode | String | Não | Ative a rotação automática de tela. A largura do vídeo de saída corresponde ao lado longo da origem (altura no modo retrato). A altura do vídeo de saída corresponde ao lado curto da origem (largura no modo retrato). Valores válidos:
Valor padrão: true. Este recurso funciona melhor para vídeos em retrato. Recomendamos ativá-lo. |
Crf | String | Não | O fator de controle de qualidade da taxa de bits. Se você especificar este parâmetro, o parâmetro Bitrate será ignorado. Um valor maior resulta em menor qualidade de vídeo e menor tamanho de arquivo. Um valor menor resulta em maior qualidade de vídeo, maior tamanho de arquivo e maior tempo de transcodificação. Valores válidos: [0,51]. Valor padrão: 26. Não recomendamos alterar este valor. |
Profile | String | Não | O perfil de codificação. Valores válidos:
Valor padrão: high. Este parâmetro se aplica apenas à codificação H.264. Melhores práticas Se você suportar várias definições, defina a definição mais baixa como baseline para garantir a reprodução em dispositivos de baixo custo. Defina outras definições como main ou high. |
Preset | String | Não | O algoritmo de vídeo predefinido. Valores válidos: veryfast, fast, medium, slow, slower. Valor padrão: medium. Este parâmetro se aplica apenas à codificação H.264. Não recomendamos alterar este valor. |
ScanMode | String | Não | O modo de varredura. Valores válidos:
|
Bufsize | String | Não | O tamanho do buffer. Unidade: KB. Valores válidos: [1000,128000]. Valor padrão: 6000. |
Maxrate | String | Não | A taxa de bits de pico do vídeo. Unidade: Kbps. Valores válidos: [1000,50000]. |
PixFmt | String | Não | O formato de pixel do vídeo. Formatos padrão como yuv420p e yuvj420p são suportados. Valor padrão: yuv420p ou o formato de pixel original. |
Exemplo do parâmetro Video
{
"Method":"dynamic",
"IntegratedLoudnessTarget":"-6",
"TruePeak":"-1",
"LoudnessRangeTarget":"8"
}
Audio: configuração de transcodificação de fluxo de áudio
Se você não tiver requisitos especiais, defina apenas Codec, Bitrate e Remove=false.
Nome | Tipo | Obrigatório | Descrição |
Codec | String | Sim | O formato de codificação de áudio: AAC ou MP3. |
Bitrate | String | Sim | A taxa de bits de destino para o áudio de saída. Unidade: Kbps. Valores válidos: [8,1000]. |
Remove | String | Sim | Indica se o fluxo de áudio deve ser removido. Valores válidos:
Valor padrão: false. |
Samplerate | String | Sim | A taxa de amostragem. Unidade: Hz. Valores válidos: 22050, 32000, 44100, 48000, 96000. Valor padrão: 44100. Se o formato do contêiner for FLV e o codec de áudio for MP3, a taxa de amostragem não pode ser 32000, 48000 ou 96000. Se o codec de áudio for MP3, a taxa de amostragem não pode ser 96000. |
Channels | String | Não | O número de canais de áudio. Valor padrão: 2.
|
Profile | String | Não | O perfil do codec de áudio. Se Codec estiver definido como AAC, os valores válidos incluem aac_low, aac_he, aac_he_v2, aac_ld e aac_eld. |
Volume | Não | A configuração de volume. |
Exemplo do parâmetro Audio
{
"Method":"dynamic",
"IntegratedLoudnessTarget":"-6",
"TruePeak":"-1",
"LoudnessRangeTarget":"8"
}
Container: formato de contêiner
Nome | Tipo | Obrigatório | Descrição |
Format | String | Sim | O formato de contêiner.
|
Exemplo do parâmetro Container
{
"Method":"dynamic",
"IntegratedLoudnessTarget":"-6",
"TruePeak":"-1",
"LoudnessRangeTarget":"8"
}
MuxConfig: configuração de segmento HLS
Especifique este parâmetro se o formato do contêiner estiver definido como m3u8.
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
Segment |
Sim |
Um objeto JSON que contém campos de configuração de segmento. |
Segment: detalhes da configuração de segmento
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
Duration |
String |
Sim |
A duração de cada segmento TS. O valor deve ser um número inteiro. Valores válidos: [1,60]. Unidade: segundos. Exemplo: {"Duration":"10"}. |
Exemplo do parâmetro MuxConfig
{
"Method":"dynamic",
"IntegratedLoudnessTarget":"-6",
"TruePeak":"-1",
"LoudnessRangeTarget":"8"
}
TransConfig: configuração de transcodificação condicional
Nome | Tipo | Obrigatório | Descrição |
TransMode | String | Não | Modo de transcodificação. Valores válidos:
Valor padrão: onepass. |
IsCheckReso | String | Não | Verifica a resolução do vídeo source para determinar se a resolução source deve ser usada na transcodificação. Valores válidos:
Valor padrão: false. |
IsCheckResoFail | String | Não | Verifica a resolução do vídeo source para determinar se a transcodificação falha. Valores válidos:
Valor padrão: false. |
IsCheckVideoBitrate | String | Não | Verifica a taxa de bits do vídeo source para determinar se a taxa de bits source deve ser usada na transcodificação. Valores válidos:
Valor padrão: false. |
IsCheckVideoBitrateFail | String | Não | Verifica a taxa de bits do vídeo source para determinar se a transcodificação falha. Valores válidos:
Valor padrão: false. Este valor tem precedência sobre IsCheckVideoBitrate. |
IsCheckAudioBitrate | String | Não | Verifica a taxa de bits do áudio source para determinar se a taxa de bits source deve ser usada na transcodificação. Valores válidos:
Valor padrão: false. |
IsCheckAudioBitrateFail | String | Não | Verifica a taxa de bits do áudio source para determinar se a transcodificação falha. Valores válidos:
Valor padrão: false. Este valor tem precedência sobre IsCheckAudioBitrate. |
Exemplo do parâmetro TransConfig
{
"Method":"dynamic",
"IntegratedLoudnessTarget":"-6",
"TruePeak":"-1",
"LoudnessRangeTarget":"8"
}
Clip: configuração de recorte de vídeo
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
TimeSpan |
Sim |
Configuração relacionada ao tempo para recorte de vídeo. |
TimeSpan: configuração de recorte de vídeo
Nome | Tipo | Obrigatório | Descrição |
Seek | String | Sim | O horário de início do clipe de vídeo.
Recomendamos o uso do Formato 1. |
Duration | String | Não | Duração do recorte do vídeo.
Recomendamos o uso do Formato 1. Nota Especifique Duration ou End. Caso especifique ambos, End prevalecerá. |
End | String | Não | A duração do segmento final a ser descartado durante o recorte do vídeo.
Recomendamos o uso do Formato 1. Nota
|
EncryptSetting: configuração de criptografia de transcodificação
Para usar a criptografia padrão HLS, primeiro defina o parâmetro EncryptType no modelo de transcodificação como AliyunVoDEncryption. Em seguida, chame a operação Submit media transcoding jobs e configure o parâmetro EncryptConfig.
Nome | Tipo | Obrigatório | Descrição |
EncryptType | String | Sim | O tipo de criptografia. Valores válidos:
|
Exemplo do parâmetro EncryptSetting
{
"Method":"dynamic",
"IntegratedLoudnessTarget":"-6",
"TruePeak":"-1",
"LoudnessRangeTarget":"8"
}
PackageSetting: configuração de empacotamento de transcodificação
Não é possível empacotar fluxos de áudio e vídeo extraídos.
Atualmente, há suporte apenas para empacotamento de taxa de bits adaptável HLS.
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
PackageType |
String |
Sim |
O tipo de empacotamento. Valor válido: HLSPackage (empacotamento de taxa de bits adaptável HLS). |
|
PackageConfig |
Não |
A configuração de empacotamento. Especifique este parâmetro para um modelo VideoPackage. |
|
|
SubtitleExtractConfigList |
Não |
A configuração de empacotamento de legendas. Especifique este parâmetro para um modelo SubtitlePackage. Não o especifique para outros tipos de modelo. |
PackageConfig: configuração de empacotamento de vídeo
Defina este parâmetro apenas para empacotamento de streaming de taxa de bits adaptável HLS.
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
BandWidth |
String |
Sim |
A largura de banda máxima. Especifique este parâmetro para empacotamento HLS. Unidade: bps. Especifique este parâmetro apenas para modelos VideoPackage. |
Exemplo do parâmetro PackageSetting
{
"Method":"dynamic",
"IntegratedLoudnessTarget":"-6",
"TruePeak":"-1",
"LoudnessRangeTarget":"8"
}
SubtitleExtractConfig: configuração de empacotamento de legendas
Nome | Tipo | Obrigatório | Descrição |
SubtitleUrlList | String[] | Sim | A URL do arquivo de legendas. O sistema aceita apenas URLs HTTP do OSS. Não há suporte para URLs HTTP de CDN nem URLs HTTPS. Nota
|
Language | String | Sim | O idioma da legenda. Por exemplo, en-US. Consulte a RFC 5646 para obter mais informações. |
Format | String | Sim | O formato do arquivo de legendas. Há suporte apenas para arquivos .vtt. Por exemplo: subtitle.vtt. |
Name | String | Sim | O nome de exibição da faixa de legenda no player. Por exemplo: Chinese ou English. |
Exemplo do parâmetro SubtitlePackage
{
"Method":"dynamic",
"IntegratedLoudnessTarget":"-6",
"TruePeak":"-1",
"LoudnessRangeTarget":"8"
}
SubtitleConfig: configuração de legendas
Nome | Tipo | Obrigatório | Descrição |
SubtitleUrl | String | Sim | A URL do OSS do arquivo de legendas. Não há suporte para URLs HTTPS nem nomes de domínio puros de CDN. Formatos de legenda com suporte: srt e ass. Nota O arquivo de legendas e o arquivo de vídeo source devem estar na mesma região (por exemplo, China East 1) e no mesmo bucket. |
CharEncode | String | Sim | O formato de codificação de caracteres. Valores válidos:
Valor padrão: UTF-8. |
Para obter mais informações sobre como enviar arquivos de legendas, consulte CreateUploadAttachedMedia e Upload files using the OSS file.
Exemplo do parâmetro SubtitleConfig
{
"Method":"dynamic",
"IntegratedLoudnessTarget":"-6",
"TruePeak":"-1",
"LoudnessRangeTarget":"8"
}
Volume: configuração de volume
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
Method |
String |
Não |
O método de ajuste de volume. Valores válidos: auto, dynamic, linear. |
|
IntegratedLoudnessTarget |
String |
Não |
O nível de volume alvo. Valores válidos: [-70,-5]. Obrigatório se Method estiver definido como dynamic. Valor padrão: -6. |
|
TruePeak |
String |
Não |
O nível de pico máximo. Valores válidos: [-9,0]. Obrigatório se Method estiver definido como dynamic. Valor padrão: -1. |
|
LoudnessRangeTarget |
String |
Não |
A faixa de volume. Valores válidos: [1,20]. Obrigatório se Method estiver definido como dynamic. Valor padrão: 8. |
Exemplo do parâmetro Volume
{
"Method":"dynamic",
"IntegratedLoudnessTarget":"-6",
"TruePeak":"-1",
"LoudnessRangeTarget":"8"
}
Combinações suportadas de formatos de contêiner e codecs de áudio
|
Contêiner |
Codecs de áudio |
|
mp3 |
MP3 |
|
mp4 |
AAC |
|
ogg |
VORBIS, FLAC |
|
flac |
FLAC |
Combinações suportadas de formatos de contêiner, codecs de áudio e codecs de vídeo
|
Contêiner |
Codecs de vídeo |
Codecs de áudio |
|
flv |
H.264 |
AAC, MP3 |
|
mp4 |
H.264, H.265 |
AAC, MP3 |
|
ts |
H.264, H.265 |
AAC, MP3 |
|
m3u8 |
H.264, H.265 |
AAC, MP3 |
|
gif |
GIF |
Não suportado |
Combinações suportadas de codecs de vídeo e parâmetros de configuração de fluxo de vídeo
|
Codecs de vídeo |
H.264 |
H.265 |
GIF |
|
Perfil |
Suportado |
× |
× |
|
Taxa de bits |
Suportado |
Suportado |
× |
|
Crf |
Suportado |
Suportado |
× |
|
Largura |
Suportado |
Suportado |
Suportado |
|
Altura |
Suportado |
Suportado |
√ |
|
Fps |
Suportado |
Suportado |
Suportado |
|
Gop |
Suportado |
Suportado |
× |
|
Preset |
√ |
× |
× |
|
ScanMode |
Suportado |
Suportado |
Suportado |
|
Bufsize |
Suportado |
Suportado |
× |
|
Maxrate |
√ |
✓ |
× |
|
PixFmt |
Suportado |
√ |
bgr8 |
TranscodeSummary: resumo da transcodificação
Nome | Tipo | Descrição |
VideoId | String | O ID do vídeo. |
TranscodeTemplateGroupId | String | O ID do grupo de modelos de transcodificação usado para a transcodificação. |
TranscodeStatus | String | O status da transcodificação. Valores válidos:
|
TranscodeJobInfoSummaryList | A lista de resumos de trabalhos de transcodificação. | |
CreationTime | String | O horário de criação da tarefa de transcodificação. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e é exibido em UTC. |
CompleteTime | String | O horário de conclusão da tarefa de transcodificação. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e é exibido em UTC. |
TranscodeJobInfoSummary: resumo de um trabalho de transcodificação
Nome | Tipo | Descrição |
TranscodeTemplateId | String | O ID do modelo de transcodificação usado. |
Width | String | A largura do vídeo de saída. Unidade: pixels. |
Height | String | A altura do vídeo de saída. Unidade: pixels. |
Duration | String | A duração do vídeo de saída. Unidade: segundos. |
Filesize | String | O tamanho do arquivo de vídeo de saída. Unidade: bytes. |
Bitrate | String | A taxa de bits média do vídeo de saída. Unidade: Kbps. |
Fps | String | A taxa de quadros do vídeo de saída. Unidade: quadros por segundo. |
Format | String | O formato de contêiner do vídeo de saída. |
WatermarkIdList | String[] | A lista de IDs de marca d'água aplicados ao vídeo de saída. |
TranscodeProgress | Long | O progresso da transcodificação. Valores válidos: [0,100]. |
TranscodeJobStatus | String | O status do trabalho de transcodificação. Valores válidos:
|
CreationTime | String | O horário de criação do trabalho de transcodificação. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e é exibido em UTC. |
CompleteTime | String | O horário de conclusão do trabalho de transcodificação. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e é exibido em UTC. |
ErrorCode | String | O código de erro retornado se o trabalho de transcodificação falhar. |
ErrorMessage | String | A mensagem de erro retornada se o trabalho de transcodificação falhar. |
TranscodeTask: informações sobre uma tarefa de transcodificação
Nome | Tipo | Descrição |
TranscodeTaskId | String | O ID da tarefa de transcodificação. |
TranscodeTemplateGroupId | String | O ID do grupo de modelos de transcodificação usado para a transcodificação. |
VideoId | String | O ID do vídeo. |
TaskStatus | String | O status da tarefa de transcodificação. Valores válidos:
|
CreationTime | String | O horário de criação da tarefa de transcodificação. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e é exibido em UTC. |
CompleteTime | String | O horário de conclusão da tarefa de transcodificação. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e é exibido em UTC. |
Trigger | String | O tipo de gatilho. Valores válidos:
|
TranscodeJobInfoList | As informações sobre os trabalhos de transcodificação. |
TranscodeJobInfo: informações sobre um trabalho de transcodificação
Nome | Tipo | Descrição |
TranscodeTaskId | String | O ID da tarefa de transcodificação. |
TranscodeJobId | String | O ID do trabalho de transcodificação. |
VideoId | String | O ID do vídeo. |
TranscodeProgress | Long | O progresso do trabalho de transcodificação. Valores válidos: [0,100]. |
TranscodeJobStatus | String | O status do trabalho de transcodificação. Valores válidos:
|
Priority | String | A prioridade da tarefa de transcodificação. |
Definition | String | A definição. Nota Este valor é a tag de definição configurada no modelo de transcodificação e não representa o intervalo de resolução real do vídeo de saída. |
TranscodeTemplateId | String | O ID do modelo de transcodificação usado para a transcodificação. |
CreationTime | String | O horário de criação do trabalho de transcodificação. |
CompleteTime | String | O horário de conclusão do trabalho de transcodificação. |
InputFileUrl | String | A URL do OSS do arquivo de origem. |
OutputFile | As informações sobre o arquivo de saída. | |
ErrorCode | String | O código de erro retornado se o trabalho de transcodificação falhar. |
ErrorMessage | String | A mensagem de erro retornada se o trabalho de transcodificação falhar. |
OutputFile: arquivo de saída após a transcodificação
|
Nome |
Tipo |
Descrição |
|
OutputFileUrl |
String |
A URL do OSS do arquivo de saída. |
|
Format |
String |
O formato de contêiner do arquivo de saída. |
|
Width |
String |
A largura do vídeo no arquivo de saída. Unidade: pixels. |
|
Height |
String |
A altura do vídeo no arquivo de saída. Unidade: pixels. |
|
Duration |
String |
A duração do arquivo de saída. Unidade: segundos. |
|
Bitrate |
String |
A taxa de bits média do arquivo de saída. Unidade: Kbps. |
|
Fps |
String |
A taxa de quadros do arquivo de saída. Unidade: quadros por segundo. |
|
Filesize |
Long |
O tamanho do arquivo de saída. Unidade: bytes. |
|
EncryptType |
String |
O tipo de criptografia usado para o arquivo de saída. O valor é uma string JSON. |
|
WatermarkIdList |
String |
A lista de IDs de marca d'água aplicados ao arquivo de saída. |
|
VideoStreamList |
String |
A lista de fluxos de vídeo. Para mais informações, consulte VideoStream: informações do fluxo de vídeo. |
|
AudioStreamList |
String |
A lista de fluxos de áudio. Para mais informações, consulte AudioStream: informações do fluxo de áudio. |
Estatísticas de dados
TopPlayVideoStatis: Estatísticas diárias de reprodução dos vídeos mais assistidos
|
Nome |
Tipo |
Descrição |
|
VideoId |
String |
O ID do vídeo. |
|
PlayDuration |
String |
A duração da reprodução em milissegundos. |
|
Title |
String |
O título do vídeo. |
|
VV |
String |
O número de visualizações do vídeo. |
|
UV |
String |
O número de usuários que reproduziram o conteúdo. |
VideoPlayStatisDetail: Estatísticas diárias de reprodução de um vídeo específico
|
Nome |
Tipo |
Descrição |
|
Date |
String |
A data no formato yyyyMMdd. Exemplo: 20170120. |
|
PlayDuration |
String |
A duração da reprodução em milissegundos. |
|
Title |
String |
O título do vídeo. |
|
VV |
String |
O número de visualizações do vídeo. |
|
UV |
String |
O número de usuários que realizaram a reprodução. |
|
PlayRange |
String |
A distribuição da duração da reprodução. |
UserPlayStatisTotals: Estatísticas diárias totais de reprodução por usuário
|
Nome |
Tipo |
Descrição |
|
Date |
String |
A data no formato yyyyMMdd. Exemplo: 20170120. |
|
PlayDuration |
String |
A duração total da reprodução em milissegundos. |
|
PlayRange |
String |
A distribuição da duração da reprodução. |
|
VV |
VV |
O número total de visualizações do vídeo. |
|
UV |
UV |
O número total de usuários que reproduziram o conteúdo. |
UserPlayStatisAvgs: Estatísticas diárias médias de reprodução por usuário
|
Nome |
Tipo |
Descrição |
|
Date |
String |
A data no formato yyyyMMdd. Exemplo: 20170120. |
|
AvgPlayDuration |
String |
A duração média da reprodução em milissegundos. |
|
AvgPlayCount |
String |
O número médio de visualizações do vídeo. |
Distribuição de VV
As estatísticas são coletadas apenas para reproduções que utilizam os SDKs do Alibaba Cloud Video on Demand Player.
|
Nome |
Tipo |
Descrição |
|
Android |
String |
O número total de visualizações de vídeo no player para Android. |
|
iOS |
String |
O número total de visualizações de vídeo no player para iOS. |
|
Flash |
String |
O número total de sessões de reprodução no player Flash. |
|
HTML5 |
String |
O número total de visualizações de vídeo no player para HTML5. |
Distribuição de UV por contagem de reprodução
As estatísticas são coletadas apenas para reproduções que utilizam os SDKs do Alibaba Cloud Video on Demand Player.
|
Nome |
Tipo |
Descrição |
|
Android |
String |
O número total de visitantes únicos no player para Android. |
|
iOS |
String |
O número total de usuários que realizaram reprodução no player para iOS. |
|
Flash |
String |
O número total de usuários de reprodução no Flash Player. |
|
HTML5 |
String |
O número total de usuários para reprodução em HTML5. |
Notificações de eventos
MessageCallback: Configurações de notificação de eventos
Nome | Tipo | Descrição |
CallbackType | String | O método de callback. Valores válidos: HTTP e MNS. |
CallbackURL | String | O endereço do webhook para callbacks HTTP. |
MnsEndpoint | String | O endpoint público da fila MNS para callbacks MNS. |
MnsQueueName | String | O nome da fila MNS para callbacks MNS. |
EventTypeList | String | O tipo de evento de callback. |
AuthSwitch | String | A chave de autenticação para callbacks HTTP. Valores válidos:
|
AuthKey | String | A chave de autenticação para callbacks HTTP. |
Sistema de múltiplas aplicações
AppInfo: Informações da aplicação
Nome | Tipo | Descrição |
AppId | String | O ID da aplicação. |
AppName | String | O nome da aplicação. |
Description | String | A descrição da aplicação. |
Type | String | O tipo da aplicação. Valores válidos:
|
Status | String | O status da aplicação. Valores válidos:
|
CreationTime | String | O horário de criação em UTC. |
ModificationTime | String | O horário de atualização em UTC. |
AppPolicy: Informações da política de autorização da aplicação
Nome | Tipo | Descrição |
AppId | String | O ID da aplicação. |
PolicyType | String | O tipo de política. Valores válidos:
|
PolicyName | String | O nome da política. |
CreationTime | String | O horário de criação em UTC. |
Description | String | A descrição da política. |