You need to enable JavaScript to run this app.
导航

转码配置

最近更新时间2024.05.21 14:57:30

首次发布时间2023.12.28 21:21:53

阅读本文,您可以获取 Python SDK 转码配置的接口调用示例,实现快速开发。

说明

本文的调用示例包含接口的部分参数。由于参数间可能存在互斥关系,在调用时,请您参考注释,进行调整。

调用说明

  • 本文提供的接口调用示例均通过 AK 和 SK 初始化实例。
  • 接口的参数说明和错误码等信息可通过接口文档或打开 API Explorer文档说明页签查看。

前提条件

调用接口前,请先完成 Python SDK 的安装及初始化操作。

调用示例

本节为您介绍转码配置相关接口的功能和调用示例。

添加转码配置

您可以调用 CreateTranscodePreset 接口添加转码配置。详细的参数说明可参见 CreateTranscodePreset 接口文档。

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService
if __name__ == '__main__':
  # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
  # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service = LiveService("live.volcengineapi.com",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])

  body = {
    # 音频编码格式,默认值为 `aac`,支持的取值及含义如下所示。
    # <li> `aac`:使用 AAC 音频编码格式; </li>
    # <li> `opus`:使用 Opus 音频编码格式。 </li>
    # <li> `copy`:不进行音频转码,所有音频编码参数不生效,音频编码参数包括音频码率(`AudioBitrate`)等。 </li>
    "Acodec": "acc",
    # 应用名称,取值与直播流地址的 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
    "App": "live",
    # 视频分辨率自适应模式开关,默认值为 `0`。支持的取值及含义如下。
    # <li> `0`:关闭视频分辨率自适应; </li>
    # <li> `1`:开启视频分辨率自适应。 </li>
    # note:
    # <li> 关闭视频分辨率自适应模式(`As` 取值为 `0`)时,转码配置的视频分辨率取视频宽度(`Width`)和视频高度(`Height`)的值对转码视频进行拉伸; </li>
    # <li> 开启视频分辨率自适应模式(`As` 取值为 `1`)时,转码配置的视频分辨率按照短边长度(`ShortSide`)、长边长度(`LongSide`)、视频宽度(`Width`)、视频高度(`Height`)的优先级取值,另一边等比缩放。 </li>
    "As": "1",
    # 音频码率,单位为 kbps,默认值为 `128`,取值范围为 [0,1000];取值为 `0` 时,表示与源流的音频码率相同。
    "AudioBitrate": 50,
    # 是否开启转码视频分辨率不超过源流分辨率,默认值为 `1` 表示开启。开启后,当源流分辨率低于转码配置分辨率时(即源流宽低于转码配置宽且源流高低于转码配置高时),将按源流视频分辨率进行转码。
    # <li> `0`:关闭; </li>
    # <li> `1`:开启。 </li>
    "AutoTransResolution": 1,
    # 是否开启转码视频码率不超过源流码率,默认值为 `1` 表示开启。开启后,当源流码率低于转码配置码率时,将按照源流视频码率进行转码。
    # <li> `0`:关闭; </li>
    # <li> `1`:开启。 </li>
    "AutoTransVb": 1,
    # 是否开启转码视频帧率不超过源流帧率,默认值为 `1` 表示开启。开启后,当源流帧率低于转码配置帧率时,将按照源流视频帧率进行转码。
    # <li> `0`:关闭; </li>
    # <li> `1`:开启。 </li>
    "AutoTransVr": 1,
    # 转码输出视频中 2 个参考帧之间的最大 B 帧数量,默认值为 `3`,取值为 `0` 时表示去除 B 帧。
    # 最大 B 帧数量的取值范围根据视频编码格式(Vcodec)的不同有所差异,取值范围如下所示。
    # <li> 视频编码格式为 H.264 (`Vcodec` 取值为 `h264`)时取值范围为 [0,7]; </li>
    # <li> 视频编码格式为 H.265 或 H.266 (`Vcodec` 取值为 `h265` 或 `h266`)时取值范围为 [0,3]、7、15。 </li>
    "BFrames": 3,
    # 视频帧率,单位为 fps,默认值为 `25`,取值为 `0` 时表示与源流视频帧率相同。
    # 视频帧率的取值范围根据视频编码格式(`Vcodec`)的不同有所差异,视频码率的取值范围如下所示。
    # <li> 视频编码格式为 H.264 或 H.265 (`Vcodec` 取值为 `h264` 或 `h265`)时,视频帧率取值范围为 [0,60]; </li>
    # <li> 视频编码格式为 H.266 (`Vcodec` 取值为 `h266`)时,视频帧率取值范围为 [0,35]。 </li>
    "FPS": 25,
    # IDR 帧之间的最大间隔时间,单位为秒,默认值为 `4`,取值范围为 [1,20]。
    "GOP": 4,
    # 视频高度,默认值为 `0`。
    # 视频高度的取值范围根据视频编码格式(`Vcodec`)的不同所有差异,视频高度取值如下所示。
    # <li> 视频编码格式为 H.264 或 H.265 (`Vcodec` 取值为 `h264` 或 `h265`)时,取值范围为 [150,1920]; </li>
    # <li> 视频编码格式为 H.266 (`Vcodec` 取值为 `h266`)时,不支持设置 `Width` 和 `Height`。 </li>
    # note:
    # <li> 当关闭视频分辨率自适应(`As` 取值为 `0`)时,转码分辨率将取 `Width` 和 `Height` 的值对转码视频进行拉伸; </li>
    # <li> 当关闭视频分辨率自适应(`As` 取值为 `0`)时,`Width` 和 `Height` 任一取值为 `0` 时,转码视频将保持源流尺寸。 </li>
    "Height": 200,
    # 长边长度,默认值为 `0`。配置不同的转码类型(`Roi`)和视频编码方式(`Vcodec`)时,短边长度的取值范围存在如下。
    # <li> 转码类型为标准转码(`Roi` 取值为 `false`)时: </li>
    # <li> 视频编码方式为 H.264 (`Vcodec` 取值为 `h264`)时取值范围为 0 和 [150,4096]; </li>
    # <li> 视频编码方式为 H.265 (`Vcodec` 取值为 `h265`)时取值范围为 0 和 [150,7680]; </li>
    # <li> 视频编码方式为 H.266 (`Vcodec` 取值为 `h266`)时取值范围为 0 和 [150,1280]。 </li>
    # <li> 转码类型为极智超清转码(`Roi` 取值为 `true`)时: </li>
    # <li> 视频编码方式为 H.264 或 H.265 (`Vcodec` 取值为 `h264` 或 `h265`)时取值范围为 0 和 [150,1920]。 </li>
    # note:
    # <li> 当开启视频分辨率自适应模式时(`As` 取值为 `1`)时,参数生效,反之则不生效。 </li>
    # <li> 当开启视频分辨率自适应模式时(`As` 取值为 `1`)时,如果 `LongSide` 、 `ShortSide` 、`Width` 、`Height` 同时取 `0`,表示保持源流尺寸。 </li>
    "LongSide": 500,
    # 转码类型是否为极智超清转码,默认值为 `false`,取值及含义如下。
    # <li> `true`:极智超清转码; </li>
    # <li> `false`:标准转码。 </li>
    # note:
    # 视频编码格式为 H.266 (`Vcodec` 取值为 `h266`)时,转码类型不支持极智超清转码。
    "Roi": True,
    # 短边长度,默认值为 `0`。配置不同的转码类型(`Roi`)和视频编码方式(`Vcodec`)时,短边长度的取值范围存在如下。
    # <li> 转码类型为标准转码(`Roi` 取值为 `false`)时: </li>
    # <li> 视频编码方式为 H.264 (`Vcodec` 取值为 `h264`)时取值范围为 0 和 [150,2160]; </li>
    # <li> 视频编码方式为 H.265 (`Vcodec` 取值为 `h265`)时取值范围为 0 和 [150,4096]; </li>
    # <li> 视频编码方式为 H.266 (`Vcodec` 取值为 `h266`)时取值范围为 0 和 [150,720]。 </li>
    # <li> 转码类型为极智超清转码(`Roi` 取值为 `true`)时: </li>
    # <li> 视频编码方式为 `H.264` 或 `H.265` (`Vcodec` 取值为 `h264` 或 `h265`)时取值范围为 0 和 [150,1920]。 </li>
    # note:
    # <li> 当开启视频分辨率自适应模式(`As` 取值为 `1`)时,参数生效,反之则不生效。 </li>
    # <li> 当开启视频分辨率自适应模式(`As` 取值为 `1`)时,如果 `LongSide` 、 `ShortSide` 、`Width` 、`Height` 同时取 `0`,表示保持源流尺寸。 </li>
    "ShortSide": 768,
    # 转码停止时长,支持触发方式为拉流转码(`TransType` 取值为 `Pull`)时设置,表示断开拉流后转码停止的时长,单位为秒,取值范围为 `-1` 和 [0,300],`-1` 表示不停止转码,默认值为 `60`。
    "StopInterval": 60,
    # 转码后缀,支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)和短横线(-)组成,长度为 1 到 10 个字符。
    # 转码后缀通常以流名称后缀的形式来使用,常见的标识有 `_sd`、`_hd`、`_uhd`,例如,当转码配置的标识为 `_hd` 时,拉取转码流时转码流的流名名称为 `源流的流名称_hd`。
    "SuffixName": "_hd",
    # 视频编码格式,支持的取值及含义如下所示。
    # <li> `h264`:使用 H.264 视频编码格式; </li>
    # <li> `h265`:使用 H.265 视频编码格式; </li>
    # <li> `h266`:使用 H.266 视频编码格式; </li>
    # <li> `copy`:不进行视频转码,所有视频编码参数不生效,视频编码参数包括视频帧率(`FPS`)、视频码率(`VideoBitrate`)、分辨率设置(`As`、`Width`、`Height`、`ShortSide`、`LongSide`)、`GOP` 和 `BFrames` 等。 </li>
    "Vcodec": "h265",
    # 域名空间,即直播流地址的域名所属的域名空间。您可以调用 [`ListDomainDetail`](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面,查看需要转码的直播流使用的域名所属的域名空间。
    "Vhost": "push.example.com",
    # 视频码率,单位为 bps,默认值为 `1000000`;取值为 `0` 时,表示与源流的视频码率相同。
    # 视频码率的取值范围根据视频编码格式(`Vcodec`)的不同有所差异,视频码率的取值范围如下所示。
    # <li> 视频编码格式为 H.264 或 H.265 (`Vcodec` 取值为 `h264` 或 `h265`)时,视频码率取值范围为 [0,30000000]; </li>
    # <li> 视频编码格式为 H.266 (`Vcodec` 取值为 `h266`)时,视频码率取值范围为 [0,6000000]。 </li>
    "VideoBitrate": 1000000,
    # 视频宽度,单位为 px,默认值为 `0`。
    # 视频宽度的取值范围根据视频编码格式(`Vcodec`)的不同所有差异,视频宽度取值如下所示。
    # <li> 视频编码格式为 H.264 或 H.265 (`Vcodec` 取值为 `h264` 或 `h265`)时,取值范围为 [150,1920]; </li>
    # <li> 视频编码格式为 H.266 (`Vcodec` 取值为 `h266`)时,不支持设置 Width 和 Height。 </li>
    # note:
    # <li> 当关闭视频分辨率自适应(`As` 取值为 `0`)时,转码分辨率将取 `Width` 和 `Height` 的值对转码视频进行拉伸; </li>
    # <li> 当关闭视频分辨率自适应(`As` 取值为 `0`)时,`Width` 和 `Height` 任一取值为 `0` 时,转码视频将保持源流尺寸。 </li>
    "Width": 0,
    # 转码触发方式,默认值为 `Pull`,支持的取值及含义如下。
    # <li> `Push`:推流转码,直播推流后会自动启动转码任务,生成转码流; </li>
    # <li> `Pull`:拉流转码,直播推流后,需要主动播放转码流才会启动转码任务,生成转码流。 </li>
    "TransType": "Pull",
  }

  resp = service.create_transcode_preset(body)
  print(resp)
  

删除转码配置

您可以调用 DeleteTranscodePreset 接口删除转码配置。详细的参数说明可参见 DeleteTranscodePreset 接口文档。

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService
if __name__ == '__main__':
  # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
  # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service = LiveService("live.volcengineapi.com",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])

  body = {
    # 应用名称,您可以调用 [ListVhostTransCodePreset](https://www.volcengine.com/docs/6469/1126853) 接口查看待删除转码配置的 `App` 取值。
    "App": "live",
    # 转码配置名称,您可以调用 [ListVhostTransCodePreset](https://www.volcengine.com/docs/6469/1126853) 接口查看待删除转码配置的 `Preset` 取值。
    "Preset": "testPreset",
    # 域名空间,您可以调用 [ListVhostTransCodePreset](https://www.volcengine.com/docs/6469/1126853) 接口查看待删除转码配置的 `Vhost` 取值。
    "Vhost": "push.example.com",
  }

  resp = service.delete_transcode_preset(body)
  print(resp)
  

更新转码配置

您可以调用 UpdateTranscodePreset 接口更新转码配置。详细的参数说明可参见 UpdateTranscodePreset 接口文档。

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService
if __name__ == '__main__':
  # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
  # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service = LiveService("live.volcengineapi.com",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])

  body = {
    # 音频编码格式,默认值为 `aac`,支持的取值及含义如下所示。
    # <li> `aac`:使用 AAC 音频编码格式; </li>
    # <li> `opus`:使用 Opus 音频编码格式。 </li>
    # <li> `copy`:不进行音频转码,所有音频编码参数不生效,音频编码参数包括音频码率(`AudioBitrate`)等。 </li>
    "Acodec": "aac",
    # 应用名称,取值与直播流地址的 `AppName` 字段取值相同,您可以调用 [ListVhostTransCodePreset](https://www.volcengine.com/docs/6469/1126853) 接口查看待更新转码配置的 `App` 取值。
    "App": "live",
    # 视频分辨率自适应模式开关,默认值为 `0`。支持的取值及含义如下。
    # <li> `0`:关闭视频分辨率自适应; </li>
    # <li> `1`:开启视频分辨率自适应。 </li>
    # note:
    # <li> 关闭视频分辨率自适应模式(`As` 取值为 `0`)时,转码配置的视频分辨率取视频宽度(`Width`)和视频高度(`Height`)的值对转码视频进行拉伸; </li>
    # <li> 开启视频分辨率自适应模式(`As` 取值为 `1`)时,转码配置的视频分辨率按照短边长度(`ShortSide`)、长边长度(`LongSide`)、视频宽度(`Width`)、视频高度(`Height`)的优先级取值,另一边等比缩放。 </li>
    "As": "1",
    # 音频码率,单位为 kbps,默认值为 `128`,取值范围为 [0,1000];取值为 `0` 时,表示与源流的音频码率相同。
    "AudioBitrate": 30,
    # 是否开启转码视频分辨率不超过源流分辨率,默认值为 `1` 表示开启。开启后,当源流分辨率低于转码配置分辨率时(即源流宽低于转码配置宽且源流高低于转码配置高时),将按源流视频分辨率进行转码。
    # <li> `0`:关闭; </li>
    # <li> `1`:开启。 </li>
    "AutoTransResolution": 1,
    # 是否开启转码视频码率不超过源流码率,默认值为 `1` 表示开启。开启后,当源流码率低于转码配置码率时,将按照源流视频码率进行转码。
    # <li> `0`:关闭; </li>
    # <li> `1`:开启。 </li>
    "AutoTransVb": 1,
    # 是否开启转码视频帧率不超过源流帧率,默认值为 `1` 表示开启。开启后,当源流帧率低于转码配置帧率时,将按照源流视频帧率进行转码。
    # <li> `0`:关闭; </li>
    # <li> `1`:开启。 </li>
    "AutoTransVr": 1,
    # 转码输出视频中 2 个参考帧之间的最大 B 帧数量,默认值为 `3`,取值为 `0` 时表示去除 B 帧。
    # 最大 B 帧数量的取值范围根据视频编码格式(Vcodec)的不同有所差异,取值范围如下所示。
    # <li> 视频编码格式为 H.264 (`Vcodec` 取值为 `h264`)时取值范围为 [0,7]; </li>
    # <li> 视频编码格式为 H.265 或 H.266 (`Vcodec` 取值为 `h265` 或 `h266`)时取值范围为 [0,3]、7、15。 </li>
    "BFrames": 3,
    # 视频帧率,单位为 fps,默认值为 `25`,取值为 `0` 时表示与源流视频帧率相同。
    # 视频帧率的取值范围根据视频编码格式(`Vcodec`)的不同有所差异,视频码率的取值范围如下所示。
    # <li> 视频编码格式为 H.264 或 H.265 (`Vcodec` 取值为 `h264` 或 `h265`)时,视频帧率取值范围为 [0,60]; </li>
    # <li> 视频编码格式为 H.266 (`Vcodec` 取值为 `h266`)时,视频帧率取值范围为 [0,35]。 </li>
    "FPS": 60,
    # IDR 帧之间的最大间隔时间,单位为秒,默认值为 `4`,取值范围为 [1,20]。
    "GOP": 4,
    # 视频高度,默认值为 `0`。
    # 视频高度的取值范围根据视频编码格式(`Vcodec`)的不同所有差异,视频高度取值如下所示。
    # <li> 视频编码格式为 H.264 或 H.265 (`Vcodec` 取值为 `h264` 或 `h265`)时,取值范围为 [150,1920]; </li>
    # <li> 视频编码格式为 H.266 (`Vcodec` 取值为 `h266`)时,不支持设置 `Width` 和 `Height`。 </li>
    # note:
    # <li> 当关闭视频分辨率自适应(`As` 取值为 `0`)时,转码分辨率将取 `Width` 和 `Height` 的值对转码视频进行拉伸; </li>
    # <li> 当关闭视频分辨率自适应(`As` 取值为 `0`)时,`Width` 和 `Height` 任一取值为 `0` 时,转码视频将保持源流尺寸。 </li>
    "Height": 768,
    # 长边长度,默认值为 `0`。配置不同的转码类型(`Roi`)和视频编码方式(`Vcodec`)时,短边长度的取值范围存在如下。
    # <li> 转码类型为标准转码(`Roi` 取值为 `false`)时: </li>
    # <li> 视频编码方式为 H.264 (`Vcodec` 取值为 `h264`)时取值范围为 0 和 [150,4096]; </li>
    # <li> 视频编码方式为 H.265 (`Vcodec` 取值为 `h265`)时取值范围为 0 和 [150,7680]; </li>
    # <li> 视频编码方式为 H.266 (`Vcodec` 取值为 `h266`)时取值范围为 0 和 [150,1280]。 </li>
    # <li> 转码类型为极智超清转码(`Roi` 取值为 `true`)时: </li>
    # <li> 视频编码方式为 H.264 或 H.265 (`Vcodec` 取值为 `h264` 或 `h265`)时取值范围为 0 和 [150,1920]。 </li>
    # note:
    # <li> 当开启视频分辨率自适应模式时(`As` 取值为 `1`)时,参数生效,反之则不生效。 </li>
    # <li> 当开启视频分辨率自适应模式时(`As` 取值为 `1`)时,如果 `LongSide` 、 `ShortSide` 、`Width` 、`Height` 同时取 `0`,表示保持源流尺寸。 </li>
    "LongSide": 600,
    # 转码配置的名称,您可以调用 [ListVhostTransCodePreset](https://www.volcengine.com/docs/6469/1126853) 接口查看待更新转码配置的 `Preset` 取值。
    "Preset": "PresetName",
    # 转码类型是否为极智超清转码,默认值为 `false`,取值及含义如下。
    # <li> `true`:极智超清转码; </li>
    # <li> `false`:标准转码。 </li>
    # note:
    # 视频编码格式为 H.266 (`Vcodec` 取值为 `h266`)时,转码类型不支持极智超清转码。
    "Roi": True,
    # 短边长度,默认值为 `0`。配置不同的转码类型(`Roi`)和视频编码方式(`Vcodec`)时,短边长度的取值范围存在如下。
    # <li> 转码类型为标准转码(`Roi` 取值为 `false`)时: </li>
    # <li> 视频编码方式为 H.264 (`Vcodec` 取值为 `h264`)时取值范围为 0 和 [150,2160]; </li>
    # <li> 视频编码方式为 H.265 (`Vcodec` 取值为 `h265`)时取值范围为 0 和 [150,4096]; </li>
    # <li> 视频编码方式为 H.266 (`Vcodec` 取值为 `h266`)时取值范围为 0 和 [150,720]。 </li>
    # <li> 转码类型为极智超清转码(`Roi` 取值为 `true`)时: </li>
    # <li> 视频编码方式为 `H.264` 或 `H.265` (`Vcodec` 取值为 `h264` 或 `h265`)时取值范围为 0 和 [150,1920]。 </li>
    # note:
    # <li> 当开启视频分辨率自适应模式(`As` 取值为 `1`)时,参数生效,反之则不生效。 </li>
    # <li> 当开启视频分辨率自适应模式(`As` 取值为 `1`)时,如果 `LongSide` 、 `ShortSide` 、`Width` 、`Height` 同时取 `0`,表示保持源流尺寸。 </li>
    "ShortSide": 500,
    # 转码停止时长,支持触发方式为拉流转码(`TransType` 取值为 `Pull`)时设置,表示断开拉流后转码停止的时长,单位为秒,取值范围为 `-1` 和 [0,300],`-1` 表示不停止转码,默认值为 `60`。
    "StopInterval": 60,
    # 转码后缀,支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)和短横线(-)组成,长度为 1 到 10 个字符。
    # 转码后缀通常以流名称后缀的形式来使用,常见的标识有 `_sd`、`_hd`、`_uhd`,例如,当转码配置的标识为 `_hd` 时,拉取转码流时转码流的流名名称为 `源流的流名称_hd`。
    "SuffixName": "hd",
    # 视频编码格式,支持的取值及含义如下所示。
    # <li> `h264`:使用 H.264 视频编码格式; </li>
    # <li> `h265`:使用 H.265 视频编码格式; </li>
    # <li> `h266`:使用 H.266 视频编码格式; </li>
    # <li> `copy`:不进行视频转码,所有视频编码参数不生效,视频编码参数包括视频帧率(`FPS`)、视频码率(`VideoBitrate`)、分辨率设置(`As`、`Width`、`Height`、`ShortSide`、`LongSide`)、`GOP` 和 `BFrames` 等。 </li>
    "Vcodec": "h265",
    # 域名空间,您可以调用 [ListVhostTransCodePreset](https://www.volcengine.com/docs/6469/1126853) 接口查看待更新转码配置的 `Vhost` 取值。
    "Vhost": "push.example.com",
    # 视频码率,单位为 bps,默认值为 `1000000`;取值为 `0` 时,表示与源流的视频码率相同。
    # 视频码率的取值范围根据视频编码格式(`Vcodec`)的不同有所差异,视频码率的取值范围如下所示。
    # <li> 视频编码格式为 H.264 或 H.265 (`Vcodec` 取值为 `h264` 或 `h265`)时,视频码率取值范围为 [0,30000000]; </li>
    # <li> 视频编码格式为 H.266 (`Vcodec` 取值为 `h266`)时,视频码率取值范围为 [0,6000000]。 </li>
    "VideoBitrate": 0,
    # 视频宽度,单位为 px,默认值为 `0`。
    # 视频宽度的取值范围根据视频编码格式(`Vcodec`)的不同所有差异,视频宽度取值如下所示。
    # <li> 视频编码格式为 H.264 或 H.265 (`Vcodec` 取值为 `h264` 或 `h265`)时,取值范围为 [150,1920]; </li>
    # <li> 视频编码格式为 H.266 (`Vcodec` 取值为 `h266`)时,不支持设置 Width 和 Height。 </li>
    # note:
    # <li> 当关闭视频分辨率自适应(`As` 取值为 `0`)时,转码分辨率将取 `Width` 和 `Height` 的值对转码视频进行拉伸; </li>
    # <li> 当关闭视频分辨率自适应(`As` 取值为 `0`)时,`Width` 和 `Height` 任一取值为 `0` 时,转码视频将保持源流尺寸。 </li>
    "Width": 1366,
    # 转码触发方式,默认值为 `Pull`,支持的取值及含义如下。
    # <li> `Push`:推流转码,直播推流后会自动启动转码任务,生成转码流; </li>
    # <li> `Pull`:拉流转码,直播推流后,需要主动播放转码流才会启动转码任务,生成转码流。 </li>
    "TransType": "Pull",
  }

  resp = service.update_transcode_preset(body)
  print(resp)
  

查询内置转码档位的详细配置

您可以调用 ListCommonTransPresetDetail 接口查询内置转码档位的详细配置。详细的参数说明可参见 ListCommonTransPresetDetail 接口文档。

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService
if __name__ == '__main__':
  # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
  # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service = LiveService("live.volcengineapi.com",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])

  body = {
    # 模板名称列表,缺省情况下,表示查询所有系统内置转码档位。
    "PresetList" : ["preser1","preset2"], 
  }

  resp = service.list_common_trans_preset_detail(body)
  print(resp)
  

查询转码配置列表

您可以调用 ListVhostTransCodePreset 接口查询转码配置列表。详细的参数说明可参见 ListVhostTransCodePreset 接口文档。

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService
if __name__ == '__main__':
  # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
  # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service = LiveService("live.volcengineapi.com",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])

  body = {
    # 域名空间,即直播流地址的域名所属的域名空间。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面,查看需要录制的直播流使用的域名所属的域名空间。
    "Vhost": "push.example.com",
  }

  resp = service.list_vhost_trans_code_preset(body)
  print(resp)
  

查询转码任务

您可以调用 TranscodingJobStatus 接口查询转码任务。详细的参数说明可参见 TranscodingJobStatus 接口文档。

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService
if __name__ == '__main__':
  # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
  # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service = LiveService("live.volcengineapi.com",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])

  query = {
    # 域名空间,即直播流地址的域名所属的域名空间。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面,查看需要查询的直播流使用的域名所属的域名空间。
    "Vhost": "push.example.com",
    # 应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
    "App": "live",
    # 流名称,取值与直播流地址中 StreamName 字段取值相同,默认为空表示查询所有流名称。支持由大小写字母(A - Z、a - z)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。
    "Stream": "example_stream",
    # 转码配置的后缀,需去除转码后缀前的下划线(`_`)。如您配置的转码后缀为`_hd`,此处应传入`hd`。
    "TranscodingTemplate": "hd",
  }

  resp = service.transcoding_job_status(query)
  print(resp)
  

重启转码任务

您可以调用 RestartTranscodingJob 接口重启转码任务。详细的参数说明可参见 RestartTranscodingJob 接口文档。

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService
if __name__ == '__main__':
  # 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。
  # 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service = LiveService("live.volcengineapi.com",os.environ['ACCESS_KEY_ID'], os.environ['ACCESS_KEY_SECRET'])

  query = {
    # 域名空间,即直播流地址的域名所属的域名空间。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面,查看需要查询的直播流使用的域名所属的域名空间。
    "Vhost": "push.example.com",
    # 应用名称,取值与直播流地址中 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
    "App": "live",
    # 流名称,取值与直播流地址中 StreamName 字段取值相同,默认为空表示查询所有流名称。支持由大小写字母(A - Z、a - z)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。
    "Stream": "example_stream",
    # 转码配置的后缀,需去除转码后缀前的下划线(`_`)。如您配置的转码后缀为`_hd`,此处应传入`hd`。
    "TranscodingTemplate": "hd",
  }

  resp = service.restart_transcoding_job(query)
  print(resp)