Class NERtcCallbackExAbstract

Implements

Constructors

constructor

Methods

onAddLiveStreamTask onApiCallExecuted onAudioDeviceChanged onAudioDeviceStateChanged onAudioEffectFinished onAudioEffectTimestampUpdate onAudioMixingStateChanged onAudioMixingTimestampUpdate onAudioRecording onCameraExposureChanged onCameraFocusChanged onClientRoleChange onConnectionStateChanged onConnectionTypeChanged onDisconnect onError onFirstAudioDataReceived onFirstAudioFrameDecoded onFirstVideoDataReceived onFirstVideoFrameDecoded onFirstVideoFrameRender onJoinChannel onLabFeatureCallback onLastmileProbeResult onLastmileQuality onLeaveChannel onLiveStreamState onLocalAudioVolumeIndication onLocalPublishFallbackToAudioOnly onLocalVideoRenderSizeChanged onLocalVideoWatermarkState onMediaRelayReceiveEvent onMediaRelayStatesChange onMediaRightChange onPermissionKeyWillExpire onReJoinChannel onReconnectingStart onRecvSEIMsg onRemoteAudioVolumeIndication onRemoteSubscribeFallbackToAudioOnly onRemoteVideoSizeChanged onRemoveLiveStreamTask onUpdateLiveStreamTask onUpdatePermissionKey onUserAudioMute onUserAudioStart onUserAudioStop onUserDataBufferedAmountChanged onUserDataReceiveMessage onUserDataStart onUserDataStateChanged onUserDataStop onUserJoined onUserLeave onUserSubStreamAudioMute onUserSubStreamAudioStart onUserSubStreamAudioStop onUserSubStreamVideoMute onUserSubStreamVideoStart onUserSubStreamVideoStop onUserVideoMute onUserVideoStart onUserVideoStop onVideoDeviceStateChanged onVirtualBackgroundSourceEnabled onWarning

Constructors

constructor

Methods

onAddLiveStreamTask

  • onAddLiveStreamTask(taskId, url, errorCode): void

  • Parameters

    • taskId: string
    • url: string
    • errorCode: number

    Returns void

onApiCallExecuted

  • onApiCallExecuted(apiName, result, message): void

  • Parameters

    • apiName: string
    • result: number
    • message: string

    Returns void

onAudioDeviceChanged

  • onAudioDeviceChanged(selected): void

  • Parameters

    • selected: number

    Returns void

onAudioDeviceStateChanged

onAudioEffectFinished

  • onAudioEffectFinished(effectId): void

  • Parameters

    • effectId: number

    Returns void

onAudioEffectTimestampUpdate

  • onAudioEffectTimestampUpdate(id, timestampMs): void

  • Parameters

    • id: number
    • timestampMs: bigint

    Returns void

onAudioMixingStateChanged

  • onAudioMixingStateChanged(reason): void

  • Parameters

    • reason: number

    Returns void

onAudioMixingTimestampUpdate

  • onAudioMixingTimestampUpdate(timestampMs): void

  • Parameters

    • timestampMs: bigint

    Returns void

onAudioRecording

  • onAudioRecording(code, filePath): void

  • Parameters

    • code: number
    • filePath: string

    Returns void

onCameraExposureChanged

  • onCameraExposureChanged(left, top, right, bottom): void

  • Parameters

    • left: number
    • top: number
    • right: number
    • bottom: number

    Returns void

onCameraFocusChanged

  • onCameraFocusChanged(left, top, right, bottom): void

  • Parameters

    • left: number
    • top: number
    • right: number
    • bottom: number

    Returns void

Abstract onClientRoleChange

onConnectionStateChanged

  • onConnectionStateChanged(state, reason): void

  • Parameters

    • state: number
    • reason: number

    Returns void

onConnectionTypeChanged

  • onConnectionTypeChanged(newConnectionType): void

  • Parameters

    • newConnectionType: number

    Returns void

Abstract onDisconnect

onError

  • onError(code): void

  • Parameters

    • code: number

    Returns void

onFirstAudioDataReceived

  • onFirstAudioDataReceived(uid): void

  • Parameters

    • uid: bigint

    Returns void

onFirstAudioFrameDecoded

  • onFirstAudioFrameDecoded(uid): void

  • Parameters

    • uid: bigint

    Returns void

onFirstVideoDataReceived

  • onFirstVideoDataReceived(streamType, uid): void

  • Parameters

    Returns void

onFirstVideoFrameDecoded

  • onFirstVideoFrameDecoded(streamType, userId, width, height): void

  • Parameters

    Returns void

onFirstVideoFrameRender

  • onFirstVideoFrameRender(streamType, userId, width, height, elapsedTime): void

  • Parameters

    Returns void

Abstract onJoinChannel

  • onJoinChannel(result, channelId, elapsed, uid): void

  • Parameters

    • result: number
    • channelId: bigint
    • elapsed: bigint
    • uid: bigint

    Returns void

onLabFeatureCallback

  • onLabFeatureCallback(key, param): void

  • Parameters

    • key: string
    • param: Object

    Returns void

onLastmileProbeResult

  • onLastmileProbeResult(result): void

  • Parameters

    Returns void

onLastmileQuality

  • onLastmileQuality(quality): void

  • Parameters

    • quality: number

    Returns void

Abstract onLeaveChannel

onLiveStreamState

  • onLiveStreamState(taskId, pushUrl, liveState): void

  • Parameters

    • taskId: string
    • pushUrl: string
    • liveState: number

    Returns void

onLocalAudioVolumeIndication

  • onLocalAudioVolumeIndication(volume, vadFlag): void

  • Parameters

    • volume: number
    • vadFlag: boolean

    Returns void

onLocalPublishFallbackToAudioOnly

  • onLocalPublishFallbackToAudioOnly(isFallback, streamType): void

  • Parameters

    Returns void

onLocalVideoRenderSizeChanged

  • onLocalVideoRenderSizeChanged(videoType, width, height): void

  • Parameters

    Returns void

onLocalVideoWatermarkState

  • onLocalVideoWatermarkState(streamType, state): void

  • Parameters

    Returns void

onMediaRelayReceiveEvent

  • onMediaRelayReceiveEvent(event, code, channelName): void

  • Parameters

    • event: number
    • code: number
    • channelName: string

    Returns void

onMediaRelayStatesChange

  • onMediaRelayStatesChange(state, channelName): void

  • Parameters

    • state: number
    • channelName: string

    Returns void

onMediaRightChange

  • onMediaRightChange(isAudioBannedByServer, isVideoBannedByServer): void

  • Parameters

    • isAudioBannedByServer: boolean
    • isVideoBannedByServer: boolean

    Returns void

onPermissionKeyWillExpire

  • onPermissionKeyWillExpire(): void

  • Returns void

onReJoinChannel

  • onReJoinChannel(result, channelId): void

  • Parameters

    • result: number
    • channelId: bigint

    Returns void

onReconnectingStart

  • onReconnectingStart(): void

  • Returns void

Abstract onRecvSEIMsg

  • onRecvSEIMsg(userId, data, dataSize): void

  • Parameters

    • userId: bigint
    • data: Uint8Array
    • dataSize: number

    Returns void

onRemoteAudioVolumeIndication

  • onRemoteAudioVolumeIndication(volumeInfo, totalVolume): void

  • Parameters

    Returns void

onRemoteSubscribeFallbackToAudioOnly

  • onRemoteSubscribeFallbackToAudioOnly(uid, isFallback, streamType): void

  • Parameters

    Returns void

onRemoteVideoSizeChanged

  • onRemoteVideoSizeChanged(uid, videoType, width, height): void

  • Parameters

    Returns void

onRemoveLiveStreamTask

  • onRemoveLiveStreamTask(taskId, errorCode): void

  • Parameters

    • taskId: string
    • errorCode: number

    Returns void

onUpdateLiveStreamTask

  • onUpdateLiveStreamTask(taskId, url, errorCode): void

  • Parameters

    • taskId: string
    • url: string
    • errorCode: number

    Returns void

onUpdatePermissionKey

  • onUpdatePermissionKey(errorCode, data, timeoutInterval): void

  • Parameters

    • errorCode: number
    • data: string
    • timeoutInterval: bigint

    Returns void

onUserAudioMute

  • onUserAudioMute(uid, muted): void

  • Parameters

    • uid: bigint
    • muted: boolean

    Returns void

Abstract onUserAudioStart

Abstract onUserAudioStop

onUserDataBufferedAmountChanged

  • onUserDataBufferedAmountChanged(uid, previousAmount): void

  • Parameters

    • uid: bigint
    • previousAmount: bigint

    Returns void

onUserDataReceiveMessage

  • onUserDataReceiveMessage(uid, buffer, size): void

  • Parameters

    • uid: bigint
    • buffer: Uint8Array
    • size: bigint

    Returns void

onUserDataStart

  • onUserDataStart(uid): void

  • Parameters

    • uid: bigint

    Returns void

onUserDataStateChanged

  • onUserDataStateChanged(uid): void

  • Parameters

    • uid: bigint

    Returns void

onUserDataStop

  • onUserDataStop(uid): void

  • Parameters

    • uid: bigint

    Returns void

Abstract onUserJoined

Abstract onUserLeave

onUserSubStreamAudioMute

  • onUserSubStreamAudioMute(uid, muted): void

  • Parameters

    • uid: bigint
    • muted: boolean

    Returns void

onUserSubStreamAudioStart

  • onUserSubStreamAudioStart(uid): void

  • Parameters

    • uid: bigint

    Returns void

onUserSubStreamAudioStop

  • onUserSubStreamAudioStop(uid): void

  • Parameters

    • uid: bigint

    Returns void

onUserSubStreamVideoMute

  • onUserSubStreamVideoMute(uid, muted): void

  • Parameters

    • uid: bigint
    • muted: boolean

    Returns void

onUserSubStreamVideoStart

  • onUserSubStreamVideoStart(uid, maxProfile): void

  • Parameters

    Returns void

onUserSubStreamVideoStop

  • onUserSubStreamVideoStop(uid): void

  • Parameters

    • uid: bigint

    Returns void

onUserVideoMute

  • onUserVideoMute(uid, muted): void

  • Parameters

    • uid: bigint
    • muted: boolean

    Returns void

Abstract onUserVideoStart

Abstract onUserVideoStop

onVideoDeviceStateChanged

  • onVideoDeviceStateChanged(deviceState): void

  • Parameters

    • deviceState: number

    Returns void

onVirtualBackgroundSourceEnabled

  • onVirtualBackgroundSourceEnabled(enabled, reason): void

  • Parameters

    • enabled: boolean
    • reason: number

    Returns void

onWarning

  • onWarning(code): void

  • Parameters

    • code: number

    Returns void

Settings

Member Visibility

Theme

On This Page

constructoronAddLiveStreamTaskonApiCallExecutedonAudioDeviceChangedonAudioDeviceStateChangedonAudioEffectFinishedonAudioEffectTimestampUpdateonAudioMixingStateChangedonAudioMixingTimestampUpdateonAudioRecordingonCameraExposureChangedonCameraFocusChangedonClientRoleChangeonConnectionStateChangedonConnectionTypeChangedonDisconnectonErroronFirstAudioDataReceivedonFirstAudioFrameDecodedonFirstVideoDataReceivedonFirstVideoFrameDecodedonFirstVideoFrameRenderonJoinChannelonLabFeatureCallbackonLastmileProbeResultonLastmileQualityonLeaveChannelonLiveStreamStateonLocalAudioVolumeIndicationonLocalPublishFallbackToAudioOnlyonLocalVideoRenderSizeChangedonLocalVideoWatermarkStateonMediaRelayReceiveEventonMediaRelayStatesChangeonMediaRightChangeonPermissionKeyWillExpireonReJoinChannelonReconnectingStartonRecvSEIMsgonRemoteAudioVolumeIndicationonRemoteSubscribeFallbackToAudioOnlyonRemoteVideoSizeChangedonRemoveLiveStreamTaskonUpdateLiveStreamTaskonUpdatePermissionKeyonUserAudioMuteonUserAudioStartonUserAudioStoponUserDataBufferedAmountChangedonUserDataReceiveMessageonUserDataStartonUserDataStateChangedonUserDataStoponUserJoinedonUserLeaveonUserSubStreamAudioMuteonUserSubStreamAudioStartonUserSubStreamAudioStoponUserSubStreamVideoMuteonUserSubStreamVideoStartonUserSubStreamVideoStoponUserVideoMuteonUserVideoStartonUserVideoStoponVideoDeviceStateChangedonVirtualBackgroundSourceEnabledonWarning