tencent cloud

云点播

动态与公告
产品动态
公告
产品简介
产品概述
产品特性
产品功能
产品优势
应用场景
解决方案
专业版
云点播专业版简介
快速入门
控制台指南
开发指南
购买指南
计费概述
计费方式
购买指引
账单查询
续费说明
欠费说明
退费说明
快速入门
控制台指南
控制台介绍
服务概览
应用管理
媒体管理
资源包管理
License 管理
实时日志分析
实践教程
媒体上传
如何将点播的媒体文件进行智能降冷
媒体处理
分发播放
如何接收事件通知
如何进行源站迁移
直播录制
如何进行自定义源站回源
直播精彩剪辑固化至云点播 VOD 指引
如何使用 EdgeOne 分发云点播内容
开发指南
媒体上传
媒体加工处理
媒体 AI
事件通知
媒体分发播放
媒体加密与版权保护
播放频道
访问管理
下载媒体文件
应用体系
错误码
播放器 SDK 文档
概述
基本概念
产品功能
Demo 体验
免费测试
购买指南
SDK 下载
License 指引
播放器教程
含 UI 集成方案
无 UI 集成方案
高级功能
API 文档
第三方播放器插件
Player SDK Policy
服务端 API 文档
History
Introduction
API Category
Other APIs
Media Processing APIs
Task Management APIs
Media Upload APIs
Media Management APIs
Event Notification Relevant API
Media Categorization APIs
Domain Name Management APIs
Distribution APIs
AI-based Sample Management APIs
Region Management APIs
Data Statistics APIs
Carousel-Related APIs
Just In Time Transcode APIs
No longer recommended APIs
Making API Requests
AI-based image processing APIs
Parameter Template APIs
Task Flow APIs
Data Types
Error Codes
Video on Demand API 2024-07-18
常见问题
移动端播放问题
费用相关问题
视频上传问题
视频发布问题
视频播放问题
Web 端播放问题
全屏播放问题
数据统计问题
访问管理相关问题
媒资降冷问题
相关协议
Service Level Agreement
VOD 政策
隐私政策
数据处理和安全协议
联系我们
词汇表

HandleCurrentPlaylist

PDF
聚焦模式
字号
最后更新时间: 2025-10-30 22:07:55

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

Operate the current play list . Supported operations include:

  • Insert: Insert a playing program into the current playlist.
  • Delete: Remove a playing program from the playlist.
  • A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: HandleCurrentPlaylist.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    SubAppId Yes Integer VOD subapplication id..
    RoundPlayId Yes String The unique identifier of the playlist.
    Operation Yes String Operation type, available options:
  • insert: insert program into the current playlist.
  • inserttemporary: temporarily insert program into the current playlist. can only be inserted after the currently playing program. temporarily inserted programs are only effective during this carousel process.
  • delete: delete program from the playlist. cannot delete currently playing programs.
  • .
    ItemId No String Playlist program id. required when operation is insert, indicating the program list will be inserted after this program. the insertion position must be after the currently playing program.
    RoundPlaylist.N No Array of RoundPlayListItemInfo Program list. required when operation is insert, inserttemporary, delete, indicating the list of programs to be operated on. the list length can be up to a maximum of 10.

    3. Output Parameters

    Parameter Name Type Description
    RoundPlaylist Array of RoundPlayListItemInfo List of successfully operated programs.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Insert a Program After Program A003 In the Current Playlist

    Input Example

    POST / HTTP/1.1
    Host: vod.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: HandleCurrentPlaylist
    <Common request parameters>
    
    {
        "SubAppId": 123,
        "RoundPlayId": "130",
        "Operation": "Insert",
        "ItemId": "a003",
        "RoundPlaylist": [
            {
                "FileId": "528xxx5487985271487",
                "AudioVideoType": "Transcode",
                "Definition": 100210
            }
        ]
    }

    Output Example

    {
        "Response": {
            "RoundPlaylist": [
                {
                    "ItemId": "a01",
                    "AudioVideoType": "Transcode",
                    "Definition": 100,
                    "FileId": "528xxx5487985271487"
                }
            ],
            "RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3"
        }
    }

    Example2 Delete the Program In the Playlist

    Input Example

    POST / HTTP/1.1
    Host: vod.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: HandleCurrentPlaylist
    <Common request parameters>
    
    {
        "SubAppId": 123,
        "RoundPlayId": "130",
        "Operation": "Delete",
        "RoundPlaylist": [
            {
                "ItemId": "a004",
                "FileId": "",
                "AudioVideoType": ""
            }
        ]
    }

    Output Example

    {
        "Response": {
            "RoundPlaylist": [
                {
                    "ItemId": "a004",
                    "AudioVideoType": "",
                    "Definition": 100,
                    "FileId": ""
                }
            ],
            "RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3"
        }
    }

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidParameterValue.FileId The FileId does not exist.
    InvalidParameterValue.Index Index parameter error.
    InvalidParameterValue.ItemId ItemId error.
    InvalidParameterValue.RoundPlayId RoundPlayId parameter error.
    InvalidParameterValue.RoundPlaylist RoundPlaylist parameter length error.
    InvalidParameterValue.SubAppId Incorrect parameter value: application id.
    LimitExceeded.PlayList Playlist length too large.

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈