You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

消息事件参考

最近更新时间：2024.04.22 17:52:21

首次发布时间：2021.09.27 11:20:21

我的收藏

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

功能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录制视频流状态变化
房间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转推直播任务状态变化
公共流PushPublicStream公共流任务状态变化
歌曲查询MusicRemoved曲库下架歌曲列表
互动白板文件转码WbTranscodeProgressChanged文件转码进度
WbTranscodeFinished文件转码结束

音频流相关

UserAudioStreamStart

EventType

UserAudioStreamStart

事件详情

音频流开始推送。

EventData

参数名类型示例值描述
RoomIdStringYour_RoomId房间 ID
UserIdStringYour_UserId用户 ID
DeviceTypeStringandroid、ios、web、mac、windows终端类型
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)

参数示例

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Timestamp": "1611736812853"
}

UserAudioStreamStop

EventType

UserAudioStreamStop

事件详情

音频流结束推送。

EventData

参数名类型示例值描述
RoomIdStringYour_RoomId房间 ID
UserIdStringYour_UserId用户 ID
DeviceTypeStringandroid、ios、web、mac、windows终端类型
ReasonString音频流结束推送原因，参看Reason
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)


Reason

值含义
StreamStop正常流停止
LeaveRoom用户离开房间导致流停止
BannedByAdmin服务端封禁该音频流导致流停止

参数示例

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Reason": "StreamStop",
    "Timestamp": "1611736812853"
}

视频流相关

UserVideoStreamStart

EventType

UserVideoStreamStart

事件详情

视频流开始推送。

EventData

参数名类型示例值描述
RoomIdStringYour_RoomId房间 ID
UserIdStringYour_UserId用户 ID
DeviceTypeStringandroid、ios、web、mac、windows终端类型
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)

参数示例

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Timestamp": "1611736812853"
}

UserVideoStreamStop

EventType

UserVideoStreamStop

事件详情

视频流结束推送。

EventData

参数名类型示例值描述
RoomIdStringYour_RoomId房间 ID
UserIdStringYour_UserId用户 ID
DeviceTypeStringandroid、ios、web、mac、windows终端类型
ReasonString视频流结束推送原因，参看Reason
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)


Reason

值含义
StreamStop正常流停止
LeaveRoom用户离开房间导致流停止
BannedByAdmin服务端封禁该视频流导致流停止

参数示例

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Reason": "StreamStop",
    "Timestamp": "1611736812853"
}

屏幕音频流相关

UserScreenAudioStreamStart

EventType

UserScreenAudioStreamStart

事件详情

屏幕音频流开始推送。

EventData

参数名类型示例值描述
RoomIdStringYour_RoomId房间 ID
UserIdStringYour_UserId用户 ID
DeviceTypeStringandroid、ios、web、mac、windows终端类型
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)

参数示例

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Timestamp": "1611736812853"
}

UserScreenAudioStreamStop

EventType

UserScreenAudioStreamStop

事件详情

屏幕音频流结束推送。

EventData

参数名类型示例值描述
RoomIdStringYour_RoomId房间 ID
UserIdStringYour_UserId用户 ID
DeviceTypeStringandroid、ios、web、mac、windows终端类型
ReasonString屏幕音频流结束推送原因，参看Reason
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)

Reason

值含义
StreamStop正常流停止
LeaveRoom用户离开房间导致流停止
BannedByAdmin服务端封禁该屏幕音频流导致流停止

参数示例

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Reason": "StreamStop",
    "Timestamp": "1611736812853"
}

屏幕视频流相关

UserScreenVideoStreamStart

EventType

UserScreenVideoStreamStart

事件详情

屏幕视频流开始推送。

EventData

参数名类型示例值描述
RoomIdStringYour_RoomId房间 ID
UserIdStringYour_UserId用户 ID
DeviceTypeStringandroid、ios、web、mac、windows终端类型
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)

参数示例

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Timestamp": "1611736812853"
}

UserScreenVideoStreamStop

EventType

UserScreenVideoStreamStop

事件详情

屏幕视频流结束推送。

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

EventData

参数名类型示例值描述
RoomIdStringYour_RoomId房间 ID
UserIdStringYour_UserId用户 ID
DeviceTypeStringandroid、ios、web、mac、windows终端类型
ReasonString屏幕视频流结束推送原因，参看Reason
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)

Reason

值含义
StreamStop正常流停止
LeaveRoom用户离开房间导致流停止
BannedByAdmin服务端封禁该屏幕视频流导致流停止

参数示例

{
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "DeviceType": "android",
    "Reason": "StreamStop",
    "Timestamp": "1611736812853"
}

录制相关

RecordStarted

EventType

RecordStarted

事件详情

录制任务开始。

不同版本录制功能在任务开始时均触发此回调。

无论录制任务是通过何种方式启动的（调用 OpenAPI 启动/在控制台上配置自动录制），在录制任务开始时，你都会收到录制任务开始的消息通知。

EventData

参数名类型示例值描述
AppIdStringYour_AppId音视频应用的唯一标识
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId用户创建的房间 ID，房间的唯一标识
TaskIdStringYour_TaskId任务 ID，同一房间内的录制任务通过 TaskId 来区分
CodeInt320任务状态，值的集合为{0，1}。其中，0 表示成功, 1 表示失败
ErrorMessageString具体的错误信息。当 Code 不为 0 时，ErrorMessage 会显示具体的错误

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 0,
    "ErrorMessage": ""
}

RecordStopped(2020-12-01)

EventType

RecordStopped

事件详情

录制任务结束。

2020-12-01 版本录制功能在任务结束时触发此回调。

无论录制任务是通过何种方式启动的（调用 OpenAPI 启动/在控制台上配置自动录制），在录制任务结束时，你都会收到录制任务结束的消息通知。

EventData

参数名类型示例值描述
AppIdStringYour_AppId音视频应用的唯一标识
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId用户创建的房间 ID，房间的唯一标识
TaskIdStringYour_TaskId任务 ID，同一房间内的录制任务通过 TaskId 来区分
CodeInt320任务状态，值的集合为{0，1}。其中，0 表示成功, 1 表示失败
ErrorMessageString具体的错误信息。当 Code 不为 0 时，ErrorMessage 会显示具体的错误
RecordFileListArray of RecordFile录制生成的音视频文件列表

RecordFile

参数名称类型描述
VidString文件在点播平台的唯一标识。你可以根据 vid 可以在点播平台上找到对应的文件。
DurationUint64文件时长，单位为毫秒。
SizeUint64文件大小，单位为 byte。
StartTimeUint64文件开始录制的 UTC 时间，单位为毫秒。
StreamListArray of Stream录制文件中包含流的列表。
VideoCodecString视频录制编码协议。默认值为 0，可以取 0 或 1。取 0 时使用 H.264,取 1 时使用 ByteVC1 编码器。
AudioCodecString音频录制编码器
VideoWidthInt录制视频宽度，单位为像素
VideoHeightInt录制视频高度，单位为像素

Stream

参数名称类型必填示例值描述
IndexUint32否0在自定义布局中，使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中，你需要使用 Index 指定对应流的布局设置。
UserIdString是Your_UserId用户Id，表示这个流所属的用户。
StreamTypeUint32否0流的类型，值可以取0或1，默认值为0。0表示普通音视频流，1表示屏幕流。

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

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 0,
    "ErrorMessage": "",
    "RecordFileList": [
        {
            "Vid": "Your_Vid",
            "Duration": 57472,
            "Size": 5018305,
            "StartTime": 1611736812853,
            "StreamList": [
                {
                    "UserId": "TestUserId",
                    "StreamType": 0
                }
            ],
            "VideoCodec": "h264",
            "AudioCodec": "aac",
            "VideoWidth": 640,
            "VideoHeight": 360
        }
    ]
}

RecordStopped(2022-06-01)

EventType

RecordStopped

事件详情

录制任务结束。

2022-06-01 版本录制功能在任务结束时触发此回调。

无论录制任务是通过何种方式启动的（调用 OpenAPI 启动/在控制台上配置自动录制），在录制任务结束时，你都会收到录制任务结束的消息通知。

EventData

参数名类型示例值描述
AppIdStringYour_AppId音视频应用的唯一标识
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId用户创建的房间 ID，房间的唯一标识
TaskIdStringYour_TaskId任务 ID，同一房间内的录制任务通过 TaskId 来区分
CodeInt320任务状态，值的集合为{0，1}。其中，0 表示成功, 1 表示失败
ErrorMessageString/具体的错误信息。当 Code 不为 0 时，ErrorMessage 会显示具体的错误
RecordFileListArray of RecordFile/录制生成的音视频文件列表

RecordFile

参数名称类型描述
VidString文件在火山引擎视频点播 VOD 平台的唯一标识。你可以根据 vid 在点播平台上找到对应的文件。仅在你选择配置存储到 Vod 平台时，此参数有效。
ObjectKeyString文件在对象存储平台中的完整路径，如abc/efg/123.mp4。仅在你选择配置存储到对象存储平台时，此参数有效。
DurationUint64文件时长，单位为毫秒。
SizeUint64文件大小，单位为 byte。
StartTimeUint64文件开始录制的 UTC 时间，单位为毫秒。
StreamListArray of Stream录制文件中包含流的列表。
VideoCodecString视频录制编码协议
AudioCodecString音频录制编码器
VideoWidthInt录制视频宽度，单位为像素
VideoHeightInt录制视频高度，单位为像素

Stream

参数名称类型必填示例值描述
IndexUint32否0在自定义布局中，使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中，你需要使用 Index 指定对应流的布局设置。
UserIdString是Your_UserId用户Id，表示这个流所属的用户。
StreamTypeUint32否0流的类型，值可以取0或1，默认值为0。0表示普通音视频流，1表示屏幕流。

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

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 0,
    "ErrorMessage": "",
    "RecordFileList": [
        {
            "Vid": "Your_Vid",
            "ObjectKey": "TestObjectKey",
            "Duration": 57472,
            "Size": 5018305,
            "StartTime": 1611736812853,
            "StreamList": [
                {
                    "UserId": "TestUserId",
                    "StreamType": 0
                }
            ],
            "VideoCodec": "h264",
            "AudioCodec": "aac",
            "VideoWidth": 640,
            "VideoHeight": 360
        }
    ]
}

RecordStopped(2023-06-01)

EventType

RecordStopped

事件详情

录制任务结束。

2023-06-01 版本录制功能在任务结束时触发此回调。

无论录制任务是通过何种方式启动的（调用 OpenAPI 启动/在控制台上配置自动录制），在录制任务结束时，你都会收到录制任务结束的消息通知。

EventData

参数名类型示例值描述
AppIdStringYour_AppId音视频应用的唯一标识
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId用户创建的房间 ID，房间的唯一标识
TaskIdStringYour_TaskId任务 ID，同一房间内的录制任务通过 TaskId 来区分
CodeInt320任务状态，值的集合为{0，1}。其中，0 表示成功, 1 表示失败
ErrorMessageString/具体的错误信息。当 Code 不为 0 时，ErrorMessage 会显示具体的错误
RecordFileListArray of RecordFile/录制生成的音视频文件列表

RecordFile

参数名称类型描述
VidString文件在火山引擎视频点播 VOD 平台的唯一标识。你可以根据 vid 在点播平台上找到对应的文件。仅在你选择配置存储到 Vod 平台时，此参数有效。
ObjectKeyString文件在对象存储平台中的完整路径，如abc/efg/123.mp4。仅在你选择配置存储到对象存储平台时，此参数有效。
DurationUint64文件时长，单位为毫秒。
SizeUint64文件大小，单位为 byte。
StartTimeUint64文件开始录制的 UTC 时间，单位为毫秒。
StreamListArray of Stream录制文件中包含流的列表。
VideoCodecString视频录制编码协议
AudioCodecString音频录制编码器
VideoWidthInt录制视频宽度，单位为像素
VideoHeightInt录制视频高度，单位为像素

Stream

参数名称类型必填示例值描述
IndexUint32否0在自定义布局中，使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中，你需要使用 Index 指定对应流的布局设置。
UserIdString是Your_UserId用户Id，表示这个流所属的用户。
StreamTypeUint32否0流的类型，值可以取0或1，默认值为0。0表示普通音视频流，1表示屏幕流。

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

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 0,
    "ErrorMessage": "",
    "RecordFileList": [
        {
            "Vid": "Your_Vid",
            "ObjectKey": "TestObjectKey",
            "Duration": 57472,
            "Size": 5018305,
            "StartTime": 1611736812853,
            "StreamList": [
                {
                    "UserId": "TestUserId",
                    "StreamType": 0
                }
            ],
            "VideoCodec": "h264",
            "AudioCodec": "aac",
            "VideoWidth": 640,
            "VideoHeight": 360
        }
    ]
}

RecordStopped(2023-11-01)

EventType

RecordStopped

事件详情

录制任务结束。
2023-11-01 版本录制功能在任务结束时触发此回调。

无论录制任务是通过何种方式启动的（调用 OpenAPI 启动/在控制台上配置自动录制），在录制任务结束时，你都会收到录制任务结束的消息通知。

EventData

参数名类型示例值描述
AppIdStringYour_AppId音视频应用的唯一标识
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId用户创建的房间 ID，房间的唯一标识
TaskIdStringYour_TaskId任务 ID，同一房间内的录制任务通过 TaskId 来区分
CodeInt320任务状态，值的集合为{0，1}。其中，0 表示成功, 1 表示失败
ErrorMessageString/具体的错误信息。当 Code 不为 0 时，ErrorMessage 会显示具体的错误
RecordFileListArray of RecordFile/录制生成的音视频文件列表

RecordFile

参数名称类型描述
VidString文件在火山引擎视频点播 VOD 平台的唯一标识。你可以根据 vid 在点播平台上找到对应的文件。仅在你选择配置存储到 Vod 平台时，此参数有效。
ObjectKeyString文件在对象存储平台中的完整路径，如abc/efg/123.mp4。仅在你选择配置存储到对象存储平台时，此参数有效。
DurationUint64文件时长，单位为毫秒。
SizeUint64文件大小，单位为 byte。
StartTimeUint64文件开始录制的 UTC 时间，单位为毫秒。
StreamListArray of Stream录制文件中包含流的列表。
VideoCodecString视频录制编码协议
AudioCodecString音频录制编码器
VideoWidthInt录制视频宽度，单位为像素
VideoHeightInt录制视频高度，单位为像素

Stream

参数名称类型必填示例值描述
IndexUint32否0在自定义布局中，使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中，你需要使用 Index 指定对应流的布局设置。
UserIdString是Your_UserId用户Id，表示这个流所属的用户。
StreamTypeUint32否0流的类型，值可以取0或1，默认值为0。0表示普通音视频流，1表示屏幕流。

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

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 0,
    "ErrorMessage": "",
    "RecordFileList": [
        {
            "Vid": "Your_Vid",
            "ObjectKey": "TestObjectKey",
            "Duration": 57472,
            "Size": 5018305,
            "StartTime": 1611736812853,
            "StreamList": [
                {
                    "UserId": "TestUserId",
                    "StreamType": 0
                }
            ],
            "VideoCodec": "h264",
            "AudioCodec": "aac",
            "VideoWidth": 640,
            "VideoHeight": 360
        }
    ]
}

RecordUploadStarted

EventType

RecordUploadStarted

事件详情

上传任务启动。

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

EventData

参数名类型示例值描述
AppIdStringYour_AppId音视频应用的唯一标识
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId用户创建的房间 ID，房间的唯一标识
TaskIdStringYour_TaskId任务 ID，同一房间内的录制任务通过 TaskId 来区分
CodeInt320任务状态，值的集合为{0，1}。其中，0 表示成功, 1 表示失败
ErrorMessageString具体的错误信息。当 Code 不为 0 时，ErrorMessage 会显示具体的错误

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 1,
    "ErrorMessage": ""
}

RecordUploadProcessing

EventType

RecordUploadProcessing

事件详情
上传任务进度。

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

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

EventData

参数名类型示例值描述
AppIdStringYour_AppId音视频应用的唯一标识
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId用户创建的房间 ID，房间的唯一标识
TaskIdStringYour_TaskId任务 ID，同一房间内的录制任务通过 TaskId 来区分
CodeInt320任务状态，值的集合为{0，1}。其中，0 表示成功, 1 表示失败
ErrorMessageString具体的错误信息。当 Code 不为 0 时，ErrorMessage 会显示具体的错误
ProgressInt1000 到 10000 之间的数字，当前已上传文件与已录制的文件的比例乘以 10000。这个数字是不断变动的，录制完成后，到达 10000 表示上传完成。

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 1,
    "ErrorMessage": "",
    "Progress" : 100
}

RecordUploadDone

EventType

RecordUploadDone

事件详情

录制文件已上传至存储平台。

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

EventData

参数名类型示例值描述
AppIdStringYour_AppId音视频应用的唯一标识
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId用户创建的房间 ID，房间的唯一标识
TaskIdStringYour_TaskId任务 ID，同一房间内的录制任务通过 TaskId 来区分
CodeInt320任务状态，值的集合为{0，1}。其中，0 表示成功, 1 表示失败
ErrorMessageString具体的错误信息。当 Code 不为 0 时，ErrorMessage 会显示具体的错误

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 1,
    "ErrorMessage": ""
}

RecordUploadBackuped

EventType

RecordUploadBackuped

事件详情

录制文件上传失败转存备份

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

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

EventData

参数名类型示例值描述
AppIdStringYour_AppId音视频应用的唯一标识
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId用户创建的房间 ID，房间的唯一标识
TaskIdStringYour_TaskId任务 ID，同一房间内的录制任务通过 TaskId 来区分
CodeInt320任务状态，值的集合为{0，1}。其中，0 表示成功, 1 表示失败
ErrorMessageString具体的错误信息。当 Code 不为 0 时，ErrorMessage 会显示具体的错误

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Code": 1,
    "ErrorMessage": ""
}

RecordAudioStreamStateChanged

EventType

RecordAudioStreamStateChanged

事件详情

录制音频流状态变化

EventData

参数名类型示例值描述
AppIdStringYour_AppId音视频应用的唯一标识
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId用户创建的房间 ID，房间的唯一标识
TaskIdStringYour_TaskId任务 ID，同一房间内的录制任务通过 TaskId 来区分
UserIdStringYour_UserId用户 ID
StreamTypeInt0音频流类型。
  • 0：麦克风采集流
  • 1：屏幕流
StateInt0任务状态。
  • 0：音频流停止发布
  • 1：音频流正在发布
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "UserId": "Your_UserId,
    "StreamType": 0,
    "State": 0,  
    "Timestamp": "1611736812853"     
}

RecordVideoStreamStateChanged

EventType

RecordVideoStreamStateChanged

事件详情

录制视频流状态变化

EventData

参数名类型示例值描述
AppIdStringYour_AppId音视频应用的唯一标识
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId用户创建的房间 ID，房间的唯一标识
TaskIdStringYour_TaskId任务 ID，同一房间内的录制任务通过 TaskId 来区分
UserIdStringYour_UserId用户 ID
StreamTypeInt0视频流类型。
  • 0：摄像头采集流
  • 1：屏幕流
StateInt0任务状态。
  • 0：视频流停止发布
  • 1：视频流正在发布
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "UserId": "Your_UserId,
    "StreamType": 0,
    "State": 0,  
    "Timestamp": "1611736812853"     
}

房间相关

UserJoinRoom

EventType

UserJoinRoom

事件详情

可见用户进入房间。

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

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

EventData

参数类型示例值说明
RoomIdString6992870232038591758房间 ID
UserIdString4398491447867063用户 ID
DeviceTypeStringandroid/ios/web/mac/windows终端类型
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)
UserExtraInfoStringYour_UserExtraInfo客户端 SDK 通过 joinRoom 传入的用户附加信息

参数示例

{
    "RoomId": "6992870232038591758",
    "UserId": "4398491447867063",
    "DeviceType": "android",
    "Timestamp": "1611736812853",
    "UserExtraInfo":"Your_UserExtraInfo"
}

UserLeaveRoom

EventType

UserLeaveRoom

事件详情

可见用户退出房间。

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

EventData

参数类型示例值说明
RoomIdString6992870232038591758房间 ID
UserIdString4398491447867063用户 ID
DeviceTypeStringandroid/ios/web/mac/windows终端类型
ReasonString原因。参看 Reason
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)

Reason:

值含义
userLeave正常退房
connectionLost因断网、杀进程等异常原因离开房间。用户离开房间 30 s 后触发此回调。
kickedByAdmin使用 OpenAPI 接口将某用户踢出房间
roomDismissByAdmin使用 OpenAPI 接口解散房间，将房间内所有用户踢出房间
onUserTokenDidExpireToken 过期被踢出房间
other其他原因

参数示例

{
    "RoomId": "6992870232038591758",
    "UserId": "4398491447867063",
    "DeviceType": "android",
    "Reason": "userLeave",
    "Timestamp": "1611736812853"
}

InvisibleUserJoinRoom

EventType

InvisibleUserJoinRoom

事件详情

不可见用户进入房间。

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

EventData

参数类型示例值说明
RoomIdString6992870232038591758房间 ID
UserIdString4398491447867063用户 ID
DeviceTypeStringandroid/ios/web/mac/windows终端类型
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)
UserExtraInfoStringYour_UserExtraInfo客户端 SDK 通过 joinRoom 传入的用户附加信息

参数示例

{
    "RoomId": "6992870232038591758",
    "UserId": "4398491447867063",
    "DeviceType": "android",
    "Timestamp": "1611736812853",
    "UserExtraInfo":"Your_UserExtraInfo"
}

InvisibleUserLeaveRoom

EventType

InvisibleUserLeaveRoom

事件详情

不可见用户退出房间。

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

EventData

参数类型示例值说明
RoomIdString6992870232038591758房间 ID
UserIdString4398491447867063用户 ID
DeviceTypeStringandroid/ios/web/mac/windows终端类型
ReasonString原因。参看 Reason
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)

Reason:

值含义
userLeave正常退房
connectionLost因断网、杀进程等异常原因离开房间。用户离开房间 30 s 后触发此回调。
kickedByAdmin使用 OpenAPI 接口将某用户踢出房间
roomDismissByAdmin使用 OpenAPI 接口解散房间，将房间内所有用户踢出房间
onUserTokenDidExpireToken 过期被踢出房间
other其他原因

参数示例

{
    "RoomId": "6992870232038591758",
    "UserId": "4398491447867063",
    "DeviceType": "android",
    "Reason": "userLeave",
    "Timestamp": "1611736812853"
}

RoleChangeInvisible2Visible

EventType

RoleChangeInvisible2Visible

事件详情

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

EventData

参数类型示例值说明
RoomIdString6992870232038591758房间 ID
UserIdString4398491447867063用户 ID
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)

参数示例

{
    "RoomId": "6992870232038591758",
    "UserId": "4398491447867063",
    "Timestamp": "1611736812853"
}

RoleChangeVisible2Invisible

EventType

RoleChangeVisible2Invisible

事件详情

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

EventData

参数类型示例值说明
RoomIdString6992870232038591758房间 ID
UserIdString4398491447867063用户 ID
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)

参数示例

{
    "RoomId": "6992870232038591758",
    "UserId": "4398491447867063",
    "Timestamp": "1611736812853"
}

RoomCreate

EventType

RoomCreate

事件详情

RTC 房间创建。

EventData

参数类型示例值说明
RoomIdString6992870232038591758房间 ID
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)

参数示例

{
    "RoomId": "6992870232038591758",
    "Timestamp": "1611736812853"
}

RoomDestroy

EventType

RoomDestroy

事件详情

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

EventData

参数类型示例值说明
RoomIdString6992870232038591758房间 ID
TimestampInt641611736812853该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)

参数示例

{
    "RoomId": "6992870232038591758",
    "Timestamp": "1611736812853"
}

音频切片相关

SegmentRealTimeData(2020-12-01)

EventType

SegmentRealTimeData

事件详情

指定音频流切片结果。

EventData

参数名类型示例值描述
AppIdStringYour_AppId应用的唯一标志
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId房间 ID，是房间的唯一标志
TaskIdStringYour_TaskId切片任务 ID。
TosBucketStringYour_TosBucket储存切片的 tos bucket
Dataarray of AudioData/
IdentifierStringYour_Identifier切片任务标志。若未自定义切片名，切片名默认为 UUID，自定义切片名时为自定义名称。自定义切片文件名由 Identifier + UserId + 时间戳 + 序号组成。默认情况下 Identifier 为 随机生成的 UUID。在自定义文件名时，Identifier 的命名规则符合正则表达式：[a-zA-Z0-9_@-.]{1,128}。

AudioData

参数名类型示例值描述
StreamStream/音频切片对应的流的信息。
ObjectKeyStringYour_ObjectKey音频切片的文件名。
SampleRateInt44100音频采样率，单位 Hz。
BitsPerSampleInt16每个音频采样的比特数。
ChannelsInt2音频声道数。
SizeUint64256044音频切片大小，单位为 byte。
TimeStampInt641647317680214音频文件生成时对应的UNIX时间戳。单位为毫秒
DurationUint328000音频的时长，单位为毫秒。

Stream

参数名称类型必填示例值描述
IndexUint32否0在自定义布局中，使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中，你需要使用 Index 指定对应流的布局设置。
UserIdString是Your_UserId用户Id，表示这个流所属的用户。
StreamTypeUint32否0流的类型，值可以取0或1，默认值为0。0表示普通音视频流，1表示屏幕流。

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "TosBucket": "Your_TosBucket",
    "Data": [
        {
            "Stream": {
                "UserId": "Your_UserId",
                "StreamType": 0
            },
            "ObjectKey": "Your_ObjectKey",
            "SampleRate": "44100",
            "BitsPerSample": "16",
            "Channels": "2",
            "Size": 256044,
            "TimeStamp": 1647317680214,
            "Duration": 8000
        }
    ], 
    "Identifier": "Your_Identifier" }

SegmentRealTimeData(2022-06-01)

EventType

SegmentRealTimeData

事件详情

指定音频流切片结果。

EventData

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

AudioData

参数名类型示例值描述
StreamStream/音频切片对应的流的信息。
ObjectKeyStringYour_ObjectKey音频切片的对象键。
SampleRateInt44100音频采样率，单位 Hz。
BitsPerSampleInt16每个音频采样的比特数。
ChannelsInt2音频声道数。
SizeUint64256044音频切片大小，单位为 byte。
TimeStampInt641647317680214音频文件生成时对应的UNIX时间戳。单位为毫秒
DurationUint328000音频的时长，单位为毫秒。

Stream

参数名称类型必填示例值描述
IndexUint32否0在自定义布局中，使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中，你需要使用 Index 指定对应流的布局设置。
UserIdString是Your_UserId用户Id，表示这个流所属的用户。
StreamTypeUint32否0流的类型，值可以取0或1，默认值为0。0表示普通音视频流，1表示屏幕流。

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Bucket": "Your_Bucket",
    "Data": [
        {
            "Stream": {
                "UserId": "Your_UserId",
                "StreamType": 0
            },
            "ObjectKey": "Your_ObjectKey",
            "SampleRate": "44100",
            "BitsPerSample": "16",
            "Channels": "2",
            "Size": 256044,
            "TimeStamp": 1647317680214,
            "Duration": 8000
        }
    ], 
    "Identifier": "Your_Identifier" 
    }

SegmentRealTimeData(2023-11-01)

EventType

SegmentRealTimeData

事件详情

指定音频流切片结果。

EventData

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

AudioData

参数名类型示例值描述
StreamStream/音频切片对应的流的信息。
ObjectKeyStringYour_ObjectKey音频切片的对象键。
SampleRateInt44100音频采样率，单位 Hz。
BitsPerSampleInt16每个音频采样的比特数。
ChannelsInt2音频声道数。
SizeUint64256044音频切片大小，单位为 byte。
TimeStampInt641647317680214音频文件生成时对应的UNIX时间戳。单位为毫秒
DurationUint328000音频的时长，单位为毫秒。

Stream

参数名称类型必填示例值描述
IndexUint32否0在自定义布局中，使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中，你需要使用 Index 指定对应流的布局设置。
UserIdString是Your_UserId用户Id，表示这个流所属的用户。
StreamTypeUint32否0流的类型，值可以取0或1，默认值为0。0表示普通音视频流，1表示屏幕流。

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Bucket": "Your_Bucket",
    "Data": [
        {
            "Stream": {
                "UserId": "Your_UserId",
                "StreamType": 0
            },
            "ObjectKey": "Your_ObjectKey",
            "SampleRate": "44100",
            "BitsPerSample": "16",
            "Channels": "2",
            "Size": 256044,
            "TimeStamp": 1647317680214,
            "Duration": 8000
        }
    ], 
    "Identifier": "Your_Identifier" 
    }

抽帧截图相关

SnapshotRealTimeData(2020-12-01)

EventType

SnapshotRealTimeData

事件详情

指定视频流截图结果。

EventData

参数名类型示例值描述
AppIdStringYour_AppId应用的唯一标志
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId房间 ID，是房间的唯一标志
TaskIdStringYour_TaskId截图任务 ID
TosBucketStringYour_TosBucket储存截图的 TOS bucket
Dataarray of ImageData

ImageData

参数名类型示例值描述
StreamStream/截图对应的流的信息。
ObjectKeyStringYour_ObjectKey截图对应的 TOS key。
FormatUint320截图格式。
  • 0: JPEG
  • 1: PNG
WidthUint32640截图宽度，单位为像素。
HeightUint32360截图高度，单位为像素。
SizeUint6428802截图大小，单位为 byte。
TimeStampUint641647316896085截图生成时对应的 UNIX 时间戳。

Stream

参数名称类型必填示例值描述
IndexUint32否0在自定义布局中，使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中，你需要使用 Index 指定对应流的布局设置。
UserIdString是Your_UserId用户Id，表示这个流所属的用户。
StreamTypeUint32否0流的类型，值可以取0或1，默认值为0。0表示普通音视频流，1表示屏幕流。

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "TosBucket": "Your_TosBucket",
    "Data": [
        {
            "Stream": {
                "UserId": "Your_UserId",
                "StreamType": 0
            },
            "ObjectKey": "Your_ObjectKey",
            "Format": 0,
            "Width": 640,
            "Height": 360,
            "Size": 28802,
            "TimeStamp": 1647316896085
        }
    ]
}

SnapshotRealTimeData(2022-06-01)

EventType

SnapshotRealTimeData

事件详情

指定视频流截图结果。

EventData

参数名类型示例值描述
AppIdStringYour_AppId应用的唯一标志
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId房间 ID，是房间的唯一标志
TaskIdStringYour_TaskId截图任务 ID
BucketStringYour_Bucket存储截图的桶名称。当存储平台为 TOS，或者支持 S3 协议的第三方存储平台时此字段才会生效。
VeImageXServiceIdString/VeImageX 的服务 ID。当存储平台为 VeImageX 时此字段才会生效。
Dataarray of ImageData

ImageData

参数名类型示例值描述
StreamStream/截图对应的流的信息。
ObjectKeyStringYour_ObjectKey对象键名称。当存储平台为 TOS，或者支持 S3 协议的第三方存储平台时此字段才会生效，你可以根据 ObjecetKey 找到对应的图片文件。
VeImageXUriStringYour_VeImageXUriVeImageX 的统一资源标识符。当存储平台为 VeImageX 时此字段才会生效，你可以根据 VeImageXUri找到对应的图片文件。
FormatUint320截图格式。
  • 0: JPEG
  • 1: PNG
WidthUint32640截图宽度，单位为像素。
HeightUint32360截图高度，单位为像素。
SizeUint6428802截图大小，单位为 byte。
TimeStampUint641647316896085截图生成时对应的 UNIX 时间戳。

Stream

参数名称类型必填示例值描述
IndexUint32否0在自定义布局中，使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中，你需要使用 Index 指定对应流的布局设置。
UserIdString是Your_UserId用户Id，表示这个流所属的用户。
StreamTypeUint32否0流的类型，值可以取0或1，默认值为0。0表示普通音视频流，1表示屏幕流。

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Bucket": "Your_Bucket",
    "Data": [
        {
            "Stream": {
                "UserId": "Your_UserId",
                "StreamType": 0
            },
            "ObjectKey": "Your_ObjectKey",
            "Format": 0,
            "Width": 640,
            "Height": 360,
            "Size": 28802,
            "TimeStamp": 1647316896085
        }
    ]
}

SnapshotRealTimeData(2023-11-01)

EventType

SnapshotRealTimeData

事件详情

指定视频流截图结果。

EventData

参数名类型示例值描述
AppIdStringYour_AppId应用的唯一标志
BusinessIdStringYour_BusinessId业务标识
RoomIdStringYour_RoomId房间 ID，是房间的唯一标志
TaskIdStringYour_TaskId截图任务 ID
BucketStringYour_Bucket存储截图的桶名称。当存储平台为 TOS，或者支持 S3 协议的第三方存储平台时此字段才会生效。
VeImageXServiceIdString/VeImageX 的服务 ID。当存储平台为 VeImageX 时此字段才会生效。
Dataarray of ImageData

ImageData

参数名类型示例值描述
StreamStream/截图对应的流的信息。
ObjectKeyStringYour_ObjectKey对象键名称。当存储平台为 TOS，或者支持 S3 协议的第三方存储平台时此字段才会生效，你可以根据 ObjecetKey 找到对应的图片文件。
VeImageXUriStringYour_VeImageXUriVeImageX 的统一资源标识符。当存储平台为 VeImageX 时此字段才会生效，你可以根据 VeImageXUri找到对应的图片文件。
FormatUint320截图格式。
  • 0: JPEG
  • 1: PNG
WidthUint32640截图宽度，单位为像素。
HeightUint32360截图高度，单位为像素。
SizeUint6428802截图大小，单位为 byte。
TimeStampUint641647316896085截图生成时对应的 UNIX 时间戳。

Stream

参数名称类型必填示例值描述
IndexUint32否0在自定义布局中，使用 Index 对流进行标志。后续在 Layout.regions.StreamIndex 中，你需要使用 Index 指定对应流的布局设置。
UserIdString是Your_UserId用户Id，表示这个流所属的用户。
StreamTypeUint32否0流的类型，值可以取0或1，默认值为0。0表示普通音视频流，1表示屏幕流。

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Bucket": "Your_Bucket",
    "Data": [
        {
            "Stream": {
                "UserId": "Your_UserId",
                "StreamType": 0
            },
            "ObjectKey": "Your_ObjectKey",
            "Format": 0,
            "Width": 640,
            "Height": 360,
            "Size": 28802,
            "TimeStamp": 1647316896085
        }
    ]
}

在线媒体流相关

RelayStreamStateChanged

EventType

RelayStreamStateChanged

事件详情

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

EventData

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

参数示例

{
        "AppId": "Your_AppId",
        "EventId": "Your_eventId",
        "EventTime": "2021-08-17T19:22:02+08:00",
        "EventType": "RelayStreamStateChanged",
        "EventData": {
                "RoomId": "Your_RoomId",
                "TaskId": "Your_TaskId",  
                "UserId": "Your_UserId",    
                "StreamUrl": "rtmp://xxx",        
                "Status": 1,
                "StartTimeStamp": 0,       
                "Msg": "",
                "Vid": "xxxxvvv"，
                "Reason": 4
        },
}

云录屏相关

Webcast

EventType

Webcast

事件详情

云录屏任务状态发生变化

EventData

参数名类型示例值描述
AppIdStringYour_AppId应用的唯一标志
RoomIdStringYour_RoomId房间 ID，是房间的唯一标志
BusinessIdStringYour_BusinessId业务标识
TaskIdStringYour_TaskId任务 ID
StatusInt1任务状态：
1：开始转推
2：正常结束
3：异常结束
4：页面刷新
5：任务重调度（推流用户重新进房）
ReasonString/异常结束描述信息，当 Status = {3,4,5} 时才有值，枚举值为 {：AudioCaptureModuleError、 WebRenderModuleError、SourceURLInaccessible、StartEventTimeout、PageBlank、PageCrash、PageFreeze} 。

参数示例

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "Status": 1
}

转推直播相关

TranscodeStarted

EventType

TranscodeStarted

事件详情

通过调用 RTC 服务端 OpenAPI 或客户端 SDK 的 API 发起的转推直播任务开始。

不同版本转推直播功能在转推直播任务开始时均触发此回调。

EventData

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

参数示例

{
 	"AppId": "Your_AppID",  
    "RoomId": "Your_RoomID",
    "TaskId": "Your_TaskID",
    "Timestamp": 1661150097044,
    "PushURL": "rtmp://xxxx",    
    "Code": 0,
    "ErrorMessage": ""
}

TranscodeStopped

EventType

TranscodeStopped

事件详情

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

EventData

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

参数示例

{
 	"AppId":"Your_AppID",
    "RoomId":"Your_RoomID",
    "TaskId":"Your_TaskID",
    "Timestamp":1661150097044,
    "PushURL": "rtmp://xxxx",    
    "Code":0,
    "ErrorMessage":""
}

TranscodeUpdated

EventType

TranscodeUpdated

事件详情

通过调用 RTC 服务端 OpenAPI 或客户端 SDK 的 API 更新了合流转推任务。

不同版本转推直播功能在转推直播任务更新时均触发此回调。

EventData

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

参数示例

{
    "AppId": "Your_AppID",
    "RoomId": "Your_RoomID", 
    "TaskId": "Your_TaskID",  
    "Timestamp": 1661150055041,   
    "PushURL": "rtmp://xxxx", 
    "Code": 0,
    "ErrorMessage": ""
}

TranscodeStateChanged

EventType

TranscodeStateChanged

事件详情

转推直播任务状态变化通知。

不同版本转推直播功能在转推直播任务状态变化时均触发此回调。

状态变化包括用户主动调用 RTC 服务端 OpenAPI 或客户端 SDK 的 API 更新了合流转推任务参数。也包括任务执行过程中出现的状态流转。

EventData

参数名类型示例值描述
AppIdStringYour_AppId应用的唯一标志
RoomIdStringYour_RoomId房间 ID，是房间的唯一标志
TaskIdStringYour_TaskId转推直播任务 ID。通过服务端发起时，该值为调用 OpenAPI 时传入的 TaskId。通过客户端 SDK 发起时， TaskId 是按照 userId@@taskId 格式拼接而成的字符串；当传入的 taskId 为空时，这里的 TaskId 为 userId。
TimestampInt641661150097044该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)
StartTimeInt641661150054990转推直播任务创建的 Unix 时间戳（ms）
FinishTimeInt640转推直播任务结束的 Unix 时间戳（ms）
PushURLStringrtmp://xxxx推流 CDN 地址。该参数当前仅在合流转推下返回。
TaskStateInt2任务状态，枚举值为 {1，2，3，4}。
  • 1：尚未开始推流或已停止推流。
  • 2：正在重连 CDN 服务。
  • 3：正在推流
  • 4：当前推流地址已切换。此时 ErrorMessage 字段中会显示切换前后的推流地址。
CodeInt0错误码。枚举值为 {0，1，2，3，4，9999}。
  • 0：请求处理成功。
  • 1：参数校验发生错误。
  • 2：订阅不到合流用户的输入流或输入流没有音视频数据。
  • 3：任务执行过程出现错误。
  • 4：更新 AV 参数后重推失败 或者 CDN 服务异常、请求连接失败。
  • 9999：其他系统异常。
ErrorMessageString具体错误信息。

参数示例

{
    "AppId": "Your_AppID",
    "RoomId": "Your_RoomID", 
    "TaskId": "Your_TaskID",  
    "Timestamp": 1661150097044, 
    "StartTime": 1661150054990,
    "FinishTime": 0,   
    "PushURL": "rtmp://xxxx", 
    "TaskState": 3,    
    "Code": 0,
    "ErrorMessage": ""
}

公共流相关

PushPublicStream

EventType
PushPublicStream

事件详情

公共流推送异常或推送结束

EventData

参数名类型示例值描述
AppIdStringYour_AppId应用的唯一标志
BusinessIdStringYour_BusinessId业务标识
PublicStreamIdStringYour_PublicStreamId公共流对应的流 Id
TimestampInt641661150097044该事件在 RTC 服务器上发生的 Unix 时间戳 (ms)
StatusInt2公共流任务状态。枚举值为 {2,3}。
  • 2：公共流推送结束
  • 3：公共流推送异常
    • MsgString具体的错误信息
    CodeInt2错误码。枚举值为 {1，2，3}。
  • 1：空闲超时结束。
  • 2：OpenAPI 调用结束。
  • 3：内部错误结束。

    • 参数示例

    {
    "AppId":"Your_AppID", 
    "BusinessId":"Your_BusinessId",    
    "PublicStreamId":"Your_PublicStreamId", 
    "Timestamp":1661150097044, 
    "Status":2, 
    "Msg":"call api stop",     
    "Code":2
}

    歌曲查询相关

    MusicRemoved

    EventType
    MusicRemoved

    事件详情

    曲库下架歌曲列表

    EventData

    参数名类型示例值描述
    AppIdStringYour_AppId应用的唯一标志
    TimestampInt1611736812853该事件在 RTC 服务器上发生的时间戳，Unix 时间，单位为毫秒
    SongUpdateArray of SongUpdate/下架歌曲详细信息

    SongList

    参数名类型示例值描述
    SongIdStringYour_SongId歌曲 ID
    VendorIdInt1供应商 ID
    UpdateAtInt1611736812853歌曲更新时间戳，Unix 时间，单位为毫秒

    参数示例

    {
    "AppId": "Your_AppId",
    "Timestamp": 1611736812853,
    "SongUpdate": [
        {
            "SongId": "Your_SongId",
            "VendorId": 2,
            "UpdateAt": 1611736812853
        }
    ]
}

    互动白板文件转码

    WbTranscodeProgressChanged

    EventType
    WbTranscodeProgressChanged

    事件详情

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

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

    EventData

    参数名类型示例值描述
    TaskIdString5f848de8-4258-4c41-964b-80556552ae82任务唯一标识

    TranscodeMode

    Int

    0

    0：静态转码
    1：动态转码

    ProgressInt0进度：当前页数/总页数 *100%。对于动态转码任务，取值为 0 或 100。
    FileNameStringdemo源文件文件名
    TotalPagesInt5总页数。对静态转码任务有效。

    WbTranscodeFinished

    EventType

    WbTranscodeFinished

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

    EventData

    参数名类型示例值描述
    TaskIdString5f848de8-4258-4c41-964b-80556552ae82任务唯一标识

    TranscodeMode

    Int

    0

    0：静态转码
    1：动态转码

    FileNameStringdemo源文件文件名
    FileIdString001动态转码文件ID。对动态转码任务有效。
    TotalPagesInt5总页数。
    WidthInt640分辨率宽，单位：像素。对静态转码任务有效。
    HeightInt360分辨率高，单位：像素。对静态转码任务有效。
    ThumbnailWidthint64缩略图分辨率宽，单位：像素
    ThumbnailHeightint64缩略图分辨率高，单位：像素

    Images

    Array of Image

    None

    转码图片结果

    • 静态转码缩略图 URL。
    • 动态转码指定缩略图时，返回缩略图 URL。不指定则为空
    ErrCodeNInt400错误码编号，含义见白板错误码
    ErrCodeStringInvalidParameter错误码类型，含义见白板错误码
    ErrMsgString和错误参数有关的信息错误码信息，含义见白板错误码

    Image

    参数名类型示例值描述
    PageIdInt1页数，从1开始编号
    ImgStringhttps://example.com/demo.png转码图片URL
    ThumbnailUrlStringhttps://example.com/thumbnail.png转码缩略图URL，如没有指定缩略图，则为空

    音频流相关

    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

    房间相关

    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

    公共流相关

    PushPublicStream

    歌曲查询相关

    MusicRemoved

    互动白板文件转码

    WbTranscodeProgressChanged

    WbTranscodeFinished