GenerateVideoPlaylist
创建边转边播播放列表能够将视频文件生成m3u8文件。生成播放列表后即时播放，并根据播放进度实施按需转码，相比离线转码能极大减少了转码等待时间并大幅度降低了转码和存储开销
服务地址：
华东1（杭州）
输入参数
只看必填
ProjectName项目名称
UserData用户自定义信息
SourceURI视频的OSS地址
SourceStartTime生成播放列表的起始时间点
SourceDuration生成播放列表的持续时间
SourceSubtitles添加字幕列表
0字幕信息
URI被嵌入字幕的OSS地址
Language字幕语言
添加
MasterURIMaster Playlist的OSS地址
Targets边转边播播放列表数组
0边转边播任务详细信息
URI边转边播输出文件的OSS地址前缀
Video视频处理参数配置
DisableVideo是否禁用视频流生成
请选择布尔值
Stream需要处理的源文件视频流索引号列表
0需要处理的视频流索引号
添加
TranscodeVideo视频转码参数
Codec视频编码格式
PixelFormat像素格式
FrameRateOption帧率选项
FrameRate视频帧率
ResolutionOption分辨率选项
Resolution输出视频的分辨率
AdaptiveResolutionDirection是否开启自适应分辨率方向
请选择布尔值
ScaleType缩放模式
Rotation视频顺时针旋转的度数
BitrateOption视频码率选项
Bitrate视频流码率
GOPSize关键帧间隔帧数
CRF指定恒定质量模式
BufferSize动态码率下解码缓存大小
MaxBitrate动态码率下限定最大码率
BFrames连续B帧的数量
Refs参考帧的数量
FilterVideo视频处理参数
Watermarks视频水印列表
0视频水印信息
Type水印类型
Dx取值为整数或小数时不同含义如下：
Dy取值为整数或小数时的不同含义如下：
StartTime添加水印的开始时间
Duration添加水印持续的时间
ReferPos添加水印的基准位置
Content文字水印的内容
FontName文字水印的字体名称
FontSize文字水印的字体大小
FontColor水印文字的字体颜色
FontApha文字水印的字体透明度
BorderWidth文字水印的描边宽度
BorderColor水印文字的描边颜色
URI水印文件的OSS地址
Width水印图片的宽度
Height水印图片的高度
添加
Delogos对视频上某矩形部分进行模糊处理
0视频模糊处理参数
StartTime添加马赛克的开始时间
Duration添加马赛克的持续时间
Dx取值为整数或小数时的不同含义如下：
Dy默认值为0
Width马赛克的宽度
Height马赛克的高度
ReferPos添加马赛克的基准位置
添加
Audio音频处理参数配置
DisableAudio是否禁用音频处理
请选择布尔值
Stream需要处理的源文件音频流索引号列表
0需要处理的音频流索引号
添加
TranscodeAudio音频转码参数
Codec音频编码方式
BitrateOption音频码率选项
Bitrate音频码率
Quality音频质量
SampleRateOption音频采样率
SampleRate音频采样率
Channel声道数
BitsPerSample音频采样位深
FilterAudio音频处理参数
Mixing是否将所有音轨混合为单轨
请选择布尔值
Subtitle字幕处理参数配置
DisableSubtitle是否禁用字幕处理
请选择布尔值
Stream需要处理的源文件字幕流索引号列表
0需要转换的字幕流索引号
添加
ExtractSubtitle字幕提取配置
URI保存提取字幕的OSS地址前缀
Format字幕提取的输出格式
TranscodeAhead触发边转边播时向前转码的ts文件数量
Duration单个ts文件的播放时长
InitialTranscode初始转码时长
InitialSegments初始转码ts文件时长数组
0初始转码ts文件时长
添加
Tags为生成的ts文件添加OSS对象标签
:
添加
添加
Tags为生成的ts文件添加OSS对象标签
:
添加
CredentialConfig链式授权配置对象
ServiceRole服务角色
PolicyServiceRole参数的角色所需配...
Chain需要传递授权的链列表
0授权链对象
AssumeRoleFor提供授权的账号ID
Role允许扮演的RAM角色
RoleType角色类型
添加
Notification消息通知对象
MNS轻量消息队列（原 MNS）消息通知参数
TopicName轻量消息队列SMQ（原 MNS）主题名称
RocketMQRocketMQ消息通知参数
TopicNameRocketMQ Topic名称
InstanceIdRocketMQ实例Id
ExtendedMessageURI使用OSS文件接受任务消息通知
OverwritePolicy当Media Playlist存在时的...
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

  • 请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。
  • 调用该接口前，请确保当前 Region 已经存在可用的项目（Project），详见项目管理。
  • 使用该接口时，默认只处理一路视频/音频/字幕流，同时支持配置处理的视频/音频/字幕流数量。
  • 该接口同时能支持生成 Media playlist 和 Master playlist，请注意文档参数说明。
  • 该接口为同步接口。播放或预转时才会触发同步或异步转码。可以通过设置 Notification 消息通知参数，通过消息通知获取转码任务结果。
  • 该接口的功能说明参见边转边播。
  • OSS 的数据处理能力也提供了生成播放列表功能，但只提供生成 Media Playlist 且参数进行了简化。详情参见 OSS 数据处理能力生成播放列表。

请求参数

字段名称字段详情
ProjectNamestring

项目名称，获取方式请参见创建项目。

示例值:immtest参考取值来源:
    CreateProject
    UpdateProject
    ListProjects
UserDatastring

用户自定义信息，在异步消息通知中会返回，方便您在系统内对消息通知进行关联处理。最大长度为 2048 字节。

示例值:{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
SourceURIstring

视频的 OSS 地址。展开详情

示例值:oss://test-bucket/test-source-object/video.mp4
SourceStartTimenumber<float>

生成播放列表的起始时间点，单位为秒（s）。取值范围如下：展开详情

示例值:0
SourceDurationnumber<float>

生成播放列表的持续时间。单位为秒（s），取值范围如下：展开详情

示例值:0
SourceSubtitlesarray<object>

添加字幕列表，默认为空。最大支持 2 个。

MasterURIstring

Master Playlist 的 OSS 地址。展开详情

示例值:oss://test-bucket/test-object/master.m3u8
Targetsarray<object>

边转边播播放列表数组，数组长度最大为 6。每个 Target 对应至多一个视频 Media Playlist 和一个或多个字幕 Media Playlist展开详情

Tagsmap<string>

为生成的 ts 文件添加 OSS 对象标签。可以使用标签来控制 OSS 文件的生命周期。

示例值:{"key1": "value1", "key2": "value2"}
CredentialConfigobject

链式授权配置对象，一般留空即可。展开详情

Notificationobject

消息通知对象，支持多种消息中间件，消息格式详情请见异步通知消息格式，请选择其中一种方式接收消息，使用方式如下所示：展开详情

OverwritePolicystring

当 Media Playlist 存在时的覆盖策略，取值范围：展开详情

示例值:overwrite

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:CA995EFD-083D-4F40-BE8A-BDF75FFF*****
Durationnumber<float>

输出视频总时长。

示例值:1082
Tokenstring

Master Playlist 的 Token。

示例值:92376fbb-171f-4259-913f-705f7ee0****
MasterURIstring

Master Playlist 的 OSS 地址。

示例值:oss://test-bucket/test-object/master.m3u8
VideoPlaylistarray<object>

视频 Media Playlist 文件列表。

AudioPlaylistarray<object>

音频 Media Playlist 文件列表。

SubtitlePlaylistarray<object>

字幕 Media Playlist 文件列表。

变更历史
变更时间变更内容概要操作
2024-03-26
变更返回参数
2023-04-04
变更请求参数Targets