api/bytertc_event_define library

Typedefs

EmptyCallbackType = void Function()

Empty Callback

OnActiveSpeakerType = void Function(String roomId, String uid)

roomId：最活跃用户所在的房间 ID

OnAudioDeviceStateChangedType = void Function(String deviceId, AudioDeviceType deviceType, MediaDeviceState deviceState, MediaDeviceError deviceError)

deviceId：设备 ID

OnAudioDeviceWarningType = void Function(String deviceId, AudioDeviceType deviceType, MediaDeviceWarning deviceWarning)

deviceId：设备 ID

OnAudioMixingPlayingProgressType = void Function(int mixId, int progress)

mixId：混音任务 ID

OnAudioMixingStateChangedType = void Function(int mixId, AudioMixingState state, AudioMixingError error)

mixId：混音任务 ID

OnAudioRecordingStateUpdateType = void Function(AudioRecordingState state, AudioRecordingErrorCode errorCode)

state：录制状态

OnAudioRouteChangedType = void Function(AudioRoute route)

route：新的音频播放路由

OnAudioStreamBannedType = void Function(String uid, bool banned)

uid：被封禁/解禁的音频流用户 ID

OnAVSyncStateChangeType = void Function(AVSyncState state)

state：音视频同步状态

OnBinaryMessageReceivedType = void Function(String uid, Uint8List message)

uid：消息发送用户的 ID

OnCloudProxyConnectedType = void Function(int interval)

interval：从开启云代理到连接成功经过的时间，单位为 ms

OnConnectionStateChanged = void Function(RTCConnectionState state)

state：当前 SDK 与信令服务器连接状态

OnCreateRoomStateChangedType = void Function(String roomId, int errorCode)

roomId：发生错误的房间 ID

OnEchoTestResultType = void Function(EchoTestResult result)

result：检测结果

OnErrorMsgType = void Function(int errorCode, String errorMessage)

errorCode：错误码

OnErrorType = void Function(ErrorCode code)

code：错误码

OnExtensionAccessErrorType = void Function(String extensionName, String msg)

extensionName：插件名字。

OnFaceDetectResultType = void Function(FaceDetectionResult result)

result：人脸检测结果

OnFirstLocalAudioFrameType = void Function(StreamIndex index)

index：音频流属性

OnFirstLocalVideoFrameCapturedType = void Function(StreamIndex streamIndex, VideoFrameInfo videoFrameInfo)

streamIndex：流属性

OnFirstPublicStreamAudioFrameType = void Function(String publicStreamId)

publicStreamId：公共流 ID

OnFirstPublicStreamVideoFrameDecodedType = void Function(String publicStreamId, VideoFrameInfo videoFrameInfo)

publicStreamId：公共流 ID

OnFirstRemoteAudioFrameType = void Function(RemoteStreamKey streamKey)

streamKey：远端音频流信息

OnFirstRemoteVideoFrameRenderedType = void Function(RemoteStreamKey streamKey, VideoFrameInfo videoFrameInfo)

streamKey：远端流信息

OnForwardStreamEventType = void Function(List<ForwardStreamEventInfo> eventInfos)

eventInfos：跨房间媒体流转发目标房间事件数组

OnForwardStreamStateChangedType = void Function(List<ForwardStreamStateInfo> stateInfos)

stateInfos：跨房间媒体流转发目标房间信息数组

OnGetPeerOnlineStatusType = void Function(String peerUid, UserOnlineStatus status)

peerUid：需要查询的用户 ID

OnHardwareEchoDetectionResultType = void Function(HardwareEchoDetectionResult result)

result：通话前回声检测结果。详见 HardwareEchoDetectionResult。

OnHttpProxyStateType = void Function(int state)

state：当前 HTTP 代理连接状态

OnHttpsProxyStateType = void Function(int state)

state：当前 HTTPS 代理连接状态

OnLeaveRoomType = void Function(RTCRoomStats stats)

stats：保留参数，目前为空。

OnLicenseWillExpireType = void Function(int days)

days：过期时间天数

OnLocalAudioPropertiesReportType = void Function(List<LocalAudioPropertiesInfo> audioPropertiesInfos)

audioPropertiesInfos：本地音频信息

OnLocalAudioStateChangedType = void Function(LocalAudioStreamState state, LocalAudioStreamError error)

state：本地音频设备的状态

OnLocalProxyStateChangedType = void Function(LocalProxyType localProxyType, LocalProxyState localProxyState, LocalProxyError localProxyError)

localProxyType：本地代理类型。

OnLocalStreamStatsType = void Function(LocalStreamStats stats)

stats：音视频流以及网络状况统计信息

OnLocalVideoSizeChangedType = void Function(StreamIndex streamIndex, VideoFrameInfo videoFrameInfo)

streamIndex：流属性

OnLocalVideoStateChangedType = void Function(StreamIndex index, LocalVideoStreamState state, LocalVideoStreamError error)

index：流属性

OnLoginResultType = void Function(String uid, LoginErrorCode errorCode, int elapsed)

uid：登录用户 ID

OnLogoutType = void Function(LogoutReason reason)

reason：登出原因

OnMediaFramePlayStateChangedType = void Function(String roomId, UserInfo userInfo, FirstFramePlayState state)

roomId：流发布用户所在的房间 ID

OnMediaFrameSendStateChangedType = void Function(String roomId, UserInfo userInfo, FirstFrameSendState state)

roomId：流发布用户所在的房间 ID

OnMessageReceivedType = void Function(String uid, String message)

uid：消息发送用户的 ID

OnMessageSendResultType = void Function(int msgid, UserMessageSendResult error)

msgid：本条消息的 ID

OnMessageType = void Function(String message)

message：识别完成后得到的文字消息

OnNetworkDetectionResultType = void Function(NetworkDetectionLinkType type, NetworkQuality quality, int rtt, double lostRate, int bitrate, int jitter)

type：探测网络类型为上行/下行

OnNetworkDetectionStoppedType = void Function(NetworkDetectionStopReason reason)

reason：停止探测的原因类型

OnNetworkQualityType = void Function(NetworkQualityStats localQuality, List<NetworkQualityStats> remoteQualities)

localQuality：本地网络质量

OnNetworkTypeChangedType = void Function(NetworkType type)

type：当前网络连接类型

OnPerformanceAlarmsType = void Function(PerformanceAlarmMode mode, String roomId, PerformanceAlarmReason reason, SourceWantedData data)

mode：指示本地是否开启发布回退功能

OnPlayPublicStreamResultType = void Function(String publicStreamId, PublicStreamErrorCode errorCode)

publicStreamId：公共流 ID

OnPublicStreamDataMessageReceivedType = void Function(String publicStreamId, Uint8List message, DataMessageSourceType sourceType)

publicStreamId：公共流 ID

OnPublicStreamSEIMessageReceivedWithChannelType = void Function(String publicStreamId, int channelId, Uint8List message)

publicStreamId：公共流 ID

OnPushPublicStreamResultType = void Function(String roomId, String publicStreamId, PublicStreamErrorCode errorCode)

roomId：发布公共流的房间 ID

OnRecordingProgressUpdateType = void Function(StreamIndex type, RecordingProgress progress, RecordingInfo info)

type：录制流的流属性

OnRecordingStateUpdateType = void Function(StreamIndex type, RecordingState state, RecordingErrorCode errorCode, RecordingInfo info)

type：录制流的流属性

OnRemoteAudioPropertiesReportType = void Function(List<RemoteAudioPropertiesInfo> audioPropertiesInfos, int totalRemoteVolume)

audioPropertiesInfos：远端音频信息

OnRemoteStreamStatsType = void Function(RemoteStreamStats stats)

stats：音视频流以及网络状况统计信息

OnRemoteVideoSizeChangedType = void Function(RemoteStreamKey streamKey, VideoFrameInfo videoFrameInfo)

streamKey：远端流信息

OnRemoteVideoSuperResolutionModeChangedType = void Function(RemoteStreamKey streamKey, VideoSuperResolutionMode mode, VideoSuperResolutionModeChangedReason reason)

streamKey：远端视频流信息

OnRoomExtraInfoUpdateType = void Function(String key, String value, String lastUpdateUserId, int lastUpdateTimeMs)

key：房间附加信息的键值。

OnRoomMessageSendResultType = void Function(int msgid, RoomMessageSendResult error)

msgid：本条消息的 ID

OnRoomStateChangedType = void Function(String roomId, String uid, int state, String extraInfo)

roomId：发生状态改变的房间 ID

OnRoomStatsType = void Function(RTCRoomStats stats)

stats：房间内的汇总统计数据

OnSEIMessageReceivedType = void Function(RemoteStreamKey streamKey, Uint8List message)

streamKey：包含 SEI 发送者的用户名，所在的房间名和媒体流

OnSEIStreamUpdateType = void Function(RemoteStreamKey streamKey, SEIStreamUpdateEvent event)

streamKey：远端流信息

OnServerMessageSendResultType = void Function(int msgid, UserMessageSendResult error, Uint8List message)

msgid：本条消息的 ID

OnServerParamsSetResultType = void Function(int error)

error：设置结果

OnSetRoomExtraInfoResultType = void Function(int taskId, SetRoomExtraInfoResult error)

taskId：调用 setRoomExtraInfo 的任务编号。

OnSimulcastSubscribeFallbackType = void Function(RemoteStreamSwitch event)

event：音视频流发生变化的信息

OnSocks5ProxyStateType = void Function(int state, String cmd, String proxyAddress, String localAddress, String remoteAddress)

state：当前 SOCKS5 代理连接状态

OnStreamMixingEventType = void Function(StreamMixingEvent eventType, String taskId, StreamMixingErrorCode error, StreamMixingType mixType)

eventType：转推直播任务状态

OnStreamPushEventType = void Function(StreamSinglePushEvent eventType, String taskId, int error)

eventType：任务状态

OnStreamSyncInfoReceivedType = void Function(RemoteStreamKey streamKey, SyncInfoStreamType streamType, Uint8List data)

streamKey：远端流信息

OnSubtitleMessageReceivedType = void Function(List<SubtitleMessage> subtitles)

subtitles：字幕消息内容。

OnSubtitleStateChangedType = void Function(SubtitleState state, SubtitleErrorCode errorCode, String errorMessage)

state：字幕状态。

OnSysStatsType = void Function(SysStats stats)

stats：CPU，内存信息

OnUserJoinedType = void Function(UserInfo userInfo, int elapsed)

userInfo：用户信息

OnUserLeaveType = void Function(String uid, UserOfflineReason reason)

uid：离开房间，或切至不可见的的远端用户 ID

OnUserOperateMediaCaptureType = void Function(String roomId, String uid)

roomId：开关采集的远端用户所在的房间 ID

OnUserPublishStreamType = void Function(String uid, MediaStreamType type)

uid：远端流发布用户的用户 ID

OnUserUnpublishStreamType = void Function(String uid, MediaStreamType type, StreamRemoveReason reason)

uid：移除的远端流发布用户的用户 ID

OnUserVisibilityChangedType = void Function(bool currentUserVisibility, UserVisibilityChangeError errorCode)

currentUserVisibility：当前用户的可见性。

OnVideoDenoiseModeChangedType = void Function(VideoDenoiseMode mode, VideoDenoiseModeChangedReason reason)

mode：视频降噪模式

OnVideoDeviceStateChangedType = void Function(String deviceId, VideoDeviceType deviceType, MediaDeviceState deviceState, MediaDeviceError deviceError)

deviceId：设备 ID

OnVideoDeviceWarningType = void Function(String deviceId, VideoDeviceType deviceType, MediaDeviceWarning deviceWarning)

deviceId：设备 ID

OnVideoStreamBannedType = void Function(String uid, bool banned)

uid：被封禁/解禁的视频流用户 ID

OnWarningType = void Function(WarningCode code)

code：警告码