本产品(
视频直播/2016-11-01
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
域名管理
API | 标题 | API概述 |
---|---|---|
AddLiveDomain | 添加直播域名 | 调用该接口添加直播域名,一次只能提交一个域名。 |
AddLiveDomainPlayMapping | 添加主播放和子播放域名映射 | 添加主播流域名和子播流域名映射。 |
DeleteLiveDomainPlayMapping | 删除播流域名的映射关系 | 删除主播流域名和子播流域名的映射关系配置。 |
AddLiveDomainMapping | 添加播流域名和推流域名的映射关系 | 添加直播域名播流域名和推流域名的映射关系配置。 |
DeleteLiveDomain | 删除已添加的直播域名 | 删除本条直播域名的全部相关记录。 |
DeleteLiveDomainMapping | 删除直播域名的映射关系 | 删除直播域名播流域名和推流域名的映射关系配置。 |
DescribeLiveDomainMapping | 查询直播域名映射 | 查询推流域名、主播流域名和子播流域名映射。 |
DescribeLiveDomainDetail | 获取指定直播域名配置的基本信息 | 查询指定推流域名或播流域名的基本配置信息。 |
DescribeLiveUserDomains | 查询用户名下所有的直播域名 | 查询用户名下所有的直播域名。 |
StartLiveDomain | 启用直播域名 | 启用状态为停用的直播域名,将DomainStatus变更为online。 |
StopLiveDomain | 停用直播域名 | 停用状态为启用的直播域名,将DomainStatus变更为offline。 |
DescribeLiveCertificateDetail | 查询证书信息 | 查询证书详细信息。 |
DescribeLiveDomainCertificateInfo | 查询指定直播域名证书信息 | 获取指定直播域名证书信息。 |
DescribeLiveCertificateList | 获取证书列表信息 | 查询指定域名或请求账号下的所有证书列表信息。 |
SetLiveDomainCertificate | 设置域名证书 | 设置某域名下证书功能是否启用及修改证书信息。 |
BatchDeleteLiveDomainConfigs | 批量删除域名配置 | 批量删除域名配置。 |
BatchSetLiveDomainConfigs | 批量配置域名 | 批量配置域名。 |
DescribeLiveDomainConfigs | 查询直播域名配置 | 查询直播域名配置,一次可查询多个功能配置。 |
DescribeLiveDomainByCertificate | 查询证书匹配的域名列表 | 根据证书信息获取加速域名。 |
DescribeLiveHttpsDomainList | 查询证书服务列表接口 | 查询用户证书服务所有已配置证书信息。 |
ModifyLiveDomainSchdmByProperty | 修改直播域名加速区域 | 修改直播域名加速区域。 |
DescribeLiveUserTags | 获取直播用户标签 | 调用DescribeLiveUserTags查询用户标签。 |
VerifyLiveDomainOwner | 验证直播域名拥有者 | 调用VerifyLiveDomainOwner验证域名归属权。 |
直播预热
API | 标题 | API概述 |
---|---|---|
SetLiveStreamPreloadTasks | 设置直播预热任务 | 设置直播预热任务,支持批量设置直播流预热。 |
DescribeLiveStreamPreloadTasks | 查询直播预热任务 | 仅支持查询最近3天内的数据。 |
HotLiveRtcStream | 设置RTC流预热 | 设置RTC流预热。 |
直播拉流
API | 标题 | API概述 |
---|---|---|
AddLivePullStreamInfoConfig | 添加直播拉流配置信息 | 添加直播拉流配置信息。 |
DescribeLivePullStreamConfig | 查询域名下拉流配置信息 | 调用DescribeLivePullStreamConfig查询域名下拉流配置信息。 |
DeleteLivePullStreamInfoConfig | 删除直播拉流配置 | 删除拉流配置信息。 |
SetLiveLazyPullStreamInfoConfig | 配置触发拉流 | 添加拉流信息。 |
DescribeLiveLazyPullStreamConfig | 查询触发拉流配置 | 查询播流域名下触发拉流配置信息。 |
DeleteLiveLazyPullStreamInfoConfig | 删除触发拉流配置信息 | 删除触发拉流配置信息。 |
UpdateLivePullStreamInfoConfig | 更新直播拉流配置 | 更新直播拉流配置信息,包括源站地址、开始时间和结束时间。 |
直播流管理
API | 标题 | API概述 |
---|---|---|
DescribeLiveStreamsBlockList | 获取域名下直播流播放的黑名单 | 调用DescribeLiveStreamsBlockList获取域名下直播流播放的黑名单。 |
DescribeLiveStreamsControlHistory | 查询直播流操作历史 | 获取某个域名或应用下的直播流操作历史。 |
DescribeLiveStreamBitRateData | 查询RTMP协议直播流的帧率和码率 | 查询RTMP协议的直播流在设置时间范围内的一组帧率和码率,适用于获取历史数据。 |
DescribeLiveStreamsOnlineList | 查询域名在线流列表 | 查询指定域名或者指定域名下某个应用的所有在线流信息。 |
DescribeLiveStreamsPublishList | 查询域名历史流列表 | 获取某一时间段内某个域名(或域名下某应用或某个流)的历史推流记录。 |
ForbidLiveStream | 禁止直播流 | 禁止某条流的推送,可以预设某个时刻将流恢复。 |
ResumeLiveStream | 开始或恢复某条直播流的推送 | 恢复某条流的推送。 |
DescribeLiveDomainOnlineUserNum | 查询域名下所有流某分钟的在线人数信息 | 查询域名下所有流的在线人数信息。 |
DescribeLiveDomainFrameRateAndBitRateData | 查询直播域名下流帧率和码率数据 | 查询推流域名下流帧率和码率数据。 |
DescribeLiveDomainLimit | 查询域名推流数量限制和转码数量限制 | 调用DescribeLiveDomainLimit查询指定播流域名的推流数量限制和转码数量限制。 |
DescribeLiveStreamState | 查询单路流状态 | 实时查询单路流状态。 |
边缘转推
API | 标题 | API概述 |
---|---|---|
DescribeLiveEdgeTransfer | 查询直播转推配置 | 调用DescribeLiveEdgeTransfer查询直播转推配置。 |
DeleteLiveEdgeTransfer | 删除直播转推配置 | 调用DeleteLiveEdgeTransfer删除直播转推配置。 |
SetLiveEdgeTransfer | 设置直播转推配置 | 调用SetLiveEdgeTransfer设置直播转推配置。 |
中心转推
API | 标题 | API概述 |
---|---|---|
AddLiveCenterTransfer | 添加直播中心转推配置 | 调用AddLiveCenterTransfer添加直播中心转推配置。 |
UpdateLiveCenterTransfer | 修改直播中心转推配置 | 调用UpdateLiveCenterTransfer修改直播中心转推配置。 |
DescribeLiveCenterTransfer | 获取直播中心转推 | 调用DescribeLiveCenterTransfer查询直播中心转推配置。 |
DeleteLiveCenterTransfer | 删除直播中心转推 | 调用DeleteLiveCenterTransfer删除直播中心转推配置。 |
主备合流
API | 标题 | API概述 |
---|---|---|
DeleteLiveStreamMerge | 删除在线流合流 | 删除在线流合流。 |
AddLiveStreamMerge | 添加主备合流 | 调用AddLiveStreamMerge添加主备合流配置。 |
DescribeLiveStreamMerge | 查询主备合流配置 | 调用DescribeLiveStreamMerge查询主备合流配置。 |
直播延播
API | 标题 | API概述 |
---|---|---|
DeleteLiveDelayConfig | 删除直播延播配置 | 调用DeleteLiveDelayConfig删除直播延播配置。 |
UpdateLiveDelayConfig | 更新直播延播配置 | 更新直播延播配置。 |
DescribeLiveDelayConfig | 查询直播延播配置 | 调用DescribeLiveDelayConfig查询直播延播配置。 |
ListLiveDelayConfig | 查询延播配置列表 | 调用ListLiveDelayConfig查询直播延播配置列表。 |
CreateLiveDelayConfig | 设置直播延播配置 | 设置直播延播配置。 |
推流回调
API | 标题 | API概述 |
---|---|---|
SetLiveStreamsNotifyUrlConfig | 设置推流回调通知地址配置 | 设置推流回调配置。 |
DescribeLiveStreamsNotifyUrlConfig | 查询直播推流回调配置 | 查询推流回调配置。 |
DeleteLiveStreamsNotifyUrlConfig | 删除直播推流回调配置 | 删除推流回调配置。 |
DescribeLiveStreamsNotifyRecords | 查询流回调记录 | 查询流回调记录。 |
直播安全
API | 标题 | API概述 |
---|---|---|
DeleteLiveStreamBlock | 删除直播流粒度封禁 | 调用DeleteLiveStreamBlock删除直播流粒度封禁。 |
SetLiveStreamBlock | 设置直播流粒度封禁 | 调用SetLiveStreamBlock设置直播流粒度封禁。 |
DescribeStreamLocationBlock | 查询直播流粒度封禁 | 调用DescribeStreamLocationBlock查询直播流粒度封禁信息。 |
直播时移
API | 标题 | API概述 |
---|---|---|
DescribeLiveShiftConfigs | 查询域名时移配置 | 调用DescribeLiveShiftConfigs查询指定域名的时移配置。 |
OpenLiveShift | 开启时移服务 | 调用OpenLiveShift为指定域名(应用、直播流)开启时移服务。 |
CloseLiveShift | 关闭时移服务 | 关闭指定域名(应用、直播流)的时移服务。 |
直播转码
API | 标题 | API概述 |
---|---|---|
AddLiveStreamTranscode | 添加转码配置信息 | 调用AddLiveStreamTranscode添加转码配置信息。 |
AddCustomLiveStreamTranscode | 添加自定义转码配置信息 | 调用AddCustomLiveStreamTranscode添加自定义转码配置信息。 |
AddRtsLiveStreamTranscode | 添加RTS自定义转码配置信息 | 调用AddRtsLiveStreamTranscode添加RTS自定义转码配置信息。 |
UpdateCustomLiveStreamTranscode | 更新自定义转码配置 | 更新自定义转码配置信息。 |
UpdateLiveStreamTranscode | 更新通用转码配置 | 更新通用转码配置信息。 |
UpdateRtsLiveStreamTranscode | 更新RTS自定义转码配置 | 更新RTS自定义转码配置信息。 |
DeleteLiveStreamTranscode | 删除转码配置 | 删除转码配置信息。 |
DescribeLiveStreamTranscodeInfo | 查询转码配置信息 | 查询转码配置信息。 |
AddTrancodeSEI | 添加转码 SEI 信息 | 添加转码SEI信息。 |
直播录制存储至VOD
API | 标题 | API概述 |
---|---|---|
AddLiveRecordVodConfig | 添加直播录制转点播配置 | 增加直播录制转点播配置,将录制内容保存到点播媒资库。 |
UpdateLiveRecordVodConfig | 更新直播录制转点播配置 | 更新直播录制转点播配置。 |
DeleteLiveRecordVodConfig | 删除直播录制转点播配置 | 删除直播录制转点播配置。 |
DescribeLiveRecordVodConfigs | 查询直播录制转点播配置 | 查询直播转点播配置列表。 |
直播录制存储至OSS
API | 标题 | API概述 |
---|---|---|
AddLiveAppRecordConfig | 添加录制配置 | 配置APP录制,输出内容保存到OSS中。 |
RealTimeRecordCommand | 实时录制指令 | 按需完成手动录制。例如动态启动录制、动态停止录制。 |
UpdateLiveAppRecordConfig | 更新直播录制 | 更新配置APP录制,输出内容保存到OSS中。 |
DeleteLiveAppRecordConfig | 解除录制配置 | 删除App级别录制配置。 |
DeleteLiveStreamRecordIndexFiles | 删除直播录制文件 | 删除直播录制文件。 |
DescribeLiveRecordConfig | 查询域名下所有App录制配置 | 查询直播域名下所有APP录制配置。 |
DescribeLiveStreamRecordContent | 查询直播流录制内容 | 查询直播录制内容。 |
CreateLiveStreamRecordIndexFiles | 创建录制索引文件 | 创建某个时间范围的M3U8索引文件。 |
DescribeLiveStreamRecordIndexFile | 查询单个录制索引文件 | 查询单个录制索引文件。 |
DescribeLiveStreamRecordIndexFiles | 查询某个时间段内的所有录制索引文件 | 查询某个时间段内的所有录制索引文件。 |
AddLiveRecordNotifyConfig | 添加域名级别录制回调配置 | 添加域名级别录制回调配置。 |
DeleteLiveRecordNotifyConfig | 删除直播录制回调配置 | 删除域名级别录制回调配置。 |
DescribeLiveRecordNotifyConfig | 查询域名级别录制回调配置 | 查询域名级别录制回调配置。 |
UpdateLiveRecordNotifyConfig | 更新域名级别录制回调配置 | 更新域名级别录制回调配置。 |
直播截图
API | 标题 | API概述 |
---|---|---|
AddLiveAppSnapshotConfig | 添加直播截图配置 | 配置截图信息。输出内容保存到OSS中,重新推流即生效。 |
DeleteLiveAppSnapshotConfig | 删除直播截图配置 | 解除直播流下AppName的截图配置,重新推流后生效。 |
DeleteSnapshotFiles | 删除直播截图文件 | 删除指定截图文件。 |
DescribeLiveSnapshotConfig | 查询域名下的截图配置 | 查询播流域名下的截图配置。 |
UpdateLiveAppSnapshotConfig | 更新直播截图配置 | 更新直播流下的截图配置。输出内容保存到OSS中,重新推流后生效。 |
DescribeLiveStreamSnapshotInfo | 查询一段时间内截图内容 | 查询某一段时间内截图内容。 |
DescribeLiveSnapshotNotifyConfig | 获取截图回调配置 | 获取截图回调配置。 |
DeleteLiveSnapshotNotifyConfig | 删除截图回调配置 | 删除截图回调配置。 |
AddLiveSnapshotNotifyConfig | 添加截图回调配置 | 添加截图回调配置。 |
UpdateLiveSnapshotNotifyConfig | 修改截图回调配置 | 修改截图回调配置。 |
SetSnapshotCallbackAuth | 设置截图回调鉴权配置 | 设置截图回调鉴权配置。 |
QuerySnapshotCallbackAuth | 查询截图回调鉴权配置 | 查询截图回调鉴权配置信息。 |
DeleteSnapshotCallbackAuth | 删除截图回调鉴权配置 | 删除截图回调鉴权配置。 |
直播封装
API | 标题 | API概述 |
---|---|---|
AddLivePackageConfig | 添加直播封装配置 | 调用AddLivePackageConfig添加直播封装配置。 |
UpdateLivePackageConfig | 更新直播封装配置 | 调用UpdateLivePackageConfig更新直播封装配置。 |
DescribeLivePackageConfig | 查询直播封装配置 | |
DeleteLivePackageConfig | 删除直播封装配置 |
直播审核
API | 标题 | API概述 |
---|---|---|
AddLiveSnapshotDetectPornConfig | 按照域名和App级别配置直播流审核服务 | 可按照域名和App级别配置播流审核服务。 |
AddLiveDetectNotifyConfig | 添加回调通知URL | 添加直播审核回调通知地址。 |
DescribeLiveSnapshotDetectPornConfig | 查询直播审核配置 | 查询直播审核配置。 |
DescribeLiveDetectNotifyConfig | 查询审核回调URL | 查询直播审核回调通知地址。 |
UpdateLiveSnapshotDetectPornConfig | 更新直播审核配置 | 更新直播审核配置。 |
UpdateLiveDetectNotifyConfig | 更新直播审核回调配置 | 更新直播审核回调通知地址。 |
DeleteLiveSnapshotDetectPornConfig | 删除直播审核配置 | 删除直播审核的配置。 |
DeleteLiveDetectNotifyConfig | 删除回调通知URL | 删除直播审核回调配置。 |
AddLiveAudioAuditConfig | 添加直播语音审核配置 | 添加直播语音审核配置信息。 |
AddLiveAudioAuditNotifyConfig | 添加音频审核回调信息 | 添加音频审核回调信息。 |
DeleteLiveAudioAuditConfig | 删除直播语音审核配置 | 删除直播语音审核配置信息。 |
DeleteLiveAudioAuditNotifyConfig | 删除直播语音审核回调配置 | 删除直播语音审核回调配置信息。 |
UpdateLiveAudioAuditNotifyConfig | 更新直播语音审核回调配置 | 更新直播语音审核回调配置信息。 |
UpdateLiveAudioAuditConfig | 更新直播语音审核配置 | 更新直播语音审核配置。 |
DescribeLiveAudioAuditConfig | 查询直播语音审核配置 | 查询直播语音审核配置。 |
DescribeLiveAudioAuditNotifyConfig | 查询直播语音审核回调配置 | 查询直播语音审核回调配置。 |
全球加速
API | 标题 | API概述 |
---|---|---|
CreateLivePrivateLine | 创建全球加速实例并绑定到直播链路 | 创建全球加速实例并绑定到直播链路。 |
DeleteLivePrivateLine | 删除全球加速实例和直播链路的绑定关系 | 解绑全球加速实例与直播链路。 |
DescribeLivePrivateLineAreas | 查询可选的全球加速链路起点 | 查询可选的全球加速链路起点。 |
DescribeLivePrivateLineAvailGA | 查询全球加速配置 | 查询全球加速实例和直播链路的绑定信息。 |
直播延迟
API | 标题 | API概述 |
---|---|---|
DescribeLiveStreamDelayConfig | 查询直播延迟时间 | 调用DescribeLiveStreamDelayConfig查询直播延迟时间。 |
SetLiveStreamDelayConfig | 配置直播延迟 | 调用SetLiveStreamDelayConfig配置直播延迟。 |
监控统计
API | 标题 | API概述 |
---|---|---|
DescribeLiveDomainBpsData | 查询域名网络带宽监控数据 | 调用DescribeLiveDomainBpsData查询直播域名的网络带宽监控数据。 |
DescribeLiveDomainTrafficData | 查询直播域名流量数据 | 查询直播域名网络流量监控数据。 |
DescribeLiveStreamTranscodeMetricData | 按流粒度查询视频流的转码用量 | 查询指定域名app及流粒度转码数据。 |
DescribeLiveCenterStreamRateData | 查询直播中心收录的流音视频帧率和码率 | 查询直播中心流的音视频帧率、码率。 |
DescribeLiveDomainBpsDataByLayer | 按协议分类查询域名带宽及流量数据 | 调用DescribeLiveDomainBpsDataByLayer按协议分类获取域名带宽及流量信息。 |
DescribeLiveDomainPushBpsData | 查询推流域名推流网络带宽监控数据 | 调用DescribeLiveDomainPushBpsData获取推流域名的推流网络带宽监控数据。 |
DescribeLiveDomainPushTrafficData | 查询推流域名推流流量监控数据 | 调用DescribeLiveDomainPushTrafficData获取推流域名推流流量监控数据。 |
DescribeLiveStreamPushMetricDetailData | 查询指定域名推流流粒度批量数据 | 查询指定域名推流app及流粒度数据。 |
DescribeLiveDomainPublishErrorCode | 查询域名推流状态码 | 查询推流域名下某个时间段内的推流状态码。 |
DescribeLiveUpVideoAudioInfo | 获取直播视频音频信息 | 查询一段时间内的流的上行推流的音视频参数。 |
DescribeLiveDomainRealTimeBpsData | 获取域名1分钟粒度带宽数据 | 调用DescribeLiveDomainRealTimeBpsData获取域名1分钟粒度带宽数据。 |
DescribeLiveDomainRealTimeTrafficData | 获取加速域名的1分钟流量监控数据 | 调用DescribeLiveDomainRealTimeTrafficData查询直播域名的实时流量监控数据。 |
DescribeLiveDomainRealTimeHttpCodeData | 查询直播域名实时HTTP返回码占比 | 获取加速域名1分钟粒度的HTTP返回码占比。 |
DescribeLiveStreamHistoryUserNum | 查询直播流历史在线人数 | 调用DescribeLiveStreamHistoryUserNum查询直播流历史在线人数。 |
DescribeLiveStreamCount | 查询在线直播流数量 | 获取直播流的实时在线原始流和转码流流数信息。 |
DescribeLiveStreamTranscodeStreamNum | 获取直播流转码流数量 | 调用DescribeLiveStreamTranscodeStreamNum实时查询转码流路数。 |
DescribeLiveDomainPvUvData | 查询直播域名PV/UV数据 | 调用DescribeLiveDomainPvUvData查询指定直播域名的PV、UV数据。 |
DescribeLiveTopDomainsByFlow | 获取流最多域名 | 调用DescribeLiveTopDomainsByFlow获取用户按流量排名的域名。 |
DescribeLiveStreamsTotalCount | 获取天粒度累计直播流路数 | 调用DescribeLiveStreamsTotalCount接口获取天粒度累计直播流路数。 |
DescribeLiveStreamMetricDetailData | 查询指定域名流粒度批量数据 | 调用DescribeLiveStreamMetricDetailData查询指定域名流粒度批量数据,单次查询最多返回5000行数据。 |
DescribeLiveStreamDetailFrameRateAndBitRateData | 查询RTMP协议直播流的详细音视频帧率码率 | 查询RTMP协议直播流的详细音视频帧率码率。 |
用量查询
API | 标题 | API概述 |
---|---|---|
DescribeLiveDomainRecordUsageData | 查询直播录制路数、转封装用量 | 调用DescribeLiveDomainRecordUsageData查询直播录制路数、转封装用量。 |
DescribeLiveDomainSnapshotData | 查询直播域名截图张数数据 | 调用DescribeLiveDomainSnapshotData查询直播域名截图张数。 |
DescribeLiveDetectPornData | 查询直播审核用量数据 | 调用DescribeLiveDetectPornData获取查询直播审核用量数据。 |
DescribeDomainUsageData | 查询域名在特定计费区域的用量数据 | 调用DescribeDomainUsageData查询域名在特定计费区域的用量数据。 |
DescribeLivePushProxyUsageData | 查询直播中心转推用量数据 | 调用DescribeLivePushProxyUsageData查询直播中心转推用量数据。 |
DescribeLiveRealtimeDeliveryAcc | 查询实时日志投递次数 | 调用DescribeLiveRealtimeDeliveryAcc查询实时日志投递次数。 |
DescribeLiveDomainTimeShiftData | 查询直播时移用量数据 | 调用DescribeLiveDomainTimeShiftData查询直播时移用量数据。 |
DescribeLiveDomainStreamTranscodeData | 查询域名转码用量数据 | 调用DescribeLiveDomainStreamTranscodeData查询域名转码用量数据。 |
DescribeLiveProducerUsageData | 查询导播台用量数据 | 调用DescribeLiveProducerUsageData查询导播台用量数据。 |
DescribeLiveDomainMonitoringUsageData | 获取域名广目监播用量 | 调用DescribeLiveDomainMonitoringUsageData获取域名广目监播用量数据。 |
DescribeLiveDelayedStreamingUsage | 查询延播时长数据 | 调用DescribeLiveDelayedStreamingUsage查询延播时长用量数据。 |
DescribeLiveGrtnDuration | 查询连麦通话时长用量数据 | 调用DescribeLiveGrtnDuration查询连麦通话时长用量数据。 |
DescribeMeterLiveBypassDuration | 查询混流转码用量数据 | DescribeMeterLiveBypassDuration |
DescribeLiveDrmUsageData | 获取直播DRM用量数据 |
云导播
API | 标题 | API概述 |
---|---|---|
导播台管理 | 导播台管理 | |
CreateCaster | 创建导播台 | 调用CreateCaster创建导播台。 |
SetCasterConfig | 设置导播台配置 | 配置导播台,全量覆盖配置信息,若指定参数置为空则清除导播台该项配置。 |
DescribeCasterConfig | 查询导播台配置 | 查询导播台配置信息。 |
DescribeCasters | 查询导播台列表 | 调用DescribeCasters查询导播台列表。 |
DescribeCasterStreamUrl | 查询导播台流信息列表 | 查询导播台流地址。 |
CopyCaster | 复制导播台 | 复制导播台,复制指定导播台并返回新导播台实例。 |
StartCaster | 启动导播台 | 启动导播台。若PVW、PGM场景不存在则创建,启动PVW、PGM场景,启动底层音视频处理任务。 |
StopCaster | 停止导播台 | 停止导播台。停止PVW(预览场景)、PGM(正式输出场景)场景。 |
DeleteCaster | 删除导播台 | 调用DeleteCaster删除导播台。 |
RestartCaster | 重启导播台 | 调用RestartCaster重启导播台。 |
输入源媒体管理 | 输入源媒体管理 | |
AddCasterVideoResource | 添加导播台视频资源 | 添加视频源,视频源数量受限于导播台输入路数。 |
DeleteCasterVideoResource | 删除导播台视频资源 | 删除视频资源。 |
ModifyCasterVideoResource | 修改导播台视频源 | 修改导播台视频资源。 |
DescribeCasterVideoResources | 查询导播台视频源 | 查询导播台视频源。 |
布局管理 | 布局管理 | |
AddCasterLayout | 添加导播台布局 | 添加导播台布局。 |
DeleteCasterLayout | 删除导播台布局数据 | 删除布局数据。 |
ModifyCasterLayout | 修改导播台布局 | 修改布局配置,传递修改项,非修改内容无需传递。 |
DescribeCasterLayouts | 查询导播台布局列表 | 查询导播台布局列表。 |
组件管理 | 组件管理 | |
AddCasterComponent | 添加导播台组件 | 调用AddCasterComponent添加导播台组件。 |
DeleteCasterComponent | 删除导播台组件 | 调用DeleteCasterComponent删除导播台组件。 |
ModifyCasterComponent | 修改导播台组件 | 调用ModifyCasterComponent修改导播台组件。 |
DescribeCasterComponents | 查询导播台组件列表 | 调用DescribeCasterComponents查询导播台组件列表。 |
场景与音频管理 | 场景与音频管理 | |
CopyCasterSceneConfig | 复制导播台场景配置 | 将原场景配置应用至目标场景并生效,仅限PVW场景配置拷贝至PGM场景。 |
DeleteCasterSceneConfig | 清除导播台的指定场景的配置信息 | 删除导播台场景配置。 |
UpdateCasterSceneConfig | 更新导播场景配置 | 增量设置场景配置,不清空原配置,布局信息在原场景上增量修改,效率较全量设置高。 |
SetCasterSceneConfig | 全量设置导播台场景配置 | 全量设置场景配置,清空场景配置,并将布局信息设置并生效至指定场景。 |
DescribeCasterScenes | 查询场景信息列表 | 查询导播台场景列表。 |
UpdateCasterSceneAudio | 更新场景音频配置 | 增加场景音频配置,将原场景音频添加到新场景。 |
DescribeCasterSceneAudio | 查询场景音频配置信息 | 查询场景音频配置。 |
StartCasterScene | 启动导播台场景 | 启动指定场景,限制仅用于PVW的打开。 |
StopCasterScene | 停止导播台场景 | 停止指定场景,限制仅用于停止PVW场景(预览场景)。 |
通道管理 | 通道管理 | |
SetCasterChannel | 设置导播台通道 | 设置导播台通道。 |
DescribeCasterChannels | 查询导播台通道信息列表 | 查询导播台通道。 |
备播管理 | 备播管理 | |
EffectCasterUrgent | 切换导播台备播 | 切换导播台备播。 |
EffectCasterVideoResource | 更新导播台备播片 | 更新导播台备播片。 |
新播单型导播台管理 | 新播单型导播台管理 | |
AddShowIntoShowList | 添加一个节目到节目单 | 添加节目到节目单中。 |
RemoveShowFromShowList | 删除节目单中的节目 | 删除节目单中的节目。 |
ModifyShowList | 修改播单属性 | 修改播单属性。 |
DescribeShowList | 节目单查询 | 查询节目单。 |
PlayChoosenShow | 手动切换节目 | 手动切换节目。 |
InitializeAutoShowListTask | 创建一个定时任务 | 创建一个定时任务。 |
DescribeAutoShowListTasks | 查询自动启停的定时任务 | 查询自动启停的定时任务。 |
EditShowAndReplace | 添加剪辑任务 | 添加剪辑任务。 |
GetEditingJobInfo | 查询剪辑任务 | 查询剪辑任务信息。 |
SetShowListBackground | 播单背景设置 | 进行播单背景设置。 |
虚拟演播厅管理 | 虚拟演播厅管理 | |
AddStudioLayout | 添加虚拟演播厅布局 | 添加虚拟演播厅的布局设置。 |
DeleteStudioLayout | 删除虚拟演播厅布局 | 删除虚拟演播厅的布局设置。 |
ModifyStudioLayout | 修改虚拟演播厅布局 | 修改虚拟演播厅布局。 |
DescribeStudioLayouts | 查询虚拟演播厅布局 | 获取虚拟演播厅布局设置。 |
(旧)播单型导播台 | (旧)播单型导播台 | |
AddCasterEpisode | 添加导播台节目 | 添加导播台节目。 |
DeleteCasterEpisode | 删除导播台节目 | 删除导播台节目。 |
ModifyCasterEpisode | 修改导播台节目配置,节目类型不允许修改 | 修改导播台节目配置,节目类型不允许修改。 |
AddCasterEpisodeGroup | 添加导播台节目列表 | 添加导播台节目列表。 |
DeleteCasterEpisodeGroup | 删除导播台节目列表 | 删除导播台节目列表。 |
AddCasterEpisodeGroupContent | 添加导播台节目列表 | 添加导播台节目列表信息。 |
AddCasterProgram | 添加导播台节目单 | 添加导播台节目单。 |
DescribeCasterProgram | 查询导播台节目单 | 查询导播台节目单。 |
ModifyCasterProgram | 修改导播台节目单 | 修改导播台节目单。 |
DeleteCasterProgram | 删除导播台节目单 | 删除导播台节目单。 |
AddPlaylistItems | 添加播放列表项 | 添加节目单项。 |
DeletePlaylistItems | 删除播放列表项目 | 删除节目单项。 |
ListPlaylistItems | 列出播放列表项 | 查询指定节目单下的节目单项。 |
EditPlaylist | 编辑播放列表 | 编辑节目单。 |
DeletePlaylist | 删除播放列表 | 删除整个节目单。 |
ListPlaylist | 获取播放列表 | 查询节目单。 |
StartPlaylist | 开始播放列表项 | 启动整个节目单。 |
StopPlaylist | 停止节目单 | 停止整个节目单。 |
云端合流
API | 标题 | API概述 |
---|---|---|
CreateMixStream | 创建合流任务 | 创建合流任务。 |
UpdateMixStream | 更新合流任务 | 更新合流任务。 |
DescribeMixStreamList | 查询合流任务列表 | 查询合流任务列表。 |
DeleteMixStream | 删除合流任务 | 删除合流任务。 |
CreateCustomTemplate | 创建合流自定义模板 | 创建合流自定义模板。 |
DeleteCustomTemplate | 删除合流自定义模板 | 删除合流自定义模板。 |
GetCustomTemplate | 获取自定义合流模板 | 获取合流自定义模板。 |
GetAllCustomTemplates | 获取全量自定义合流模板 | 获取全量自定义合流模板。 |
直播水印
API | 标题 | API概述 |
---|---|---|
AddLiveStreamWatermark | 添加⽔印模板 | 调用AddLiveStreamWatermark添加水印模板。 |
DeleteLiveStreamWatermark | 删除⽔印模板 | 调用DeleteLiveStreamWatermark删除指定⽔印模板。 |
UpdateLiveStreamWatermark | 更新水印模板 | 调用UpdateLiveStreamWatermark更新水印模板。 |
DynamicUpdateWaterMarkStreamRule | 动态更新水印 | 调用DynamicUpdateWaterMarkStreamRule动态更新水印。 |
DescribeLiveStreamWatermarks | 查询水印模板列表 | 调用DescribeLiveStreamWatermarks查询水印模板列表。 |
AddLiveStreamWatermarkRule | 添加水印规则 | 调用AddLiveStreamWatermarkRule添加水印规则。 |
DeleteLiveStreamWatermarkRule | 删除水印规则 | 调用DeleteLiveStreamWatermarkRule删除水印规则。 |
UpdateLiveStreamWatermarkRule | 更新水印规则 | 调用UpdateLiveStreamWatermarkRule更新水印规则。 |
DescribeLiveStreamWatermarkRules | 查询水印规则列表 | 调用DescribeLiveStreamWatermarkRules查询水印规则列表。 |
边缘转码
API | 标题 | API概述 |
---|---|---|
ListEdgeTranscodeTemplate | 查询边缘转码模板列表 | 查询边缘转码模板列表。 |
GetEdgeTranscodeTemplate | 查询边缘转码模板详情 | 查询边缘转码模板详情。 |
CreateEdgeTranscodeJob | 创建边缘转码任务 | 创建边缘转码任务。 |
DeleteEdgeTranscodeJob | 删除边缘转码任务 | 删除边缘转码任务。 |
ListEdgeTranscodeJob | 查询边缘转码任务列表 | 查询边缘转码任务列表。 |
GetEdgeTranscodeJob | 查询边缘转码任务详情 | 查询边缘转码任务详情。 |
UpdateEdgeTranscodeJob | 更新边缘转码任务 | 更新边缘转码任务。 |
StartEdgeTranscodeJob | 启动边缘转码任务 | 启动边缘转码任务。 |
StopEdgeTranscodeJob | 停止边缘转码任务 | 停止边缘转码任务。 |
直播日志
API | 标题 | API概述 |
---|---|---|
EnableLiveRealtimeLogDelivery | 开启域名实时日志投递 | 调用EnableLiveRealtimeLogDelivery开启域名实时日志投递。 |
DisableLiveRealtimeLogDelivery | 暂停域名实时日志投递 | 调用DisableLiveRealtimeLogDelivery暂停域名实时日志投递。 |
ModifyLiveRealtimeLogDelivery | 更改域名实时日志投递 | 调用ModifyLiveRealtimeLogDelivery更改域名实时日志投递。 |
CreateLiveRealTimeLogDelivery | 创建域名实时日志投递 | 调用CreateLiveRealTimeLogDelivery创建域名实时日志投递。 |
DeleteLiveRealtimeLogDelivery | 删除域名实时日志推送 | 调用DeleteLiveRealtimeLogDelivery删除域名实时日志推送。 |
DescribeLiveDomainRealtimeLogDelivery | 查询域名实时日志投递信息 | 调用DescribeLiveDomainRealtimeLogDelivery查询域名实时日志投递信息。 |
ListLiveRealtimeLogDelivery | 查询用户下所有实时日志投递 | 调用ListLiveRealtimeLogDelivery查询用户下所有实时日志投递。 |
ListLiveRealtimeLogDeliveryDomains | 查询实时日志投递服务下所有直播域名 | 调用ListLiveRealtimeLogDeliveryDomains查询实时日志投递服务下所有直播域名。 |
ListLiveRealtimeLogDeliveryInfos | 查询所有实时日志投递服务信息 | 调用ListLiveRealtimeLogDeliveryInfo查询所有实时日志投递服务信息。 |
DescribeLivePushProxyLog | 查询转推离线日志下载地址 | 通过DescribeLivePushProxyLog,获取直播转推离线日志下载地址。 |
DeleteLiveRealTimeLogLogstore | 删除实时日志推送的logstore | 调用DeleteLiveRealTimeLogLogstore删除实时日志推送的logstore。 |
DescribeLiveDomainLog | 日志下载 | 获取直播指定域名的原始访问日志的下载地址。 |
直播监播
API | 标题 | API概述 |
---|---|---|
CreateLiveStreamMonitor | 创建监播室 | 创建监播室。 |
UpdateLiveStreamMonitor | 更新监播室 | 更新监播室配置。 |
DescribeLiveStreamMonitorList | 查询监播室列表 | 查询已创建的监播室列表。 |
StartLiveStreamMonitor | 开启监播 | 开启监播。 |
StopLiveStreamMonitor | 停止监播 | 停止监播。 |
DeleteLiveStreamMonitor | 删除监播室 | 删除监播室。 |
互动消息(新)
API | 标题 | API概述 |
---|---|---|
CreateLiveMessageApp | 创建互动消息应用 | 调用CreateLiveMessageApp创建互动消息应用。 |
CreateLiveMessageGroup | 创建直播互动群组 | 调用CreateLiveMessageGroup创建互动消息群组。 |
DescribeLiveMessageGroup | 查询直播互动群组详细信息 | 查询直播互动群组详细信息。 |
ModifyLiveMessageGroup | 修改直播互动群组信息 | 调用ModifyLiveMessageGroup修改互动消息群组信息。 |
DeleteLiveMessageGroup | 删除直播互动群组 | 调用DeleteLiveMessageGroup删除互动消息群组。 |
ListLiveMessageGroups | 查询直播互动群组列表 | 调用ListLiveMessageGroups查询互动消息群组列表。 |
ListLiveMessageGroupByPage | 查询互动消息群组列表(支持翻页) | 查询互动消息群组列表,并支持翻页功能。 |
ModifyLiveMessageGroupBand | 修改用户禁言状态 | 修改用户禁言状态。 |
DescribeLiveMessageGroupBand | 查询用户禁言状态信息 | 调用DescribeLiveMessageGroupBand查询用户禁言状态信息。 |
CheckLiveMessageUsersOnline | 查询指定的用户是否在线 | 调用CheckLiveMessageUsersOnline查询指定的用户是否在线。 |
CheckLiveMessageUsersInGroup | 查询指定用户是否在群组中 | 调用CheckLiveMessageUsersInGroup查询指定用户是否在群组中。 |
ListLiveMessageGroupUsers | 查询群组用户列表 | 调用ListLiveMessageGroupUsers查询群组用户列表。 |
ListLiveMessageGroupMessages | 查询群组消息列表 | 调用ListLiveMessageGroupMessages查询群组消息列表。 |
UnbanLiveMessageGroup | 解除群组全员禁言 | 调用UnbanLiveMessageGroup新增禁言用户。 |
RecoverLiveMessageDeletedGroup | 恢复已删除的互动消息群组 | 调用RecoverLiveMessageDeletedGroup恢复已删除的互动消息群组。 |
BanLiveMessageGroup | 群组全员禁言 | 调用BanLiveMessageGroup新增禁言用户。 |
AddLiveMessageGroupBand | 新增禁言用户 | 调用AddLiveMessageGroupBand新增禁言用户。 |
RemoveLiveMessageGroupBand | 解除禁言用户 | 解除直播互动群组用户禁言 |
DeleteLiveMessageGroupMessage | 删除(撤回)某条群组消息 | 调用DeleteLiveMessageGroupMessage删除(撤回)某条群组消息。 |
DeleteLiveMessageUserMessage | 删除(撤回)某条单聊消息 | 调用DeleteLiveMessageUserMessage删除(撤回)某条单聊消息。 |
SendLiveMessageGroup | 发送消息到群组 | 发送消息到群组。 |
SendLiveMessageUser | 发送消息到用户 | 发送消息到用户。 |
ListLiveMessageApps | 查询直播互动应用列表 | 调用ListLiveMessageApps查询互动消息应用列表。 |
DescribeLiveMessageApp | 查询直播互动应用信息 | 调用DescribeLiveMessageApp查询互动消息应用信息。 |
ModifyLiveMessageAppDisable | 修改直播互动应用禁用信息 | 修改App禁用。 |
ModifyLiveMessageAppAudit | 修改直播互动应用鉴权信息 | 修改互动消息应用安全审核设置。 |
ModifyLiveMessageAppCallback | 修改直播互动应用回调信息 | 修改互动消息应用回调信息。 |
KickLiveMessageGroupUser | 将指定用户从群组中踢出去 | 踢出互动消息群组用户。 |
ModifyLiveMessageUserInfo | 修改用户信息 | 修改用户信息。 |
实时音视频
API | 标题 | API概述 |
---|---|---|
频道管理 | 频道管理 | |
DescribeChannelParticipants | 查询频道内在线用户列表 | 查询频道内在线用户列表。 |
DescribeChannelUsers | 查询频道内在线用户列表 | 查询频道内在线用户列表的详细信息。 |
RemoveTerminals | 从频道中踢出指定终端用户 | 从频道中踢出指定终端用户。 |
CreateRoomRealTimeStreamAddress | 创建RTMP流在房间中的推流地址 | 创建RTMP流在房间中的推流地址。 |
DeleteChannel | 删除频道 | 删除频道。 |
旁路转推 | 旁路转推 | |
StartLiveMPUTask | 创建混流转推任务(新) | 创建混流转推任务。 |
UpdateLiveMPUTask | 更新混流转推任务(新) | 更新混流转推任务。 |
StopLiveMPUTask | 停止混流转推任务(新) | 停止混流转推任务。 |
ListRtcMPUTaskDetail | 查询混流转推任务参数明细 | 查询混流转推任务参数明细。 |
SetLiveMpuTaskSei | 设置自定义SEI | 设置连麦旁路自定义sei。 |
事件回调 | 事件回调 | |
CreateEventSub | 创建订阅房间消息回调 | 创建订阅房间消息的回调。 |
ListEventSub | 查询订阅房间消息列表 | 查询订阅房间消息列表。 |
ListEventSubEvent | 查询回调记录 | 查询回调记录。 |
UpdateEventSub | 更新订阅房间消息回调 | 更新订阅房间消息回调。 |
DeleteEventSub | 删除订阅房间消息回调 | 删除订阅房间消息的回调。 |
CreateRtcMPUEventSub | 创建混流转推事件订阅 | 创建混流转推事件订阅。 |
UpdateRtcMPUEventSub | 更新混流转推事件订阅 | 更新混流转推事件订阅。 |
DeleteRtcMPUEventSub | 删除混流转推事件订阅 | 删除混流转推事件订阅。 |
DescribeRtcMPUEventSub | 查询混流转推事件订阅 | 查询混流转推事件订阅。 |
ListRtcMPUEventSubRecord | 查询混流转推事件订阅记录 | 查询混流转推事件订阅记录。 |
质量数据 | 质量数据 | |
DescribeLiveInteractionMetricData | 查询实时音视频指标数据 | 调用DescribeLiveInteractionMetricData查询实时音视频指标数据。 |
实时语音转文字/翻译 | 实时语音转文字/翻译 | |
CreateRtcAsrTask | 创建实时语音转文字或翻译 | 创建一个新的实时字幕任务,用于实时转录音频流为文本。 |
QueryRtcAsrTasks | 查询实时语音转文字或翻译 | 查询当前已创建的实时语音转文字或翻译任务的状态信息。 |
StopRtcAsrTask | 停止实时语音转文字或翻译 | 调用StopRtcAsrTask停止实时字幕任务。 |
DeleteRtcAsrTask | 删除实时语音转文字或翻译任务 | 调用DeleteRtcAsrTask删除实时语音转文字或翻译任务。 |
高级功能
API | 标题 | API概述 |
---|---|---|
触发规则配置 | 触发规则配置 | |
DeleteLiveAIProduceRules | 删除字幕规则 | 删除字幕规则。 |
DescribeLiveAIProduceRules | 查询字幕规则 | 查询字幕规则列表。 |
UpdateLiveAIProduceRules | 更新实时字幕规则 | 更新字幕规则。 |
AddLiveAIProduceRules | 添加实时字幕规则 | 添加字幕规则。 |
AI模板配置 | AI模板配置 | |
DeleteLiveAISubtitle | 删除字幕模板 | 调用DeleteLiveAISubtitle删除指定字幕模板。 |
DescribeLiveAISubtitle | 查询字幕模板 | 调用DescribeLiveAISubtitle查询字幕模板列表。 |
UpdateLiveAISubtitle | 更新字幕模板 | 调用UpdateLiveAISubtitle更新字幕模板。 |
AddLiveAISubtitle | 添加直播字幕模板 | 调用AddLiveAISubtitle添加字幕模板。 |
工具箱
API | 标题 | API概述 |
---|---|---|
DescribeLiveIpInfo | 获取直播IP信息 | 调用DescribeLiveIpInfo验证指定IP是否为CDN节点的IP地址。 |
DescribeLiveStreamAuthChecking | 查询流鉴权 | 查询当前在线流的鉴权。 |