转码配置

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

调用说明

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

前提条件

调用接口前，请先完成 Go SDK 的安装及初始化操作

调用示例

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

添加转码配置

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

接口调用示例如下所示。

package main

import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
   	"github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live_v20230101.NewInstance()

  service.SetCredential(base.Credentials{
    AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
    SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live_v20230101.CreateTranscodePresetBody{}
     
  //音频编码格式，默认值为 `aac`，支持的取值及含义如下所示。
  // <li> `aac`：使用 AAC 音频编码格式； </li>
  // <li> `opus`：使用 Opus 音频编码格式。 </li>
  // <li> `copy`：不进行音频转码，所有音频编码参数不生效，音频编码参数包括音频码率（`AudioBitrate`）等。 </li>
  var bodyAcodec *string 

  var bodyAcodecValue string = "acc" 

  bodyAcodec = &bodyAcodecValue 

  body.Acodec = bodyAcodec 
    
  //应用名称，取值与直播流地址的 AppName 字段取值相同。支持由大小写字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
  body.App = "live"
    
  //视频分辨率自适应模式开关，默认值为 `0`。支持的取值及含义如下。
  // <li> `0`：关闭视频分辨率自适应； </li>
  // <li> `1`：开启视频分辨率自适应。 </li>
  // note：
  // <li> 关闭视频分辨率自适应模式（`As` 取值为 `0`）时，转码配置的视频分辨率取视频宽度（`Width`）和视频高度（`Height`）的值对转码视频进行拉伸； </li>
  // <li> 开启视频分辨率自适应模式（`As` 取值为 `1`）时，转码配置的视频分辨率按照短边长度（`ShortSide`）、长边长度（`LongSide`）、视频宽度（`Width`）、视频高度（`Height`）的优先级取值，另一边等比缩放。 </li>
  var bodyAs *string 

  var bodyAsValue string = "1" 

  bodyAs = &bodyAsValue 

  body.As = bodyAs 
    
  //音频码率，单位为 kbps，默认值为 `128`，取值范围为 [0,1000]；取值为 `0` 时，表示与源流的音频码率相同。
  var bodyAudioBitrate *int32 

  var bodyAudioBitrateValue int32 = 50 

  bodyAudioBitrate = &bodyAudioBitrateValue 

  body.AudioBitrate = bodyAudioBitrate 
    
  //是否开启转码视频分辨率不超过源流分辨率，默认值为 `1` 表示开启。开启后，当源流分辨率低于转码配置分辨率时（即源流宽低于转码配置宽且源流高低于转码配置高时），将按源流视频分辨率进行转码。
  // <li> `0`：关闭； </li>
  // <li> `1`：开启。 </li>
  var bodyAutoTransResolution *int32 

  var bodyAutoTransResolutionValue int32 = 1 

  bodyAutoTransResolution = &bodyAutoTransResolutionValue 

  body.AutoTransResolution = bodyAutoTransResolution 
    
  //是否开启转码视频码率不超过源流码率，默认值为 `1` 表示开启。开启后，当源流码率低于转码配置码率时，将按照源流视频码率进行转码。
  // <li> `0`：关闭； </li>
  // <li> `1`：开启。 </li>
  var bodyAutoTransVb *int32 

  var bodyAutoTransVbValue int32 = 1 

  bodyAutoTransVb = &bodyAutoTransVbValue 

  body.AutoTransVb = bodyAutoTransVb 
    
  //是否开启转码视频帧率不超过源流帧率，默认值为 `1` 表示开启。开启后，当源流帧率低于转码配置帧率时，将按照源流视频帧率进行转码。
  // <li> `0`：关闭； </li>
  // <li> `1`：开启。 </li>
  var bodyAutoTransVr *int32 

  var bodyAutoTransVrValue int32 = 1 

  bodyAutoTransVr = &bodyAutoTransVrValue 

  body.AutoTransVr = bodyAutoTransVr 
    
  //转码输出视频中 2 个参考帧之间的最大 B 帧数量，默认值为 `3`，取值为 `0` 时表示去除 B 帧。
  // 最大 B 帧数量的取值范围根据视频编码格式（Vcodec）的不同有所差异，取值范围如下所示。
  // <li> 视频编码格式为 H.264 （`Vcodec` 取值为 `h264`）时取值范围为 [0,7]； </li>
  // <li> 视频编码格式为 H.265 （`Vcodec` 取值为 `h265`）时取值范围为 [0,3]、7、15； </li>
  // <li> 视频编码格式为 H.266 （`Vcodec` 取值为 `h266`）时取值范围为 [0,3]、7、15。 </li>
  var bodyBFrames *int32 

  var bodyBFramesValue int32 = 3 

  bodyBFrames = &bodyBFramesValue 

  body.BFrames = bodyBFrames 
    
  //视频帧率，单位为 fps，默认值为 `25`，取值为 `0` 时表示与源流视频帧率相同。
  // 视频帧率的取值范围根据视频编码格式（`Vcodec`）的不同有所差异，视频码率的取值范围如下所示。
  // <li> 视频编码格式为 H.264 或 H.265 （`Vcodec` 取值为 `h264` 或 `h265`）时，视频帧率取值范围为 [0,60]； </li>
  // <li> 视频编码格式为 H.266 （`Vcodec` 取值为 `h266`）时，视频帧率取值范围为 [0,35]。 </li>
  var bodyFPS *int32 

  var bodyFPSValue int32 = 25 

  bodyFPS = &bodyFPSValue 

  body.FPS = bodyFPS 
    
  //IDR 帧之间的最大间隔时间，单位为秒，默认值为 `4`，取值范围为 [1,20]。
  var bodyGOP *int32 

  var bodyGOPValue int32 = 4 

  bodyGOP = &bodyGOPValue 

  body.GOP = bodyGOP 
    
  //视频高度，默认值为 `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>
  var bodyHeight *int32 

  var bodyHeightValue int32 = 200 

  bodyHeight = &bodyHeightValue 

  body.Height = bodyHeight 
    
  //长边长度，默认值为 `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>
  var bodyLongSide *int32 

  var bodyLongSideValue int32 = 500 

  bodyLongSide = &bodyLongSideValue 

  body.LongSide = bodyLongSide 
    
  //转码类型是否为极智超清转码，默认值为 `false`，取值及含义如下。
  // <li> `true`：极智超清转码； </li>
  // <li> `false`：标准转码。 </li>
  // note：
  // 视频编码格式为 H.266 （`Vcodec` 取值为 `h266`）时，转码类型不支持极智超清转码。
  var bodyRoi *bool 

  var bodyRoiValue bool = true 

  bodyRoi = &bodyRoiValue 

  body.Roi = bodyRoi 
    
  //短边长度，默认值为 `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>
  var bodyShortSide *int32 

  var bodyShortSideValue int32 = 768 

  bodyShortSide = &bodyShortSideValue 

  body.ShortSide = bodyShortSide 
    
  //转码停止时长，支持触发方式为拉流转码（`TransType` 取值为 `Pull`）时设置，表示断开拉流后转码停止的时长，单位为秒，取值范围为 `-1` 和 [0,300]，`-1` 表示不停止转码，默认值为 `60`。
  var bodyStopInterval *int32 

  var bodyStopIntervalValue int32 = 60 

  bodyStopInterval = &bodyStopIntervalValue 

  body.StopInterval = bodyStopInterval 
    
  //转码后缀，支持由大小写字母（A - Z、a - z）、下划线（_）和短横线（-）组成，长度为 1 到 10 个字符。
  // 转码后缀通常以流名称后缀的形式来使用，常见的标识有 `_sd`、`_hd`、`_uhd`，例如，当转码配置的标识为 `_hd` 时，拉取转码流时转码流的流名名称为 `源流的流名称_hd`。
  body.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>
  body.Vcodec = "h265"
    
  //域名空间，即直播流地址的域名所属的域名空间。您可以调用 [`ListDomainDetail`](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面，查看需要转码的直播流使用的域名所属的域名空间。
  body.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>
  var bodyVideoBitrate *int32 

  var bodyVideoBitrateValue int32 = 1000000 

  bodyVideoBitrate = &bodyVideoBitrateValue 

  body.VideoBitrate = bodyVideoBitrate 
    
  //视频宽度，单位为 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>
  var bodyWidth *int32 

  var bodyWidthValue int32 = 0 

  bodyWidth = &bodyWidthValue 

  body.Width = bodyWidth 
    
  //转码触发方式，默认值为 `Pull`，支持的取值及含义如下。
  // <li> `Push`：推流转码，直播推流后会自动启动转码任务，生成转码流； </li>
  // <li> `Pull`：拉流转码，直播推流后，需要主动播放转码流才会启动转码任务，生成转码流。 </li>
  var bodyTransType *string 

  var bodyTransTypeValue string = "Pull" 

  bodyTransType = &bodyTransTypeValue 

  body.TransType = bodyTransType
  
  resp, err := service.CreateTranscodePreset(context.Background(), body)

  if err != nil {
    fmt.Printf("error %v", err)
  } else {
    fmt.Printf("success %+v", resp)
  }
}

删除转码配置

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

接口调用示例如下所示。

package main

import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
   	"github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live_v20230101.NewInstance()

  service.SetCredential(base.Credentials{
    AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
    SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live_v20230101.DeleteTranscodePresetBody{}
     
  //应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。
  body.App = "live"
    
  //转码配置名称。
  body.Preset = "testPreset"
    
  //域名空间名称。
  body.Vhost = "push.example.com"
  
  resp, err := service.DeleteTranscodePreset(context.Background(), body)

  if err != nil {
    fmt.Printf("error %v", err)
  } else {
    fmt.Printf("success %+v", resp)
  }
}

更新转码配置

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

接口调用示例如下所示。

package main

import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
   	"github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live_v20230101.NewInstance()

  service.SetCredential(base.Credentials{
    AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
    SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live_v20230101.UpdateTranscodePresetBody{}
     
  //音频编码格式，支持以下 3 种类型。
  // <li> aac：使用 AAC 编码格式； </li>
  // <li> copy：不进行转码，所有音频编码参数不生效； </li>
  // <li> opus：使用 Opus 编码格式。 </li>
  var bodyAcodec *string 

  var bodyAcodecValue string = "aac" 

  bodyAcodec = &bodyAcodecValue 

  body.Acodec = bodyAcodec 
    
  //应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。
  var bodyApp *string 

  var bodyAppValue string = "live" 

  bodyApp = &bodyAppValue 

  body.App = bodyApp 
    
  //宽高自适应模式开关，默认值为 0。支持的取值及含义如下。
  // <li> 0：关闭宽高自适应 </li>
  // <li> 1：开启宽高自适应 </li>
  // note：
  // <li> 关闭宽高自适应时，转码配置分辨率取 `Width` 和 `Height` 的值对转码视频进行拉伸； </li>
  // <li> 开启宽高自适应时，转码配置分辨率按照 `ShortSide` 、 `LongSide` 、`Width` 、`Height` 的优先级取值，另一边等比缩放。 </li>
  // <li> 修改 `As` 为 0 时，请确认 `Width` 和 `Height` 的取值是否超出阈值； </li>
  // <li> 修改 `As` 为 1 时，请确认 `ShortSide` 和 `LongSide` 的取值是否超出阈值。 </li>
  var bodyAs *string 

  var bodyAsValue string = "1" 

  bodyAs = &bodyAsValue 

  body.As = bodyAs 
    
  //音频码率，单位为 kbps。
  var bodyAudioBitrate *int32 

  var bodyAudioBitrateValue int32 = 30 

  bodyAudioBitrate = &bodyAudioBitrateValue 

  body.AudioBitrate = bodyAudioBitrate 
    
  //是否开启转码不超过源流分辨率。开启后，当源流分辨率低于转码配置分辨率时(即源流宽低于转码配置宽且源流高低于转码配置高时)，将按源流视频分辨率进行转码，默认开启。
  // <li> 0：关闭 </li>
  // <li> 1：开启 </li>
  var bodyAutoTransResolution *int32 

  var bodyAutoTransResolutionValue int32 = 1 

  bodyAutoTransResolution = &bodyAutoTransResolutionValue 

  body.AutoTransResolution = bodyAutoTransResolution 
    
  //是否开启不超过源流码率。开启后，当源流码率低于转码配置码率时，将按照源流视频码率进行转码，默认开启。
  // <li> 0：关闭 </li>
  // <li> 1：开启 </li>
  var bodyAutoTransVb *int32 

  var bodyAutoTransVbValue int32 = 1 

  bodyAutoTransVb = &bodyAutoTransVbValue 

  body.AutoTransVb = bodyAutoTransVb 
    
  //是否开启不超过源流帧率。开启后，当源流帧率低于转码配置帧率时，将按照源流视频帧率进行转码，默认开启。
  // <li> 0：关闭 </li>
  // <li> 1：开启 </li>
  var bodyAutoTransVr *int32 

  var bodyAutoTransVrValue int32 = 1 

  bodyAutoTransVr = &bodyAutoTransVrValue 

  body.AutoTransVr = bodyAutoTransVr 
    
  //2 个参考帧之间的最大 B 帧数，默认值为 3。配置不同的视频编码格式时，最大 B 帧数的取值存在如下差异。
  // <li> H.264：取值范围为 [0,7]； </li>
  // <li> H.265：取值范围为 [0,3]、7、15； </li>
  // <li> H.266：取值范围为 [0,3]、7、15。 </li>
  // 取值为 0 时，表示去除 B 帧。
  var bodyBFrames *int32 

  var bodyBFramesValue int32 = 3 

  bodyBFrames = &bodyBFramesValue 

  body.BFrames = bodyBFrames 
    
  //视频帧率，单位为 fps，默认值为 25，帧率越大，画面越流畅。
  // 配置不同视频编码格式时，视频帧率的取值存在如下差异。
  // <li> H.264：取值范围为 [0,60]； </li>
  // <li> H.265：取值范围为 [0,60]； </li>
  // <li> H.266：取值范围为 [0,35]。 </li>
  var bodyFPS *int32 

  var bodyFPSValue int32 = 60 

  bodyFPS = &bodyFPSValue 

  body.FPS = bodyFPS 
    
  //IDR 帧之间的最大间隔，单位为秒，默认值为 4，取值范围为 [1,20]。
  var bodyGOP *int32 

  var bodyGOPValue int32 = 4 

  bodyGOP = &bodyGOPValue 

  body.GOP = bodyGOP 
    
  //视频高度，默认值为 0。配置不同视频编码格式时，视频高度的取值存在如下差异。
  // <li> H.264：取值范围为 [150,1920]； </li>
  // <li> H.265：取值范围为 [150,1920]。 </li>
  // note：
  // <li> 当 `As` 的取值为 0 时，参数生效；反之则不生效； </li>
  // <li> 编码格式为 H.266 时，不支持设置 Width 和 Height，请使用自适应配置。 </li>
  var bodyHeight *int32 

  var bodyHeightValue int32 = 768 

  bodyHeight = &bodyHeightValue 

  body.Height = bodyHeight 
    
  //长边长度，配置不同的视频编码方式和转码类型时，长边长度的取值范围存在如下差异。
  // <li> `Roi` 取 false 时： </li>
  // <li> H.264：取值范围为 0 和 [150,4096]； </li>
  // <li> H.265：取值范围为 0 和 [150,7680]； </li>
  // <li> H.266：取值范围为 0 和 [150,1280]。 </li>
  // <li> `Roi` 取 true 时： </li>
  // <li> H.264：取值范围为 0 和 [150,1920]； </li>
  // <li> H.265：取值范围为 0 和 [150,1920]。 </li>
  // note：
  // <li> 当 `As` 的取值为 1 即开启宽高自适应时，参数生效，反之则不生效。 </li>
  // <li> 当 `As` 的取值为 1 时，如果 `LongSide` 、 `ShortSide` 、`Width` 、`Height` 同时取 0，表示保持源流尺寸。 </li>
  var bodyLongSide *int32 

  var bodyLongSideValue int32 = 600 

  bodyLongSide = &bodyLongSideValue 

  body.LongSide = bodyLongSide 
    
  //转码配置的名称。
  body.Preset = "PresetName"
    
  //是否极智超清转码，取值及含义如下。
  // <li> true：极智超清转码； </li>
  // <li> false：标准转码。 </li>
  // note：
  // <li> 修改 `Roi` 为 true，且 `As` 为 1 时，请确认 `ShortSide` 和 `LongSide` 的取值是否超出阈值。 </li>
  // <li> 视频编码格式为 H.266 时，转码类型不支持极智超清转码。 </li>
  var bodyRoi *bool 

  var bodyRoiValue bool = true 

  bodyRoi = &bodyRoiValue 

  body.Roi = bodyRoi 
    
  //短边长度，配置不同的视频编码方式和转码类型时，短边长度的取值范围存在如下差异。
  // <li> `Roi` 取 false 时： </li>
  // <li> H.264：取值范围为 0 和 [150,2160]； </li>
  // <li> H.265：取值范围为 0 和 [150,4096]； </li>
  // <li> H.266：取值范围为 0 和 [150,720]。 </li>
  // <li> `Roi` 取 true 时： </li>
  // <li> H.264：取值范围为 0 和 [150,1920]； </li>
  // <li> H.265：取值范围为 0 和 [150,1920]。 </li>
  // note：
  // <li> 当 `As` 的取值为 1 即开启宽高自适应时，参数生效，反之则不生效。 </li>
  // <li> 当 `As` 的取值为 1 时，如果 `LongSide` 、 `ShortSide` 、`Width` 、`Height` 同时取 0，表示保持源流尺寸。 </li>
  var bodyShortSide *int32 

  var bodyShortSideValue int32 = 500 

  bodyShortSide = &bodyShortSideValue 

  body.ShortSide = bodyShortSide 
    
  //转码停止时长，支持触发方式为拉流转码时设置，表示断开拉流后转码停止的时长，单位为秒，取值范围为 -1 和 [0,300]，-1 表示不停止转码，默认值为 60。
  var bodyStopInterval *int32 

  var bodyStopIntervalValue int32 = 60 

  bodyStopInterval = &bodyStopIntervalValue 

  body.StopInterval = bodyStopInterval 
    
  //转码流后缀名。支持 10 个字符以内的大小写字母、下划线与中划线，常见后缀包括：_sd、_hd、_uhd。
  // 例如，配置的转码流后缀名为_hd，则拉转码流时转码的流名为 stream-123456789_hd。
  var bodySuffixName *string 

  var bodySuffixNameValue string = "hd" 

  bodySuffixName = &bodySuffixNameValue 

  body.SuffixName = bodySuffixName 
    
  //视频编码格式，支持的取值及含义如下所示。
  // <li> h264：使用 H.264 编码格式； </li>
  // <li> h265：使用 H.265 编码格式； </li>
  // <li> h266：使用 H.266 编码格式； </li>
  // <li> copy：不进行转码，所有视频编码参数不生效。 </li>
  var bodyVcodec *string 

  var bodyVcodecValue string = "h265" 

  bodyVcodec = &bodyVcodecValue 

  body.Vcodec = bodyVcodec 
    
  //域名空间名称。
  body.Vhost = "push.example.com"
    
  //视频码率，单位为 bps，默认值为 1000000；取 0 时，表示使用源流码率。
  // 配置不同的视频编码格式时，视频码率的取值范围存在如下差异。
  // <li> H.264：取值范围为 [0,30000000]； </li>
  // <li> H.265：取值范围为 [0,30000000]； </li>
  // <li> H.266：取值范围为 [0,6000000]。 </li>
  var bodyVideoBitrate *int32 

  var bodyVideoBitrateValue int32 = 0 

  bodyVideoBitrate = &bodyVideoBitrateValue 

  body.VideoBitrate = bodyVideoBitrate 
    
  //视频宽度，默认值为 0。配置不同视频编码格式时，视频宽度的取值存在如下差异。
  // <li> H.264：取值范围为 [150,1920]； </li>
  // <li> H.265：取值范围为 [150,1920]。 </li>
  // note：
  // <li> 当 `As` 的取值为 0 即关闭宽高自适应时，转码分辨率将取 Width 和 Height 的值对转码视频进行拉伸； </li>
  // <li> Width 和 Height 任一配置为 0 时，转码视频将保持源流尺寸； </li>
  // <li> 编码格式为 H.266 时，不支持设置 Width 和 Height，请使用自适应配置。 </li>
  var bodyWidth *int32 

  var bodyWidthValue int32 = 1366 

  bodyWidth = &bodyWidthValue 

  body.Width = bodyWidth 
    
  //转码触发方式，默认值为 Pull，支持的取值及含义如下。
  // <li> Push：推流转码，直播推流后会自动启动转码任务，生成转码流； </li>
  // <li> Pull：拉流转码，直播推流后，需要主动播放转码流才会启动转码任务，生成转码流。 </li>
  var bodyTransType *string 

  var bodyTransTypeValue string = "Pull" 

  bodyTransType = &bodyTransTypeValue 

  body.TransType = bodyTransType
  
  resp, err := service.UpdateTranscodePreset(context.Background(), body)

  if err != nil {
    fmt.Printf("error %v", err)
  } else {
    fmt.Printf("success %+v", resp)
  }
}

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

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

接口调用示例如下所示。

package main

import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
   	"github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live_v20230101.NewInstance()

  service.SetCredential(base.Credentials{
    AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
    SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live_v20230101.ListCommonTransPresetDetailBody{}
     
  //模板名称列表，缺省情况下，表示查询所有系统内置转码档位。
  bodyPresetList := []*string{}

  var bodyPresetList0 *string 

  var bodyPresetList0Value string  = "preser1" 

  bodyPresetList0 = &bodyPresetList0Value 

  bodyPresetList = append(bodyPresetList, bodyPresetList0)    

   var bodyPresetList1 *string 

  var bodyPresetList1Value string  = "preset2" 

  bodyPresetList1 = &bodyPresetList1Value 

  bodyPresetList = append(bodyPresetList, bodyPresetList1)    

  body.PresetList = bodyPresetList
  
  resp, err := service.ListCommonTransPresetDetail(context.Background(), body)

  if err != nil {
    fmt.Printf("error %v", err)
  } else {
    fmt.Printf("success %+v", resp)
  }
}

查询转码配置列表

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

接口调用示例如下所示。

package main

import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
   	"github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live_v20230101.NewInstance()

  service.SetCredential(base.Credentials{
    AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
    SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

  body := &live_v20230101.ListVhostTransCodePresetBody{}
     
  //域名空间。
  body.Vhost = "push.example.com"
  
  resp, err := service.ListVhostTransCodePreset(context.Background(), body)

  if err != nil {
    fmt.Printf("error %v", err)
  } else {
    fmt.Printf("success %+v", resp)
  }
}

查询转码任务

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

接口调用示例如下所示。

package main

import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
   	"github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live_v20230101.NewInstance()

  service.SetCredential(base.Credentials{
    AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
    SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

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

  if err != nil {
    fmt.Printf("error %v", err)
  } else {
    fmt.Printf("success %+v", resp)
  }
}

重启转码任务

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

接口调用示例如下所示。

package main

import (
    "os"
    "context"
    "fmt"

    "github.com/volcengine/volc-sdk-golang/base"
   	"github.com/volcengine/volc-sdk-golang/service/live/v20230101"
)

func main () {
  // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
  // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET
  service := live_v20230101.NewInstance()

  service.SetCredential(base.Credentials{
    AccessKeyID:     os.Getenv("ACCESS_KEY_ID"),
    SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"),
  })

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

  if err != nil {
    fmt.Printf("error %v", err)
  } else {
    fmt.Printf("success %+v", resp)
  }
}