文档中心

拉流转推

最近更新时间：2024.04.15 11:37:00

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

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

说明

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

调用说明

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

前提条件

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

调用示例

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

创建拉流转推任务

您可以调用 CreatePullToPushTask 接口创建拉流转推任务。详细的参数说明可参见 CreatePullToPushTask 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.CreatePullToPushTaskBody; 
import com.volcengine.model.live.v20230101.CreatePullToPushTaskBodyWatermark;
import com.volcengine.model.live.v20230101.CreatePullToPushTaskRes;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

public class CreatePullToPushTaskDemo  {
  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"));

    CreatePullToPushTaskBody body = new CreatePullToPushTaskBody();
     
    // 拉流转推任务的名称，由 1 到 20 位中文、大小写字母和数字组成，默认为空，表示不配置任务名称。
    body.setTitle("task001");
    
    // 任务的开始时间，Unix 时间戳，单位为秒。
    // note：
    // 拉流转推任务持续时间最长为 7 天。
    body.setStartTime(1640891476);
    
    // 任务的结束时间，Unix 时间戳，单位为秒。
    // note：
    // 拉流转推任务持续时间最长为 7 天。
    body.setEndTime(1640841476);
    
    // 接收拉流转推任务状态回调的地址，最大长度为 2000 个字符，默认为空。
    body.setCallbackURL("http://example.mtime.cn/live/example/callbackapi");
    
    // 拉流来源类型，支持的取值及含义如下。
    // <li> 0：直播源； </li>
    // <li> 1：点播视频。 </li>
    body.setType(0);
    
    // 点播视频文件循环播放模式，当拉流来源类型为点播视频（Type 为 1）时为必选参数，参数取值及含义如下所示。
    // <li> -1：无限循环，至任务结束； </li>
    // <li> 0：有限次循环，循环次数为 PlayTimes 取值为准。 </li>
    body.setCycleMode(-1);
    
    // 推流地址，即直播源或点播视频转推的目标地址。
    body.setDstAddr("rtmp://example.mtime.cn/Video/2022/02/04/mp4/190204084208765161.mp4");
    
    // 直播源的拉流地址，拉流来源类型为直播源（Type 为 0）时，为必选参数，最大长度为 1000 个字符。
    body.setSrcAddr("http://example.mtime.cn/Video/2003/02/04/mp4/190204084208765161.mp4");
    
    // 点播视频播放地址列表，拉流来源类型为点播视频（Type 为 1）时，为必选参数，最多支持传入 30 个点播视频播放地址，每个地址最大长度为 1000 个字符。
    List<String> CreatePullToPushTaskBodySrcAddrS = new ArrayList<>(); 

    CreatePullToPushTaskBodySrcAddrS.add("https://pull.example.com/live/stream-123");
    
    body.setSrcAddrS(CreatePullToPushTaskBodySrcAddrS); 
    
    // 点播视频文件循环播放次数，当循环播放模式为有限次循环（CycleMode为0）时为必选参数。
    body.setPlayTimes(3);
    
    // 推流域名，推流地址（DstAddr）为空时必传；反之，则该参数不生效。
    body.setDomain("example.mtime.cn");
    
    // 推流应用名称，推流地址（DstAddr）为空时必传；反之，则该参数不生效。
    body.setApp("live");
    
    // 推流的流名称，推流地址（DstAddr）为空时必传；反之，则该参数不生效。
    body.setStream("stream-123");
    
    // 为拉流转推视频添加的水印配置信息。
    CreatePullToPushTaskBodyWatermark CreatePullToPushTaskBodyWatermark = new CreatePullToPushTaskBodyWatermark();  

    
    // 水印图片字符串，图片最大 2MB，最小 100Bytes，最大分辨率为 1080×1080。图片 Data URL 格式为：`data:image/<mediatype>;base64,<data>`。
    // <li> `mediatype`：图片类型，支持 png、jpg、jpeg 格式； </li>
    // <li> `data`：base64 编码的图片字符串。 </li>
    // 例如，`data:image/png;base64,iVBORw0KGg****mCC`
    CreatePullToPushTaskBodyWatermark.setPicture("data:image/png;base64,iVBORw0KGg\*\*\*\*mCC");
    
    // 水平偏移，表示水印左侧边与转码流画面左侧边之间的距离，使用相对比率，取值范围为 [0,1)。
    Float CreatePullToPushTaskBodyWatermarkRelativePosX = (float)0.1;

    CreatePullToPushTaskBodyWatermark.setRelativePosX(CreatePullToPushTaskBodyWatermarkRelativePosX);
    
    // 垂直偏移，表示水印顶部边与转码流画面顶部边之间的距离，使用相对比率，取值范围为 [0,1)。
    Float CreatePullToPushTaskBodyWatermarkRelativePosY = (float)0.1;

    CreatePullToPushTaskBodyWatermark.setRelativePosY(CreatePullToPushTaskBodyWatermarkRelativePosY);
    
    // 水印宽度占直播原始画面宽度百分比，支持精度为小数点后两位。
    Float CreatePullToPushTaskBodyWatermarkRatio = (float)0.1;

    CreatePullToPushTaskBodyWatermark.setRatio(CreatePullToPushTaskBodyWatermarkRatio);
     
    body.setWatermark(CreatePullToPushTaskBodyWatermark); 
        
    
    // 是否开启点播预热，开启点播预热后，系统会自动将点播视频文件缓存到 CDN 节点上，当用户请求直播时，可以直播从 CDN 节点获取视频，从而提高直播流畅度。
    // 拉流来源类型为点播视频（Type 为 1）时，参数生效。
    // <li> 0：不开启； </li>
    // <li> 1：开启（默认值）。 </li>
    body.setPreDownload(1);
    
    // 点播文件启播时间偏移值，单位为秒，数量与拉流地址列表中地址数量相等，缺省情况下为空表示不进行偏移。
    // 拉流来源类型为点播视频（Type 为 1）时，参数生效。
    List<Float> CreatePullToPushTaskBodyOffsetS = new ArrayList<>(); 

    Float bodyOffsetS0 = (float)1.1;

    CreatePullToPushTaskBodyOffsetS.add(bodyOffsetS0);

    
    body.setOffsetS(CreatePullToPushTaskBodyOffsetS); 
    
    // 续播策略，续播策略指转推点播视频进行直播时出现断流并恢复后，如何继续播放的策略，拉流来源类型为点播视频（Type 为 1）时参数生效，支持的取值及含义如下。
    // <li> 0：从断流处续播（默认值）； </li>
    // <li> 1：从断流处+自然流逝时长处续播。 </li>
    body.setContinueStrategy(9);
    
    // 点播文件启播时间偏移值，单位为秒，仅当点播视频播放地址列表（SrcAddrS）只有一个地址，且未配置 Offsets 时生效，缺省情况下为空表示不进行偏移。
    Float bodyOffset = (float)30;

    body.setOffset(bodyOffset);

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

删除拉流转推任务

您可以调用 DeletePullToPushTask 接口删除拉流转推任务。详细的参数说明可参见 DeletePullToPushTask 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.DeletePullToPushTaskBody;
import com.volcengine.model.live.v20230101.DeletePullToPushTaskRes;
import com.volcengine.service.live.v20230101.LiveService;

public class DeletePullToPushTaskDemo  {
  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"));

    DeletePullToPushTaskBody body = new DeletePullToPushTaskBody();
     
    // 任务 ID，任务的唯一标识，您可以通过[获取拉流转推任务列表](https//www.volcengine.com/docs/6469/1126896)接口获取。
    body.setTaskId("8fde6aa0281d9f*******05a6e242365");

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

更新拉流转推任务

您可以调用 UpdatePullToPushTask 接口更新拉流转推任务。详细的参数说明可参见 UpdatePullToPushTask 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.UpdatePullToPushTaskBody; 
import com.volcengine.model.live.v20230101.UpdatePullToPushTaskBodyWatermark;
import com.volcengine.model.live.v20230101.UpdatePullToPushTaskRes;
import com.volcengine.service.live.v20230101.LiveService;
import java.util.ArrayList; 
import java.util.List; 

public class UpdatePullToPushTaskDemo  {
  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"));

    UpdatePullToPushTaskBody body = new UpdatePullToPushTaskBody();
     
    // 拉流转推任务的名称，由 1 到 20 位中文、大小写字母和数字组成，默认为空，表示不修改任务名称。
    body.setTitle("task001");
    
    // 任务 ID，任务的唯一标识，您可以通过[获取拉流转推任务列表](https//www.volcengine.com/docs/6469/1126896)接口获取。
    body.setTaskId("8fde6aa0281*********59a6e242365");
    
    // 任务的开始时间，Unix 时间戳，单位为秒。
    // note：
    // 拉流转推任务持续时间最长为 7 天。
    body.setStartTime(1640891476);
    
    // 任务等结束时间，Unix 时间戳，单位为秒。
    // note：
    // 拉流转推任务持续时间最长为 7 天。
    body.setEndTime(1640891976);
    
    // 接收拉流转推任务状态回调的地址，最大长度为 2000 个字符。
    body.setCallbackURL("http://example.mtime.cn/live/example/callbackapi");
    
    // 拉流来源类型，支持的取值及含义如下。
    // <li> 0：直播源； </li>
    // <li> 1：点播视频。 </li>
    body.setType(0);
    
    // 点播视频文件循环播放模式，当拉流来源类型为点播视频（Type 为 1）时为必选参数，参数取值及含义如下所示。
    // <li> -1：无限循环，至任务结束； </li>
    // <li> 0：有限次循环，循环次数为 PlayTimes 取值为准。 </li>
    body.setCycleMode(-1);
    
    // 推流地址，即直播源或点播视频转推的目标地址。
    body.setDstAddr("rtmp://example.mtime.cn/Video/2022/02/04/mp4/190204084208765161.mp4");
    
    // 直播源的拉流地址，拉流来源类型为直播源（Type 为 0）时，为必选参数，最大长度为 1000 个字符。
    body.setSrcAddr("http://example.mtime.cn/Video/2003/02/04/mp4/190204084208765161.mp4");
    
    // 点播视频播放地址列表，拉流来源类型为点播视频（Type 为 1）时，为必选参数，最多支持传入 30 个点播视频播放地址，每个地址最大长度为 1000 个字符。
    List<String> UpdatePullToPushTaskBodySrcAddrS = new ArrayList<>(); 

    UpdatePullToPushTaskBodySrcAddrS.add("http://example.mtime.cn/Video/2003/02/04/mp4/190204084208765161.mp4");
    
    body.setSrcAddrS(UpdatePullToPushTaskBodySrcAddrS); 
    
    // 推流的流名称，推流地址（DstAddr）为空时必传；反之，则该参数不生效
    body.setStream("stream-123");
    
    // 推流应用名称，推流地址（DstAddr）为空时必传；反之，则该参数不生效
    body.setApp("live");
    
    // 推流域名，推流地址（DstAddr）为空时必传；反之，则该参数不生效
    body.setDomain("push.example.com");
    
    // 为拉流转推视频添加的水印配置信息。
    UpdatePullToPushTaskBodyWatermark UpdatePullToPushTaskBodyWatermark = new UpdatePullToPushTaskBodyWatermark();  

    
    // 水印图片字符串，图片最大 2MB，最小 100Bytes，最大分辨率为 1080×1080。图片 Data URL 格式为：`data:image/<mediatype>;base64,<data>`。
    // <li> mediatype：图片类型，支持 png、jpg、jpeg 格式； </li>
    // <li> data：base64 编码的图片字符串。 </li>
    // 例如，`data:image/png;base64,iVBORw0KGg****mCC`
    UpdatePullToPushTaskBodyWatermark.setPicture("data:image/png;base64,iVBORw0KGg\*\*\*\*mCC");
    
    // 水平偏移，表示水印左侧边与转码流画面左侧边之间的距离，使用相对比率，取值范围为 [0,1)。
    Float UpdatePullToPushTaskBodyWatermarkRelativePosX = (float)0.1;

    UpdatePullToPushTaskBodyWatermark.setRelativePosX(UpdatePullToPushTaskBodyWatermarkRelativePosX);
    
    // 垂直偏移，表示水印顶部边与转码流画面顶部边之间的距离，使用相对比率，取值范围为 [0,1)。
    Float UpdatePullToPushTaskBodyWatermarkRelativePosY = (float)0.1;

    UpdatePullToPushTaskBodyWatermark.setRelativePosY(UpdatePullToPushTaskBodyWatermarkRelativePosY);
    
    // 水印宽度占直播原始画面宽度百分比，支持精度为小数点后两位。
    Float UpdatePullToPushTaskBodyWatermarkRatio = (float)0.1;

    UpdatePullToPushTaskBodyWatermark.setRatio(UpdatePullToPushTaskBodyWatermarkRatio);
     
    body.setWatermark(UpdatePullToPushTaskBodyWatermark); 
        
    
    // 是否开启点播预热，开启点播预热后，系统会自动将点播视频文件缓存到 CDN 节点上，当用户请求直播时，可以直播从 CDN 节点获取视频，从而提高直播流畅度。
    // 拉流来源类型为点播视频（Type 为 1）时，参数生效。
    // <li> 0：不开启； </li>
    // <li> 1：开启（默认值）。 </li>
    body.setPreDownload(1);
    
    // 点播文件启播时间偏移值，单位为秒，数量与拉流地址列表中地址数量相等，缺省情况下表示不进行偏移。
    // 拉流来源类型为点播视频（Type 为 1）时，参数生效。
    List<Float> UpdatePullToPushTaskBodyOffsetS = new ArrayList<>(); 

    Float bodyOffsetS0 = (float)1.1;

    UpdatePullToPushTaskBodyOffsetS.add(bodyOffsetS0);

    
    body.setOffsetS(UpdatePullToPushTaskBodyOffsetS); 
    
    // 续播策略，续播策略指转推点播视频进行直播时出现断流并恢复后，如何继续播放的策略，拉流来源类型为点播视频（Type 为 1）时参数生效，支持的取值及含义如下。
    // <li> 0：从断流处续播（默认值）； </li>
    // <li> 1：从断流处+自然流逝时长处续播。 </li>
    body.setContinueStrategy(9);
    
    // 点播文件启播时间偏移值，单位为秒，仅当点播视频播放地址列表（SrcAddrS）只有一个地址，且未配置 Offsets 时生效，缺省情况下表示不进行偏移。
    Float bodyOffset = (float)30;

    body.setOffset(bodyOffset);
    
    // 点播视频文件循环播放次数，当循环播放模式为有限次循环（CycleMode为0）时为必选参数。
    body.setPlayTimes(3);

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

启用拉流转推任务

您可以调用 RestartPullToPushTask 接口启用拉流转推任务。详细的参数说明可参见 RestartPullToPushTask 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.RestartPullToPushTaskBody;
import com.volcengine.model.live.v20230101.RestartPullToPushTaskRes;
import com.volcengine.service.live.v20230101.LiveService;

public class RestartPullToPushTaskDemo  {
  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"));

    RestartPullToPushTaskBody body = new RestartPullToPushTaskBody();
     
    // 任务 ID，任务的唯一标识，您可以通过[获取拉流转推任务列表](https//www.volcengine.com/docs/6469/1126896)接口获取。
    body.setTaskId("8fde6aa0281d********986e242365");

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

停用拉流转推任务

您可以调用 StopPullToPushTask 接口停用拉流转推任务。详细的参数说明可参见 StopPullToPushTask 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.StopPullToPushTaskBody;
import com.volcengine.model.live.v20230101.StopPullToPushTaskRes;
import com.volcengine.service.live.v20230101.LiveService;

public class StopPullToPushTaskDemo  {
  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"));

    StopPullToPushTaskBody body = new StopPullToPushTaskBody();
     
    // 任务 ID，任务的唯一标识，您可以通过[获取拉流转推任务列表](https//www.volcengine.com/docs/6469/1126896)接口获取。
    body.setTaskId("8fde6aa0281d9f6e1*******a6e242365");

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

获取拉流转推任务列表

您可以调用 ListPullToPushTask 接口获取拉流转推任务列表。详细的参数说明可参见 ListPullToPushTask 接口文档。

接口调用示例如下所示。

package com.volcengine.live.demo;
import com.volcengine.model.live.v20230101.ListPullToPushTaskQuery;
import com.volcengine.model.live.v20230101.ListPullToPushTaskRes;
import com.volcengine.service.live.v20230101.LiveService;

public class ListPullToPushTaskDemo  {
  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"));

    ListPullToPushTaskQuery query = new ListPullToPushTaskQuery();
    
    // 查询数据的页码，默认为 1，表示查询第一页的数据。
    query.setPage(1);
    
    // 每页显示的数据条数，默认为 20，最大值为 500。
    query.setSize(20);
    
    // 拉流转推任务的名称，不区分大小写，支持模糊查询。
    // 例如，`title` 取值为 `doc` 时，则返回任务名称为 `docspace`、`docs`、`DOC` 等 title 中包含 `doc` 关键词的所有任务列表。
    query.setTitle("doc");

    try {
      ListPullToPushTaskRes resp = service.listPullToPushTask(query);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

调用说明

前提条件

调用示例

创建拉流转推任务

删除拉流转推任务

更新拉流转推任务

启用拉流转推任务

停用拉流转推任务

获取拉流转推任务列表

视频直播

拉流转推

调用说明

前提条件

调用示例

创建拉流转推任务

删除拉流转推任务

更新拉流转推任务

启用拉流转推任务

停用拉流转推任务

获取拉流转推任务列表