Parameter untuk pemrosesan media di ApsaraVideo VOD - ApsaraVideo VOD

Topik ini menjelaskan parameter pemrosesan media yang digunakan dalam API ApsaraVideo VOD.

EncryptConfig: konfigurasi untuk enkripsi HLS

Parameter	Tipe	Diperlukan	Deskripsi
CipherText	String	Ya	Kunci ciphertext yang digunakan untuk mendapatkan kunci plaintext.
DecryptKeyUri	String	Ya	Alamat yang digunakan untuk mendapatkan kunci dekripsi berdasarkan kunci ciphertext. Contoh: `http://example.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk****`.
KeyServiceType	String	Ya	Tipe layanan kunci. Nilai default: KMS, yang menunjukkan Key Management Service dari Alibaba Cloud.

Contoh parameter EncryptConfig

{
  "CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk****",
  "DecryptKeyUri":"http://example.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk****",
  "KeyServiceType":"KMS"
}

OverrideParams: konfigurasi untuk pekerjaan transkoding

Parameter	Tipe	Diperlukan	Deskripsi
Watermarks	Watermark[]	Tidak	Konfigurasi watermark. Untuk mengganti watermark, Anda harus mengatur parameter ini.
SubtitleSetting	SubtitleSetting	Tidak	Paket subtitle. Untuk mengganti subtitle video, Anda harus mengatur parameter ini. Catatan Pastikan bahwa subtitle parameters are set in advance untuk template transkoding yang Anda gunakan. Jika tidak, Anda tidak dapat memodifikasi konfigurasi subtitle. Untuk informasi lebih lanjut tentang cara mengatur parameter subtitle, lihat SubtitleConfig. URL baru yang digunakan untuk mendapatkan file subtitle harus berupa HTTP-based Object Storage Service (OSS) URL, seperti `http://out-dda**.cn-shanghai.aliyuncs.com/subtitle/subtitle.ass`. CDN URLs and HTTPS-based OSS URLs are not supported.**
PackageSubtitleSetting	PackageSubtitleSetting[]	Tidak	Konfigurasi pengemasan subtitle. Untuk mengganti URL yang digunakan untuk mendapatkan file subtitle untuk template streaming bitrate adaptif, Anda harus mengatur parameter ini.
TranscodeTemplateList	TranscodeTemplate[]	Tidak	Konfigurasi template transkoding. Untuk memodifikasi konfigurasi template transkoding, Anda harus mengatur parameter ini. Anda dapat memodifikasi parameter Video, Audio, Clip, Rotate, dan TranscodeFileRegular dari template transkoding. Anda tidak dapat memodifikasi parameter template kualitas asli. Untuk memodifikasi konfigurasi template transkoding, Anda harus mengatur parameter TranscodeTemplateId.

Catatan

Anda hanya dapat mengganti gambar atau teks untuk watermark.

Contoh parameter TranscodeTemplateList

        [
                {
                  "TranscodeTemplateId":"9580424e49b28c952a46544e3e8f****",
                  "Video":{
                          "Width":720,
                          "Height":480,
                          "Bitrate":"600"
                  },
                  "Audio":{
                          "Bitrate":128
                  }, 
                  "Clip":{
                          "TimeSpan":{
                                "Seek":"1"
                                "Duration":"5"
                        },
                  "Rotate":"270",
                  "TranscodeFileRegular":"{MediaId}/{JobId}/{PlayDefinition}"
                  }
                }
        ]

Watermark: konfigurasi watermark

Parameter	Tipe	Diperlukan	Deskripsi
WatermarkId	String	Ya	ID watermark yang terkait dengan template transkoding. Anda dapat menanyakan ID watermark di konsol ApsaraVideo VOD. Untuk informasi lebih lanjut, lihat Kelola watermark.
FileUrl	String	Tidak	URL OSS file watermark. Untuk mengonfigurasi watermark gambar, Anda harus mengatur parameter ini. Untuk informasi lebih lanjut tentang cara mendapatkan URL OSS, lihat CreateUploadAttachedMedia.
Content	String	Tidak	Konten watermark teks. Untuk mengonfigurasi watermark teks, Anda harus mengatur parameter ini.

Penting

File watermark harus disimpan pada origin yang sama dengan video sumber.

SubtitleSetting: file subtitle

Parameter	Tipe	Diperlukan	Deskripsi
SubtitleList	Subtitle	Ya	File subtitle.

Subtitle: konfigurasi subtitle

Parameter

Tipe

Diperlukan

Deskripsi

SubtitleUrl

String

URL OSS file subtitle. URL HTTPS tidak didukung.

CharEncode

String

Format encoding konten subtitle. Nilai valid:

auto: deteksi otomatis
UTF-8
GBK
BIG5

Catatan: Kami merekomendasikan Anda mengatur parameter CharEncode ke format encoding yang valid berdasarkan kebutuhan bisnis Anda. Jika Anda mengatur parameter ke auto, format encoding yang terdeteksi mungkin bukan format encoding yang sebenarnya.

PackageSubtitleSetting: pengaturan pengemasan subtitle

Parameter	Tipe	Diperlukan	Deskripsi
PackageSubtitleList	PackageSubtitle[]	Ya	Paket subtitle. Untuk mengganti subtitle video, Anda harus mengatur parameter ini.

PackageSubtitle: konfigurasi pengemasan subtitle

Parameter	Tipe	Diperlukan	Deskripsi
SubtitlePackageTemplateId	String	Ya	ID template paket subtitle.
Language	String	Ya	Bahasa subtitle, seperti en-US. Untuk informasi lebih lanjut, lihat RFC 5646. Catatan Parameter ini hanya digunakan untuk menanyakan URL file subtitle yang akan diganti dan tidak dapat digunakan untuk mengubah bahasa subtitle.
SubtitleUrl	String	Ya	URL file subtitle. Hanya URL OSS HTTP yang didukung. URL CDN HTTP dan URL HTTPS tidak didukung. Catatan Anda hanya dapat menentukan satu URL HTTP. Anda hanya dapat menyimpan file subtitle di bucket yang dialokasikan oleh ApsaraVideo VOD.

Catatan

Parameter SubtitlePackageTemplateId dan Language hanya digunakan untuk menanyakan URL file subtitle yang akan diganti dan tidak dapat digunakan untuk mengubah bahasa subtitle.

Contoh parameter OverrideParams

{
  "Watermarks":[
    {
      "WatermarkId":"watermark1",
      "FileUrl":"http://****.bucket.aliyuncs.com/image/replace.png"
    },
    {
      "WatermarkId":"watermark2",
      "Content":"Watermark Test"
    }
  ],
  "SubtitleSetting":{
          "SubtitleList":[
                {
                "SubtitleUrl":"http://outin-****.oss-cn-shanghai.aliyuncs.com/subtitles/7b850b-724c-4011-b885-dd16c****.ass",
                "CharEncode":"UTF-8"
                },
                {
                "SubtitleUrl":"http://outin-****.oss-cn-shanghai.aliyuncs.com/subtitles/7b86db-724c-4011-b885-dd161d****.srt",
                "CharEncode":"auto"
                }
        ]
  },
  "PackageSubtitleSetting": {
    "PackageSubtitleList": [
      {
        "Language": "en-US",
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395****", 
        "SubtitleUrl": "http://outin-****.oss-cn-shanghai.aliyuncs.com/789679188D1F36A00AEB****.vtt" 
      },
      {
        "Language": "ja",  
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395ad****",
        "SubtitleUrl": "http://outin-****.oss-cn-shanghai.aliyuncs.com/F43FD90FF4B936A00AEB****.vtt"
      }
    ]
  }
}

WatermarkConfig: konfigurasi watermark

Parameter untuk watermark gambar

Parameter	Tipe	Diperlukan	Deskripsi
Dx	String	Ya	Offset horizontal watermark. Jenis nilai berikut didukung: Nilai piksel: [8,4096] Rasio gambar: (0,1). Nilai 0 menunjukkan bahwa proporsi offset vertikal terhadap tinggi gambar video adalah 0%. Nilai 1 menunjukkan bahwa proporsinya adalah 100%. Nilai 0,5 menunjukkan bahwa proporsinya adalah 50%. Nilai lainnya dapat dikonversi dengan cara yang sama.
Dy	String	Ya	Offset vertikal watermark. Jenis nilai berikut didukung: Nilai piksel: [8,4096] Rasio gambar: (0,1). Nilai 0 menunjukkan bahwa proporsi offset vertikal terhadap tinggi gambar video adalah 0%. Nilai 1 menunjukkan bahwa proporsinya adalah 100%. Nilai 0,5 menunjukkan bahwa proporsinya adalah 50%. Nilai lainnya dapat dikonversi dengan cara yang sama.
Width	String	Ya	Lebar watermark. Jenis nilai berikut didukung: Nilai piksel: [8,4096] Rasio gambar: (0,1). Nilai 0 menunjukkan bahwa proporsi offset horizontal terhadap lebar gambar video adalah 0%. Nilai 1 menunjukkan bahwa proporsinya adalah 100%. Nilai 0,5 menunjukkan bahwa proporsinya adalah 50%. Nilai lainnya dapat dikonversi dengan cara yang sama.
Height	String	Ya	Tinggi watermark. Jenis nilai berikut didukung: Nilai piksel: [8,4096] Rasio gambar: (0,1). Nilai 0 menunjukkan bahwa proporsi offset horizontal terhadap lebar gambar video adalah 0%. Nilai 1 menunjukkan bahwa proporsinya adalah 100%. Nilai 0,5 menunjukkan bahwa proporsinya adalah 50%. Nilai lainnya dapat dikonversi dengan cara yang sama.
ReferPos	String	Ya	Posisi watermark. Nilai valid: BottomRight BottomLeft TopRight TopLeft
Timeline	Timeline	Tidak	Timeline untuk tampilan watermark, termasuk waktu mulai dan waktu akhir. Nilainya adalah string JSON.

Penting

Parameter ini hanya berlaku untuk watermark gambar.

Parameter untuk watermark teks

Parameter	Tipe	Diperlukan	Deskripsi
Content	String	Ya	Konten watermark teks. Contoh: "Watermark Teks".
FontName	String	Tidak	Nama font. Untuk informasi lebih lanjut, lihat Nilai parameter nama font.
FontColor	String	Tidak	Warna font. Untuk informasi lebih lanjut, lihat Parameter pengaturan warna.
FontAlpha	String	Tidak	Transparansi watermark teks. Nilai valid: (0,1]. Nilai default: 1.0.
BorderColor	String	Tidak	Warna garis luar font. Untuk informasi lebih lanjut, lihat Parameter pengaturan warna.
Top	Integer	Tidak	Margin atas watermark teks. Hanya nilai integer yang didukung. Nilai default: 0. Nilai valid: [0,4096].
Left	Integer	Tidak	Margin kiri watermark teks. Hanya nilai integer yang didukung. Nilai default: 0. Nilai valid: [0,4096].
FontSize	Integer	Tidak	Ukuran font. Hanya nilai integer yang didukung. Nilai default: 16. Nilai valid: (4,120).
BorderWidth	Integer	Tidak	Lebar garis luar font. Hanya nilai integer yang didukung. Nilai default: 0. Nilai valid: (0,4096].

Timeline: konfigurasi timeline watermark

Parameter	Tipe	Diperlukan	Deskripsi
Start	String	Ya	Awal rentang waktu saat watermark ditampilkan. Satuan: detik. Nilai valid: bilangan positif. Nilai default: 0.
Duration	String	Ya	Rentang waktu saat watermark ditampilkan. Satuan: detik. Nilai valid: [Nilai parameter Start,ToEND]. Nilai default: ToEND, yang menunjukkan akhir video.

Penting

Parameter ini hanya berlaku untuk watermark gambar.

Nilai parameter untuk nama font

Nama font	Deskripsi
SimSun	Simplified Chinese-SimSun
WenQuanYi Zen Hei	WenQuanYi Zen Hei
WenQuanYi Zen Hei Mono	Simplified Chinese-WenQuanYi Zen Hei Mono
WenQuanYi Zen Hei Sharp	Simplified Chinese-WenQuanYi Zen Hei Sharp
Yuanti SC	Yuanti SC Regular

Cuplikan video

Konfigurasi template cuplikan

SnapshotTemplateConfig

Parameter

Tipe

Diperlukan

Deskripsi

SnapshotType

String

Jenis snapshot. Nilai valid:

NormalSnapshot: snapshot normal
SpriteSnapshot: sprite gambar
WebVttSnapshot: snapshot WebVTT

SnapshotConfig

JSON

Konfigurasi snapshot, yang bervariasi berdasarkan jenis snapshot. Untuk informasi lebih lanjut, lihat SnapshotConfig.

SnapshotConfig

Catatan

Sprite gambar terdiri dari beberapa snapshot normal. Oleh karena itu, parameter SnapshotConfig diperlukan untuk sprite gambar dan snapshot normal.

Parameter	Tipe	Diperlukan	Deskripsi
FrameType	String	Ya	Jenis frame snapshot. Nilai valid: intra: keyframe normal: frame normal
Count	Long	Ya	Jumlah snapshot yang ingin Anda ambil.
Interval	Long	Ya	Interval snapshot. Nilainya harus lebih besar dari atau sama dengan 0. Satuan: detik. Jika Anda mengatur parameter ini ke 0, snapshot diambil pada interval yang merata berdasarkan durasi video dibagi dengan nilai parameter Count.
SpecifiedOffsetTime	Long	Ya	Titik waktu ketika snapshot pertama diambil. Satuan: milidetik.
Width	Integer	Tidak	Lebar setiap snapshot. Nilai valid: [8,4096]. Secara default, lebar video sumber digunakan. Satuan: piksel.
Height	Integer	Tidak	Tinggi setiap snapshot. Nilai valid: [8,4096]. Secara default, tinggi video sumber digunakan. Satuan: piksel.
SpriteSnapshotConfig	JSON	Tidak	Konfigurasi snapshot untuk sprite gambar. Parameter ini diperlukan jika Anda mengatur SnapshotType ke SpriteSnapshot. Untuk informasi lebih lanjut, lihat SpriteSnapshotConfig.
Format	String	Tidak	Format file keluaran. Atur nilainya ke vtt. Parameter ini hanya berlaku ketika parameter SnapshotType diatur ke WebVttSnapshot.
SubOut	JSON	Tidak	Menentukan bagaimana snapshot ditampilkan. Parameter ini hanya berlaku ketika parameter SnapshotType diatur ke WebVttSnapshot. Untuk informasi lebih lanjut, lihat SubOut.

SpriteSnapshotConfig

Parameter	Tipe	Diperlukan	Deskripsi
CellWidth	String	Tidak	Lebar snapshot asli yang menyusun sprite gambar. Nilai default: lebar snapshot normal. Satuan: piksel.
CellHeight	String	Tidak	Tinggi snapshot asli yang menyusun sprite gambar. Nilai default: tinggi snapshot normal. Satuan: piksel.
Padding	String	Ya	Padding snapshot asli yang menyusun sprite gambar. Satuan: piksel.
Margin	String	Ya	Margin snapshot asli yang menyusun sprite gambar. Satuan: piksel.
Color	String	Ya	Warna latar belakang sprite gambar. Untuk informasi lebih lanjut, lihat Parameter pengaturan warna. Catatan Anda tidak dapat mengatur warna latar belakang menggunakan nilai RGB.
Columns	String	Ya	Jumlah kolom untuk snapshot asli yang menyusun sprite gambar. Nilai valid: [1,10000].
Lines	String	Ya	Jumlah baris untuk snapshot asli yang menyusun sprite gambar. Nilai valid: [1,10000].
KeepCellPic	String	Ya	Menentukan apakah akan mempertahankan snapshot asli yang menyusun sprite gambar. Nilai valid: keep delete

SubOut

Parameter

Tipe

Diperlukan

Deskripsi

IsSptFrag

String

Nilai valid:

false: menyimpan setiap snapshot secara terpisah.
true: menggabungkan beberapa snapshot untuk menghasilkan sprite gambar dan menyimpan sprite gambar tersebut.

Contoh parameter SnapshotConfig

{
  "SnapshotConfig": {
    "Count": 10,
    "SpecifiedOffsetTime": 0,
    "Interval": 1
  },
  "SnapshotType": "NormalSnapshot"
}

Animasi frame

Konfigurasi template animasi frame

DynamicImageTemplateConfig

Parameter	Tipe	Diperlukan	Deskripsi
Name	String	Ya	Nama template animasi frame.
Video	JSON	Ya	Konfigurasi tampilan stiker animasi. Untuk informasi lebih lanjut, lihat Video.
Container	JSON	Ya	Format stiker animasi. Untuk informasi lebih lanjut, lihat Container.
Clip	JSON	Ya	Konfigurasi yang digunakan untuk menghasilkan stiker animasi dari klip video. Untuk informasi lebih lanjut, lihat Clip.
SetDefaultCover	String	Ya	Menentukan apakah akan secara otomatis menggunakan stiker animasi yang diambil sebagai thumbnail video. Nilai valid: true: menggunakan stiker animasi yang diambil sebagai thumbnail video. false: tidak menggunakan stiker animasi yang diambil sebagai thumbnail video.

Video

Catatan

Jika Anda tidak menentukan Width atau Height, ukuran video sumber digunakan.
Jika Anda hanya menentukan parameter Width, tinggi stiker animasi diubah berdasarkan rasio aspek video sumber.
Jika Anda hanya menentukan parameter Height, lebar stiker animasi diubah berdasarkan rasio aspek video sumber.

Parameter	Tipe	Diperlukan	Deskripsi
Width	String	Tidak	Lebar stiker animasi. Nilai valid:[128,4096].
Height	String	Tidak	Tinggi stiker animasi. Nilai valid:[128,4096].
Fps	String	Ya	Frame rate stiker animasi. Nilai valid: (0,60].

Container

Parameter

Tipe

Diperlukan

Deskripsi

Format

String

Format stiker animasi. Nilai valid:

webp
gif

Clip

Parameter	Tipe	Diperlukan	Deskripsi
TimeSpan	JSON	Ya	Konfigurasi timeline stiker animasi. Untuk informasi lebih lanjut, lihat TimeSpan.

TimeSpan

Catatan

Jika Anda ingin menangkap stiker animasi berdasarkan durasi, tentukan parameter Seek dan Duration. Jika Anda ingin menangkap bagian tertentu dari video untuk menghasilkan stiker animasi, Anda harus menentukan parameter Seek dan End.
Jika Anda menentukan parameter Seek, Duration, dan End pada saat yang sama, parameter Seek dan End berlaku.

Parameter	Tipe	Diperlukan	Deskripsi
Seek	String	Ya	Waktu mulai klip video yang ditangkap. Nilai dalam format berikut didukung: Format 1: sssss[.SSS]. Nilai valid: [0.000,86399.999]. Contoh: 0. Format 2: hh:mm:ss[.SSS]. Nilai valid:[00:00:00.000,23:59:59.999]. Contoh: 00:00:05.003.
Duration	String	Tidak	Durasi klip video. Nilai dalam format berikut didukung: Format 1: sssss[.SSS]. Nilai valid: [0.000,86399.999]. Contoh: 15. Format 2: hh:mm:ss[.SSS]. Nilai valid:[00:00:00.000,23:59:59.999]. Contoh: 00:00:10.003.
End	String	Tidak	Durasi sisa video setelah klip video dipotong. Jika Anda menentukan parameter ini, parameter Duration tidak berlaku. Nilai dalam format berikut didukung: Format 1: sssss[.SSS]. Nilai valid: [0.000,86399.999]. Contoh: 12000.55. Format 2: hh:mm:ss[.SSS]. Nilai valid:[00:00:00.000,23:59:59.999]. Contoh: 00:00:15.003.

Contoh parameter DynamicImageTemplateConfig

{
  "Video": {
    "Fps": 5,
    "Width": 1024
  },
  "Clip": {
    "TimeSpan": {
      "Seek": 0,
      "Duration": 15
    }
  },
  "Container": {
    "Format": "gif"
  },
  "SetDefaultCover": "false"
}