You need to enable JavaScript to run this app.
实时音视频

实时音视频

请输入
  • 文档首页
    • 实时音视频实时音视频产品动态发版说明服务端 OpenAPI
复制全文
我的收藏
发版说明
服务端 OpenAPI
复制全文
我的收藏
服务端 OpenAPI

2025 年

  • 2025 年 8 月
    功能接口版本变更说明发布时间
    输入在线媒体流2023-11-01新增支持将在线媒体流推送至 WTN 网络，对应字段 WtnStreamId。功能详细说明，请参见输入在线媒体流。2025-08-14
  • 2025 年 4 月
    功能接口版本变更说明发布时间
    房间管理回调2023-11-01UserLeaveRoom和 InvisibleUserLeaveRoom 回调中增加在房时长信息。2025-04-11
    输入在线媒体流2023-11-01新增：
    • 支持点播流暂停和恢复播放，具体参数参看StreamControl.IsPause。
    • 支持点播数据流回调播放进度信息，具体参数参看StreamControl.DataStreamOptions。
    • 播放点播流情况下调用更新接口，若 StreamUrl 和 StreamMode均未修改，则点播流继续播放，不会从头开始播放。
    		2025-04-10
  • 2025 年 3 月
    功能接口版本变更说明发布时间
    房间管理2023-11-01BanRoomUser 新增 IP 参数，支持封禁指定 IP 地址的所有用户。2025-03-24

2024 年

  • 2024 年 12 月
    功能接口版本变更说明发布时间
    实时字幕（新增）2023-11-01新增实时字幕功能，可将房间内指定用户的说话内容生成字幕。2024-12-27
    云端录制2023-11-01云端录制支持录制最高 4k 分辨率视频。2024-12-18
  • 2024 年 11 月
    功能接口版本变更说明发布时间
    获取数据指标2023-11-01新增获取实时公共流订阅数据，你可以使用该接口查询一段时间内某个应用的公共流订阅数据。2024-11-29
    云端录制2023-11-01第三方云存储平台鉴权方式，新增临时访问凭证（SecurityToken）鉴权，以增强系统的安全性。详细说明，请参看StartRecord。2024-11-27
  • 2024 年 8 月
    功能接口版本变更说明发布时间
    服务地址-RTC OpenAPI 新增亚太东南（柔佛）服务接入地址：open-ap-singapore-1.volcengineapi.com2024-08-27
    云端录制2023-11-01
    • 新增参数 MaxSilenceSeconds，控制单流录制任务最大中断时间，实现任务仅暂停不停止。
    • 支持设置音频相关参数。
    		2024-08-26
    云端录制2023-11-01
  • 2024 年 6 月
    功能接口版本变更说明发布时间
    房间管理2023-11-01
    2020-12-01    		更新回调，参见下表。2024-08-27

更新的回调如下：

更新回调描述
可见用户进入房间废弃UserExtraInfo 参数，请使用 ExtraInfo代替。
不可见用户进入房间废弃UserExtraInfo 参数，请使用 ExtraInfo代替。
可见用户退房新增ExtraInfo参数，回调 RTC 服务端传出的用户附加信息和客户端 SDK 通过 joinRoom 传入的用户附加信息。
不可见用户退房新增ExtraInfo参数，回调 RTC 服务端传出的用户附加信息和客户端 SDK 通过 joinRoom 传入的用户附加信息。
音频流开始推送新增ExtraInfo参数，回调 RTC 服务端传出的用户附加信息和客户端 SDK 通过 joinRoom 传入的用户附加信息。
音频流结束推送新增ExtraInfo参数，回调 RTC 服务端传出的用户附加信息和客户端 SDK 通过 joinRoom 传入的用户附加信息。
视频流开始推送新增ExtraInfo参数，回调 RTC 服务端传出的用户附加信息和客户端 SDK 通过 joinRoom 传入的用户附加信息。
视频流结束推送新增ExtraInfo参数，回调 RTC 服务端传出的用户附加信息和客户端 SDK 通过 joinRoom 传入的用户附加信息。
屏幕音频流开始推送新增ExtraInfo参数，回调 RTC 服务端传出的用户附加信息和客户端 SDK 通过 joinRoom 传入的用户附加信息。
屏幕音频流结束推送新增ExtraInfo参数，回调 RTC 服务端传出的用户附加信息和客户端 SDK 通过 joinRoom 传入的用户附加信息。
屏幕视频流开始推送新增ExtraInfo参数，回调 RTC 服务端传出的用户附加信息和客户端 SDK 通过 joinRoom 传入的用户附加信息。
屏幕视频流结束推送新增ExtraInfo参数，回调 RTC 服务端传出的用户附加信息和客户端 SDK 通过 joinRoom 传入的用户附加信息。
用户身份切换（不可见 -> 可见）新增ExtraInfo参数，回调 RTC 服务端传出的用户附加信息和客户端 SDK 通过 joinRoom 传入的用户附加信息。
用户身份切换（可见 -> 不可见）新增ExtraInfo参数，回调 RTC 服务端传出的用户附加信息和客户端 SDK 通过 joinRoom 传入的用户附加信息。
  • 2024 年 3 月
    功能接口版本变更说明发布时间
    互动白板2020-12-01
    2023-11-01    		新增回调：2024-03-28
    应用管理2023-11-01新增接口 ModifyAppStatus，用于控制指定应用的启用/停用状态。2024-03-26
    云端录制2023-11-01
    2023-06-01
    2022-06-01
    2020-12-01    		存储方式选择 VOD 时，新增海外存储 Region：ap-southeast-1。2024-03-11
  • 2024 年 2 月
    功能接口版本变更说明发布时间
    获取数据指标2023-11-01新增版本 2023-11-01，该版本： 2024-02-27

  • 2024 年 1 月

    功能接口版本变更说明发布时间
    云端录制2023-11-01
    • StartRecord 接口新增 StorageClass 请求参数，上传到视频点播平台时, 支持选择文件的存储类型。
    • StartRecord 接口新增 AutoSetFileExtension 请求参数，上传到视频点播平台时, 可以选择是否需要根据文件后缀自动设置 FileExtension。
    		2024-01-11
    音视频内容安全2023-11-01新增版本 2023-11-01，该版本：
    • 当 HTTP 响应状态码 !=200 时，表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaData 的 Code 和 Message 字段解析错误原因。
    • 当 HTTP 响应状态码 ==200 时，表示调用成功。
    • 若任务运行中，重复调用开始接口进行相同审核操作，如指定相同用户或指定重复审核类型，不会导致请求失败，BaseResponse.Result 会提示 The task has been started. Please do not call the startup task interface repeatedly。
    • 新增以下接口：
      • StartDetection：对用户通过 RTC 发送的视频、音频内容进行审核。
      • StopDetection：关闭审核任务。
      • ListDetectionTask：查询指定用户的审核状态。
      • 错误码变更：InternalError.Parallel 变更为 InternalError.Redis。
    		2024-01-06
    房间管理2023-11-01新增 2023-11-01 版本。
    版本说明、新增接口信息，参见下方的房间管理 。    		2024-01-05
    云端媒体处理2023-11-01新增 2023-11-01 版本。
    版本说明、新增接口信息，参见下方的云端媒体处理。    		2024-01-05
    公共流2023-11-01新增 2023-11-01 版本。
    版本说明、新增接口信息，参见下方的公共流。    		2024-01-05


    1. 房间管理 2023-11-01

    • 版本特性
      • 当 HTTP 响应状态码 !=200 时，表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaData 的 Code 和 Message 字段解析错误原因。
      • 当 HTTP 响应状态码 ==200 时，表示调用成功。
    • 新增接口
      新增接口接口描述
      BanRoomUser封禁房间&用户。可解散整个房间或移除指定用户。
      UpdateBanRoomUserRule更新房间&用户封禁规则。可对封禁时长进行更新。
      BanUserStream封禁房间内某个用户的音/视频流。
      UnbanUserStream解封房间内某个用户的音/视频流。
      GetRoomOnlineUsers获取指定房间的实时用户列表。
      LimitTokenPrivilege限制某个用户指定 Token 的发布权限。
      • 错误码变更
        • InternalError.UnmarshalFail 变更为 InternalError.Unmarshal。
        • InternalError.RPCError 变更为 InternalError.RPC。
        • UnknownUser错误码废弃，不再返回错误，BaseResponse.Result 会提示 User is not found.
        • 调用 BanRoomUser 时，若用户已被封禁，不再返回错误，BaseResponse.Result 会提示 User has been banned.
        • 调用 BanRoomUser 时，若房间已被封禁，不再返回错误，BaseResponse.Result 会提示 Room has been banned.
        • 调用 BanRoomUser 时，若房间未找到，不再返回错误，BaseResponse.Result 会提示 Room is not found.
        • 调用 BanRoomUser 时，若用户已被封禁，不再返回错误，BaseResponse.Result 会提示 Room has been banned.
        • 调用 UpdateBanRoomUserRule 时，若房间未被封禁，不再返回错误，BaseResponse.Result 会提示 Room is not banned.
        • 调用 UpdateBanRoomUserRule 时，若用户未被封禁，不再返回错误，BaseResponse.Result 会提示 User is not banned.
        • 新增 MissingParameter.NoRoomId 错误码。
        • 新增 MissingParameter.NoUserId 错误码。
        • 新增 MissingParameter.NoToken 错误码。
        • 新增 MissingParameter.NoAppId 错误码。
        • 新增 InvalidParameter.Forbidden 错误码。


    2. 云端媒体处理 2023-11-01

    • 版本特性
      • 该版本下云端媒体处理接口：
        • 当 HTTP 响应状态码 !=200 时，表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaData 的 Code 和 Message 字段解析错误原因。
        • 当 HTTP 响应状态码 ==200 时，表示调用成功。
      • 若任务运行中，使用相同的 TaskId 重复调用开始接口不会导致请求失败，BaseResponse.Result 会提示 The task has been started. Please do not call the startup task interface repeatedly。
      • 移除填写参数值不合法时自动调整为默认值逻辑。
      • 调用UpdatePushMixedStreamToCDN 或 UpdateRecord时，若查不到正在运行的任务，会返回InvalidParameter.ErrorActiveTaskNotFound 错误。
    • 接口变更
      新增接口接口描述
      StartRecord录制房间内音视频通话，生成音视频文件。
      StopRecord停止云端录制任务。
      UpdateRecord更新云端录制任务部分参数。
      GetRecordTask查询指定录制任务的相关信息。
      StartPushMixedStreamToCDN将其中的多路音视频流合为一路，并将合并得到的音视频流通过 RTMP 协议推送到指定的推流地址。
      StartPushSingleStreamToCDN将一路流通过 RTMP 协议推送到指定的 CDN 推流地址。
      UpdatePushMixedStreamToCDN更新合流转推任务的部分参数。
      StopPushStreamToCDN结束合流转推任务。
      GetPushSingleStreamToCDNTask查询指定单流转推任务的相关信息。
      GetPushMixedStreamToCDNTask查询指定合流转推任务的相关信息。
      StartSegment对房间中的音频流进行切片，供后续处理。
      UpdateSegment更新音频切片任务的部分参数。
      StopSegment结束音频切片任务。
      GetSegmentTask查询指定音频切片任务的相关信息。
      StartSnapshot对房间内的实时音视频互动按一定时间间隔进行截图。
      UpdateSnapshot更新抽帧截图任务的部分参数。
      StopSnapshot关闭已启动的抽帧截图任务。
      GetSnapshotTask查询指定抽帧截图任务的相关信息。
      StartRelayStream将在线媒体流输入到 RTC 房间中，供频道内的远端用户欣赏。
      UpdateRelayStream更新在线媒体流任务的部分参数。
      StopRelayStream停止在线媒体流任务。
      ListRelayStream查询指定 AppId 下指定房间内所有输入的媒体流任务。
      StartWebCast将指定页面的音视频流转推到 RTC 房间供房间内用户观看。
      StopWebCast停止已启动的云录屏任务。
      GetWebCastTask查询指定云录屏任务的相关信息


    3. 公共流 2023-11-01

    • 版本特性
      • 该版本下公共流接口：
        • 当 HTTP 响应状态码 !=200 时，表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaData 的 Code 和 Message 字段解析错误原因。
        • 当 HTTP 响应状态码 ==200 时，表示调用成功。
      • 移除填写参数值不合法时自动调整为默认值逻辑。
    • 接口变更
      新增接口接口描述
      StartPushPublicStream将指定音视频房间内的单路或多路音视频流，使用指定的布局方式，进行发布。
      UpdatePublicStreamParam更新公共流任务部分参数。
      StopPushPublicStream停止发布公共流。

2023 年

  • 2023 年 12 月
    功能接口版本变更说明发布时间
    获取数据指标2023-11-01新增接口： 2023-12-27
    应用管理2023-11-01
    • 新增接口：
    • 2023-11-01 版本下 OpenAPI 返回结构进行如下优化：
      • 当 HTTP 响应状态码 !=200 时，表示调用失败。你可以根据返回结构中 BaseResponse.ResponseMetaData 的 Code 和 Message 字段解析错误原因。
      • 当 HTTP 响应状态码 ==200 时，表示调用成功。
    		2023-12-27
  • 2023 年 11 月
    功能接口版本变更说明发布时间
    输入在线媒体流2020-12-01流处理模式为转封装时，新增支持原视频编码方式为 ByteVC1。2023-11-13
    获取数据指标2020-12-01废弃 GetUserStreamState 接口，请使用音视频流状态变化相关回调来获取用户的实时推流状态。2023-11-08
    房间管理2020-12-012023-11-07
    实时消息通信2023-07-20新增以下接口：
    • SendUnicast：向指定的一个应用客户端发送房间外点对点消息。
    • SendRoomUnicast：向指定 RTC 房间内指定的一个应用客户端发送消息。
    • SendBroadcast：向指定一个 RTC 房间内的所有用户广播消息。
    • BatchSendRoomUnicast：向指定 RTC 房间内的批量用户发送点对点消息。
    		2023-11-01
  • 2023 年 10 月
    功能接口版本变更说明发布时间
    转推直播2023-06-01新增版本 2023-06-01，该版本：
    • 新增功能
      • 支持 Layout.CustomLayout.region 宽高设置绝对值像素。
      • 支持设置 SEI 信息的 PayLoadType
      • 支持传入 SEI Message
      • 支持开启合流 SEI 音量提示
    • 功能优化：若返回的一级错误码为 InvalidParamter, http 响应状态码为 400。
    		2023-10-23
    2020-12-01
    • 新增：支持开启合流 SEI 音量提示
    • 功能优化：自定义布局下，支持最多将 30 路流合为一路流进行转推。
    • 参数优化：Control.VolumeIndicationInterval 参数类型变为 Float32，取值范围由[1,∞] 变为[0.3,∞]
    		2023-10-23
    云端录制2023-06-01
    • 新增：支持 Layout.CustomLayout.region 宽高设置绝对值像素。
    • 功能优化：若返回的一级错误码是 InvalidParamter, http 响应状态码为 400。
    		2023-10-23
    公共流2020-12-01
    • StartPushPublicStream 接口新增 TranscodeMode 请求参数，支持设置公共流处理模式。
    • UpdatePublicStreamParam 接口新增 TranscodeMode 请求参数，支持更新公共流处理模式。
    • Control 字段新增 UserCaptureStatsMode 参数，支持开启房间用户采集状态回调。
    • Control 字段新增 UserCaptureStatsInterval 参数，支持设置房间用户采集状态回调间隔。
    • Control 字段新增 StreamPublishStatsMode 参数，支持开启房间用户发布状态回调。
    • Control 字段新增 StreamPublishStatsInterval 参数，支持设置房间用户发布状态回调间隔。
    		2023-10-18
  • 2023 年 9 月
    功能接口版本变更说明发布时间
    房间管理2023-08-01新增接口 GetRoomOnlineUsers：获取指定房间的实时用户列表。2023-09-20
  • 2023 年 7 月
    功能接口版本变更说明发布时间
    转推直播2020-12-01
    • 更新回调TranscodeStateChanged： TaskState 字段新增枚举值 4，表示当前推流地址已切换。
    • 接口新参数增：
      • UpdatePushMixedStreamToCDN 接口新增 IsUpdatePartialParam 请求参数，支持合流转推参数部分更新。
      • UpdatePushMixedStreamToCDN 接口新增 SequenceNumber 请求参数，支持为更新请求添加序列号，确保服务端按照最新配置更新合流转推接口。
      • GetPushSingleStreamToCDNTask 接口新增 PushStreamState 返回参数，支持查询推流状态。
      • GetPushMixedStreamToCDNTask 接口新增 PushStreamState 返回参数，支持查询推流状态。
    		2023-07-27
    转推直播2020-12-01新增 Layout.CustomLayout.Regions.Region.ApplySpatialAudio 参数，支持设置该路流对应用户是否开启空间音频效果。2023-07-11
  • 2023 年 6 月
    功能接口版本变更说明发布时间
    房间管理2020-12-01进房互踢行为优化，详情查看用户进退房回调说明2023-06-15
    音视频内容安全2020-12-01回调新增 AudioSegmentInfo,音频审核时返回音频切片信息。2023-06-08
    歌曲查询2020-12-01新增回调：曲库下架歌曲列表2023-06-07
    转推直播2020-12-01
    • 改进优化：合流转推与单流转推接口支持 Layout.CustomLayout.Regions.Region 字段传空。
    • 新增以下回调：
    		2023-06-02
    云端录制2020-12-01
    2022-06-01
    • 改进优化：录制切片规则发生变化，详情请参看录制切片规则。
    • 参数新增：
      • 新增 Layout.CustomLayout.Regions.Region.MediaType 参数，支持设置单个用户流的媒体类型。
      • 新增 Layout.CustomLayout.Regions.Region.AlternateImageRenderMode参数，支持补位图独立设置渲染模式。
    		2023-06-02
  • 2023 年 5 月
    功能接口版本变更说明发布时间
    页面转推2020-12-01页面转推功能更名为云录屏，原云录屏功能下线。2023-05-09
  • 2023 年 4 月
    功能接口版本变更说明发布时间
    房间管理2020-12-01
    • 新增接口：
      • BanRoomUser：封禁房间&用户。可解散整个房间或移除指定用户。
      • UpdateBanRoomUserRule：更新房间&用户封禁规则。可对封禁时长进行更新。
    • 废弃接口
      • 废弃 KickUser 接口，请使用 BanRoomUser 接口移除指定用户。
      • 废弃 DismissRoom 接口，请使用 BanRoomUser 接口解散房间。
    		2023-04-11
  • 2023 年 3 月
    功能接口版本变更说明发布时间
    合流转推2020-12-01新增接口： 2023-03-29
    音频切片2022-06-01新增 GetSegmentTask 接口，查询合流转推任务状态。可查询指定音频切片任务的相关信息2023-03-29
    抽帧截图2022-06-01新增 GetSnapshotTask 接口，查询抽帧截图任务状态。可查询指定抽帧截图任务的相关信息。2023-03-29
    页面转推2020-12-01新增 GetWebCastTask 接口，查询页面转推任务状态。可查询指定页面转推任务的相关信息。2023-03-29
    转推直播2020-12-01
    • 开始合流转推接口名由 StartTranscode 变为 StartPushMixedStreamToCDN。
    • 更新合流转推接口名由 UpdateTranscode 变为 UpdatePushMixedStreamToCDN。
    		2023-03-22
    音视频内容安全2020-12-01新增支持房间维度审核。详情可参看StartDetection.UserId。2023-03-16
    输入在线媒体流2020-12-01StreamControl.FrameRate 取值范围由[1,60] 变为[1,30]2023-03-13
    公共流2020-12-01新增 VideoConfig.VideoCodec参数，支持 H.264 和 VP8编码协议。2023-03-02
    歌曲查询2020-12-01
    • 支持根据关键字搜索歌曲：搜索音乐列表 SearchMusics
    • 支持根据筛选条件查询歌曲列表：查询歌曲列表 ListMusics
    		2023-03-01
  • 2023 年 2 月
    功能接口版本变更说明发布时间
    云端录制2022-06-01云端录制支持音视频模式录制下生成纯音频文件，即 Control.MediaType = 0 , FileFormatConfig= MP3、AAC 或 M4A时，可以生成纯音频文件。2023-02-24
    房间管理2020-12-01
    • 废弃 ListRooms 接口，请使用 ListRoomInfo 接口查询一段时间内，某个应用下进行音视频通话的房间列表及房间相关信息。
    • 废弃 ListUsers 接口，请使用 ListUserInfo 接口查询一段时间内，某个应用下进行音视频通话的指定房间内特定或全部用户信息。
    		2023-02-16
    转推直播2020-12-01新增支持设置布局的边框圆角半径。详情可参看 Region。2023-02-13
    抽帧截图2022-06-01
    • 新增 S3 存储平台，包括：
      • 华为云 OBS
      • 腾讯云 COS
      • 七牛云 Kodo
      • 新增 VeImageX 储存平台。
    		2023-02-07
    云端录制2022-06-01新增 S3 存储平台，包括：
    • 华为云 OBS
    • 腾讯云 COS
    • 七牛云 Kodo
    		2023-02-07
    音频切片2022-06-01新增 S3 存储平台，包括：
    • 华为云 OBS
    • 腾讯云 COS
    • 七牛云 Kodo
    		2023-02-07
    转推直播2020-12-01新增支持在房间内无用户推流的场景下发起转推直播任务。详细参数可参看Control。2023-02-03
  • 2023 年 1 月
    功能接口版本变更说明发布时间
    获取数据指标2020-12-01
    • 新增接口 ListCallDetail：获取通话质量指标。可查询一段时间内，某个应用下进行音视频通话的指定房间内某个用户的上下行数据。
    • 获取离线质量数据支持查询 web 端指标数据。详细参数可参看 ListQuality。
    		2023-01-18
    获取数据指标2020-12-01获取离线分布质量数据支持查询 web 端指标数据。详细参数可参看ListQualityDistribution2023-01-17
    转推直播2020-12-01废弃StopTranscode接口，请使用 StopPushStreamToCDN 接口结束转推任务。2023-01-13
    抽帧截图2020-12-01
    2022-06-01    		新增接口： 2023-01-12

2022 年

  • 2022 年 6 月
    功能接口版本变更说明发布时间
    输入在线媒体流2020-12-01新增接口 ListRelayStream：查询输入媒体流任务。可查询指定 AppID 下指定房间内所有输入的媒体流任务。2022-06-30
    页面转推2020-12-01新增支持将指定网页中的内容转推到 RTC 房间内。2022-07-07
    获取数据指标2020-12-01新增接口 ListCallDetail：获取通话质量指标。可查询一段时间内，某个应用下进行音视频通话的指定房间内某个用户的上下行数据。2022-06-13
    云端录制2022-06-01新增版本 2022-06-01，该版本：
    • 新增录制生成文件新增支持 S3 存储，支持的存储平台包括：
      • 火山引擎视频点播 VOD
      • 火山引擎对象存储 TOS
      • Amazon S3
      • 阿里云对象存储OSS
    • 新增以下接口
    • StartRecord：开始云端录制。
    • UpdateRecord：更新云端录制。
    • StopRecord：结束云端录制。
    • GetRecordTask：查询录制任务状态。
    		2022-06-01
    2020-12-01
    • 新增 Layout.MainVideoStream 参数
    • 废弃 Layout.MainVideoStreamIndex 参数。
      当前版本 MainVideoStreamIndex 依然可用，但我们强烈建议你使用 MainVideoStream 参数。
      如果你同时指定了 MainVideoStream 和 MainVideoStreamIndex的值，此时只有 MainVideoStream生效。 垂直布局支持屏幕流。
    		2022-06-01
    转推直播2020-12-01
    • 新增 Layout.MainVideoStream参数
    • 废弃 Layout.MainVideoStreamIndex 参数。
      当前版本 MainVideoStreamIndex 依然可用，但我们强烈建议你使用 MainVideoStream 参数。
      如果你同时指定了 MainVideoStream 和 MainVideoStreamIndex的值，此时只有 MainVideoStream生效。
    • 垂直布局支持屏幕流。
    		2022-06-01
最近更新时间：2025.11.10 17:12:09
这个页面对您有帮助吗？
有用
有用
无用
无用