文档中心

实时音视频

服务端回调

消息事件参考

事件清单（EventType）

消息通知服务支持的事件有：

功能	EventType	事件描述
音频流	UserAudioStreamStart	音频流开始推送。
音频流	UserAudioStreamStop	音频流结束推送。
视频流	UserVideoStreamStart	视频流开始推送。
视频流	UserVideoStreamStop	视频流结束推送。
屏幕音频流	UserScreenAudioStreamStart	屏幕音频流开始推送。
屏幕音频流	UserScreenAudioStreamStop	屏幕音频流结束推送。
屏幕视频流	UserScreenVideoStreamStart	屏幕视频流开始推送。
屏幕视频流	UserScreenVideoStreamStop	屏幕视频流结束推送。
云端录制	RecordStarted	录制任务开始。
	RecordStopped(2020-12-01)	录制任务结束（2020-12-01）。
	RecordStopped(2022-06-01)	录制任务结束（2022-06-01）。
	RecordStopped(2023-06-01)	录制任务结束（2023-06-01）。
	RecordStopped(2023-11-01)	录制任务结束（2023-11-01）。
	RecordUploadStarted	上传任务启动。
	RecordUploadProcessing	上传进度。
	RecordUploadDone	已完成上传至存储。
	RecordUploadBackuped	上传失败转存备份。
	RecordAudioStreamStateChanged	录制音频流状态变化。
	RecordVideoStreamStateChanged	录制视频流状态变化。
	RecordSyncUploadStarted	录制生成 m3u8 文件且上传成功。
	RecordSyncUploadFailed	录制生成 m3u8 文件且上传失败。
房间	UserJoinRoom	可见用户进房。
	UserLeaveRoom	可见用户退房。
	InvisibleUserJoinRoom	不可见用户进房。
	InvisibleUserLeaveRoom	不可见用户退房。
	RoleChangeInvisible2Visible	用户身份切换（不可见 -> 可见）
	RoleChangeVisible2Invisible	用户身份切换（可见 -> 不可见）
	RoomCreate	房间创建。
	RoomDestroy	房间销毁。
音频切片	SegmentRealTimeData(2020-12-01)	切片结果（2020-12-01）。
	SegmentRealTimeData(2022-06-01)	切片结果（2022-06-01）。
	SegmentRealTimeData(2023-11-01)	切片结果（2023-11-01）。
抽帧截图	SnapshotRealTimeData(2020-12-01)	截图结果（2020-12-01）。
	SnapshotRealTimeData(2022-06-01)	截图结果（2022-06-01）。
	SnapshotRealTimeData(2023-11-01)	截图结果（2023-11-01）。
在线媒体流	RelayStreamStateChanged	在线媒体流任务状态变化。
云录屏	Webcast	云录屏任务状态变化。
转推直播	TranscodeStarted	转推直播任务开始。
	TranscodeStopped	转推直播任务结束。
	TranscodeUpdated	转推直播任务更新。
	TranscodeStateChanged	转推直播任务状态变化。
WTN 流	PushPublicStream	WTN 流任务状态变化。
	WTNStreamStart	WTN 开始推流。
	WTNStreamStop	WTN 结束推流。
歌曲查询	MusicRemoved	曲库下架歌曲列表。
互动白板文件转码	WbTranscodeProgressChanged	文件转码进度。
互动白板文件转码	WbTranscodeFinished	文件转码结束。
实时对话式 AI	VoiceChat	智能体任务状态变化。

事件详情（EventData）

音频流相关

UserAudioStreamStart

音频流开始推送。

参数名	类型	示例值	描述
RoomId	String	`Your_RoomId`	房间 ID。
UserId	String	`Your_UserId`	用户 ID。
DeviceType	String	`android`、`ios`、`web`、`mac`、`windows`	终端类型。
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。

UserAudioStreamStop

音频流结束推送。

参数名	类型	示例值	描述
RoomId	String	`Your_RoomId`	房间 ID。
UserId	String	`Your_UserId`	用户 ID。
DeviceType	String	`android`、`ios`、`web`、`mac`、`windows`	终端类型。
Reason	String	`StreamStop`	音频流结束推送原因： `StreamStop`：正常流停止 `LeaveRoom`：用户离开房间导致流停止 `BannedByAdmin`：服务端封禁该音频流导致流停止
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。

视频流相关

UserVideoStreamStart

视频流开始推送。

参数名	类型	示例值	描述
RoomId	String	`Your_RoomId`	房间 ID。
UserId	String	`Your_UserId`	用户 ID。
DeviceType	String	`android`、`ios`、`web`、`mac`、`windows`	终端类型。
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。

UserVideoStreamStop

视频流结束推送。

参数名	类型	示例值	描述
RoomId	String	`Your_RoomId`	房间 ID。
UserId	String	`Your_UserId`	用户 ID。
DeviceType	String	`android`、`ios`、`web`、`mac`、`windows`	终端类型。
Reason	String	`StreamStop`	视频流结束推送原因： `StreamStop`：正常流停止 `LeaveRoom`：用户离开房间导致流停止 `BannedByAdmin`：服务端封禁该视频流导致流停止
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。

屏幕音频流相关

UserScreenAudioStreamStart

屏幕音频流开始推送。

参数名	类型	示例值	描述
RoomId	String	`Your_RoomId`	房间 ID。
UserId	String	`Your_UserId`	用户 ID。
DeviceType	String	`android`、`ios`、`web`、`mac`、`windows`	终端类型。
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。

UserScreenAudioStreamStop

屏幕音频流结束推送。

参数名	类型	示例值	描述
RoomId	String	`Your_RoomId`	房间 ID。
UserId	String	`Your_UserId`	用户 ID。
DeviceType	String	`android`、`ios`、`web`、`mac`、`windows`	终端类型。
Reason	String	`StreamStop`	屏幕音频流结束推送原因： `StreamStop`：正常流停止 `LeaveRoom`：用户离开房间导致流停止 `BannedByAdmin`：服务端封禁该屏幕音频流导致流停止
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。

屏幕视频流相关

UserScreenVideoStreamStart

屏幕视频流开始推送。

参数名	类型	示例值	描述
RoomId	String	`Your_RoomId`	房间 ID。
UserId	String	`Your_UserId`	用户 ID。
DeviceType	String	`android`、`ios`、`web`、`mac`、`windows`	终端类型。
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。

UserScreenVideoStreamStop

屏幕视频流结束推送。

注：在 Electron 1.4.0 版本中结束屏幕视频流推送时，不会触发此回调。

参数名	类型	示例值	描述
RoomId	String	`Your_RoomId`	房间 ID。
UserId	String	`Your_UserId`	用户 ID。
DeviceType	String	`android`、`ios`、`web`、`mac`、`windows`	终端类型。
Reason	String	`StreamStop`	屏幕视频流结束推送原因： `StreamStop`：正常流停止 `LeaveRoom`：用户离开房间导致流停止 `BannedByAdmin`：服务端封禁该屏幕视频流导致流停止
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。

录制相关

RecordStarted

录制任务开始。
不同版本录制功能在任务开始时均触发此回调。
无论录制任务是通过何种方式启动的（调用 OpenAPI 启动/在控制台上配置自动录制），在录制任务开始时，你都会收到录制任务开始的消息通知。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	音视频应用的唯一标识。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	用户创建的房间 ID，房间的唯一标识。
TaskId	String	`Your_TaskId`	任务 ID，同一房间内的录制任务通过 `TaskId` 来区分。
Code	Int32	`0`	任务状态：`0` 表示成功、`1` 表示失败。
ErrorMessage	String	`-`	具体的错误信息。当 `Code` 不为 `0` 时，`ErrorMessage` 会显示具体的错误。

RecordStopped(2020-12-01)

录制任务结束。
2020-12-01 版本录制功能在任务结束时触发此回调。
无论录制任务是通过何种方式启动的（调用 OpenAPI 启动/在控制台上配置自动录制），在录制任务结束时，你都会收到录制任务结束的消息通知。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	音视频应用的唯一标识。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	用户创建的房间 ID，房间的唯一标识。
TaskId	String	`Your_TaskId`	任务 ID，同一房间内的录制任务通过 `TaskId` 来区分。
Code	Int32	`0`	任务状态： `0`：任务结束，录制文件上传目标存储平台成功 `1`：任务结束，录制文件上传目标存储平台失败、备份存储失败 `2`：任务结束，录制文件上传目标存储平台失败，备份存储成功
ErrorMessage	String	`-`	具体的错误信息。当 `Code` 不为 `0` 时，`ErrorMessage` 会显示具体的错误。
RecordFileList	Array of RecordFile		录制生成的音视频文件列表。

RecordFile

参数名称	类型	描述
Vid	String	文件在点播平台的唯一标识。你可以根据 `vid` 可以在点播平台上找到对应的文件。
Duration	Uint64	文件时长，单位为毫秒。
Size	Uint64	文件大小，单位为 byte。
StartTime	Uint64	文件开始录制的 UTC 时间，单位为毫秒。
StreamList	Array of Stream	录制文件中包含流的列表。
VideoCodec	String	视频录制编码协议。默认值为 `0`，可以取 `0` 或 `1`。取 `0` 时使用 `H.264`，取 `1` 时使用 `ByteVC1` 编码器。
AudioCodec	String	音频录制编码器。
VideoWidth	Int	录制视频宽度，单位为像素。
VideoHeight	Int	录制视频高度，单位为像素。

Stream

参数名称	类型	示例值	描述
Index	Uint32	`0`	在自定义布局中，使用 `Index` 对流进行标志。后续在 `Layout.regions.StreamIndex` 中，你需要使用 `Index` 指定对应流的布局设置。
UserId	String	`Your_UserId`	该流所属的用户 ID。
StreamType	Uint32	`0`	流的类型：`0` 表示普通音视频流、`1` 表示屏幕流。

注意：如果录制结束回调 Code=0，但是 RecordFileList 为空，没有生成录制文件，请联系技术支持排查具体原因。

RecordStopped(2022-06-01)

录制任务结束。
2022-06-01 版本录制功能在任务结束时触发此回调。
无论录制任务是通过何种方式启动的（调用 OpenAPI 启动/在控制台上配置自动录制），在录制任务结束时，你都会收到录制任务结束的消息通知。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	音视频应用的唯一标识。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	用户创建的房间 ID，房间的唯一标识。
TaskId	String	`Your_TaskId`	任务 ID，同一房间内的录制任务通过 `TaskId` 来区分。
Code	Int32	`0`	任务状态： `0`：任务结束，录制文件上传目标存储平台成功 `1`：任务结束，录制文件上传目标存储平台失败、备份存储失败 `2`：任务结束，录制文件上传目标存储平台失败，备份存储成功
ErrorMessage	String	`-`	具体的错误信息。当 `Code` 不为 `0` 时，`ErrorMessage` 会显示具体的错误。
RecordFileList	Array of RecordFile	`-`	录制生成的音视频文件列表。

RecordFile

参数名称	类型	描述
Vid	String	文件在火山引擎视频点播 VOD 平台的唯一标识。你可以根据 vid 在点播平台上找到对应的文件。仅在你选择配置存储到 Vod 平台时，此参数有效。
ObjectKey	String	文件在对象存储平台中的完整路径，如 `abc/efg/123.mp4`。仅在你选择配置存储到对象存储平台时，此参数有效。
Duration	Uint64	文件时长，单位为毫秒。
Size	Uint64	文件大小，单位为 byte。
StartTime	Uint64	文件开始录制的 UTC 时间，单位为毫秒。
StreamList	Array of Stream	录制文件中包含流的列表。
VideoCodec	String	视频录制编码协议。
AudioCodec	String	音频录制编码器。
VideoWidth	Int	录制视频宽度，单位为像素。
VideoHeight	Int	录制视频高度，单位为像素。

Stream

参数名称	类型	示例值	描述
Index	Uint32	`0`	在自定义布局中，使用 `Index` 对流进行标志。后续在 `Layout.regions.StreamIndex` 中，你需要使用 `Index` 指定对应流的布局设置。
UserId	String	`Your_UserId`	该流所属的用户 ID。
StreamType	Uint32	`0`	流的类型：`0` 表示普通音视频流、`1` 表示屏幕流。

注意：如果录制结束回调 Code=0，但是 RecordFileList 为空，没有生成录制文件，请联系技术支持排查具体原因。

RecordStopped(2023-06-01)

录制任务结束。
2023-06-01 版本录制功能在任务结束时触发此回调。
无论录制任务是通过何种方式启动的（调用 OpenAPI 启动/在控制台上配置自动录制），在录制任务结束时，你都会收到录制任务结束的消息通知。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	音视频应用的唯一标识。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	用户创建的房间 ID，房间的唯一标识。
TaskId	String	`Your_TaskId`	任务 ID，同一房间内的录制任务通过 `TaskId` 来区分。
Code	Int32	`0`	任务状态。 `0`：任务结束，录制文件上传目标存储平台成功。 `1`：任务结束，录制文件上传目标存储平台失败、备份存储失败。 `2`：任务结束，录制文件上传目标存储平台失败，备份存储成功。
ErrorMessage	String	`-`	具体的错误信息。当 `Code` 不为 `0` 时，`ErrorMessage` 会显示具体的错误。
RecordFileList	Array of RecordFile	`-`	录制生成的音视频文件列表。

RecordFile

参数名称	类型	描述
Vid	String	文件在火山引擎视频点播 VOD 平台的唯一标识。你可以根据 vid 在点播平台上找到对应的文件。仅在你选择配置存储到 Vod 平台时，此参数有效。
ObjectKey	String	文件在对象存储平台中的完整路径，如 `abc/efg/123.mp4`。仅在你选择配置存储到对象存储平台时，此参数有效。
Duration	Uint64	文件时长，单位为毫秒。
Size	Uint64	文件大小，单位为 byte。
StartTime	Uint64	文件开始录制的 UTC 时间，单位为毫秒。
StreamList	Array of Stream	录制文件中包含流的列表。
VideoCodec	String	视频录制编码协议。
AudioCodec	String	音频录制编码器。
VideoWidth	Int	录制视频宽度，单位为像素。
VideoHeight	Int	录制视频高度，单位为像素。

Stream

参数名称	类型	示例值	描述
Index	Uint32	`0`	在自定义布局中，使用 `Index` 对流进行标志。后续在 `Layout.regions.StreamIndex` 中，你需要使用 `Index` 指定对应流的布局设置。
UserId	String	`Your_UserId`	该流所属的用户 ID。
StreamType	Uint32	`0`	流的类型：`0` 表示普通音视频流、`1` 表示屏幕流。

注意：如果录制结束回调 Code=0，但是 RecordFileList 为空，没有生成录制文件，请联系技术支持排查具体原因。

RecordStopped(2023-11-01)

录制任务结束。
2023-11-01 版本录制功能在任务结束时触发此回调。
无论录制任务是通过何种方式启动的（调用 OpenAPI 启动/在控制台上配置自动录制），在录制任务结束时，你都会收到录制任务结束的消息通知。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	音视频应用的唯一标识。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	用户创建的房间 ID，房间的唯一标识。
TaskId	String	`Your_TaskId`	任务 ID，同一房间内的录制任务通过 `TaskId` 来区分。
Code	Int32	`0`	任务状态。 `0`：任务结束，录制文件上传目标存储平台成功。 `1`：任务结束，录制文件上传目标存储平台失败、备份存储失败。 `2`：任务结束，录制文件上传目标存储平台失败，备份存储成功。
ErrorMessage	String	`-`	具体的错误信息。当 `Code` 不为 `0` 时，`ErrorMessage` 会显示具体的错误。
RecordFileList	Array of RecordFile	`-`	录制生成的音视频文件列表。

RecordFile

参数名称	类型	描述
Vid	String	文件在火山引擎视频点播 VOD 平台的唯一标识。你可以根据 vid 在点播平台上找到对应的文件。仅在你选择配置存储到 Vod 平台时，此参数有效。
ObjectKey	String	文件在对象存储平台中的完整路径，如 `abc/efg/123.mp4`。仅在你选择配置存储到对象存储平台时，此参数有效。
Duration	Uint64	文件时长，单位为毫秒。
Size	Uint64	文件大小，单位为 byte。
StartTime	Uint64	文件开始录制的 UTC 时间，单位为毫秒。
StreamList	Array of Stream	录制文件中包含流的列表。
VideoCodec	String	视频录制编码协议。
AudioCodec	String	音频录制编码器。
VideoWidth	Int	录制视频宽度，单位为像素。
VideoHeight	Int	录制视频高度，单位为像素。

Stream

参数名称	类型	示例值	描述
Index	Uint32	`0`	在自定义布局中，使用 `Index` 对流进行标志。后续在 `Layout.regions.StreamIndex` 中，你需要使用 `Index` 指定对应流的布局设置。
UserId	String	`Your_UserId`	该流所属的用户 ID。
StreamType	Uint32	`0`	流的类型：`0` 表示普通音视频流、`1` 表示屏幕流。

注意：如果录制结束回调 Code=0，但是 RecordFileList 为空，没有生成录制文件，请联系技术支持排查具体原因。

RecordUploadStarted

上传任务启动。
不同版本录制功能在上传任务启动时均触发此回调。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	音视频应用的唯一标识。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	用户创建的房间 ID，房间的唯一标识。
TaskId	String	`Your_TaskId`	任务 ID，同一房间内的录制任务通过 TaskId 来区分。
Code	Int32	`0`	任务状态：`0` 表示成功、`1` 表示失败。
ErrorMessage	String	`-`	具体的错误信息。当 `Code` 不为 `0` 时，`ErrorMessage` 会显示具体的错误。

RecordUploadProcessing

上传任务进度。

上传进程持续一分钟及以上，才会有此回调。每隔一分钟上传一次。

不同版本录制功能在上传任务进度发生变化时均触发此回调。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	音视频应用的唯一标识。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	用户创建的房间 ID，房间的唯一标识。
TaskId	String	`Your_TaskId`	任务 ID，同一房间内的录制任务通过 TaskId 来区分。
Code	Int32	`0`	任务状态：`0` 表示成功、`1` 表示失败。
ErrorMessage	String	`-`	具体的错误信息。当 `Code` 不为 `0` 时，`ErrorMessage` 会显示具体的错误。
Progress	Int	`100`	0 到 10000 之间的数字，当前已上传文件与已录制的文件的比例乘以 10000。这个数字是不断变动的，录制完成后，到达 10000 表示上传完成。

RecordUploadDone

录制文件已上传至存储平台。
不同版本录制功能在录制文件已上传至存储平台时均触发此回调。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	音视频应用的唯一标识。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	用户创建的房间 ID，房间的唯一标识。
TaskId	String	`Your_TaskId`	任务 ID，同一房间内的录制任务通过 TaskId 来区分。
Code	Int32	`0`	任务状态：`0` 表示成功、`1` 表示失败。
ErrorMessage	String	`-`	具体的错误信息。当 `Code` 不为 `0` 时，`ErrorMessage` 会显示具体的错误。

RecordUploadBackuped

录制文件上传失败转存备份。
不同版本录制功能在录制文件上传失败转存备份时均触发此回调。

备份使用的 TOS Bucket 需要开启版本控制，防止文件名重复导致文件被覆盖。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	音视频应用的唯一标识。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	用户创建的房间 ID，房间的唯一标识。
TaskId	String	`Your_TaskId`	任务 ID，同一房间内的录制任务通过 TaskId 来区分。
Code	Int32	`0`	任务状态：`0` 表示成功、`1` 表示失败。
ErrorMessage	String	`-`	具体的错误信息。当 `Code` 不为 `0` 时，`ErrorMessage` 会显示具体的错误。

RecordAudioStreamStateChanged

录制音频流状态变化。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	音视频应用的唯一标识。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	用户创建的房间 ID，房间的唯一标识。
TaskId	String	`Your_TaskId`	任务 ID，同一房间内的录制任务通过 TaskId 来区分。
UserId	String	`Your_UserId`	用户 ID。
StreamType	Int	`0`	音频流类型。 `0`：麦克风采集流 `1`：屏幕流
State	Int	`0`	任务状态： `0`：音频流停止发布 `1`：音频流正在发布
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。

RecordVideoStreamStateChanged

录制视频流状态变化。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	音视频应用的唯一标识。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	用户创建的房间 ID，房间的唯一标识。
TaskId	String	`Your_TaskId`	任务 ID，同一房间内的录制任务通过 TaskId 来区分。
UserId	String	`Your_UserId`	用户 ID。
StreamType	Int	`0`	视频流类型： `0`：摄像头采集流 `1`：屏幕流
State	Int	`0`	任务状态： `0`：视频流停止发布 `1`：视频流正在发布
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。

RecordSyncUploadStarted

录制生成 m3u8 文件且上传至指定存储平台。此事件仅在第一次上传成功后回调。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	音视频应用的唯一标识。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	用户创建的房间 ID，房间的唯一标识。
TaskId	String	`Your_TaskId`	任务 ID，同一房间内的录制任务通过 TaskId 来区分。
Code	Int32	`0`	任务状态：`0` 成功，`1` 失败。
ErrorMessage	String	`-`	具体的错误信息。当 `Code` 不为 `0` 时，`ErrorMessage` 会显示具体的错误。
RecordFileList	Array of RecordFile	`-`	录制生成的音视频文件列表。

RecordFile

参数名称	类型	描述
Vid	String	文件在火山引擎视频点播 VOD 平台的唯一标识。你可以根据 vid 在点播平台上找到对应的文件。仅在你选择配置存储到 Vod 平台时，此参数有效。
ObjectKey	String	文件在对象存储平台中的完整路径，如 `abc/efg/123.mp4`。仅在你选择配置存储到对象存储平台时，此参数有效。
StartTime	Uint64	文件开始录制的 UTC 时间，单位为毫秒。
StreamList	Array of Stream	录制文件中包含流的列表。
VideoCodec	String	视频录制编码协议。
AudioCodec	String	音频录制编码器。
VideoWidth	Int	录制视频宽度，单位为像素。
VideoHeight	Int	录制视频高度，单位为像素。

Stream

参数名称	类型	示例值	描述
Index	Uint32	`0`	在自定义布局中，使用 `Index` 对流进行标志。后续在 `Layout.regions.StreamIndex` 中，你需要使用 `Index` 指定对应流的布局设置。
UserId	String	`Your_UserId`	该流所属的用户 ID。
StreamType	Uint32	`0`	流的类型：`0` 表示普通音视频流、`1` 表示屏幕流。

RecordSyncUploadFailed

录制生成 m3u8 文件且上传至指定存储平台失败。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	音视频应用的唯一标识。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	用户创建的房间 ID，房间的唯一标识。
TaskId	String	`Your_TaskId`	任务 ID，同一房间内的录制任务通过 TaskId 来区分。
Code	Int32	`0`	任务状态：`0` 表示成功、`1` 表示失败。
ErrorMessage	String	`-`	具体的错误信息。当 `Code` 不为 `0` 时，`ErrorMessage` 会显示具体的错误。

房间相关

UserJoinRoom

可见用户进入房间。
相同 UserId 用户重复进房时，每一次进房都会触发该回调，建议进行去重操作。

注：关于可见用户和不可见用户，参看 setUserVisibility。

参数	类型	示例值	说明
RoomId	String	`6992870232038591758`	房间 ID。
UserId	String	`4398491447867063`	用户 ID。
DeviceType	String	`android`/`ios`/`web`/`mac`/`windows`	终端类型。
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。
ExtraInfo	String	`Your_ExtraInfo`	客户端 SDK 通过 `joinRoom` 传入的用户附加信息。

UserLeaveRoom

可见用户退出房间。
相同 UserId 用户反复登录造成被踢，被踢掉用户不会触发此回调。只有在最后一次退房时会触发该回调。

参数	类型	示例值	说明
RoomId	String	`6992870232038591758`	房间 ID。
UserId	String	`4398491447867063`	用户 ID。
DeviceType	String	`android`/`ios`/`web`/`mac`/`windows`	终端类型。
Reason	String	`userLeave`	原因： `userLeave`：正常退房 `connectionLost`：因断网、杀进程等异常原因离开房间，用户离开房间 30s 后触发此回调 `kickedByAdmin`：使用 OpenAPI 接口将某用户踢出房间 `roomDismissByAdmin`：使用 OpenAPI 接口解散房间，将房间内所有用户踢出房间 `onUserTokenDidExpire`：Token 过期被踢出房间 `other`：其他原因
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。
Duration	Int64	`20`	用户在房间里的通话时长(s)。

InvisibleUserJoinRoom

不可见用户进入房间。
相同 UserId 用户重复进房时，每一次进房都会触发该回调，建议进行去重操作。

参数	类型	示例值	说明
RoomId	String	`6992870232038591758`	房间 ID。
UserId	String	`4398491447867063`	用户 ID。
DeviceType	String	`android`/`ios`/`web`/`mac`/`windows`	终端类型。
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。
ExtraInfo	String	`Your_ExtraInfo`	客户端 SDK 通过 `joinRoom` 传入的用户附加信息。

InvisibleUserLeaveRoom

不可见用户退出房间。
相同 UserId 用户反复登录造成被踢，被踢掉用户不会触发此回调。只有在最后一次退房时会触发该回调。

参数	类型	示例值	说明
RoomId	String	`6992870232038591758`	房间 ID。
UserId	String	`4398491447867063`	用户 ID。
DeviceType	String	`android`/`ios`/`web`/`mac`/`windows`	终端类型。
Reason	String	`userLeave`	退房原因： `userLeave`：正常退房 `connectionLost`：因断网、杀进程等异常原因离开房间，用户离开房间 30s 后触发此回调 `kickedByAdmin`：使用 OpenAPI 接口将某用户踢出房间 `roomDismissByAdmin`：使用 OpenAPI 接口解散房间，将房间内所有用户踢出房间 `onUserTokenDidExpire`：Token 过期被踢出房间 `other`：其他原因。
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。
Duration	Int64	`20`	用户在房间里的通话时长(s)。

RoleChangeInvisible2Visible

可见用户调用 setUserVisibility ，不可见 -> 可见。

参数	类型	示例值	说明
RoomId	String	`6992870232038591758`	房间 ID。
UserId	String	`4398491447867063`	用户 ID。
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。

RoleChangeVisible2Invisible

可见用户调用 setUserVisibility ，可见 -> 不可见。

参数	类型	示例值	说明
RoomId	String	`6992870232038591758`	房间 ID。
UserId	String	`4398491447867063`	用户 ID。
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。

RoomCreate

RTC 房间创建。

参数	类型	示例值	说明
RoomId	String	`6992870232038591758`	房间 ID。
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。

RoomDestroy

RTC 房间销毁，房间中所有用户全部离开房间。

参数	类型	示例值	说明
RoomId	String	`6992870232038591758`	房间 ID。
Timestamp	Int64	`1611736812853`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。

音频切片相关

SegmentRealTimeData(2020-12-01)

指定音频流切片结果。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	应用的唯一标志。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	房间 ID，是房间的唯一标志。
TaskId	String	`Your_TaskId`	切片任务 ID。
TosBucket	String	`Your_TosBucket`	储存切片的 TOS Bucket。
Data	Array of AudioData	`-`	音频切片的列表。
Identifier	String	`Your_Identifier`	切片任务标志。若未自定义切片名，切片名默认为 UUID，自定义切片名时为自定义名称。自定义切片文件名由 Identifier + UserId + 时间戳 + 序号组成。默认情况下 Identifier 为随机生成的 UUID。在自定义文件名时，Identifier 的命名规则符合正则表达式：[a-zA-Z0-9_@-.]{1,128}。

AudioData

参数名	类型	示例值	描述
Stream	Stream	`-`	音频切片对应的流的信息。
ObjectKey	String	`Your_ObjectKey`	音频切片的文件名。
SampleRate	Int	`44100`	音频采样率，单位 Hz。
BitsPerSample	Int	`16`	每个音频采样的比特数。
Channels	Int	`2`	音频声道数。
Size	Uint64	`256044`	音频切片大小，单位为 byte。
TimeStamp	Int64	`1647317680214`	音频文件生成时对应的 Unix 时间戳。单位为毫秒。
Duration	Uint32	`8000`	音频的时长，单位为毫秒。

Stream

参数名称	类型	示例值	描述
Index	Uint32	`0`	在自定义布局中，使用 `Index` 对流进行标志。后续在 `Layout.regions.StreamIndex` 中，你需要使用 `Index` 指定对应流的布局设置。
UserId	String	`Your_UserId`	该流所属的用户 ID。
StreamType	Uint32	否	`0`

SegmentRealTimeData(2022-06-01)

指定音频流切片结果。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	应用的唯一标志。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	房间 ID，是房间的唯一标志。
TaskId	String	`Your_TaskId`	切片任务 ID。
Bucket	String	`Your_Bucket`	存储音频切片的桶名称。
Data	Array of AudioData	`-`	音频切片的列表。
Identifier	String		切片任务标志。若未自定义切片名，切片名默认为 UUID，自定义切片名时为自定义名称。自定义切片文件名由 Identifier + UserId + 时间戳 + 序号组成。默认情况下 Identifier 为随机生成的 UUID。在自定义文件名时，Identifier 的命名规则符合正则表达式：[a-zA-Z0-9_@-.]{1,128}。

AudioData

参数名	类型	示例值	描述
Stream	Stream	`-`	音频切片对应的流的信息。
ObjectKey	String	`Your_ObjectKey`	音频切片的对象键。
SampleRate	Int	`44100`	音频采样率，单位 Hz。
BitsPerSample	Int	`16`	每个音频采样的比特数。
Channels	Int	`2`	音频声道数。
Size	Uint64	`256044`	音频切片大小，单位为 byte。
TimeStamp	Int64	`1647317680214`	音频文件生成时对应的 Unix 时间戳。单位为毫秒。
Duration	Uint32	`8000`	音频的时长，单位为毫秒。

Stream

参数名称	类型	示例值	描述
Index	Uint32	`0`	在自定义布局中，使用 `Index` 对流进行标志。后续在 `Layout.regions.StreamIndex` 中，你需要使用 `Index` 指定对应流的布局设置。
UserId	String	`Your_UserId`	该流所属的用户 ID。
StreamType	Uint32	`0`	流的类型：`0` 表示普通音视频流、`1` 表示屏幕流。

SegmentRealTimeData(2023-11-01)

指定音频流切片结果。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	应用的唯一标志。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	房间 ID，是房间的唯一标志。
TaskId	String	`Your_TaskId`	切片任务 ID。
Bucket	String	`Your_Bucket`	存储音频切片的桶名称。
Data	Array of AudioData	`-`	音频切片的列表。
Identifier	String		切片任务标志。若未自定义切片名，切片名默认为 UUID，自定义切片名时为自定义名称。自定义切片文件名由 Identifier + UserId + 时间戳 + 序号组成。默认情况下 Identifier 为随机生成的 UUID。在自定义文件名时，Identifier 的命名规则符合正则表达式：[a-zA-Z0-9_@-.]{1,128}。

AudioData

参数名	类型	示例值	描述
Stream	Stream	`-`	音频切片对应的流的信息。
ObjectKey	String	`Your_ObjectKey`	音频切片的对象键。
SampleRate	Int	`44100`	音频采样率，单位 Hz。
BitsPerSample	Int	`16`	每个音频采样的比特数。
Channels	Int	`2`	音频声道数。
Size	Uint64	`256044`	音频切片大小，单位为 byte。
TimeStamp	Int64	`1647317680214`	音频文件生成时对应的 Unix 时间戳。单位为毫秒。
Duration	Uint32	`8000`	音频的时长，单位为毫秒。

Stream

参数名称	类型	示例值	描述
Index	Uint32	`0`	在自定义布局中，使用 `Index` 对流进行标志。后续在 `Layout.regions.StreamIndex` 中，你需要使用 `Index` 指定对应流的布局设置。
UserId	String	`Your_UserId`	该流所属的用户 ID。
StreamType	Uint32	`0`	流的类型：`0` 表示普通音视频流、`1` 表示屏幕流。

抽帧截图相关

SnapshotRealTimeData(2020-12-01)

指定视频流截图结果。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	应用的唯一标志。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	房间 ID，是房间的唯一标志。
TaskId	String	`Your_TaskId`	截图任务 ID。
TosBucket	String	`Your_TosBucket`	储存截图的 TOS Bucket。
Data	Array of ImageData	`-`	截图的列表。

ImageData

参数名	类型	示例值	描述
Stream	Stream	`-`	截图对应的流的信息。
ObjectKey	String	`Your_ObjectKey`	截图对应的 TOS key。
Format	Uint32	`0`	截图格式： `0`: JPEG `1`: PNG。
Width	Uint32	`640`	截图宽度，单位为像素。
Height	Uint32	`360`	截图高度，单位为像素。
Size	Uint64	`28802`	截图大小，单位为 byte。
TimeStamp	Uint64	`1647316896085`	截图生成时对应的 Unix 时间戳。

Stream

参数名称	类型	示例值	描述
Index	Uint32	`0`	在自定义布局中，使用 `Index` 对流进行标志。后续在 `Layout.regions.StreamIndex` 中，你需要使用 `Index` 指定对应流的布局设置。
UserId	String	`Your_UserId`	该流所属的用户 ID。
StreamType	Uint32	`0`	流的类型：`0` 表示普通音视频流、`1` 表示屏幕流。

SnapshotRealTimeData(2022-06-01)

指定视频流截图结果。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	应用的唯一标志。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	房间 ID，是房间的唯一标志。
TaskId	String	`Your_TaskId`	截图任务 ID。
Bucket	String	`Your_Bucket`	存储截图的桶名称。当存储平台为 TOS，或者支持 S3 协议的第三方存储平台时此字段才会生效。
VeImageXServiceId	String	`-`	VeImageX 的服务 ID。当存储平台为 VeImageX 时此字段才会生效。
Data	Array of ImageData	`-`	截图的列表。

ImageData

参数名	类型	示例值	描述
Stream	Stream	`-`	截图对应的流的信息。
ObjectKey	String	`Your_ObjectKey`	对象键名称。当存储平台为 TOS，或者支持 S3 协议的第三方存储平台时此字段才会生效，你可以根据 ObjecetKey 找到对应的图片文件。
VeImageXUri	String	`Your_VeImageXUri`	VeImageX 的统一资源标识符。当存储平台为 VeImageX 时此字段才会生效，你可以根据 VeImageXUri找到对应的图片文件。
Format	Uint32	`0`	截图格式： `0`: JPEG `1`: PNG。
Width	Uint32	`640`	截图宽度，单位为像素。
Height	Uint32	`360`	截图高度，单位为像素。
Size	Uint64	`28802`	截图大小，单位为 byte。
TimeStamp	Uint64	`1647316896085`	截图生成时对应的 Unix 时间戳。

Stream

参数名称	类型	示例值	描述
Index	Uint32	`0`	在自定义布局中，使用 `Index` 对流进行标志。后续在 `Layout.regions.StreamIndex` 中，你需要使用 `Index` 指定对应流的布局设置。
UserId	String	`Your_UserId`	该流所属的用户 ID。
StreamType	Uint32	`0`	流的类型：`0` 表示普通音视频流、`1` 表示屏幕流。

SnapshotRealTimeData(2023-11-01)

指定视频流截图结果。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	应用的唯一标志。
BusinessId	String	`Your_BusinessId`	业务标识。
RoomId	String	`Your_RoomId`	房间 ID，是房间的唯一标志。
TaskId	String	`Your_TaskId`	截图任务 ID。
Bucket	String	`Your_Bucket`	存储截图的桶名称。当存储平台为 TOS，或者支持 S3 协议的第三方存储平台时此字段才会生效。
VeImageXServiceId	String	`-`	VeImageX 的服务 ID。当存储平台为 VeImageX 时此字段才会生效。
Data	Array of ImageData	`-`	截图的列表。

ImageData

参数名	类型	示例值	描述
Stream	Stream	`-`	截图对应的流的信息。
ObjectKey	String	`Your_ObjectKey`	对象键名称。当存储平台为 TOS，或者支持 S3 协议的第三方存储平台时此字段才会生效，你可以根据 ObjecetKey 找到对应的图片文件。
VeImageXUri	String	`Your_VeImageXUri`	VeImageX 的统一资源标识符。当存储平台为 VeImageX 时此字段才会生效，你可以根据 VeImageXUri找到对应的图片文件。
Format	Uint32	`0`	截图格式： `0`: JPEG `1`: PNG。
Width	Uint32	`640`	截图宽度，单位为像素。
Height	Uint32	`360`	截图高度，单位为像素。
Size	Uint64	`28802`	截图大小，单位为 byte。
TimeStamp	Uint64	`1647316896085`	截图生成时对应的 Unix 时间戳。

Stream

参数名称	类型	示例值	描述
Index	Uint32	`0`	在自定义布局中，使用 `Index` 对流进行标志。后续在 `Layout.regions.StreamIndex` 中，你需要使用 `Index` 指定对应流的布局设置。
UserId	String	`Your_UserId`	该流所属的用户 ID。
StreamType	Uint32	`0`	流的类型：`0` 表示普通音视频流、`1` 表示屏幕流。

在线媒体流相关

RelayStreamStateChanged

输入在线媒体流状态发生变化。

参数名	类型	示例值	描述
RoomId	String	`Your_RoomId`	房间 ID，是房间的唯一标志。
TaskId	String	`Your_TaskId`	任务 ID。
UserId	String	`Your_UserId`	在线媒体流对应的 UserId。
StreamUrl	String	`rtmp://xxx`	在线流媒体地址。
Status	Int	`1`	任务状态： `1`：待机中 `2`：连接中 `3`：运行中 `4`：已停止 `5`：重试中。
StartTimeStamp	Int	`0`	任务起始时间戳，用于定时播放，Unix时间，单位为秒。默认为 `0`，表示立即启动。
Msg	String	`-`	描述信息
Reason	Int	`1`	任务停止原因： `1`：空闲超时 `2`：停止接口调用 `3`：流播放结束 `4`：内部错误 `5`：url地址异常 `6`：编码格式不支持 `7`：`token` 错误 `8`：没有发布权限 `9`：被移除房间仅当 `status`=`4` 时，`Reason` 有值。

云录屏相关

Webcast

云录屏任务状态发生变化

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	应用的唯一标志。
RoomId	String	`Your_RoomId`	房间 ID，是房间的唯一标志。
BusinessId	String	`Your_BusinessId`	业务标识。
TaskId	String	`Your_TaskId`	任务 ID。
Status	Int	`1`	任务状态： `1`：开始转推 `2`：正常结束 `3`：异常结束 `4`：页面刷新 `5`：任务重调度（推流用户重新进房）
Reason	String	`-`	异常结束描述信息，当 Status = `{3,4,5}` 时才有值，枚举值为 `{：AudioCaptureModuleError、 WebRenderModuleError、SourceURLInaccessible、StartEventTimeout、PageBlank、PageCrash、PageFreeze}` 。

转推直播相关

TranscodeStarted

通过调用 RTC 服务端 OpenAPI 或客户端 SDK 的 API 发起的转推直播任务开始。
不同版本转推直播功能在转推直播任务开始时均触发此回调。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	应用的唯一标志。
RoomId	String	`Your_RoomId`	房间 ID，是房间的唯一标志。
TaskId	String	`Your_TaskId`	转推直播任务 ID。通过服务端发起时，该值为调用 OpenAPI 时传入的 TaskId。通过客户端 SDK 发起时，TaskId 是按照 `userId`@@`taskId` 格式拼接而成的字符串；当传入的 taskId 为空时，这里的 TaskId 为 `userId`。
Timestamp	Int64	`1661150097044`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。
PushURL	String	`rtmp://xxxx`	推流 CDN 地址。该参数当前仅在合流转推下返回。
Code	Int	`0`	操作结果类型： 0：创建任务成功 1：创建任务失败
ErrorMessage	String	`-`	具体错误信息，当 `Code` 为 `1` 时，ErrorMessage 会显示具体的错误信息。

TranscodeStopped

通过调用 RTC 服务端 OpenAPI 或客户端 SDK 的 API 终止了转推直播任务。
不同版本转推直播功能在转推直播任务结束时均触发此回调。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	应用的唯一标志。
RoomId	String	`Your_RoomId`	房间 ID，是房间的唯一标志。
TaskId	String	`Your_TaskId`	转推直播任务 ID。通过服务端发起时，该值为调用 OpenAPI 时传入的 TaskId。通过客户端 SDK 发起时， TaskId 是按照 `userId`@@`taskId` 格式拼接而成的字符串；当传入的 taskId 为空时，这里的 TaskId 为 `userId`。
Timestamp	Int64	`1661150097044`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。
PushURL	String	`rtmp://xxxx`	推流 CDN 地址。该参数当前仅在合流转推下返回。
Code	Int	`0`	操作结果类型： 0：停止任务成功 1：停止任务失败
ErrorMessage	String	`-`	具体错误信息，当 `Code` 为 `1` 时，ErrorMessage 会显示具体的错误信息。

TranscodeUpdated

通过调用 RTC 服务端 OpenAPI 或客户端 SDK 的 API 更新了合流转推任务。
不同版本转推直播功能在转推直播任务更新时均触发此回调。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	应用的唯一标志。
RoomId	String	`Your_RoomId`	房间 ID，是房间的唯一标志。
TaskId	String	`Your_TaskId`	转推直播任务 ID。通过服务端发起时，该值为调用 OpenAPI 时传入的 TaskId。通过客户端 SDK 发起时， TaskId 是按照 `userId`@@`taskId` 格式拼接而成的字符串；当传入的 taskId 为空时，这里的 TaskId 为 `userId`。
Timestamp	Int64	`1661150097044`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。
PushURL	String	`rtmp://xxxx`	推流 CDN 地址。
Code	Int	`0`	操作结果类型： 0：更新配置成功 1：创建配置失败
ErrorMessage	String	`-`	具体错误信息，当 `Code` 为 `1` 时，ErrorMessage 会显示具体的错误信息。

TranscodeStateChanged

转推直播任务状态变化通知。
不同版本转推直播功能在转推直播任务状态变化时均触发此回调。
状态变化包括用户主动调用 RTC 服务端 OpenAPI 或客户端 SDK 的 API 更新了合流转推任务参数。也包括任务执行过程中出现的状态流转。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	应用的唯一标志。
RoomId	String	`Your_RoomId`	房间 ID，是房间的唯一标志。
TaskId	String	`Your_TaskId`	转推直播任务 ID。通过服务端发起时，该值为调用 OpenAPI 时传入的 TaskId。通过客户端 SDK 发起时， TaskId 是按照 `userId`@@`taskId` 格式拼接而成的字符串；当传入的 taskId 为空时，这里的 TaskId 为 `userId`。
Timestamp	Int64	`1661150097044`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。
StartTime	Int64	`1661150054990`	转推直播任务创建的 Unix 时间戳（ms）
FinishTime	Int64	`0`	转推直播任务结束的 Unix 时间戳（ms）
PushURL	String	`rtmp://xxxx`	推流 CDN 地址。该参数当前仅在合流转推下返回。
TaskState	Int	`2`	任务状态： `1`：尚未开始推流或已停止推流 `2`：正在重连 CDN 服务 `3`：正在推流 4：当前推流地址已切换。此时 `ErrorMessage` 字段中会显示切换前后的推流地址。
Code	Int	`0`	错误码： `0`：请求处理成功 `1`：请求参数校验发生错误 `2`：订阅 RTC 用户发布的音视频流发生错误 `3`：合流任务执行过程发生错误 `4`：推流到 CDN 发生错误 `5`：RTC 房间内没有合流任务需要订阅的音视频流 `9999`：其他系统异常
ErrorMessage	String	`-`	具体错误信息。
OnStatusCode	String	`-`	推流失败时 CDN 返回的错误码。
OnStatusDescription	String	`-`	推流失败时 CDN 返回的错误详情。

WTN 流（原公共流）相关

PushPublicStream

WTN 流推送异常或推送结束

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	应用的唯一标志。
BusinessId	String	`Your_BusinessId`	业务标识。
PublicStreamId	String	`Your_PublicStreamId`	WTN 流对应的流 ID。
Timestamp	Int64	`1661150097044`	该事件在 RTC 服务器上发生的 Unix 时间戳（ms）。
Status	Int	`2`	WTN 流任务状态： `1`：WTN 流启动成功 `2`：WTN 流推送结束 `3`：WTN 流推送异常
Msg	String	`-`	具体的错误信息。
Code	Int	`2`	错误码： `1`：空闲超时结束 `2`：OpenAPI 调用结束 `3`：内部错误结束

WTNStreamStart

开始推流回调。

参数名	类型	示例值	描述
streamId	String	`Your_StreamId`	WTN 流 ID。
sourceProtocol	String	`RTMP`	推流协议，取值为 `RTMP` 或 `WHIP`
startPushTime	Int64	`1678886400000`	开始推流时间，毫秒级 UTC 时间戳。

WTNStreamStop

结束推流回调。

参数名	类型	示例值	描述
streamId	String	`Your_StreamId`	WTN 流 ID。
sourceProtocol	String	`RTMP`	推流协议，取值为 `RTMP` 或 `WHIP`
startPushTime	Int64	`1678886400000`	开始推流时间，毫秒级 UTC 时间戳。
stopPushTime	Int64	`1678886500000`	结束推流时间，毫秒级 UTC 时间戳。
reason	Int		结束原因： `430`：使用了相同的 WTN 流 ID 开启了一个新的推流，导致当前推流进程结束。 `445`：客户端与服务器之间的 TCP 连接意外中断，请检查推流端的网络状况。 `446`：音频转码服务（ffmpeg）遇到错误。请检查音频流格式是否标准；若格式无误，请联系技术支持。 `447`：超时未收到转码后数据。 `448`：推流的视频编码为 H.265，当前不支持该格式。 `449`：推流的视频包含 B 帧，当前服务不支持该编码方式。 `450`：服务器进程异常。

歌曲查询相关

MusicRemoved

曲库下架歌曲列表。

参数名	类型	示例值	描述
AppId	String	`Your_AppId`	应用的唯一标志。
Timestamp	Int	`1611736812853`	该事件在 RTC 服务器上发生的时间戳，Unix 时间戳，单位为毫秒。
SongUpdate	Array of SongUpdate	`-`	下架歌曲详细信息。

SongUpdate

参数名	类型	示例值	描述
SongId	String	`Your_SongId`	歌曲 ID。
VendorId	Int	`1`	供应商 ID。
UpdateAt	Int	`1611736812853`	歌曲更新时间戳，Unix 时间戳，单位为毫秒。

互动白板文件转码

WbTranscodeProgressChanged

文件转码进度。触发时机说明如下：

任务开始时
任务完成时
静态转码任务每完成 10 页时，也会触发一次回调。

参数名	类型	示例值	描述
TaskId	String	`5f848de8-4258-4c41-964b-80556552ae82`	任务唯一标识。
TranscodeMode	Int	`0`	`0`：静态转码 `1`：动态转码。
Progress	Int	`0`	进度：当前页数/总页数 *100%。对于动态转码任务，取值为 `0` 或 `100`。
FileName	String	`demo`	源文件文件名。
TotalPages	Int	`5`	总页数。对静态转码任务有效。

WbTranscodeFinished

文件转码任务结束后回调一次，成功或失败。

参数名	类型	示例值	描述
TaskId	String	`5f848de8-4258-4c41-964b-80556552ae82`	任务唯一标识。
TranscodeMode	Int	`0`	`0`：静态转码 `1`：动态转码。
FileName	String	`demo`	源文件文件名。
FileId	String	`001`	动态转码文件ID。对动态转码任务有效。
TotalPages	Int	`5`	总页数。
Width	Int	`640`	分辨率宽，单位：像素。对静态转码任务有效。
Height	Int	`360`	分辨率高，单位：像素。对静态转码任务有效。
ThumbnailWidth	int	`64`	缩略图分辨率宽，单位：像素。
ThumbnailHeight	int	`64`	缩略图分辨率高，单位：像素。
Images	Array of Image	None	转码图片结果：静态转码缩略图 URL。动态转码指定缩略图时，返回缩略图 URL。不指定则为空。
ErrCodeN	Int	`400`	错误码编号，含义见白板错误码。
ErrCode	String	`InvalidParameter`	错误码类型，含义见白板错误码。
ErrMsg	String	`和错误参数有关的信息`	错误码信息，含义见白板错误码。

Image

参数名	类型	示例值	描述
PageId	Int	`1`	页数，从 1 开始编号。
Img	String	`https://example.com/demo.png`	转码图片 URL。
ThumbnailUrl	String	`https://example.com/thumbnail.png`	转码缩略图 URL，如没有指定缩略图，则为空。

对话式 AI

消息名称：VoiceChat
事件详情：请参见事件和错误码。

最近更新时间：2026.09.28 10:19:26

这个页面对您有帮助吗？

有用

无用

实时音视频

音频流相关 #

UserAudioStreamStart #

UserAudioStreamStop #

视频流相关 #

UserVideoStreamStart #

UserVideoStreamStop #

屏幕音频流相关 #

UserScreenAudioStreamStart #

UserScreenAudioStreamStop #

屏幕视频流相关 #

UserScreenVideoStreamStart #

UserScreenVideoStreamStop #

录制相关 #

RecordStarted #

RecordStopped(2020-12-01) #

RecordStopped(2022-06-01) #

RecordStopped(2023-06-01) #

RecordStopped(2023-11-01) #

RecordUploadStarted #

RecordUploadProcessing #

RecordUploadDone #

RecordUploadBackuped #

RecordAudioStreamStateChanged #

RecordVideoStreamStateChanged #

RecordSyncUploadStarted #

RecordSyncUploadFailed #

房间相关 #

UserJoinRoom #

UserLeaveRoom #

InvisibleUserJoinRoom #

InvisibleUserLeaveRoom #

RoleChangeInvisible2Visible #

RoleChangeVisible2Invisible #

RoomCreate #

RoomDestroy #

音频切片相关 #

SegmentRealTimeData(2020-12-01) #

SegmentRealTimeData(2022-06-01) #

SegmentRealTimeData(2023-11-01) #

抽帧截图相关 #

SnapshotRealTimeData(2020-12-01) #

SnapshotRealTimeData(2022-06-01) #

SnapshotRealTimeData(2023-11-01) #

在线媒体流相关 #

RelayStreamStateChanged #

云录屏相关 #

Webcast #

转推直播相关 #

TranscodeStarted #

TranscodeStopped #

TranscodeUpdated #

TranscodeStateChanged #

WTN 流（原公共流）相关 #

PushPublicStream #

WTNStreamStart #

WTNStreamStop #

歌曲查询相关 #

MusicRemoved #

互动白板文件转码 #

WbTranscodeProgressChanged #

WbTranscodeFinished #

Image

对话式 AI #

音频流相关

UserAudioStreamStart

UserAudioStreamStop

视频流相关

UserVideoStreamStart

UserVideoStreamStop

屏幕音频流相关

UserScreenAudioStreamStart

UserScreenAudioStreamStop

屏幕视频流相关

UserScreenVideoStreamStart

UserScreenVideoStreamStop

录制相关

RecordStarted

RecordStopped(2020-12-01)

RecordStopped(2022-06-01)

RecordStopped(2023-06-01)

RecordStopped(2023-11-01)

RecordUploadStarted

RecordUploadProcessing

RecordUploadDone

RecordUploadBackuped

RecordAudioStreamStateChanged

RecordVideoStreamStateChanged

RecordSyncUploadStarted

RecordSyncUploadFailed

房间相关

UserJoinRoom

UserLeaveRoom

InvisibleUserJoinRoom

InvisibleUserLeaveRoom

RoleChangeInvisible2Visible

RoleChangeVisible2Invisible

RoomCreate

RoomDestroy

音频切片相关

SegmentRealTimeData(2020-12-01)

SegmentRealTimeData(2022-06-01)

SegmentRealTimeData(2023-11-01)

抽帧截图相关

SnapshotRealTimeData(2020-12-01)

SnapshotRealTimeData(2022-06-01)

SnapshotRealTimeData(2023-11-01)

在线媒体流相关

RelayStreamStateChanged

云录屏相关

Webcast

转推直播相关

TranscodeStarted

TranscodeStopped

TranscodeUpdated

TranscodeStateChanged

WTN 流（原公共流）相关

PushPublicStream

WTNStreamStart

WTNStreamStop

歌曲查询相关

MusicRemoved

互动白板文件转码

WbTranscodeProgressChanged

WbTranscodeFinished

对话式 AI