调用方式--视频直播-火山引擎

文档中心

简体

文档备案控制台

登录立即注册

视频直播

视频直播

视频直播

文档指南

请输入

产品动态

功能发布历史

产品公告

关于时移录制功能开始收取录制费用的公告

关于安全管理相关的服务端 API 接口升级公告

关于截图配置相关的服务端 API 接口升级公告

关于服务端 API 接口升级至 2023-01-01 版本的公告

关于视频直播服务更新离线日志格式的公告

关于视频直播欠费关停规则更新的公告

关于视频直播部分计费项调整的公告

产品简介

产品计费

直播服务费

标准直播计费

超低延时直播计费

增值服务费

拉流转推计费

活动带宽计费

云导播计费

画质测评计费

声影同传计费

预付费资源包

直播 SDK 费用

其他云产品费用

修改计费配置

控制台指南

超低延时直播

超低延时直播介绍

超低延时直播 Demo 体验

超低延时直播技术白皮书

视频媒体特性

音频媒体特性

媒体安全特性

媒体传输保活机制

媒体传输结束处理

超低延时直播 Web 端接入规范

控制台介绍

域名管理

校验域名归属

域名配置

修改域名的加速区域

修改拉流域名和推流域名的关联关系

配置 HTTPS 安全加密

访问控制

访问控制概述

配置 URL 鉴权

配置 IP 黑白名单

配置 Referer 黑白名单

配置 HTTP 响应头

配置 HTTP 请求头

配置拉流带宽限额

配置推流路数限额

配置云监控

功能配置

直播管理

应用管理

创建或绑定应用

加密管理

HLS 标准加密

数据中心

流数据查询

SDK 数据查询

直播工具

地址生成器

IP 归属查询

客户端 SDK

客户端 SDK 简介

发布历史

Android 推拉流 SDK 发布历史

iOS 推拉流 SDK 发布历史

HarmonyOS NEXT 拉流 SDK 发布历史

React Native 推拉流 SDK 发布历史

Flutter 拉流 SDK 发布历史

uni-app 拉流 SDK 发布历史

升级指南

iOS 动态库升级指南

跑通 Demo

SDK 准备

集成 SDK

初始化 SDK

推流 SDK

Android

更多功能

SDK API 参考

iOS

更多功能

SDK API 参考

React Native

SDK API 参考

拉流 SDK

Android

SDK API 参考

iOS

SDK API 参考

React Native

SDK API 参考

HarmonyOS NEXT

Flutter

uni-app

SDK API 参考

互动直播

Web SDK

Web 拉流 SDK

功能集成

FLV 协议拉流

RTM 协议拉流

LL-HLS 协议拉流

自适应码率（ABR）拉流

拉流事件监听

DRM 加密流播放

多线路和多清晰度切换

视频流过期处理

播放日志上报

SEI 消息监听

自适应缓冲策略减少 RTM 流延迟和卡顿

SDK API

方法及属性

Web 推流 SDK

SDK API

方法及属性

小程序 SDK

拉流 SDK

服务类目和资质要求

集成指南

NPM 方式集成小程序 SDK

插件方式集成小程序 SDK

SDK API

微信小程序直播拉流 UI 实现最佳实践

API 参考

API 发布历史

使用 API Explorer

调用方式

公共错误码

域名管理

CreateDomain - 添加域名

CreateDomainV2 - 批量添加域名

UpdateDomainVhost - 更新域名的域名空间

DeleteDomain - 删除域名

DisableDomain - 禁用域名

EnableDomain - 启用域名

DescribeDomain - 查询域名信息

ListDomainDetail - 查询域名列表

证书管理

CreateCert - 添加或更新证书

DeleteCert - 删除证书

BindCert - 绑定证书

UnbindCert - 解绑证书

DescribeCertDetailSecretV2 - 查看证书详情

ListCertV2 - 查询证书列表

加密管理

UpdateEncryptDRM - 更新 DRM 证书管理平台访问密钥和 FairPlay 证书

DescribeEncryptDRM - 查看 DRM 证书管理平台访问密钥和 FairPlay 证书

BindEncryptDRM - 添加或更新加密配置

ListBindEncryptDRM - 查询加密配置

UnBindEncryptDRM - 删除加密配置

DescribeLicenseDRM - 获取 DRM 授权许可文件

DescribeCertDRM - 获取 FairPlay 证书文件

UpdateEncryptHLS - 更新 HLS 密钥获取配置

DescribeEncryptHLS - 查询 HLS 密钥获取配置

GetHLSEncryptDataKey - 查询 HLS 加密密钥

Header 配置

UpdateHTTPHeaderConfig - 添加或更新 HTTP header 配置

DescribeHTTPHeaderConfig - 查询 HTTP Header 配置

EnableHTTPHeaderConfig - 启用或禁用 HTTP Header 配置

DeleteHTTPHeaderConfig - 删除 HTTP Header 配置

安全管理

UpdateAuthKey - 添加或更新推拉流鉴权

DescribeAuth - 查询推拉流鉴权

UpdateReferer - 添加或更新 Referer 黑白名单

DescribeReferer - 查询 Referer 黑白名单

DeleteReferer - 删除 Referer 黑白名单

UpdateIPAccessRule - 创建或更新 IP 访问限制

DescribeIPAccessRule - 查询 IP 访问限制

DeleteIPAccessRule - 删除 IP 访问限制

限额管理

UpdateStreamQuotaConfig - 添加或更新推拉流限额配置

DescribeStreamQuotaConfig - 查询推拉流限额配置

DeleteStreamQuotaConfig - 删除推拉流限额配置

直播地址

GeneratePushURL - 生成推流地址

GeneratePlayURL - 生成拉流地址

流管理

DescribeLiveStreamInfoByPage - 查询在线流列表

DescribeClosedStreamInfoByPage - 查询历史流列表

DescribeForbiddenStreamInfoByPage - 查询禁推流列表

KillStream - 断开直播流

ForbidStream - 禁推直播流

ResumeStream - 解禁直播流

DescribeLiveStreamState - 查询流状态

转码配置

CreateTranscodePreset - 添加转码配置

DeleteTranscodePreset - 删除转码配置

UpdateTranscodePreset - 更新转码配置

ListCommonTransPresetDetail - 查询内置转码档位的详细配置

ListVhostTransCodePreset - 查询转码配置列表

TranscodingJobStatus - 查询转码任务

RestartTranscodingJob - 重启转码任务

录制配置

CreateRecordPresetV2 - 添加录制配置

DeleteRecordPreset - 删除录制配置

UpdateRecordPresetV2 - 更新录制配置

ListVhostRecordPresetV2 - 查询录制配置列表

CreatePullRecordTask - 创建直播录制任务

StopPullRecordTask - 停止直播录制任务

ListPullRecordTask - 查询直播录制任务

DescribeRecordTaskFileHistory - 查询录制历史详情

GetPullRecordTask - 查询单个直播录制任务

CreateLiveStreamRecordIndexFiles - 创建录制索引文件

截图配置

CreateSnapshotPresetV2 - 添加截图配置

UpdateSnapshotPresetV2 - 更新截图配置

ListVhostSnapshotPresetV2 - 查询截图配置列表

DeleteSnapshotPreset - 删除截图配置

DescribeCDNSnapshotHistory - 查询截图历史详情

截图审核

CreateSnapshotAuditPreset - 添加截图审核配置

DeleteSnapshotAuditPreset - 删除截图审核配置

UpdateSnapshotAuditPreset - 更新截图审核配置

ListVhostSnapshotAuditPreset -查询截图审核配置列表

拉流回源

UpdateRelaySourceV3 - 添加或更新播放触发回源配置

DeleteRelaySourceV3 - 删除播放触发回源配置

DescribeRelaySourceV3 - 查询播放触发回源配置

CreateRelaySourceV4 - 添加固定回源配置

DeleteRelaySourceV4 - 删除固定回源配置

UpdateRelaySourceV4 - 更新固定回源配置

ListRelaySourceV4 - 查询固定回源配置列表

直播时移

CreateTimeShiftPresetV3 - 添加直播时移配置

DeleteTimeShiftPresetV3 - 删除直播时移配置

UpdateTimeShiftPresetV3 - 更新直播时移配置

ListTimeShiftPresetV2 - 查询直播时移配置列表

直播水印

CreateWatermarkPreset - 添加水印配置

DeleteWatermarkPreset - 删除水印配置

UpdateWatermarkPreset - 更新水印配置

ListWatermarkPreset - 查询水印配置

ListVhostWatermarkPreset - 查询水印配置列表

CreateWatermarkPresetV2 - 添加水印模板

UpdateWatermarkPresetV2 - 更新水印模板

DeleteWatermarkPresetV2 - 删除水印模板

ListWatermarkPresetDetail - 查询水印模版列表

字幕配置

CreateSubtitleTranscodePreset - 添加字幕配置

ListVhostSubtitleTranscodePreset - 查询字幕配置列表

UpdateSubtitleTranscodePreset - 更新字幕配置

DeleteSubtitleTranscodePreset - 删除字幕配置

拉流转推

CreatePullToPushTask - 创建拉流转推任务

DeletePullToPushTask - 删除拉流转推任务

UpdatePullToPushTask - 更新拉流转推任务

StopPullToPushTask - 停用拉流转推任务

ListPullToPushTaskV2- 获取拉流转推任务列表

CreatePullToPushGroup - 创建拉流转推群组

UpdatePullToPushGroup - 更新拉流转推群组

DeletePullToPushGroup - 删除拉流转推群组

ListPullToPushGroup - 查询拉流转推群组列表

ContinuePullToPushTask - 启用拉流转推任务

RelaunchPullToPushTask - 重启拉流转推任务

直播垫片

CreateLivePadPreset - 创建直播垫片配置

DescribeLivePadPresetDetail - 查询直播垫片配置列表

UpdateLivePadPreset - 更新直播垫片配置

DeleteLivePadPreset - 删除直播垫片配置

DescribeLivePadStreamList - 查询正在播放垫片的直播流

StopLivePadStream - 断开正在播放垫片的直播流

画质测评

CreateLiveVideoQualityAnalysisTask - 创建画质评测任务

ListLiveVideoQualityAnalysisTasks - 查询画质评测任务列表

GetLiveVideoQualityAnalysisTaskDetail - 查询单个画质测评任务详情

DeleteLiveVideoQualityAnalysisTask - 删除画质测评任务

云端混流

CreateCloudMixTask - 创建云端混流任务

DeleteCloudMixTask - 结束云端混流任务

UpdateCloudMixTask - 更新云端混流任务

ListCloudMixTask - 查看云端混流任务列表

GetCloudMixTaskDetail - 查看云端混流任务

高光智剪

CreateHighLightTask - 创建高光剪辑任务

DeleteTaskByAccountID - 删除高光剪辑任务

DescribeHighLightTaskByAccountID - 查询高光剪辑任务详情

ListHighLightTask - 查询高光剪辑任务列表

高光剪辑回调消息说明

通用轮播

CreateCarouselTask - 创建轮播任务

DeleteCarouselTask - 删除轮播任务

UpdateCarouselTask - 更新轮播任务

GetCarouselDetail - 查询轮播任务

ListCarouselTask - 查询轮播任务列表

用量查询

DescribeLiveBandwidthData - 查询直播域名带宽用量

DescribeLiveTrafficData - 查询直播域名流量用量

DescribeLiveRecordData - 查询直播域名录制用量

DescribeLiveTranscodeData - 查询直播域名转码用量

DescribeLiveSnapshotData - 查询直播域名截图张数

DescribeLiveAuditData - 查询截图审核用量

DescribeLivePullToPushData - 查询拉流转推时长用量

DescribeLiveTimeShiftData - 查询直播时移存储用量

DescribeLiveP95PeakBandwidthData - 查询 95 带宽峰值

DescribeLivePullToPushBandwidthData - 查询拉流转推带宽用量

日志管理

DescribeLiveLogData - 查询日志文件信息

统计分析

DescribeLiveRegionData - 查询区域标识符

DescribeLiveISPData - 查询运营商标识符

DescribeLivePushStreamMetrics - 查询单路推流监控数据

DescribeLiveBatchPushStreamMetrics - 查询多路推流监控数据

DescribeLiveSourceStreamMetrics - 查询单路回源流监控数据

DescribeLiveBatchSourceStreamMetrics - 查询多路回源流监控数据

DescribeLiveStreamSessionData - 查询域名或单个直播流的拉流数据

DescribeLiveBatchStreamTrafficData - 查询直播流的流量数据

DescribeLiveSourceTrafficData - 查询直播流或域名的回源流量监控数据

DescribeLiveBatchStreamTranscodeData - 查询直播流的转码数据

DescribeLivePlayStatusCodeData - 查询域名状态码占比

DescribeIpInfo - 查询 IP 地址归属的 CDN 节点

DescribeLiveStreamCountData - 查询峰值流数

DescribeLivePushStreamInfoData - 查询推流流信息

DescribeLiveTranscodeInfoData - 查询直播域名转码数据明细

DescribeLiveTopPlayData - 查询 TOPN 直播流或域名的流量和带宽信息

DescribeLiveEdgeStatData - 查询边缘数据

回调管理

UpdateCallback - 添加或更新回调配置

DeleteCallback - 删除回调配置

DescribeCallback - 查询回调配置

DescribeLiveCallbackData - 查询回调记录

回调内容说明

历史版本

统计分析

DescribeLivePushStreamCountData - 查询推流峰值流数

DescribeLiveSourceBandwidthData - 查询直播流或域名的回源带宽监控数据

DescribeLiveBatchSourceStreamAvgMetrics - 查询多路回源流监控数据平均值

DescribeLiveMetricTrafficData - 查询直播流或域名的流量监控数据

DescribeLiveMetricBandwidthData - 查询直播流或域名的带宽监控数据

拉流转推

RestartPullToPushTask - 启用拉流转推任务

声影同传

CreateSpeechTask - 创建声影同传任务

SearchSpeechTask - 搜索声影同传任务

GetSpeechTask - 查询声影同传任务

UpdateSpeechTask - 更新声影同传任务

DeleteSpeechTask - 删除声影同传任务

RestartSpeechTask - 重启声影同传任务

GetSpeechConfig - 获取声影同传配置

服务端 SDK

服务端 SDK 简介

Java SDK

安装及初始化

Golang SDK

安装及初始化

Python SDK

安装及初始化

PHP SDK

安装及初始化

最佳实践

直播视频录制到点播

直播视频截图到 veImageX

使用 OBS 推流

RTMPS 协议推流

SRT 协议推流

QUIC 协议直播

生成直播地址最佳实践

纯音频或纯视频直播

H.265 全链路方案

使用 IAM 用户进行项目权限划分

使用 Web 拉流 SDK 进行低延迟 FLV 直播

直播 DRM 加密

常见问题

常见问题列表

功能咨询问题

计费购买问题

域名管理问题

客户端 SDK 问题

相关协议

视频云服务专用条款

视频直播服务等级协议（SLA）

视频直播 SDK 开发者使用合规规范

视频直播 SDK 隐私政策

视频直播 SDK 扩展功能说明目录

veLive（应用）免责声明

veLive（应用）服务协议

veLive（应用）隐私政策

文档首页

视频直播

API 参考

调用方式

API 参考

调用方式

请求结构
公共参数
签名方法
返回结构
公共错误码