为满足您对原生环境的开播与观播需求,企业直播将相关底层能力整合包装,输出了一套支持您自有产品独立接入的 aPaaS 方案(即 aPaaS SDK 和服务端 API),结合企业直播 SaaS 服务,实现多终端的开播与观播能力。通过丰富的 OpenAPI、可定制化的开观播 SDK 以及模块化 SDK 功能组件,有助于您快速集成落地定制化直播间,打造专属直播体验。
SDK 基本信息公示
开播 SDK
观播 SDK
类别
功能介绍
开播 SDK
开播 SDK 提供录屏直播和视频直播两大功能。
录屏直播
主持人可以实时共享屏幕画面,而无需有线或无线连接的繁琐步骤,大大降低了直播门槛。录屏直播适用于游戏直播或演示效果直播等场景。
注意
- 该功能仅适用于 iOS 12 及以上版本。
- iOS 16.4 硬编存在问题,会导致直播画面模糊。
- 仅 Android 10 及以上版本支持录制设备声音。
直播开始前
点击录屏直播页签,使用以下功能。
功能 | 描述 |
---|
更换封面 | 点击变更,从本地选择图片作为直播间横屏封面。 |
修改直播间标题 | 点击直播间标题进行编辑修改。
如果您希望不同观看页语言的观众能够看到对应语言的直播间标题,可以完成以下操作: - 在企业直播控制台直播间的观看页管理 > 基础信息页面,打开页面语言开关并选择相应的语言。
- 在开播端点击直播间标题,按照界面提示的顺序编辑多语言直播间标题,使用“|”分割不同语言。例如,在上一步选择了简体中文和英文后,编辑直播间标题时输入
直播间 A|Live room A ,则观看页语言为简体中文的观众看到的直播间标题为直播间 A ,观看页语言为英文的观众看到的直播间标题为 Live room A 。
|
横竖屏切换 | 点击横屏或竖屏,切换直播屏幕方向。默认为竖屏模式。 |
帧率模式切换 | 点击 FPS,选择切换为高帧率模式或默认帧率模式。
在主持人共享高帧率画面时,高帧率模式可为观众提供更流畅的观看体验。该模式适用于游戏直播等场景。
高帧率模式可能导致设备耗电快、过热以及带宽使用量增加。因此,建议主持人在共享屏幕画面帧率为 30 fps 及以上且上行带宽为 100 Mbps 及以上时使用该模式。 说明 目前仅 Android 开播 SDK 支持该功能。 |
清屏 | 双击屏幕进行清屏操作,即隐藏预览页的所有组件。如需撤销清屏,可以再次双击屏幕或点击撤销图标撤销清屏。 |
退出预览页 | 点击退出图标,退出预览页。 |
开始直播 | 点击开始直播,进入授权页面。确保授予您的 App 录制屏幕的权限。 |
直播开始后
功能 | 描述 |
---|
查看直播间信息 | 您可以查看直播间的以下信息: - 在线人数。
- 直播结束倒计时。
说明 仅在开启直播结束时间功能后支持查看。有关如何开启直播结束时间功能,详见自动关播。 - 当前的直播间人气。
- 当前的网络状态。
- 本次直播的直播时长。
|
在聊天区与观众互动 | 查看和回复观众发言。
为确保不同观看页语言的观众能够查看对应语言的主持人发言,您可以完成以下操作: - 登录企业直播控制台。
- 在直播列表中,单击进入直播间。
- 在左侧导航栏,选择观看页管理 > 基础信息,打开页面语言开关并选择相应的语言。
- 在左侧导航栏,选择菜单管理 > 聊天互动页面,在基础配置页签下打开评论翻译开关。观看页聊天区的内容会自动翻译为对应语言。
- 为提高不同语言主持人发言的准确性,主持人可以在聊天区按照界面提示的顺序编辑多语言聊天内容,使用“|”分割不同语言。例如,在步骤 3 中选择了简体中文和英文后,主持人在聊天区发送
你好|Hello ,则观看页语言为简体中文的观众在聊天区看到的内容为你好 ,观看页语言为英文的观众在聊天区看到的内容为Hello 。
|
设置 | 点击设置图标,进行以下设置。 - 静音:主持人麦克风静音。静音后,观众仅可听到主持人的设备声音。
- 清屏:隐藏开播页面上的所有组件,让主持人专注于自身画面。如需撤销清屏,可以双击屏幕或点击撤销图标撤销清屏。
- 清空评论:清空直播间所有评论。
|
清屏 | 双击屏幕进行清屏操作,即隐藏开播页面上的所有组件。如需撤销清屏,可以再次双击屏幕或点击撤销图标撤销清屏。 |
切换页面 | 观众可看到主持人的屏幕内容。主持人可以切换到想要共享给观众的页面,例如游戏画面或演示画面。 |
关播 | 点击关播图标,关闭当前直播。 |
视频直播
在直播期间,主持人可以通过设备摄像头露脸直播。开播 SDK 提供的美颜、滤镜和道具贴纸功能保障了观众更好的观看体验。
直播开始前
点击视频直播页签,使用以下功能。
功能 | 描述 |
---|
更换封面 | 点击变更,从本地选择图片作为直播间横屏封面。 |
修改直播间标题 | 点击直播间标题进行编辑修改。
如果您希望不同观看页语言的观众能够看到对应语言的直播间标题,可以完成以下操作: - 在企业直播控制台直播间的观看页管理 > 基础信息页面,打开页面语言开关并选择相应的语言。
- 在开播端点击直播间标题,按照界面提示的顺序编辑多语言直播间标题,使用“|”分割不同语言。例如,在上一步选择了简体中文和英文后,编辑直播间标题时输入
直播间 A|Live room A ,则观看页语言为简体中文的观众看到的直播间标题为直播间 A ,观看页语言为英文的观众看到的直播间标题为 Live room A 。
|
前后摄像头翻转 | 点击翻转,切换前后摄像头。默认为前置摄像头。 |
美颜 | 点击美颜,使用美颜和滤镜功能。 |
道具 | 点击道具,添加画面特效。 |
图层 | 点击图层,在图层弹窗中,您可以进行以下操作: - 长按拖动或点击上移、下移调整图层的显示层级。如果挂件出现重叠,则上层图层的挂件会对下层图层的挂件造成遮挡。
- 点击隐藏或显示,隐藏或显示指定图层。图层对应的挂件在画布中也将同步隐藏或显示。
- 点击删除,删除指定图层。图层对应的挂件也将从画布中删除。
- 点击清空挂件,删除画布中的所有挂件。
说明 - 最多支持 20 个图层。
- 使用相同设备重新进入直播间时,支持读取您离开直播间时的图层配置。
|
挂件 | 点击挂件,在挂件弹窗中,您可以进行以下操作: - 点击上传图片,从本地上传图片。
说明 - 最大支持上传 10 MB 的 PNG、HEIC(仅 iOS 支持该格式)和 GIF 格式的图片。
- 在同一台设备上添加的挂件可在不同直播间内共享。
- 点击挂件右下方的删除图标,删除该挂件。
- 点击挂件,将该挂件添加至画布。
说明 - 同一挂件支持重复添加至画布。
- 最多支持添加 10 个 GIF 格式的图片至画布。
- 每一个添加至画布的挂件都对应一个图层。
您还可以点击画布上的挂件,并按需进行以下操作:
- 点击挂件右上方的删除图标,将该挂件从画布中删除。
- 拖动挂件右下方的缩放图标或使用双指,等比例放大或缩小挂件。
- 单指挪动挂件的位置。
说明 使用相同设备重新进入直播间时,支持读取您离开直播间时的挂件配置。 |
模板 | 点击模板,在模板列表弹窗中,点击竖屏或横屏页签并按需进行以下操作: 说明 竖屏模板仅适用于竖屏直播,横屏模板仅适用于横屏直播。 - 点击新建模板,进入新建模板页面,按需配置模板并点击保存。
- 点击编辑模板名称。
- 配置美颜、道具、挂件和图层等内容。
说明 模板中仅保存美颜、道具、挂件和图层的相关配置。您也可以配置其他内容,用于预览页面效果。
- 点击模板,进入模板预览页面。您可以进行以下操作:
- 左右滑动快速切换模板。
- 点击立即下载下载指定模板。若已下载的模板有更新,则需点击模板有更新,点击下载更新指定模板。
说明 模板下载后,模板中的挂件(如有)将自动添加至挂件列表中。若挂件剩余数量不足,模板将下载失败。
下载模板后,您可以进行以下操作:
- 点击编辑图标,对指定模板进行编辑修改。
- 点击删除图标,删除指定模板。模板删除后,仅正在使用该模板的直播间可继续使用该模板。
- 点击立即使用,使用指定模板。您也可以在使用模板的基础上对直播间进行相应修改。
说明 - 若从挂件列表中删除了模板中的挂件,则需重新下载该模板才可继续使用。
- 直播间下载和使用的模板仅对当前设备有效。若您使用其他设备进入该直播间,则需重新下载和使用模板。
|
横竖屏切换 | 点击横屏或竖屏,切换直播屏幕方向。默认为竖屏模式。 |
清晰度切换 | 点击清晰度,在选择清晰度弹窗内可以修改直播画面清晰度。默认清晰度为超清 720P。 |
清屏 | 双击屏幕进行清屏操作,即隐藏除挂件外的所有组件。如需撤销清屏,可以再次双击屏幕或点击撤销图标撤销清屏。 |
退出预览页 | 点击退出图标,退出预览页。 |
开始直播 | 点击开始直播,基于设置好的效果开始直播。 |
直播开始后
功能 | 描述 |
---|
查看直播间信息 | 您可以查看直播间的以下信息: - 在线人数。
- 直播结束倒计时。
说明 仅在开启直播结束时间功能后支持查看。有关如何开启直播结束时间功能,详见自动关播。 - 当前的直播间人气。
- 当前的网络状态。
- 本次直播的直播时长。
|
在聊天区与观众互动 | 查看和回复观众发言。
为确保不同观看页语言的观众能够查看对应语言的主持人发言,您可以完成以下操作: - 登录企业直播控制台。
- 在直播列表中,单击进入直播间。
- 在左侧导航栏,选择观看页管理 > 基础信息,打开页面语言开关并选择相应的语言。
- 在左侧导航栏,选择菜单管理 > 聊天互动页面,在基础配置页签下打开评论翻译开关。观看页聊天区的内容会自动翻译为对应语言。
- 为提高不同语言主持人发言的准确性,主持人可以在聊天区按照界面提示的顺序编辑多语言聊天内容,使用“|”分割不同语言。例如,在步骤 3 中选择了简体中文和英文后,主持人在聊天区发送
你好|Hello ,则观看页语言为简体中文的观众在聊天区看到的内容为你好 ,观看页语言为英文的观众在聊天区看到的内容为Hello 。
|
设置 | 点击设置图标,进行以下设置。 - 翻转:切换前后摄像头。
- 美颜:使用美颜和滤镜功能。
- 道具:添加画面特效。
- 挂件:添加或删除挂件等。详见直播开始前。
- 图层:移动或隐藏图层等。详见直播开始前。
- 镜像:画面镜像翻转。
- 闪光灯:开启主持人设备的闪光灯。
- 静音:主持人麦克风静音,让观众听不到主持人说话声音。
- 清屏:隐藏除挂件、本地图片、文本外的所有组件,让主持人专注于自身画面。
您也可以双击屏幕进行清屏操作。
如需撤销清屏,可再次双击屏幕或点击撤销图标撤销清屏。 - 清空评论:清空直播间所有评论。
- 媒体:选择本地图片,即可将其展示在开播页面。观众在观看页可看到主持人的摄像头画面和选中的图片。主持人可点击图片右上方的 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 协议。