RTCVideoEventHandler class

RTCVideo event callback

Properties

hashCode → int

The hash code for this object.

no setter, inherited

onAudioDeviceStateChanged ↔ OnAudioDeviceStateChangedType?

Audio device state callback, returns the state of audio capture and audio playback devices.

getter/setter pair

onAudioDeviceWarning ↔ OnAudioDeviceWarningType?

Audio device warning callback. The audio devices includes audio capture devices and audio rendering devices.

getter/setter pair

onAudioFramePlayStateChanged ↔ OnMediaFramePlayStateChangedType?

Callback on first audio frame playback status change.

getter/setter pair

onAudioFrameSendStateChanged ↔ OnMediaFrameSendStateChangedType?

Callback on first audio frame send status change.

getter/setter pair

onAudioMixingPlayingProgress ↔ OnAudioMixingPlayingProgressType?

Callback for playback progress of mixed audio files.

getter/setter pair

onAudioMixingStateChanged ↔ OnAudioMixingStateChangedType?

Callback when audio file playback status changes in audio mixing

getter/setter pair

onAudioRecordingStateUpdate ↔ OnAudioRecordingStateUpdateType?

After calling RTCVideo.startAudioRecording/RTCVideo.stopAudioRecording to change the recording status, you will receive the callback.

getter/setter pair

onAudioRouteChanged ↔ OnAudioRouteChangedType?

This callback is triggered when the audio playback route changes.

getter/setter pair

onCloudProxyConnected ↔ OnCloudProxyConnectedType?

After calling RTCVideo.startCloudProxy to enable the cloud proxy, this event is called back when the SDK successfully connects to the cloud proxy server for the first time.

getter/setter pair

onConnectionStateChanged ↔ OnConnectionStateChanged?

This callback is triggered when the status of the network connection between the SDK and the RTC server changes.

getter/setter pair

onCreateRoomStateChanged ↔ OnCreateRoomStateChangedType?

Callback for failed room creation.

getter/setter pair

onEchoTestResult ↔ OnEchoTestResultType?

Callback about the call test result.

getter/setter pair

onError ↔ OnErrorType?

Callbacks when error occurs.

getter/setter pair

onExtensionAccessError ↔ OnExtensionAccessErrorType?

Valid since v3.56.1

getter/setter pair

onFirstLocalAudioFrame ↔ OnFirstLocalAudioFrameType?

The local user will receive this callback when the first local audio frame is captured.

getter/setter pair

onFirstLocalVideoFrameCaptured ↔ OnFirstLocalVideoFrameCapturedType?

This callback is triggered when the first locally captured video/screen share screen is rendered in the local view.

getter/setter pair

onFirstRemoteAudioFrame ↔ OnFirstRemoteAudioFrameType?

The local user will receive this callback after receiving the first remote audio frame.

getter/setter pair

onFirstRemoteVideoFrameDecoded ↔ OnFirstRemoteVideoFrameRenderedType?

This callback after the first frame of remote video stream is received and decoded by SDK.

getter/setter pair

onFirstRemoteVideoFrameRendered ↔ OnFirstRemoteVideoFrameRenderedType?

This callback is triggered after the first frame of remote video stream is locally rendered by SDK.

getter/setter pair

onGetPeerOnlineStatus ↔ OnGetPeerOnlineStatusType?

The user receives this callback after calling RTCVideo.getPeerOnlineStatus.

getter/setter pair

onHardwareEchoDetectionResult ↔ OnHardwareEchoDetectionResultType?

Callback that notifies you the result of the echo detection before a call.

getter/setter pair

onHttpProxyState ↔ OnHttpProxyStateType?

This callback is triggered when the HTTP proxy connection status changes.

getter/setter pair

onHttpsProxyState ↔ OnHttpsProxyStateType?

This callback is triggered when the HTTPS proxy connection status changes.

getter/setter pair

onLicenseWillExpire ↔ OnLicenseWillExpireType?

License expiration time reminder

getter/setter pair

onLocalAudioPropertiesReport ↔ OnLocalAudioPropertiesReportType?

After calling RTCVideo.enableAudioPropertiesReport, you will periodically receive this callback for the information about local audio.

getter/setter pair

onLocalAudioStateChanged ↔ OnLocalAudioStateChangedType?

The local user receives this callback when the audio state changes.

getter/setter pair

onLocalProxyStateChanged ↔ OnLocalProxyStateChangedType?

Callback on local proxy connection. After calling RTCVideo.setLocalProxy to set local proxies, you will receive this callback that informs you of the states of local proxy connection.

getter/setter pair

onLocalVideoSizeChanged ↔ OnLocalVideoSizeChangedType?

This callback when local video size or rotation information changes.

getter/setter pair

onLocalVideoStateChanged ↔ OnLocalVideoStateChangedType?

The local user receives this callback when the video state changes.

getter/setter pair

onLoginResult ↔ OnLoginResultType?

The user receives this callback after calling RTCVideo.login.

getter/setter pair

onLogout ↔ OnLogoutType?

The user receives this callback after calling RTCVideo.logout or when the local user is kicked out because another user logs in with the same UserId.

getter/setter pair

onNetworkDetectionResult ↔ OnNetworkDetectionResultType?

Callback of pre-call network detection result.

getter/setter pair

onNetworkDetectionStopped ↔ OnNetworkDetectionStoppedType?

Callback for end of pre-call network detection.

getter/setter pair

onNetworkTimeSynchronized ↔ EmptyCallbackType?

After calling RTCVideo.getNetworkTimeInfo for the first time, the SDK starts network time synchronization internally. This callback will be triggered when the synchronization is completed.

getter/setter pair

onNetworkTypeChanged ↔ OnNetworkTypeChangedType?

This callback is triggered when the client's network connection type has changed.

getter/setter pair

onPerformanceAlarms ↔ OnPerformanceAlarmsType?

This callback is triggered:

getter/setter pair

onRecordingProgressUpdate ↔ OnRecordingProgressUpdateType?

This callback is triggered every second after RTCVideo.startFileRecording is called for local recording.

getter/setter pair

onRecordingStateUpdate ↔ OnRecordingStateUpdateType?

The user will receive this callback after calling RTCVideo.startFileRecording or RTCVideo.stopFileRecording.

getter/setter pair

onRemoteAudioPropertiesReport ↔ OnRemoteAudioPropertiesReportType?

After calling RTCVideo.enableAudioPropertiesReport, the local user will receive this callback periodically to get the volume information of the remote audio.

getter/setter pair

onRemoteVideoSizeChanged ↔ OnRemoteVideoSizeChangedType?

Users in the room who subscribe to the video stream receive this callback when the remote video size or rotation information changes.

getter/setter pair

onScreenVideoFramePlayStateChanged ↔ OnMediaFramePlayStateChangedType?

Callback on first screen frame playback status change.

getter/setter pair

onScreenVideoFrameSendStateChanged ↔ OnMediaFrameSendStateChangedType?

Callback on first screen frame send status change.

getter/setter pair

onSEIMessageReceived ↔ OnSEIMessageReceivedType?

The user receives this callback after receiving a video frame with a SEI message.

getter/setter pair

onSEIStreamUpdate ↔ OnSEIStreamUpdateType?

Callback about publishing status of the black frame video stream.

getter/setter pair

onServerMessageSendResult ↔ OnServerMessageSendResultType?

This callback is asynchronous. This callback is received after the user calls RTCVideo.sendServerMessage or RTCVideo.sendServerBinaryMessage to send a message.

getter/setter pair

onServerParamsSetResult ↔ OnServerParamsSetResultType?

The user receives this callback after calling RTCVideo.setServerParams.

getter/setter pair

onSimulcastSubscribeFallback ↔ OnSimulcastSubscribeFallbackType?

Once the fallback option is set, fallback or reverting from a Fallback of a media stream will trigger this callback.

getter/setter pair

onSocks5ProxyState ↔ OnSocks5ProxyStateType?

This callback is triggered when the Socks5 proxy connection status changes.

getter/setter pair

onStreamSyncInfoReceived ↔ OnStreamSyncInfoReceivedType?

The user receives this callback after receiving an audio stream sync message from the remote user calling RTCVideo.sendStreamSyncInfo.

getter/setter pair

onSysStats ↔ OnSysStatsType?

This callback is triggered periodically (2s) reporting the current CPU and memory usage.

getter/setter pair

onUserBinaryMessageReceivedOutsideRoom ↔ OnBinaryMessageReceivedType?

Local users will receive this callback when they receive a binary message from a user outside the room calling RTCVideo.sendUserBinaryMessageOutsideRoom.

getter/setter pair

onUserMessageReceivedOutsideRoom ↔ OnMessageReceivedType?

Local users will receive this callback when they receive a text message from a user outside the room calling RTCVideo.sendUserMessageOutsideRoom.

getter/setter pair

onUserMessageSendResultOutsideRoom ↔ OnMessageSendResultType?

Callback for sending a message to a specified user outside the room.

getter/setter pair

onUserStartAudioCapture ↔ OnUserOperateMediaCaptureType?

When a user calls RTCVideo.startAudioCapture to turn on the device for audio capture, others in the room will receive this callback.

getter/setter pair

onUserStartVideoCapture ↔ OnUserOperateMediaCaptureType?

When a user calls RTCVideo.startVideoCapture to start video capture, other users in the room will receive this callback.

getter/setter pair

onUserStopAudioCapture ↔ OnUserOperateMediaCaptureType?

When a user calls RTCVideo.stopAudioCapture to turn off audio capture, others in the room will receive this callback.

getter/setter pair

onUserStopVideoCapture ↔ OnUserOperateMediaCaptureType?

When a user calls RTCVideo.startVideoCapture to stop video capture, other users in the room will receive this callback.

getter/setter pair

onVideoDeviceStateChanged ↔ OnVideoDeviceStateChangedType?

Video device state callback, returns the state of camera capture and screen capture devices.

getter/setter pair

onVideoDeviceWarning ↔ OnVideoDeviceWarningType?

Video device warning callback. The video devices includes video capture devices.

getter/setter pair

onVideoFramePlayStateChanged ↔ OnMediaFramePlayStateChangedType?

Callback on first video frame playback status change.

getter/setter pair

onVideoFrameSendStateChanged ↔ OnMediaFrameSendStateChangedType?

Callback on first video frame send status change.

getter/setter pair

onWarning ↔ OnWarningType?

Callbacks when warning occurs.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited