You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

拉流回源

最近更新时间：2024.04.15 11:36:59

首次发布时间：2023.12.28 21:21:52

我的收藏

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

说明

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

调用说明

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

前提条件

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

调用示例

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

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

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

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.UpdateRelaySourceV3Body; 
import com.volcengine.model.live.v20230101.UpdateRelaySourceV3BodyGroupDetailsItemServersItem; 
import com.volcengine.model.live.v20230101.UpdateRelaySourceV3BodyGroupDetailsItem;
import com.volcengine.model.live.v20230101.UpdateRelaySourceV3Res;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 
import java.util.LinkedHashMap; 
import java.util.Map; 

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

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    UpdateRelaySourceV3Body body = new UpdateRelaySourceV3Body();
     
    // 域名空间，即直播流地址的域名所属的域名空间。您可以调用 [ListDomainDetail](https//www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https//console-stable.volcanicengine.com/live/main/domain/list)页面，查看直播流使用的域名所属的域名空间。
    body.setVhost("push.example.com");
    
    // 应用名称，即直播流地址的 `AppName` 字段取值，默认为空，表示为当前域名空间的全局播放触发回源配置。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    body.setApp("live");
    
    // 回源组配置详情。
    List<UpdateRelaySourceV3BodyGroupDetailsItem> UpdateRelaySourceV3BodyGroupDetails = new ArrayList<>(); 

    UpdateRelaySourceV3BodyGroupDetailsItem UpdateRelaySourceV3BodyGroupDetailsItem = new UpdateRelaySourceV3BodyGroupDetailsItem(); 
 
    // 回源组名称。
    UpdateRelaySourceV3BodyGroupDetailsItem.setGroup("relay1");
    
    // 回源服务器配置列表。
    List<UpdateRelaySourceV3BodyGroupDetailsItemServersItem> UpdateRelaySourceV3BodyGroupDetailsItemServers = new ArrayList<>(); 

    UpdateRelaySourceV3BodyGroupDetailsItemServersItem UpdateRelaySourceV3BodyGroupDetailsItemServersItem = new UpdateRelaySourceV3BodyGroupDetailsItemServersItem(); 
 
    // 回源协议，支持两种回源协议。
    // <li> rtmp：RTMP 回源协议； </li>
    // <li> flv：FLV 回源协议。 </li>
    UpdateRelaySourceV3BodyGroupDetailsItemServersItem.setRelaySourceProtocol("rtmp");
    
    // 直播源服务器的地址，支持填写回源服务的域名或 IP 地址。
    // note：
    // <li> 当源站使用了非默认端口时，支持在回源地址中以`域名:端口`或 `IP:端口`的形式配置端口。 </li>
    // <li> 最多支持添加 10 个回源地址，回源失败时，将按照您添加的地址顺序轮循尝试。 </li>
    UpdateRelaySourceV3BodyGroupDetailsItemServersItem.setRelaySourceDomain("example.org");
    
    // 自定义回源参数，缺省情况下为空。格式为 `"Key":"Value"`，例如，`"domain":"live.push.net"`。
    Map<String, Object> UpdateRelaySourceV3BodyGroupDetailsItemServersItemRelaySourceParams = new LinkedHashMap<>(); 

    UpdateRelaySourceV3BodyGroupDetailsItemServersItemRelaySourceParams.put("key1","value1"); 

    UpdateRelaySourceV3BodyGroupDetailsItemServersItemRelaySourceParams.put("key2","value2"); 

    UpdateRelaySourceV3BodyGroupDetailsItemServersItem.setRelaySourceParams(UpdateRelaySourceV3BodyGroupDetailsItemServersItemRelaySourceParams); 

    UpdateRelaySourceV3BodyGroupDetailsItemServers.add(UpdateRelaySourceV3BodyGroupDetailsItemServersItem);

    UpdateRelaySourceV3BodyGroupDetailsItem.setServers(UpdateRelaySourceV3BodyGroupDetailsItemServers); 

    UpdateRelaySourceV3BodyGroupDetails.add(UpdateRelaySourceV3BodyGroupDetailsItem);

    body.setGroupDetails(UpdateRelaySourceV3BodyGroupDetails);

    try {
      UpdateRelaySourceV3Res resp = service.updateRelaySourceV3(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

删除播放触发回源配置

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

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DeleteRelaySourceV3Body;
import com.volcengine.model.live.v20230101.DeleteRelaySourceV3Res;
import com.volcengine.service.live.v20230101.LiveService;

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

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    DeleteRelaySourceV3Body body = new DeleteRelaySourceV3Body();
     
    // 直播流使用的域名所属的域名空间。您可以调用 [ListDomainDetail](https//www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https//console-stable.volcanicengine.com/live/main/domain/list)页面，查看直播流使用的域名。所属的域名空间。
    body.setVhost("push.example.com");
    
    // 应用名称，即直播流地址的 `AppName` 字段取值，默认为空，表示删除当前域名空间的全局播放触发回源配置。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    body.setApp("live");
    
    // 回源组名称。
    body.setGroup("relay1");

    try {
      DeleteRelaySourceV3Res resp = service.deleteRelaySourceV3(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

查询播放触发回源配置

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

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DescribeRelaySourceV3Body;
import com.volcengine.model.live.v20230101.DescribeRelaySourceV3Res;
import com.volcengine.service.live.v20230101.LiveService;

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

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    DescribeRelaySourceV3Body body = new DescribeRelaySourceV3Body();
     
    // 直播流使用的域名所属的域名空间。您可以调用 [ListDomainDetail](https//www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https//console-stable.volcanicengine.com/live/main/domain/list)页面，查看直播流使用的域名。所属的域名空间。
    body.setVhost("push.example.com");
    
    // 应用名称，即直播流地址的 `AppName` 字段取值，默认为空，表示查询当前域名空间下所有播放触发回源配置。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。
    body.setApp("live");
    
    // 回源组名称。
    body.setGroup("relay1");

    try {
      DescribeRelaySourceV3Res resp = service.describeRelaySourceV3(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

添加固定回源配置

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

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.CreateRelaySourceV4Body;
import com.volcengine.model.live.v20230101.CreateRelaySourceV4Res;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

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

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

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

    CreateRelaySourceV4BodySrcAddrS.add("rtmp://live.example.com");
    
    body.setSrcAddrS(CreateRelaySourceV4BodySrcAddrS);

    try {
      CreateRelaySourceV4Res resp = service.createRelaySourceV4(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

删除固定回源配置

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

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DeleteRelaySourceV4Body;
import com.volcengine.model.live.v20230101.DeleteRelaySourceV4Res;
import com.volcengine.service.live.v20230101.LiveService;

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

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

    DeleteRelaySourceV4Body body = new DeleteRelaySourceV4Body();
     
    // 应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。
    body.setApp("live");
    
    // 流名称，由 1 到 100 位数字、字母、下划线及"-"和"."组成。
    body.setStream("stream-123");
    
    // 推流域名。
    body.setDomain("push.example.com");

    try {
      DeleteRelaySourceV4Res resp = service.deleteRelaySourceV4(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

更新固定回源配置

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

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.UpdateRelaySourceV4Body;
import com.volcengine.model.live.v20230101.UpdateRelaySourceV4Res;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

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

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

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

    UpdateRelaySourceV4BodySrcAddrS.add("rtmp://live.example.com");
    
    body.setSrcAddrS(UpdateRelaySourceV4BodySrcAddrS);

    try {
      UpdateRelaySourceV4Res resp = service.updateRelaySourceV4(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

查询固定回源配置列表

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

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.ListRelaySourceV4Body;
import com.volcengine.model.live.v20230101.ListRelaySourceV4Res;
import com.volcengine.service.live.v20230101.LiveService;

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

    service.setAccessKey(System.getenv("ACCESS_KEY_ID"));

    service.setSecretKey(System.getenv("ACCESS_KEY_SECRET"));

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

    try {
      ListRelaySourceV4Res resp = service.listRelaySourceV4(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}