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: the status of an audio or a video file. |
|
|
CreationTime |
String |
O horário de criação do áudio ou vídeo. O horário deve estar em UTC. |
|
Size |
Long |
O tamanho do arquivo source. Unidade: bytes. |
|
Snapshots |
String[] |
As URLs dos snapshots de 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 múltiplas 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 | Enviando |
|
UploadFail | Falha no envio |
|
UploadSucc | Envio concluído |
|
Transcoding | Transcodificando | Arquivos de mídia neste status estão sendo transcodificados. Se um vídeo estiver passando pela transcodificação inicial, não haverá streams de reprodução válidos disponíveis e não será possível chamar operações de API para obter URLs de reprodução. Determine o status da transcodificação usando as notificações de evento Single Definition Transcoding Complete ou Transcode complete. |
TranscodeFail | Falha na transcodificação | Erros no arquivo source geralmente causam falhas na transcodificação. Obtenha a mensagem de erro através da notificação de evento Single Definition Transcoding Complete ou Transcode complete. Para mais informações sobre como solucionar falhas de transcodificação, consulte FAQ about transcoding. |
Checking | Em revisão |
Nota Observe que o status Em revisão descrito aqui refere-se ao 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 da moderação assistida por máquina (visível em ApsaraVideo VOD console > Review Management > Video Review). O status Reviewing da moderação assistida por máquina descreve apenas o status do trabalho de revisão automática, enquanto o status Em revisão do arquivo descreve os status dos trabalhos de revisão automática e manual. |
Blocked | Bloqueado |
|
Normal | Normal |
|
ProduceFail | Falha na síntese | Indica que a produção do corte de vídeo falhou. Ao usar a edição online do ApsaraVideo VOD para produzir cortes de vídeo, certifique-se de que todos os ativos de mídia utilizados estejam no status Normal. Caso contrário, a produção do vídeo poderá falhar. |
ImageInfo: Informações da imagem
|
Nome |
Tipo |
Descrição |
|
ImageId |
String |
O ID da imagem. |
|
URL |
String |
A URL da imagem. Se um domínio acelerado estiver configurado, uma URL de 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 da imagem. |
|
|
CreationTime |
String |
O horário de criação da imagem. O horário está em UTC. |
|
String |
O status da imagem. Para mais informações, consulte Status: the status of an image. |
|
|
String |
O ID do aplicativo. |
Status: Status da imagem
|
Valor |
Descrição |
Observações |
|
Uploading |
Enviando |
Status inicial da imagem, indicando que ela está sendo enviada. Se suas imagens permanecerem neste status por um longo período, consulte Why Are My Uploaded Files Always in the Uploading Status?. |
|
UploadFail |
Falha no envio da imagem. |
Problemas de rede ou corrupção do arquivo source podem causar falhas. Tente novamente ou envie um arquivo source diferente. |
|
Normal |
Normal |
Envio da imagem concluído com sucesso. |
AttachedMediaInfo: Informações sobre 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 domínio para CDN for especificado, uma URL de 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 |
O horário de criação do ativo de mídia auxiliar. O horário deve estar em UTC. |
|
ModificationTime |
String |
O horário da última modificação do ativo de mídia auxiliar. O horário deve estar em UTC. |
|
String |
O status do ativo de mídia auxiliar. Para mais informações, consulte Status: Auxiliary Media Asset Status. |
|
|
String |
O ID do aplicativo. |
Status: Status do ativo de mídia auxiliar
|
Valor |
Descrição |
Explicação |
|
Uploading |
Enviando |
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 |
Falha no envio do ativo de mídia auxiliar. |
Informações do arquivo de recurso 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 of an audio or video source file. |
CreationTime | String | O horário de criação do arquivo. O horário 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. 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 de vídeo. |
|
Height |
Long |
A altura da resolução de vídeo. |
|
HasBFrames |
String |
Indica se o stream possui B-frames. |
|
Sar |
String |
Taxa de proporção do sinal codificado. |
|
Dar |
String |
A taxa de proporção de exibição (DAR). |
|
PixFmt |
String |
O formato de pixel. |
|
Level |
String |
O nível de codificação. |
|
Fps |
String |
A taxa de quadros alvo. |
|
AvgFPS |
String |
A taxa média de quadros. |
|
Timebase |
String |
A base de tempo. |
|
StartTime |
String |
O horário 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 [0, 360). |
AudioStream: Informações do stream de áudio
|
Nome |
Tipo |
Descrição |
|
Index |
String |
O número ordinal do stream de áudio. 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 |
O horário 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 do arquivo source de áudio ou vídeo
|
Valor |
Descrição |
Observações |
|
Uploading |
Enviando |
Estado inicial do arquivo. Indica que o arquivo está sendo enviado. |
|
Normal |
Normal |
O arquivo foi enviado com sucesso. |
|
UploadFail |
Falha |
Falha no envio do arquivo. |
|
Deleted |
Excluído |
O arquivo foi excluído. |
Mezzanine: Informações do arquivo source de 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). |
Envio em lote de múltiplos arquivos de mídia via URLs
URLUploadInfo: Informações sobre um trabalho de envio via URL
|
Nome |
Tipo |
Descrição |
|
JobId |
String |
O ID do trabalho de envio. |
|
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 envio via URL. Para mais informações sobre este parâmetro, consulte Status: the status of a URL-based upload job. |
|
|
CreationTime |
String |
O horário de criação do trabalho. |
|
CompleteTime |
Long |
O horário de conclusão do trabalho. |
|
UserData |
String |
Um campo definido pelo usuário. |
|
ErrorCode |
String |
Código de erro. |
|
ErrorMessage |
String |
Mensagem de erro. |
Status: Status do trabalho de envio via URL
|
Valor |
Descrição |
|
PENDING |
O trabalho de envio foi submetido e aguarda processamento. |
|
PROCESSING |
O processamento da tarefa pode ser iniciado. |
|
DOWNLOADING |
O arquivo está sendo baixado. |
|
DOWNLOAD_SUCCESS |
O download do arquivo foi concluído. |
|
DOWNLOAD_FAIL |
Falha no download do arquivo. |
|
UPLOADING |
O arquivo está sendo enviado. |
|
UPLOAD_SUCCESS |
O envio do arquivo foi concluído. |
|
UPLOAD_FAIL |
Falha no envio do arquivo. |
|
SUCCESS |
O trabalho de envio 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 | O horário de criação do arquivo de vídeo ou áudio. O horário está em UTC. |
MediaType | MediaType | O tipo do arquivo de mídia. Valores válidos:
|
Por padrão, a operação de API de reprodução retorna uma URL acelerada por CDN. Se nenhum domínio estiver configurado, a operação de 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 de 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 Output specifications. |
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 á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 do stream de mídia. Este ID é o identificador único 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 entra em vigor apenas quando uma definição do modelo de transcodificação integrado Narrowband HD 1.0 estiver configurada. Para mais informações, consulte TranscodeTemplate: Transcoding template configurations. |
CreationTime | String | O horário de criação do stream. O horário está em UTC. |
ModificationTime | String | O horário da última atualização do stream. O horário 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 | ID do ativo de mídia. |
CreationTime | String | Horário de criação do ativo de mídia. O horário deve estar em UTC. |
MediaType | String | Tipo do ativo de mídia. Valores válidos:
|
Video | Informações sobre o vídeo. | |
Audio | Informações sobre o áudio. | |
Image | Informações sobre a imagem. | |
AttachedMedia | 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 |
ID da categoria. |
|
CateName |
String |
Nome da categoria. O valor pode ter até 64 bytes e deve estar codificado no formato UTF-8. |
|
ParentId |
Long |
ID da categoria pai. Para categorias de nível 1, o ID da categoria pai é -1. |
|
Level |
Long |
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 |
Nome do stream ao vivo. |
|
DomainName |
String |
Nome de domínio. |
|
AppName |
String |
Nome da aplicação. |
|
PlaylistId |
String |
ID da playlist. |
|
RecordStartTime |
String |
Horário de início da gravação. |
|
RecordEndTime |
String |
Horário de término da gravação. |
|
Video |
Video |
Informações do vídeo. |
Edição online
EditingProject: projeto de edição online
|
Nome |
Tipo |
Descrição |
|
ProjectId |
String |
ID do projeto de edição online. |
|
Title |
String |
Título do projeto de edição online. |
|
CreationTime |
String |
Horário 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 corresponde às 20:00:00 de 11 de janeiro de 2017 no horário de Pequim (UTC+8). |
|
ModifiedTime |
String |
Ú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 equivale às 20:00:00 de 11 de janeiro de 2017, UTC+8). |
|
Status |
String |
Status do projeto de edição online. |
|
Description |
String |
Descrição do projeto de edição online. |
|
Timeline |
String |
Timeline do projeto de edição online. O valor é uma string JSON. |
|
Duration |
String |
Duração total do projeto de edição online. Deve ser igual à duração total da timeline. |
|
CoverURL |
String |
URL da miniatura do projeto de edição online. |
ProjectStatus: status do projeto de edição online
|
Valor |
Descrição |
Observações |
|
Normal |
Rascunho |
Status inicial de um projeto de edição online. |
|
Producing |
Renderizando |
Nenhuma. |
|
Produced |
Produção do vídeo concluída com sucesso. |
Nenhuma. |
|
ProduceFailed |
Falha na síntese. |
Nenhuma. |
Material: informações de material para um projeto de edição online
Este tipo refere-se genericamente a materiais, incluindo tanto os materiais do módulo Material Management quanto os vídeos da Media Library.
|
Nome |
Tipo |
Descrição |
|
MaterialId |
String |
ID do material. |
|
Title |
String |
Título do material. |
|
Description |
String |
Descrição do material. |
|
Duration |
Float |
Duração do material em segundos. O valor tem precisão de quatro casas decimais. |
|
CoverURL |
String |
URL da miniatura do material. |
|
Status |
String |
Status do material. |
|
CreationTime |
String |
Horário de criação do material. O horário é exibido em UTC. |
|
Size |
Long |
Tamanho do arquivo source em bytes. |
|
CateId |
Long |
ID da categoria do material. |
|
CateName |
String |
Nome da categoria do material. |
|
Tags |
String |
Tags do material. Separe múltiplas tags com vírgula (,). |
|
Snapshots |
String[] |
Array de URLs de snapshots do material. |
|
Sprites |
String[] |
Array de URLs de sprites do material. |
ProduceConfig: configuração de produção de vídeo
Nome | Tipo | Descrição |
TemplateGroupId | String | ID do grupo de modelos de transcodificação usado para transcodificar os arquivos de vídeo produzidos. Os vídeos produzidos servem como arquivos source 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á utilizado. Se especificado, o grupo de modelos informado será usado. Para visualizar o ID do grupo de modelos, acesse Transcoding Settings no console do ApsaraVideo VOD. |
TemplateId | String | ID do modelo de composição usado na composição de vídeo para gerar arquivos source de recursos de mídia. Este campo é opcional. Se o valor estiver vazio, o modelo interno de edição online 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 interno será H.264 e o formato do contêiner será MP4. Caso tenha outros requisitos para especificar parâmetros de composição (como composição de imagens animadas, legendagem inteligente, edição rápida M3U8 ou suporte a parâmetros personalizados), submit a ticket para solicitar. |
Width | Integer | 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 máxima e a altura máxima de todos os arquivos source na timeline. Por exemplo, se uma timeline contiver três arquivos source com resoluções de 1280 × 720 pixels, 1920 × 1080 pixels e 720 × 1280 pixels, a resolução do vídeo de saída será 1920 × 1280 pixels. |
Height | Integer | Altura do vídeo de saída, em pixels. Parâmetro opcional. A resolução de saída usa, por padrão, a maior largura e a maior altura entre todos os arquivos source da timeline. Por exemplo, se uma timeline utilizar três arquivos source com resoluções de 1280×720, 1920×1080 e 720×1280, a resolução do vídeo de saída será 1920×1280. |
Bitrate | Integer | Taxa de bits do vídeo produzido. Unidade: Kbit/s. Campo opcional. O valor padrão corresponde à taxa de bits máxima dos arquivos source especificados na Timeline. Por exemplo, se você especificar três materiais na Timeline e as taxas de bits dos arquivos source forem 400, 600 e 800 Kbit/s, a taxa de bits padrão do vídeo produzido será 800 Kbit/s. |
StorageLocation | String | Endereço de armazenamento do arquivo. Este parâmetro é obrigatório para regiões fora de China (Shanghai). |
MediaMetadata: metadados do vídeo produzido
|
Nome |
Tipo |
Descrição |
|
Title |
String |
Título do vídeo produzido. O valor pode ter até 128 bytes e deve estar codificado em UTF-8. |
|
Description |
String |
Descrição do vídeo produzido. O valor pode ter até 1.024 bytes e deve estar codificado em UTF-8. |
|
CoverURL |
String |
URL da miniatura personalizada do vídeo produzido. |
|
CateId |
String |
ID da categoria do vídeo produzido. Faça login no ApsaraVideo VOD console. No painel de navegação à esquerda, escolha Configuration Management > Media Management > Categories. |
|
Tags |
String |
Tags do vídeo produzido. Cada nome de tag pode ter até 32 bytes. É possível especificar no máximo 16 tags. Separe múltiplas tags com vírgulas (,). A string deve estar codificada no formato UTF-8. |
Edição online - Timeline (para o novo editor)
Os recursos de edição online variam conforme a região. Antes de utilizar este recurso, confirme se a região do seu service oferece suporte a ele. Para mais informações, consulte Service regions. Para descrições de parâmetros relacionados aos tipos de dados de edição online no editor legado, consulte Online editing data types (for the legacy editor).
Timeline: informações da timeline
A timeline resulta 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: faixas, 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 faixas de vídeo. A ordem de empilhamento de múltiplas faixas 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 faixas de áudio. |
|
|
SubtitleTracks |
Não |
Lista de faixas de legendas. |
|
|
EffectTracks |
Não |
Lista de faixas de efeitos. |
VideoTrack: informações da faixa de vídeo
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 faixa de vídeo padrão. Quando Type=Effect, a faixa atual funciona como uma faixa de efeitos. Nesse caso, VideoTrackClips pode conter EffectTrackItem. |
|
MainTrack |
Boolean |
Não |
Especifica se a faixa atual é a faixa principal. O padrão é False. |
|
VideoTrackClips |
Sim |
Lista de clipes de mídia da faixa de vídeo. |
AudioTrack: informações da faixa de áudio
AudioTrack organiza ativos de mídia baseados em áudio, incluindo arquivos somente de áudio e vídeos com streams de áudio.
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
MainTrack |
Boolean |
Não |
Especifica se a faixa atual é a faixa principal. O padrão é False. |
|
AudioTrackClips |
Sim |
Lista de clipes de mídia da faixa de áudio. |
SubtitleTrack: informações da faixa de legenda
SubtitleTrack organiza legendas, incluindo textos de banner e arquivos externos de legendas.
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
SubtitleTrackClips |
Sim |
Lista de clipes de mídia da faixa de legendas. |
EffectTrack: informações da faixa de efeitos
EffectTrack adiciona efeitos globais a todo o vídeo e oferece suporte a filtros e VFX.
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
EffectTrackItems |
Sim |
Lista de itens da faixa de efeitos. |
VideoTrackClip: informações de mídia da faixa de vídeo
VideoTrackClip inclui ativos de mídia de vídeo e imagem.
In, Out, TimelineIn e TimelineOut marcam os pontos inicial e final do clipe de origem e seu posicionamento na timeline. Por exemplo, para posicionar o segmento de 5 a 10 segundos de um vídeo na posição de 15 a 20 segundos na timeline, defina In=5, Out=10, TimelineIn=15 e TimelineOut=20.
Name | Type | Required | Description |
MediaId | String | No | ID de mídia do clipe da faixa de vídeo. Em alguns contextos, também é chamado de VideoId (para vídeo/áudio) ou ImageId (para imagens). |
Type | String | No | Tipo do clipe de mídia. O padrão é Video. Valores válidos:
Exemplo: Use GlobalImage in a video track |
X | Float | No | Distância horizontal do canto superior esquerdo da imagem ou vídeo até o canto superior esquerdo do vídeo de saída. Aceita valores percentuais ou em 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 | No | Distância vertical do canto superior esquerdo da imagem ou vídeo até o canto superior esquerdo do vídeo de saída. Aceita valores percentuais ou em 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 | No | Largura da imagem no vídeo de saída. Aceita valores percentuais ou em 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 | No | Altura da imagem no vídeo de saída. Aceita valores percentuais ou em 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 | No | Modo de dimensionamento do vídeo. O padrão é Fill. Este modo só entra em vigor quando Width e Height são definidos para a faixa de vídeo. Nesse caso, Width e Height definem as dimensões da área alvo, e o vídeo é dimensionado adaptativamente dentro dessa área.
|
In | Float | No | 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 | No | 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 fonte se não for especificado. |
MaxOut | Float | No | 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 fonte 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. Exemplo: Set MaxOut in a video track |
Duration | Float | No | Duração do clipe. Geralmente usado para fontes de imagem. Unidade: segundos, com precisão de quatro casas decimais. |
DyncFrames | Int | No | Taxa de quadros para imagens animadas. Aplica-se apenas quando a origem é uma imagem animada. Exemplo: Use GIF stickers |
TimelineIn | Float | No | Tempo inicial do clipe na timeline. Unidade: segundos, com precisão de quatro casas decimais. Se não for especificado, TimelineIn é calculado automaticamente com base no posicionamento sequencial. |
TimelineOut | Float | No | Tempo final do clipe na timeline. Unidade: segundos, com precisão de quatro casas decimais. Se não for especificado, TimelineOut é calculado automaticamente com base no posicionamento sequencial. |
Speed | Float | No | Velocidade de reprodução do clipe de vídeo. Intervalo válido: 0,1–100. Por exemplo, Speed=2 reproduz o clipe em velocidade dupla, reduzindo pela metade sua Duration na saída final. Exemplo: Adjust audio/video speed |
MaskVideoUrl | String | No | 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[] | No | Lista de efeitos aplicados ao clipe. |
AudioTrackClip: informações de mídia da faixa de áudio
AudioTrackClip inclui arquivos somente de áudio e vídeos que contêm streams de áudio.
In, Out, TimelineIn e TimelineOut marcam os pontos inicial e final do clipe de origem e seu posicionamento na timeline. Por exemplo, para posicionar o segmento de 5 a 10 segundos de um vídeo na posição de 15 a 20 segundos na timeline, 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 faixa 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 fonte se não for especificado. |
|
TimelineIn |
Float |
Não |
Tempo inicial do clipe na timeline. 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 timeline. 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 em velocidade dupla, reduzindo pela metade sua Duration na saída final. Exemplo: Adjust audio/video speed |
|
Effects |
Effect[] |
Não |
Lista de efeitos aplicados ao clipe. |
|
LoopMode |
Boolean |
Não |
Comportamento de reprodução em loop do clipe na timeline. True ativa a reprodução em loop. False (padrão) desativa o loop. Exemplo: Audio loop playback |
SubtitleTrackClip: informações de mídia da faixa de legenda
SubtitleTrackClip inclui ativos de mídia de legenda.
Name | Type | Required | Description |
Type | String | Yes | Tipo de mídia da legenda. Valores válidos:
|
SubType | String | No | Subtipo da mídia de legenda. Valores válidos:
Ignore este campo quando Type for Text. |
FileURL | String | No | 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: Edit directly using a subtitle file Nota FileURL suporta apenas URLs públicas do OSS. URLs aceleradas do OSS, URLs de CDN e outras URLs HTTP não são suportadas. |
X | Float | No | Quando Type for Text, distância horizontal do canto superior esquerdo do texto até o canto superior esquerdo do vídeo de saída. Aceita valores percentuais ou em 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 | No | Quando Type for Text, distância vertical do canto superior esquerdo do texto até o canto superior esquerdo do vídeo de saída. Aceita valores percentuais ou em 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 | No | Quando Type for Text, tempo inicial do texto na timeline. Unidade: segundos, com precisão de quatro casas decimais. Se não for especificado, TimelineIn é calculado automaticamente com base no posicionamento sequencial. |
TimelineOut | Float | No | Quando Type for Text, tempo final do texto na timeline. Unidade: segundos, com precisão de quatro casas decimais. Se não for especificado, TimelineOut é calculado automaticamente com base no posicionamento sequencial. |
Content | String | No | Quando Type for Text, obrigatório. Especifica o conteúdo do texto. |
Font | String | No | Quando Type for Text, especifica a fonte. O padrão é SimSun. Para a lista completa de fontes suportadas, consulte Font list. |
FontSize | Int | No | Quando o tipo de legenda for texto de banner, especifica o tamanho da fonte. |
FontColor | String | No | Quando Type for Text, especifica a cor da fonte em formato hexadecimal (# seguido de dígitos hexadecimais). Exemplo: #ffffff. |
FontColorOpacity | String | No | 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 | No | Quando Type for Text, especifica o estilo da fonte. | |
Spacing | Int | No | Quando Type for Text, especifica o espaçamento entre caracteres. Unidade: pixels. O padrão é 0. |
Angle | Float | No | Quando Type for Text, especifica o ângulo de rotação anti-horário. Unidade: graus. O padrão é 0. |
BorderStyle | Int | No | Especifica o estilo de borda e sombra para texto de banner. Valores válidos: 1 ou 3. 1 = borda + sombra. 3 = caixa de fundo opaca. O padrão é 1. |
Outline | Int | No | Quando Type for Text, especifica a largura do traço. Unidade: pixels. O padrão é 0. |
OutlineColour | String | No | Quando Type for Text, especifica a cor do traço em formato hexadecimal (# seguido de dígitos hexadecimais). Exemplo: #ffffff. |
Shadow | Int | No | Quando Type for Text, especifica a profundidade da sombra. Unidade: pixels. O padrão é 0. |
BackColour | String | No | Quando Type for Text, especifica a cor da sombra em formato hexadecimal (# seguido de dígitos hexadecimais). Exemplo: #ffffff. |
Alignment | String | No | Quando Type for Text, especifica o alinhamento do texto. O padrão é TopLeft. Valores válidos:
|
AdaptMode | String | No | Especifica como o texto de banner se adapta quando excede a largura do vídeo ou a TextWidth especificada. Valores válidos:
|
TextWidth | Integer | No | Largura da caixa de texto da legenda. Entra em vigor apenas quando AdaptMode estiver definido. A quebra automática de linha ou o dimensionamento usam essa largura. Se não for especificado, a largura do vídeo será usada. Unidade: pixels. |
FontUrl | String | No | Quando Type for Text, aceita 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 | No | Quando Type for Text, especifica o estilo de word art. Para estilos e efeitos de word art, consulte Word art effect examples. |
AaiMotionInEffect | String | No | Quando Type for Text, especifica o efeito de animação de entrada. Para tipos e exemplos de efeitos de entrada, consulte Entrance effects. |
AaiMotionIn | Float | No | 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 inferior a 0,5 segundos, a duração da entrada será igual à duração total menos a duração da saída. |
AaiMotionOutEffect | String | No | Quando o tipo de legenda for banner, especifica o efeito de entrada para o texto de banner. Para os tipos e efeitos de entradas de legenda, consulte Entrance effects. |
AaiMotionOut | Float | No | 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 inferior a 0,5 segundos, a duração da saída será igual à duração total do texto. |
AaiMotionLoopEffect | String | No | 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 de loop, consulte Loop effects. |
Ratio | Float | No | Quando Type for Text, especifica a velocidade de reprodução do efeito de 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 faixa de efeitos
EffectTrackItem inclui efeitos VFX e filtros.
Name | Type | Required | Description |
Type | String | Yes | Tipo do item da faixa de efeitos. Valores válidos: VFX, Filter. |
SubType | String | Yes | Subtipo do item da faixa de efeitos. Para tipos de efeitos suportados e exemplos, consulte Special effect examples e Filter effect examples. |
TimelineIn | Float | No | Tempo inicial do efeito na timeline. Unidade: segundos, com precisão de quatro casas decimais. O padrão é 0 se não for especificado. |
TimelineOut | Float | No | Tempo final do efeito na timeline. 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 | No | Duração do efeito na timeline. 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 | No | Aplica-se apenas quando SubType for mosaic_rect ou blur. Distância horizontal do canto superior esquerdo da área de efeito até o canto superior esquerdo do vídeo de saída. Aceita valores percentuais ou em 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 | No | Aplica-se apenas quando SubType for mosaic_rect ou blur. Distância vertical do canto superior esquerdo da área de efeito até o canto superior esquerdo do vídeo de saída. Aceita valores percentuais ou em 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 | No | Aplica-se apenas quando SubType for mosaic_rect ou blur. Largura da área de efeito no vídeo de saída. Aceita valores percentuais ou em 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 | No | Aplica-se apenas quando SubType for mosaic_rect ou blur. Altura da área de efeito no vídeo de saída. Aceita valores percentuais ou em 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 efeitos possuem propriedades únicas, mas também compartilham atributos comuns.
Para descrições detalhadas das propriedades individuais de Effect, consulte Effect configuration reference.
As propriedades comuns de Effect são as seguintes:
Name | Type | Required | Description |
Type | String | Yes | Tipo de efeito. Valores válidos:
|
SubType | String | No | Subtipo do 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 | Nome do modelo. |
VodTemplateId | String | ID do modelo. |
TemplateType | String | Tipo do modelo. Valores válidos:
|
IsDefault | String | Indica se esta é a marca d'água padrão. Valores válidos:
|
TemplateConfig | JSON | Configuração detalhada do modelo. O valor é uma string JSON.
|
CreationTime | String | Horário de criação do modelo. O horário está no formato UTC. |
ModifyTime | String | 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 |
ID do job de snapshot. |
|
CreationTime |
String |
Horário de criação do job de snapshot. O horário está em UTC. |
|
Total |
Long |
Número total de snapshots. |
|
Regular |
String |
Regra para geração de URLs de snapshot. |
|
Snapshots |
Snapshot[] |
Dados do snapshot. |
Snapshot: Informações do snapshot
|
Nome |
Tipo |
Descrição |
|
Index |
String |
Valor de índice do snapshot. |
|
Url |
String |
URL do snapshot. |
DynamicImage: Informações da imagem dinâmica
|
Nome |
Tipo |
Descrição |
|
VideoId |
String |
ID do vídeo. |
|
DynamicImageId |
String |
ID da imagem dinâmica. |
|
FileURL |
String |
URL do arquivo de imagem dinâmica. |
|
Width |
String |
Largura da imagem dinâmica. |
|
Height |
String |
Altura da imagem dinâmica. |
|
Duration |
String |
Duração da imagem dinâmica. |
|
Format |
String |
Formato da imagem dinâmica. Os valores válidos são |
|
FileSize |
String |
Tamanho do arquivo de imagem dinâmica. |
|
Fps |
String |
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 | Horário em que a marca d'água foi adicionada. |
Name | String | Sim | Nome da marca d'água. |
IsDefault | String | Sim | Indica se a marca d'água é a padrão. Valores válidos:
|
Type | String | Sim | Tipo da marca d'água. Valores válidos:
|
WatermarkId | String | Sim | ID da marca d'água. |
FileUrl | String | Não | URL do OSS ou URL do CDN do arquivo de marca d'água. Este parâmetro não se aplica a marcas d'água de texto. |
WatermarkConfig | Sim | 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 trabalho de transcodificação
|
Nome |
Tipo |
Descrição |
|
JobId |
String |
O ID do trabalho 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 momento em que o grupo de modelos foi criado. |
ModifyTime | String | Sim | O momento da última modificação do grupo de modelos. |
TranscodeTemplateList | Sim | A lista de configurações de modelos 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 segmentos 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 recorte 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 e 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. É possível 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
{
"Type":"VideoPackage",
"Video":{
"Codec":"H.264",
"Bitrate":"900",
"Width":"960",
"Remove":"false",
"Fps":"30"
},
"Audio":{
"Codec":"AAC",
"Bitrate":"128",
"Samplerate":"44100"
},
"Container":{
"Format":"m3u8"
},
"MuxConfig":{
"Segment":{
"Duration":"6"
}
},
"EncryptSetting":{
"EncryptType":"AliyunVoDEncryption"
},
"PackageSetting":{
"PackageType":"HLSPackage"
"PackageConfig":{
"BandWidth":"900000"
}
},
"SubtitleUrl": "http://outin-40564284ef058b2163e1****.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8ed****-cn.ass",
"CharEncode": "UTF-8",
"WatermarkIds":["USER_DEFAULT_WATERMARK","ddddddddd"],
"Definition":"SD",
"TemplateName":"test"
}
Video: configuração de transcodificação de fluxo de vídeo
Se não houver 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 à do 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 alvo 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 | Ativa 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 verticais. 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 aplica-se apenas à codificação H.264. Melhores práticas Se você oferecer suporte a várias definições, defina a definição mais baixa como baseline para garantir a reprodução em dispositivos básicos. Defina as 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 aplica-se 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 máxima 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
{
"Codec":"H.264",
"Bitrate":"128",
"Remove":"false",
"Width":"640",
"Fps":"30"
}
Audio: configuração de transcodificação de fluxo de áudio
Se não houver 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 alvo 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
{
"Codec":"AAC",
"Bitrate":"128",
"Remove":"false",
"Samplerate":"44100"
}
Container: formato de contêiner
Nome | Tipo | Obrigatório | Descrição |
Format | String | Sim | O formato do contêiner.
|
Exemplo do parâmetro Container
{
"Format":"mp4"
}
MuxConfig: configuração de segmentos 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
{
"Segment":{
"Duration":"10"
}
}
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 deve usar a resolução original 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 deve falhar. Valores válidos:
Valor padrão: false. |
IsCheckVideoBitrate | String | Não | Verifica a taxa de bits do vídeo source para determinar se deve usar a taxa de bits original 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 deve falhar. 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 deve usar a taxa de bits original 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 deve falhar. Valores válidos:
Valor padrão: false. Este valor tem precedência sobre IsCheckAudioBitrate. |
Exemplo do parâmetro TransConfig
{
"IsCheckReso":"true",
"IsCheckResoFail":"false",
"IsCheckVideoBitrate":"false",
"IsCheckVideoBitrateFail":"false",
"IsCheckAudioBitrate":"false",
"IsCheckAudioBitrateFail":"false"
}
Clip: configuração de corte de vídeo
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
TimeSpan |
Sim |
Configuração relacionada ao tempo para o corte de vídeo. |
TimeSpan: configuração de corte de vídeo
Nome | Tipo | Obrigatório | Descrição |
Seek | String | Sim | Tempo inicial do clipe de vídeo.
Recomendamos o uso do Formato 1. |
Duration | String | Não | Duração do corte de vídeo.
Recomendamos o uso do Formato 1. Nota É necessário especificar Duration ou End. Se ambos forem especificados, End terá efeito. |
End | String | Não | Duração do segmento final a ser descartado durante o corte de 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 | Tipo de criptografia. Valores válidos:
|
Exemplo do parâmetro EncryptSetting
{
"EncryptType":"AliyunVoDEncryption"
}
PackageSetting: configuração de empacotamento de transcodificação
Não é possível empacotar streams de áudio e vídeo extraídos.
Atualmente, apenas o empacotamento adaptativo de taxa de bits HLS é suportado.
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
PackageType |
String |
Sim |
Tipo de empacotamento. Valor válido: HLSPackage (empacotamento adaptativo de taxa de bits HLS). |
|
PackageConfig |
Não |
Configuração de empacotamento. Especifique este parâmetro para modelos VideoPackage. |
|
|
SubtitleExtractConfigList |
Não |
Configuração de empacotamento de legendas. Especifique este parâmetro para modelos SubtitlePackage. Não especifique para outros tipos de modelo. |
PackageConfig: configuração de empacotamento de vídeo
Defina este parâmetro apenas para empacotamento de streaming adaptativo de taxa de bits HLS.
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
BandWidth |
String |
Sim |
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
VideoPackage template configuration:
{
"PackageType":"HLSPackage",
"PackageConfig":{
"BandWidth":"400000"
}
}
SubtitleExtractConfig: configuração de empacotamento de legendas
Nome | Tipo | Obrigatório | Descrição |
SubtitleUrlList | String[] | Sim | URL do arquivo de legenda. Apenas URLs HTTP do OSS são suportadas. URLs HTTP de CDN e URLs HTTPS não são suportadas. Nota
|
Language | String | Sim | Idioma da legenda. Por exemplo, en-US. Consulte a RFC 5646 para mais informações. |
Format | String | Sim | Formato do arquivo de legenda. Apenas arquivos .vtt são suportados. Exemplo: subtitle.vtt. |
Name | String | Sim | Nome de exibição da faixa de legenda no player. Exemplo: Chinese ou English. |
Exemplo do parâmetro SubtitlePackage
SubtitlePackage template configuration:
{
"PackageType": "HLSPackage",
"SubtitleExtractConfigList": [
{
"SubtitleUrlList": [
"http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/4bff3675-79a5-40fa-8c86-1f98169d****-eng.vtt"
],
"Language": "en-US",
"Format": "vtt",
"Name": "English"
},
{
"SubtitleUrlList": [
"http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/a3f50b08-11c3-4511-94cf-7fd4f7a5****-jpn.vtt"
],
"Language": "ja",
"Format": "vtt",
"Name": "Japanese"
},
{
"SubtitleUrlList": [
"http://outin-40514****.oss-cn-shanghai.aliyuncs.com/subtitles/4dba87c2-a787-42cd-8328-2369aeb8****-cn.vtt"
],
"Language": "cn",
"Format": "vtt",
"Name": "Chinese"
}
]
}
SubtitleConfig: configuração de legenda
Nome | Tipo | Obrigatório | Descrição |
SubtitleUrl | String | Sim | URL do OSS do arquivo de legenda. URLs HTTPS e nomes de domínio CDN puros não são suportados. Formatos de legenda suportados: srt e ass. Nota O arquivo de legenda 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 | Formato de codificação de caracteres. Valores válidos:
Valor padrão: UTF-8. |
Para mais informações sobre o upload de arquivos de legenda, consulte CreateUploadAttachedMedia e OSS file upload.
Exemplo do parâmetro SubtitleConfig
{
"SubtitleUrl": "http://outin-40564284ef058b2d300163e1****.oss-cn-shanghai.aliyuncs.com/subtitles/c737f-14f1-4364-b107-d5f7f8ed****.ass",
"CharEncode": "UTF-8"
}
Volume: configuração de volume
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
Method |
String |
Não |
Método de ajuste de volume. Valores válidos: auto, dynamic, linear. |
|
IntegratedLoudnessTarget |
String |
Não |
Nível de loudness alvo. Valores válidos: [-70,-5]. Obrigatório se Method for definido como dynamic. Valor padrão: -6. |
|
TruePeak |
String |
Não |
Nível de pico máximo. Valores válidos: [-9,0]. Obrigatório se Method for definido como dynamic. Valor padrão: -1. |
|
LoudnessRangeTarget |
String |
Não |
Faixa de loudness. Valores válidos: [1,20]. Obrigatório se Method for 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 stream de vídeo
|
Codecs de Vídeo |
H.264 |
H.265 |
GIF |
|
Profile |
Suportado |
× |
× |
|
Bitrate |
Suportado |
Suportado |
× |
|
Crf |
Suportado |
Suportado |
× |
|
Width |
Suportado |
Suportado |
Suportado |
|
Height |
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 | ID do vídeo. |
TranscodeTemplateGroupId | String | ID do grupo de modelos de transcodificação usado para a transcodificação. |
TranscodeStatus | String | Status da transcodificação. Valores válidos:
|
TranscodeJobInfoSummaryList | Lista de resumos dos jobs de transcodificação. | |
CreationTime | String | Hora em que a tarefa de transcodificação foi criada. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC. |
CompleteTime | String | Hora em que a tarefa de transcodificação foi concluída. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC. |
TranscodeJobInfoSummary: resumo de um job de transcodificação
Nome | Tipo | Descrição |
TranscodeTemplateId | String | ID do modelo de transcodificação utilizado. |
Width | String | Largura do vídeo de saída. Unidade: pixels. |
Height | String | Altura do vídeo de saída. Unidade: pixels. |
Duration | String | Duração do vídeo de saída. Unidade: segundos. |
Filesize | String | Tamanho do arquivo de vídeo de saída. Unidade: bytes. |
Bitrate | String | Taxa de bits média do vídeo de saída. Unidade: Kbps. |
Fps | String | Taxa de quadros do vídeo de saída. Unidade: quadros por segundo. |
Format | String | Formato de contêiner do vídeo de saída. |
WatermarkIdList | String[] | Lista de IDs de marca d'água aplicados ao vídeo de saída. |
TranscodeProgress | Long | Progresso da transcodificação. Valores válidos: [0,100]. |
TranscodeJobStatus | String | Status do job de transcodificação. Valores válidos:
|
CreationTime | String | Hora em que o job de transcodificação foi criado. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC. |
CompleteTime | String | Hora em que o job de transcodificação foi concluído. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC. |
ErrorCode | String | Código de erro retornado se o job de transcodificação falhar. |
ErrorMessage | String | Mensagem de erro retornada se o job de transcodificação falhar. |
TranscodeTask: informações sobre uma tarefa de transcodificação
Nome | Tipo | Descrição |
TranscodeTaskId | String | ID da tarefa de transcodificação. |
TranscodeTemplateGroupId | String | ID do grupo de modelos de transcodificação usado para a transcodificação. |
VideoId | String | ID do vídeo. |
TaskStatus | String | Status da tarefa de transcodificação. Valores válidos:
|
CreationTime | String | Hora em que a tarefa de transcodificação foi criada. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC. |
CompleteTime | String | Hora em que a tarefa de transcodificação foi concluída. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC. |
Trigger | String | Tipo de gatilho. Valores válidos:
|
TranscodeJobInfoList | Informações sobre os jobs de transcodificação. |
TranscodeJobInfo: informações sobre um job de transcodificação
Nome | Tipo | Descrição |
TranscodeTaskId | String | ID da tarefa de transcodificação. |
TranscodeJobId | String | ID do job de transcodificação. |
VideoId | String | ID do vídeo. |
TranscodeProgress | Long | Progresso do job de transcodificação. Valores válidos: [0,100]. |
TranscodeJobStatus | String | Status do job de transcodificação. Valores válidos:
|
Priority | String | Prioridade da tarefa de transcodificação. |
Definition | String | Definição. Nota Este valor corresponde à tag de definição configurada no modelo de transcodificação e não representa a faixa de resolução real do vídeo de saída. |
TranscodeTemplateId | String | ID do modelo utilizado para a transcodificação. |
CreationTime | String | Momento em que o job de transcodificação foi criado. |
CompleteTime | String | Momento em que o job de transcodificação foi concluído. |
InputFileUrl | String | URL do arquivo source no OSS. |
OutputFile | Informações sobre o arquivo de saída. | |
ErrorCode | String | Código de erro retornado quando há falha na transcodificação. |
ErrorMessage | String | Mensagem de erro retornada quando há falha na transcodificação. |
OutputFile: arquivo de saída após a transcodificação
|
Nome |
Tipo |
Descrição |
|
OutputFileUrl |
String |
URL do arquivo de saída no OSS. |
|
Format |
String |
Formato de contêiner do arquivo de saída. |
|
Width |
String |
Largura do vídeo no arquivo de saída. Unidade: pixels. |
|
Height |
String |
Altura do vídeo no arquivo de saída. Unidade: pixels. |
|
Duration |
String |
Duração do arquivo de saída. Unidade: segundos. |
|
Bitrate |
String |
Taxa de bits média do arquivo de saída. Unidade: Kbps. |
|
Fps |
String |
Taxa de quadros do arquivo de saída. Unidade: quadros por segundo. |
|
Filesize |
Long |
Tamanho do arquivo de saída. Unidade: bytes. |
|
EncryptType |
String |
Tipo de criptografia aplicado ao arquivo de saída. O valor é uma string JSON. |
|
WatermarkIdList |
String |
Lista de IDs de marca d'água aplicados ao arquivo de saída. |
|
VideoStreamList |
String |
Lista de fluxos de vídeo. Para mais informações, consulte VideoStream: video stream information. |
|
AudioStreamList |
String |
Lista de fluxos de áudio. Para mais informações, consulte AudioStream: audio stream information. |
Estatísticas de dados
TopPlayVideoStatis: Estatísticas diárias dos vídeos mais reproduzidos
|
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 |
Quantidade 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 |
Quantidade de usuários que realizaram a reprodução. |
|
PlayRange |
String |
A distribuição da duração de reprodução. |
UserPlayStatisTotals: Estatísticas totais diárias 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 de reprodução em milissegundos. |
|
PlayRange |
String |
A distribuição da duração de reprodução. |
|
VV |
VV |
O número total de visualizações de vídeo. |
|
UV |
UV |
A quantidade total de usuários que reproduziram conteúdo. |
UserPlayStatisAvgs: Estatísticas médias diárias 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 de reprodução em milissegundos. |
|
AvgPlayCount |
String |
A média de visualizações de vídeo. |
Distribuição de VV
A coleta de estatísticas ocorre apenas para reproduções que utilizam os SDKs do Alibaba Cloud Video on Demand Player.
|
Nome |
Tipo |
Descrição |
|
Android |
String |
O total de visualizações de vídeo provenientes do player para Android. |
|
iOS |
String |
O total de visualizações de vídeo provenientes do player para iOS. |
|
Flash |
String |
Quantidade total de sessões de reprodução realizadas pelo player Flash. |
|
HTML5 |
String |
O total de visualizações de vídeo provenientes do player para HTML5. |
Distribuição de UV por contagem de reprodução
A coleta de estatísticas ocorre apenas para reproduções que utilizam os SDKs do Alibaba Cloud Video on Demand Player.
|
Nome |
Tipo |
Descrição |
|
Android |
String |
O total de visitantes únicos provenientes do player para Android. |
|
iOS |
String |
Quantidade total de usuários que realizaram reprodução no player iOS. |
|
Flash |
String |
Total de usuários de reprodução no Flash Player. |
|
HTML5 |
String |
Quantidade 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. |