全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 智能硬件
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 更多
视频直播

直播API概述

更新时间:2018-07-13 22:56:10

视频直播服务提供Web管理控制台、API和软件开发工具包,您可以通过它们使用、管理视频直播服务,也可以与您自己的应用和服务集成。

所有服务按使用付费,服务能力自动伸缩,告别复杂的架构设计和编程开发,维护成本几近于零,您可以专注于业务逻辑实现及最终用户体验的提升。

请确保在使用这些接口前,已充分了解 视频直播 产品说明、使用协议和收费方式。

当前Live Open API版本号为:2016-11-01

术语表

业务限制资源规格限制说明

附录

直播截图

API 描述
AddLiveAppSnapshotConfig 添加截图配置
DeleteLiveAppSnapshotConfig 删除截图配置
DescribeLiveSnapshotConfig 查询域名下的截图配置
DescribeLiveStreamSnapshotInfo 查询截图信息
UpdateLiveAppSnapshotConfig 更新截图配置

直播拉流

API 描述
DeleteLivePullStreamInfoConfig 删除拉流
AddLivePullStreamInfoConfig 添加拉流
DescribeLivePullStreamConfig 查询拉流信息

互动直播

API 描述
CreateRoom 互动直播的所有交互都基于房间展开,必须先创建房间,直播间可重复使用。
DeleteRoom 在直播结束或不再使用此直播间时删除直播间。
DescribeRoomList 获取房间列表,创建直播间后可获取。
DescribeRoomStatus 获取房间状态,可获取直播间的推端流状态。
ForbidPushStream 禁止推流,主要用于后台管理主播是否能推流。
AllowPushStream 解除禁止推流,用于被禁止推流后的房间恢复推流权限。
DescribeForbidPushStreamRoomList 获取禁播房间列表,被禁止推流的房间可以通过此接口获取。
DescribeRoomKickoutUserList 获取被踢出直播间的用户列表,踢人操作在客户端上发起。
SendRoomNotification 房间通知,主要用于进出入房间的通知,适合在整个房间广播的消息通知。
SendRoomUserNotification 房间用户通知,主要用户发送礼物的通知,适合向房间内的个人发送通知。

直播审核

API 描述
AddLiveSnapshotDetectPornConfig 添加审核配置
AddLiveDetectNotifyConfig 添加审核回调
DescribeLiveSnapshotDetectPornConfig 查询审核配置
DescribeLiveDetectNotifyConfig 查询审核回调
UpdateLiveSnapshotDetectPornConfig 更新审核配置
UpdateLiveDetectNotifyConfig 更新审核回调
DeleteLiveSnapshotDetectPornConfig 删除审核配置
DeleteLiveDetectNotifyConfig 删除审核回调

状态通知

API 描述
SetLiveStreamsNotifyUrlConfig 设置NotifyURL
DescribeLiveStreamsNotifyUrlConfig 查询NotifyURL
DeleteLiveStreamsNotifyUrlConfig 删除NotifyURL

直播转点播

API 描述
AddLiveRecordVodConfig 添加直转点配置
DescribeLiveRecordVodConfigs 查询直转点配置
DeleteLiveRecordVodConfig 删除直转点配置

直播录制

API 描述
AddLiveAppRecordConfig 添加APP录制配置
DeleteLiveAppRecordConfig 删除APP录制配置
DescribeLiveRecordConfig 查询域名下录制配置列表
DescribeLiveStreamRecordContent 查询录制内容
CreateLiveStreamRecordIndexFiles 创建录制索引文件
DescribeLiveStreamRecordIndexFile 查询单个录制索引文件
DescribeLiveStreamRecordIndexFiles 查询录制索引文件
AddLiveRecordNotifyConfig 添加录制回调配置
DeleteLiveRecordNotifyConfig 删除录制回调配置
DescribeLiveRecordNotifyConfig 查询录制回调配置
UpdateLiveRecordNotifyConfig 更新录制回调配置

直播流管理

API 描述
ForbidLiveStream 禁止直播流推送
DescribeLiveStreamsBlockList 查询推流黑名单列表
DescribeLiveStreamsControlHistory 查询流控历史
DescribeLiveStreamsOnlineList 查询推流在线列表
DescribeLiveStreamsPublishList 查询推流历史
ResumeLiveStream 恢复直播流推送
DescribeLiveStreamsFrameRateAndBitRateData 查询直播流实时帧率和码率
DescribeLiveStreamBitRateData 查询直播流历史帧率和码率

导播服务

API 描述
CreateCaster 创建导播台
AddCasterLayout 添加布局
AddCasterVideoResource 添加视频源
CopyCaster 复制导播台
CopyCasterSceneConfig 复制场景配置
AddCasterComponent 添加组件
DeleteCaster 删除导播台
DeleteCasterLayout 删除布局
DeleteCasterVideoResource 删除视频源
DescribeCasterConfig 查询导播台配置信息
DescribeCasterLayouts 查询布局列表
DescribeCasters 查询导播台列表
DescribeCasterScenes 查询导播台场景列表
DescribeCasterStreamUrl 查询导播台流地址
DescribeCasterVideoResources 查询视频源
EffectCasterUrgent 切换备播
EffectCasterVideoResource 更新备播
ModifyCasterLayout 修改布局
ModifyCasterVideoResource 修改视频源
SetCasterConfig 配置导播台
SetCasterSceneConfig 设置场景配置
StartCaster 启动导播台
StartCasterScene 启动场景
StopCaster 停止导播台
StopCasterScene 停止场景
UpdateCasterSceneConfig 更新导播场景配置
DeleteCasterComponent 删除组件
DescribeCasterComponents 查询组件列表
ModifyCasterComponent 修改组件

直播转码

API 描述
AddLiveStreamTranscode 添加转码配置
DeleteLiveStreamTranscode 删除转码配置
DescribeLiveStreamTranscodeInfo 查询转码配置信息
AddCustomLiveStreamTranscode 添加自定义转码配置
AddTrancodeSEI 添加转码SEI信息

资源监控

API 描述
DescribeLiveStreamHistoryUserNum 查询直播流历史在线人数
DescribeLiveStreamOnlineUserNum 查询直播流实时在线人数
DescribeLiveDomainBpsData 查询直播域名网络带宽监控数据
DescribeLiveDomainTrafficData 查询直播域名网络流量监控数据
DescribeLiveDomainTranscodeData 查询直播域名转码时长数据
DescribeLiveDomainRecordData 查询直播域名录制时长数据
DescribeLiveDomainSnapshotData 查询直播域名截图张数数据
本文导读目录