直播时移--视频直播-火山引擎

文档中心

立即注册

导航

直播时移

最近更新时间：2024.09.14 11:16:50首次发布时间：2023.12.28 21:21:53

阅读本文，您可以获取 Python SDK 直播时移的接口调用示例，实现快速开发。

说明

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

调用说明

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

前提条件

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

调用示例

本节为您介绍直播时移相关接口的功能和调用示例。

添加直播时移配置

您可以调用 CreateTimeShiftPresetV3 接口添加直播时移配置。详细的参数说明可参见 CreateTimeShiftPresetV3 接口文档。

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

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

    body = {
        # 域名空间，即直播流地址的域名所属的域名空间。您可以调用 [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）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
        "App": "live",
        # 流名称，取值与直播流地址中 StreamName 字段取值相同，默认为空表示当前应用下的所有流都进行时移。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
        # note：
        # 流名称不为空时，表示只为此条流开启时移。通过流名称配置时移时，同一个 App 最多可指定 20 路流开启时移。
        "Stream": "example_stream",
        # 最大时移时长，即允许用户回看的最长时间，单位为秒，支持的取值如下所示。
        # <li> 86400：1 天； </li>
        # <li> 259200：3 天； </li>
        # <li> 604800：7 天； </li>
        # <li> 1296000：15 天。 </li>
        "MaxShiftTime": 86400,
        # 时移拉流域名。
        # note：
        # 录制到 TOS 时，需配置直播流对应的拉流域名。录制到 VOD 时，需配置 VOD 的空间对应的分发域名。
        "PullDomain": "testpull",
        # 时移类型。支持的取值如下所示。
        # <li> 0：录制时移，即时移复用录制配置，需提前创建对应级别的录制配置； </li>
        # <li> 1：独立时移，即时移不复用录制配置。 </li>
        "TimeShiftType": 0,
    }

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

删除直播时移配置

您可以调用 DeleteTimeShiftPresetV3 接口删除直播时移配置。详细的参数说明可参见 DeleteTimeShiftPresetV3 接口文档。

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

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

    body = {
        # 域名空间名称，您可以调用[ListTimeShiftPresetV2](https://www.volcengine.com/docs/6469/1126883) 接口，获取待删除时移配置的 Vhost 取值。
        "Vhost": "push.example.com",
        # 应用名称，您可以调用[ListTimeShiftPresetV2](https://www.volcengine.com/docs/6469/1126883) 接口，获取待删除时移配置的 App 取值。
        "App": "live",
    }

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

更新直播时移配置

您可以调用 UpdateTimeShiftPresetV3 接口更新直播时移配置。详细的参数说明可参见 UpdateTimeShiftPresetV3 接口文档。

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

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

    body = {
        # 域名空间名称，您可以调用[ListTimeShiftPresetV2](https://www.volcengine.com/docs/6469/1126883) 接口，获取待更新时移配置的 Vhost 取值。
        "Vhost": "push.example.com",
        # 应用名称，您可以调用[ListTimeShiftPresetV2](https://www.volcengine.com/docs/6469/1126883) 接口，获取待更新时移配置的 App 取值。
        "App": "live",
        # 开启时移的流名称，默认为空表示更新 App 级别的时移配置，不为空时表示更新 Stream 级别的时移配置。您可以调用[ListTimeShiftPresetV2](https://www.volcengine.com/docs/6469/1126883) 接口，获取待更新时移配置的 Stream 取值并进行更新。
        "Stream": "example_stream",
        # 最大时移时长，即允许用户回看的最长时间，单位为秒，支持的取值如下所示。
        # <li> 86400：1 天； </li>
        # <li> 259200：3 天； </li>
        # <li> 604800：7 天； </li>
        # <li> 1296000：15 天。 </li>
        "MaxShiftTime": 86400,
    }

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

查询直播时移配置列表

您可以调用 ListTimeShiftPresetV2 接口查询直播时移配置列表。详细的参数说明可参见 ListTimeShiftPresetV2 接口文档。

接口调用示例如下所示。

# coding:utf-8
import os

from volcengine.live.v20230101.live_service import LiveService

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

    body = {
        # 时移类型，默认类型为 vod。
        # <li> vod：点播时移，表示查询时移录制存储在 VOD 中的时移配置； </li>
        # <li> tos：直播时移，表示查询时移录制存储在 TOS 以及 fcdn-tos 中的时移配置。 </li>
        "Type": "tos",
        # 域名空间，即直播流地址的域名所属的域名空间。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看需要时移的直播流使用的域名所属的域名空间。
        "Vhost": "push.example.com",
    }

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