拉流回源--视频直播-火山引擎

文档中心

立即注册

导航

拉流回源

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

阅读本文，您可以获取 PHP SDK 拉流回源的接口调用示例，实现快速开发。

说明

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

调用说明

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

前提条件

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

调用示例

本节为您介绍拉流回源相关接口的功能和调用示例。

添加或更新播放触发回源配置

您可以调用 UpdateRelaySourceV3 接口添加或更新播放触发回源配置。详细的参数说明可参见 UpdateRelaySourceV3 接口文档。

接口调用示例如下所示。

<?php
include_once "./vendor/autoload.php";

use Volc\Service\Live\V20230101\Live;

// 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
// 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
$client = Live::getInstance();

$client->setAccessKey(getenv("VOLC_ACCESSKEY"));

$client->setSecretKey(getenv("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",
    // 回源组配置详情。
    "GroupDetails" => [
        [
            // 回源组名称。
            "Group" => "relay1",
            // 回源服务器配置列表。
            "Servers" => [
                [
                    // 回源协议，支持两种回源协议。
                    // <li> rtmp：RTMP 回源协议； </li>
                    // <li> flv：FLV 回源协议。 </li>
                    "RelaySourceProtocol" => "rtmp",
                    // 直播源服务器的地址，支持填写回源服务的域名或 IP 地址。
                    // note：
                    // <li> 当源站使用了非默认端口时，支持在回源地址中以域名:端口或 IP:端口的形式配置端口。 </li>
                    // <li> 最多支持添加 10 个回源地址，回源失败时，将按照您添加的地址顺序轮循尝试。 </li>
                    "RelaySourceDomain" => "example.org",
                    // 自定义回源参数，缺省情况下为空。格式为 "Key":"Value"，例如，"domain":"live.push.net"。
                    "RelaySourceParams" => [
                        "key1" => "value1",
                        "key2" => "value2",
                    ],
                ],
            ],
        ],
    ],
];

$response = $client->updateRelaySourceV3($body);
print_r($response);

删除播放触发回源配置

您可以调用 DeleteRelaySourceV3 接口删除播放触发回源配置。详细的参数说明可参见 DeleteRelaySourceV3 接口文档。

接口调用示例如下所示。

<?php
include_once "./vendor/autoload.php";

use Volc\Service\Live\V20230101\Live;

// 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
// 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
$client = Live::getInstance();

$client->setAccessKey(getenv("VOLC_ACCESSKEY"));

$client->setSecretKey(getenv("VOLC_SECRETKEY"));

$body = [
    // 直播流使用的域名所属的域名空间，您可以调用 [DescribeRelaySourceV3](https://www.volcengine.com/docs/6469/1126874) 接口获取待删除配置的 Vhost 取值。
    "Vhost" => "push.example.com",
    // 应用名称，您可以调用 [DescribeRelaySourceV3](https://www.volcengine.com/docs/6469/1126874) 接口获取待删除配置的 App 取值。
    "App" => "live",
    // 回源组名称。
    "Group" => "relay1",
];

$response = $client->deleteRelaySourceV3($body);
print_r($response);

查询播放触发回源配置

您可以调用 DescribeRelaySourceV3 接口查询播放触发回源配置。详细的参数说明可参见 DescribeRelaySourceV3 接口文档。

接口调用示例如下所示。

<?php
include_once "./vendor/autoload.php";

use Volc\Service\Live\V20230101\Live;

// 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
// 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
$client = Live::getInstance();

$client->setAccessKey(getenv("VOLC_ACCESSKEY"));

$client->setSecretKey(getenv("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",
    // 回源组名称。
    "Group" => "relay1",
];

$response = $client->describeRelaySourceV3($body);
print_r($response);

添加固定回源配置

您可以调用 CreateRelaySourceV4 接口添加固定回源配置。详细的参数说明可参见 CreateRelaySourceV4 接口文档。

接口调用示例如下所示。

<?php
include_once "./vendor/autoload.php";

use Volc\Service\Live\V20230101\Live;

// 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
// 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
$client = Live::getInstance();

$client->setAccessKey(getenv("VOLC_ACCESSKEY"));

$client->setSecretKey(getenv("VOLC_SECRETKEY"));

$body = [
    // 回源开始时间，Unix 时间戳，单位为秒。
    // note：
    // <li> 回源开始到结束最大时间跨度为 7 天； </li>
    // <li> 开始时间与结束时间同时缺省，表示永久回源。 </li>
    "StartTime" => 1683518058,
    // 回源结束时间，Unix 时间戳，单位为秒。
    // note：
    // <li> 回源开始到结束最大时间跨度为 7 天； </li>
    // <li> 开始时间与结束时间同时缺省，表示永久回源。 </li>
    "EndTime" => 1683777258,
    // 应用名称，即直播流地址的 AppName 字段取值，支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    "App" => "live",
    // 流名称，即直播流地址的 StreamName 字段取值，支持由大小写字母（A - Z、a - z）、数字（0 - 9）、字母、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。
    "Stream" => "example_stream",
    // 拉流域名，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看直播流使用的拉流域名。
    "Domain" => "pull.example.com",
    // 回源地址列表，支持输入 RTMP、FLV、HLS 和 SRT 协议的直播推流地址。
    // note：
    // <li> 当源站使用了非默认端口时，支持在回源地址中以域名:端口或 IP:端口的形式配置端口。 </li>
    // <li> 最多支持添加 10 个回源地址，回源失败时，将按照您添加的地址顺序轮循尝试。 </li>
    "SrcAddrS" => ["rtmp://live.example.com"],
];

$response = $client->createRelaySourceV4($body);
print_r($response);

删除固定回源配置

您可以调用 DeleteRelaySourceV4 接口删除固定回源配置。详细的参数说明可参见 DeleteRelaySourceV4 接口文档。

接口调用示例如下所示。

<?php
include_once "./vendor/autoload.php";

use Volc\Service\Live\V20230101\Live;

// 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
// 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
$client = Live::getInstance();

$client->setAccessKey(getenv("VOLC_ACCESSKEY"));

$client->setSecretKey(getenv("VOLC_SECRETKEY"));

$body = [
    // 应用名称，您可以调用 [ListRelaySourceV4](https://www.volcengine.com/docs/6469/1126878) 接口，获取待删除固定回源配置的 App 取值。
    "App" => "live",
    // 流名称，您可以调用 [ListRelaySourceV4](https://www.volcengine.com/docs/6469/1126878) 接口，获取待删除固定回源配置的 Stream 取值。
    "Stream" => "stream-123",
    // 拉流域名，您可以调用 [ListRelaySourceV4](https://www.volcengine.com/docs/6469/1126878) 接口，获取待删除固定回源配置的 Domain 取值。
    "Domain" => "pull.example.com",
];

$response = $client->deleteRelaySourceV4($body);
print_r($response);

更新固定回源配置

您可以调用 UpdateRelaySourceV4 接口更新固定回源配置。详细的参数说明可参见 UpdateRelaySourceV4 接口文档。

接口调用示例如下所示。

<?php
include_once "./vendor/autoload.php";

use Volc\Service\Live\V20230101\Live;

// 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
// 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
$client = Live::getInstance();

$client->setAccessKey(getenv("VOLC_ACCESSKEY"));

$client->setSecretKey(getenv("VOLC_SECRETKEY"));

$body = [
    // 开始时间，Unix 时间戳，单位为秒。
    // note：
    // <li> 回源开始到结束最大时间跨度为 7 天； </li>
    // <li> 开始时间与结束时间同时缺省，表示永久回源。 </li>
    "StartTime" => 1683518058,
    // 结束时间，Unix 时间戳，单位为秒。
    // note：
    // <li> 回源开始到结束最大时间跨度为 7 天； </li>
    // <li> 开始时间与结束时间同时缺省，表示永久回源。 </li>
    "EndTime" => 1683777258,
    // 应用名称，拉流域名，您可以调用 [ListRelaySourceV4](https://www.volcengine.com/docs/6469/1126878) 接口，获取待更新固定回源配置的 App 取值。
    "App" => "live",
    // 流名称，您可以调用 [ListRelaySourceV4](https://www.volcengine.com/docs/6469/1126878) 接口，获取待更新固定回源配置的 Domain 取值。
    "Stream" => "example_stream",
    // 拉流域名，您可以调用 [ListRelaySourceV4](https://www.volcengine.com/docs/6469/1126878) 接口，获取待更新固定回源配置的 Domain 取值。
    "Domain" => "pull.example.com",
    // 回源地址列表，支持 RTMP、FLV、HLS 和 SRT 回源协议。
    // note：
    // <li> 当源站使用了非默认端口时，支持在回源地址中以域名:端口或 IP:端口的形式配置端口。 </li>
    // <li> 最多支持添加 10 个回源地址，回源失败时，将按照您添加的地址顺序轮循尝试。 </li>
    "SrcAddrS" => ["rtmp://live.example.com"],
];

$response = $client->updateRelaySourceV4($body);
print_r($response);

查询固定回源配置列表

您可以调用 ListRelaySourceV4 接口查询固定回源配置列表。详细的参数说明可参见 ListRelaySourceV4 接口文档。

接口调用示例如下所示。

<?php
include_once "./vendor/autoload.php";

use Volc\Service\Live\V20230101\Live;

// 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。
// 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY
$client = Live::getInstance();

$client->setAccessKey(getenv("VOLC_ACCESSKEY"));

$client->setSecretKey(getenv("VOLC_SECRETKEY"));

$body = [
    // 直播流使用的域名。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看直播流使用的域名。
    "Domain" => "push.example.com",
    // 查询数据的页码，默认为 1，表示查询第一页的数据。
    "Page" => 1,
    // 每页显示的数据条数，默认为 20，最大值为 500。
    "Size" => 20,
];

$response = $client->listRelaySourceV4($body);
print_r($response);