You need to enable JavaScript to run this app.
导航

SDK 概述

最近更新时间2024.03.28 17:26:16

首次发布时间2022.02.24 19:18:57

为满足您对原生环境的开播与观播需求,企业直播将相关底层能力整合包装,输出了一套支持您自有产品独立接入的 aPaaS 方案(即 aPaaS SDK 和服务端 API),结合企业直播 SaaS 服务,实现多终端的开播与观播能力。通过丰富的 OpenAPI、可定制化的开观播 SDK 以及模块化 SDK 功能组件,有助于您快速集成落地定制化直播间,打造专属直播体验。

SDK 基本信息公示

开播 SDK

观播 SDK

类别

功能介绍

开播 SDK

开播 SDK 提供录屏直播和视频直播两大功能。

录屏直播

主持人可以实时共享屏幕画面,而无需有线或无线连接的繁琐步骤,大大降低了直播门槛。录屏直播适用于游戏直播或演示效果直播等场景。

注意

  • 该功能仅适用于 iOS 12 及以上版本。
  • iOS 16.4 硬编存在问题,会导致直播画面模糊。
  • 仅 Android 10 及以上版本支持录制设备声音。

直播开始前

点击录屏直播页签,使用以下功能。

功能

描述

更换封面

点击更换封面,从本地选择图片作为直播间横屏封面。

修改直播间标题

点击直播间标题进行编辑修改。

横竖屏切换

点击横屏竖屏,切换直播屏幕方向。默认为竖屏模式。

清屏

双击屏幕进行清屏操作,即隐藏预览页的所有组件。如需撤销清屏,可以再次双击屏幕或点击撤销图标撤销清屏。

退出预览页

点击退出图标,退出预览页。

开始直播

点击开始直播,进入授权页面。确保授予您的 App 录制屏幕的权限。

直播开始后

功能

描述

查看直播间信息

您可以查看直播间的以下信息:

  • 直播间标题。
  • 本次直播的直播时长。
  • 当前的直播状态。
  • 当前的网络状态。
  • 当前的直播间人气。

在聊天区与观众互动

查看和回复观众发言。

设置

点击设置图标,进行以下设置。

  • 静音:主持人麦克风静音。静音后,观众仅可听到主持人的设备声音。
  • 清屏:隐藏开播页面上的所有组件,让主持人专注于自身画面。如需撤销清屏,可以双击屏幕或点击撤销图标撤销清屏。

清屏

双击屏幕进行清屏操作,即隐藏开播页面上的所有组件。如需撤销清屏,可以再次双击屏幕或点击撤销图标撤销清屏。

切换页面

观众可看到主持人的屏幕内容。主持人可以切换到想要共享给观众的页面,例如游戏画面或演示画面。

关播

点击关播图标,关闭当前直播。

视频直播

在直播期间,主持人可以通过设备摄像头露脸直播。开播 SDK 提供的美颜和特效功能保障了观众更好的观看体验。

直播开始前

点击视频直播页签,使用以下功能。

功能

描述

更换封面

点击更换封面,从本地选择图片作为直播间横屏封面。

修改直播间标题

点击直播间标题进行编辑修改。

美颜

点击美颜,使用美颜和滤镜功能。

道具

点击道具,添加画面特效。

挂件

点击挂件,在挂件弹窗中,您可以进行以下操作:
图片

  • 点击上传图片,从本地上传图片。

    说明

    • 最大支持上传 10 MB 的 PNG、HEIC(仅 iOS 支持该格式)和 GIF 格式的图片。
    • 在同一台设备上添加的挂件可在不同直播间内共享。
  • 点击挂件右下方的删除图标,删除该挂件。
  • 点击挂件,将该挂件添加至画布。

    说明

    • 同一挂件支持重复添加至画布。
    • 最多支持添加 10 个 GIF 格式的图片至画布。
    • 每一个添加至画布的挂件都对应一个图层。
    您还可以点击画布上的挂件,并按需进行以下操作:
    图片
    • 点击挂件右上方的删除图标,将该挂件从画布中删除。
    • 拖动挂件右下方的缩放图标或使用双指,等比例放大或缩小挂件。
    • 单指挪动挂件的位置。

说明

使用相同设备重新进入直播间时,支持读取您离开直播间时的挂件配置。

图层

点击图层,在图层弹窗中,您可以进行以下操作:
图片

  • 长按拖动或点击上移下移调整图层的显示层级。如果挂件出现重叠,则上层图层的挂件会对下层图层的挂件造成遮挡。
  • 点击隐藏显示,隐藏或显示指定图层。图层对应的挂件在画布中也将同步隐藏或显示。
  • 点击删除,删除指定图层。图层对应的挂件也将从画布中删除。
  • 点击清空挂件,删除画布中的所有挂件。

说明

  • 最多支持 20 个图层。
  • 使用相同设备重新进入直播间时,支持读取您离开直播间时的图层配置。

模板

点击模板,在模板列表弹窗中,点击竖屏横屏页签并按需进行以下操作:

说明

竖屏模板仅适用于竖屏直播,横屏模板仅适用于横屏直播。

图片

  • 点击新建模板,进入新建模板页面,按需配置模板并点击保存
    图片
    • 点击编辑模板名称。
    • 配置美颜、道具、挂件和图层等内容。

      说明

      模板中仅保存美颜、道具、挂件和图层的相关配置。您也可以配置其他内容,用于预览页面效果。

  • 点击模板,进入模板预览页面。您可以进行以下操作:
    图片
    • 左右滑动快速切换模板。
    • 点击立即下载下载指定模板。若已下载的模板有更新,则需点击模板有更新,点击下载更新指定模板。

      说明

      模板下载后,模板中的挂件(如有)将自动添加至挂件列表中。若挂件剩余数量不足,模板将下载失败。

      下载模板后,您可以进行以下操作:
      图片
      • 点击编辑图标,对指定模板进行编辑修改。
      • 点击删除图标,删除指定模板。模板删除后,仅正在使用该模板的直播间可继续使用该模板。
      • 点击立即使用,使用指定模板。您也可以在使用模板的基础上对直播间进行相应修改。

    说明

    • 若从挂件列表中删除了模板中的挂件,则需重新下载该模板才可继续使用。
    • 直播间下载和使用的模板仅对当前设备有效。若您使用其他设备进入该直播间,则需重新下载和使用模板。

前后摄像头翻转

点击翻转,切换前后摄像头。默认为前置摄像头。

横竖屏切换

点击横屏竖屏,切换直播屏幕方向。默认为竖屏模式。

清晰度切换

点击清晰度,在选择清晰度弹窗内可以修改直播画面清晰度。默认清晰度为超清 720P

清屏

双击屏幕进行清屏操作,即隐藏除挂件外的所有组件。如需撤销清屏,可以再次双击屏幕或点击撤销图标撤销清屏。

退出预览页

点击退出图标,退出预览页。

开始直播

点击开始直播,基于设置好的效果开始直播。

直播开始后

功能

描述

查看直播间信息

您可以查看直播间的以下信息:

  • 直播间标题。
  • 本次直播的直播时长。
  • 当前的直播状态。
  • 当前的网络状态。
  • 当前的直播间人气。

在聊天区与观众互动

查看和回复观众发言。

前后摄像头翻转

点击翻转图标,切换前后摄像头。

美颜

点击美颜图标,使用美颜和滤镜功能。

道具

点击道具图标,添加画面特效。

关播

点击关播图标,关闭当前直播。

设置

点击设置图标,进行以下设置。

  • 挂件:添加或删除挂件等。详见直播开始前
  • 图层:移动或隐藏图层等。详见直播开始前
  • 镜像:画面镜像翻转。
  • 闪光灯:开启主持人设备的闪光灯。
  • 静音:主持人麦克风静音,让观众听不到主持人说话声音。
  • 清屏:隐藏除挂件、本地图片、文本外的所有组件,让主持人专注于自身画面。如需撤销清屏,可以双击屏幕或点击撤销图标撤销清屏。
  • 媒体:选择本地图片,即可将其展示在开播页面。观众在观看页可看到主持人的摄像头画面和选中的图片。主持人可点击图片右上方的 x,将其从开播页面和观看页删除。
  • 文本:在输入框中输入文字,将文字转换成白底黑字的图片并展示在开播页面。观众在观看页可看到主持人的摄像头画面和转换后的白底黑字图片。主持人可点击图片右上方的 x,将其从开播页面和观看页删除。

    说明

    • 文字转换成的图片不在本地保存。
    • 最多支持将 15 个字符转换为图片,超出的部分不在图片中显示。

清屏

双击屏幕进行清屏操作,即隐藏除挂件、本地图片、文本外的所有组件。如需撤销清屏,可以再次双击屏幕或点击撤销图标撤销清屏。

观播 SDK

您可以通过企业直播控制台或调用对应的服务端 API,在集成了观播 SDK 的观看页和 App 端实现指定功能。具体功能,详见 SaaS 与 aPaaS 功能差异。您也可以通过调用 SDK API 或修改相关参数,自定义观看页的显示。详见对应的 SDK 文档。

说明

  • 微信小程序观播 SDK 目前支持的功能较少,详见集成微信小程序观播 SDK
  • Android 观播 SDK、iOS 观播 SDK 以及 Web 观播 SDK(PC 端 )采用的直播协议是 RTM(超低延时)协议或 HTTP-FLV 协议,而 Web 观播 SDK(移动端)采用的直播协议是 RTM(超低延时)协议或 HLS 协议。