Class NERtcCallbackExAbstract

Implements

Constructors

constructor

Methods

onAddLiveStreamTask onAiData onApiCallExecuted onAsrCaptionResult onAsrCaptionStateChanged 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 onPushStreamingReconnectedSuccess onPushStreamingReconnecting onReconnectingStart onRecvSEIMsg onReJoinChannel onRemoteAudioVolumeIndication onRemoteSubscribeFallbackToAudioOnly onRemoteVideoSizeChanged onRemoveLiveStreamTask onStartPushStreaming onStopPushStreaming 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: string, url: string, errorCode: number): void

    Parameters

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

    Returns void

onAiData

  • onAiData(type: string, data: string): void

    AI 功能回调接口

    Parameters

    • type: string

      数据类型

    • data: string

      数据

    Returns void

onApiCallExecuted

  • onApiCallExecuted(apiName: string, result: number, message: string): void

    Parameters

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

    Returns void

onAsrCaptionResult

onAsrCaptionStateChanged

  • onAsrCaptionStateChanged(
        state: NERtcAsrCaptionState,
        code: number,
        message: string,
    ): void

    实时字幕状态回调。

    Parameters

    Returns void

    Note

    当调用 startASRCaption 或者 stopASRCaption 成功后，会收到 onAsrCaptionStateChanged 回调。

onAudioDeviceChanged

  • onAudioDeviceChanged(selected: number): void

    Parameters

    • selected: number

    Returns void

onAudioDeviceStateChanged

onAudioEffectFinished

  • onAudioEffectFinished(effectId: number): void

    Parameters

    • effectId: number

    Returns void

onAudioEffectTimestampUpdate

  • onAudioEffectTimestampUpdate(id: number, timestampMs: bigint): void

    Parameters

    • id: number
    • timestampMs: bigint

    Returns void

onAudioMixingStateChanged

  • onAudioMixingStateChanged(reason: number): void

    Parameters

    • reason: number

    Returns void

onAudioMixingTimestampUpdate

  • onAudioMixingTimestampUpdate(timestampMs: bigint): void

    Parameters

    • timestampMs: bigint

    Returns void

onAudioRecording

  • onAudioRecording(code: number, filePath: string): void

    Parameters

    • code: number
    • filePath: string

    Returns void

onCameraExposureChanged

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

    Parameters

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

    Returns void

onCameraFocusChanged

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

    Parameters

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

    Returns void

AbstractonClientRoleChange

  • onClientRoleChange(oldRole: number, newRole: number): void

    Parameters

    • oldRole: number
    • newRole: number

    Returns void

onConnectionStateChanged

  • onConnectionStateChanged(state: number, reason: number): void

    Parameters

    • state: number
    • reason: number

    Returns void

onConnectionTypeChanged

  • onConnectionTypeChanged(newConnectionType: number): void

    Parameters

    • newConnectionType: number

    Returns void

AbstractonDisconnect

onError

  • onError(code: number): void

    Parameters

    • code: number

    Returns void

onFirstAudioDataReceived

  • onFirstAudioDataReceived(uid: bigint): void

    Parameters

    • uid: bigint

    Returns void

onFirstAudioFrameDecoded

  • onFirstAudioFrameDecoded(uid: bigint): void

    Parameters

    • uid: bigint

    Returns void

onFirstVideoDataReceived

onFirstVideoFrameDecoded

  • onFirstVideoFrameDecoded(
        streamType: NERtcVideoStreamType,
        userId: bigint,
        width: number,
        height: number,
    ): void

    Parameters

    Returns void

onFirstVideoFrameRender

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

    Parameters

    Returns void

AbstractonJoinChannel

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

    Parameters

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

    Returns void

onLabFeatureCallback

  • onLabFeatureCallback(key: string, param: string): void

    Parameters

    • key: string
    • param: string

    Returns void

onLastmileProbeResult

onLastmileQuality

  • onLastmileQuality(quality: number): void

    Parameters

    • quality: number

    Returns void

AbstractonLeaveChannel

onLiveStreamState

  • onLiveStreamState(taskId: string, pushUrl: string, liveState: number): void

    Parameters

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

    Returns void

onLocalAudioVolumeIndication

  • onLocalAudioVolumeIndication(volume: number, vadFlag: boolean): void

    Parameters

    • volume: number
    • vadFlag: boolean

    Returns void

onLocalPublishFallbackToAudioOnly

onLocalVideoRenderSizeChanged

  • onLocalVideoRenderSizeChanged(
        videoType: NERtcVideoStreamType,
        width: number,
        height: number,
    ): void

    Parameters

    Returns void

onLocalVideoWatermarkState

onMediaRelayReceiveEvent

  • onMediaRelayReceiveEvent(event: number, code: number, channelName: string): void

    Parameters

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

    Returns void

onMediaRelayStatesChange

  • onMediaRelayStatesChange(state: number, channelName: string): void

    Parameters

    • state: number
    • channelName: string

    Returns void

onMediaRightChange

  • onMediaRightChange(
        isAudioBannedByServer: boolean,
        isVideoBannedByServer: boolean,
    ): void

    Parameters

    • isAudioBannedByServer: boolean
    • isVideoBannedByServer: boolean

    Returns void

onPermissionKeyWillExpire

  • onPermissionKeyWillExpire(): void

    Returns void

onPushStreamingReconnectedSuccess

  • onPushStreamingReconnectedSuccess(): void

    推流过程中重连成功回调。
    该回调在如下情况下会被触发：

    • 重连中重连成功

    Returns void

onPushStreamingReconnecting

  • onPushStreamingReconnecting(reason: number): void

    推流过程中断开，变为重连状态回调。
    该回调在如下情况下会被触发：

    • startPushStreaming 成功开启推流，推流过程中推流状态变为重连中。

    Parameters

    Returns void

onReconnectingStart

  • onReconnectingStart(): void

    Returns void

AbstractonRecvSEIMsg

  • onRecvSEIMsg(userId: bigint, data: Uint8Array, dataSize: number): void

    Parameters

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

    Returns void

onReJoinChannel

  • onReJoinChannel(result: number, channelId: bigint): void

    Parameters

    • result: number
    • channelId: bigint

    Returns void

onRemoteAudioVolumeIndication

onRemoteSubscribeFallbackToAudioOnly

  • onRemoteSubscribeFallbackToAudioOnly(
        uid: bigint,
        isFallback: boolean,
        streamType: NERtcVideoStreamType,
    ): void

    Parameters

    Returns void

onRemoteVideoSizeChanged

  • onRemoteVideoSizeChanged(
        uid: bigint,
        videoType: NERtcVideoStreamType,
        width: number,
        height: number,
    ): void

    Parameters

    Returns void

onRemoveLiveStreamTask

  • onRemoveLiveStreamTask(taskId: string, errorCode: number): void

    Parameters

    • taskId: string
    • errorCode: number

    Returns void

onStartPushStreaming

  • onStartPushStreaming(result: number, channelId: bigint): void

    开始推流 startPushStreaming 结果回调。
    该回调在如下情况下会被触发:

    • 成功调用 startPushStreaming。

    Parameters

    • result: number

      OK 成功；其他值表示开始推流失败，错误码请参考 NERtcConstants.ErrorCode。

    • channelId: bigint

      房间 ID。

    Returns void

onStopPushStreaming

  • onStopPushStreaming(result: number): void

    停止推流 stopPushStreaming 结果回调。
    该回调在如下情况下会被触发：

    • 成功调用 stopPushStreaming。

    Parameters

    Returns void

onUpdateLiveStreamTask

  • onUpdateLiveStreamTask(taskId: string, url: string, errorCode: number): void

    Parameters

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

    Returns void

onUpdatePermissionKey

  • onUpdatePermissionKey(
        errorCode: number,
        data: string,
        timeoutInterval: bigint,
    ): void

    Parameters

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

    Returns void

onUserAudioMute

  • onUserAudioMute(uid: bigint, muted: boolean): void

    Parameters

    • uid: bigint
    • muted: boolean

    Returns void

AbstractonUserAudioStart

AbstractonUserAudioStop

onUserDataBufferedAmountChanged

  • onUserDataBufferedAmountChanged(uid: bigint, previousAmount: bigint): void

    Parameters

    • uid: bigint
    • previousAmount: bigint

    Returns void

onUserDataReceiveMessage

  • onUserDataReceiveMessage(uid: bigint, buffer: Uint8Array, size: bigint): void

    Parameters

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

    Returns void

onUserDataStart

  • onUserDataStart(uid: bigint): void

    Parameters

    • uid: bigint

    Returns void

onUserDataStateChanged

  • onUserDataStateChanged(uid: bigint): void

    Parameters

    • uid: bigint

    Returns void

onUserDataStop

  • onUserDataStop(uid: bigint): void

    Parameters

    • uid: bigint

    Returns void

AbstractonUserJoined

AbstractonUserLeave

onUserSubStreamAudioMute

  • onUserSubStreamAudioMute(uid: bigint, muted: boolean): void

    Parameters

    • uid: bigint
    • muted: boolean

    Returns void

onUserSubStreamAudioStart

  • onUserSubStreamAudioStart(uid: bigint): void

    Parameters

    • uid: bigint

    Returns void

onUserSubStreamAudioStop

  • onUserSubStreamAudioStop(uid: bigint): void

    Parameters

    • uid: bigint

    Returns void

onUserSubStreamVideoMute

  • onUserSubStreamVideoMute(uid: bigint, muted: boolean): void

    Parameters

    • uid: bigint
    • muted: boolean

    Returns void

onUserSubStreamVideoStart

onUserSubStreamVideoStop

  • onUserSubStreamVideoStop(uid: bigint): void

    Parameters

    • uid: bigint

    Returns void

onUserVideoMute

AbstractonUserVideoStart

AbstractonUserVideoStop

onVideoDeviceStateChanged

  • onVideoDeviceStateChanged(deviceState: number): void

    Parameters

    • deviceState: number

    Returns void

onVirtualBackgroundSourceEnabled

  • onVirtualBackgroundSourceEnabled(enabled: boolean, reason: number): void

    Parameters

    • enabled: boolean
    • reason: number

    Returns void

onWarning

  • onWarning(code: number): void

    Parameters

    • code: number

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
onAddLiveStreamTaskonAiDataonApiCallExecutedonAsrCaptionResultonAsrCaptionStateChangedonAudioDeviceChangedonAudioDeviceStateChangedonAudioEffectFinishedonAudioEffectTimestampUpdateonAudioMixingStateChangedonAudioMixingTimestampUpdateonAudioRecordingonCameraExposureChangedonCameraFocusChangedonClientRoleChangeonConnectionStateChangedonConnectionTypeChangedonDisconnectonErroronFirstAudioDataReceivedonFirstAudioFrameDecodedonFirstVideoDataReceivedonFirstVideoFrameDecodedonFirstVideoFrameRenderonJoinChannelonLabFeatureCallbackonLastmileProbeResultonLastmileQualityonLeaveChannelonLiveStreamStateonLocalAudioVolumeIndicationonLocalPublishFallbackToAudioOnlyonLocalVideoRenderSizeChangedonLocalVideoWatermarkStateonMediaRelayReceiveEventonMediaRelayStatesChangeonMediaRightChangeonPermissionKeyWillExpireonPushStreamingReconnectedSuccessonPushStreamingReconnectingonReconnectingStartonRecvSEIMsgonReJoinChannelonRemoteAudioVolumeIndicationonRemoteSubscribeFallbackToAudioOnlyonRemoteVideoSizeChangedonRemoveLiveStreamTaskonStartPushStreamingonStopPushStreamingonUpdateLiveStreamTaskonUpdatePermissionKeyonUserAudioMuteonUserAudioStartonUserAudioStoponUserDataBufferedAmountChangedonUserDataReceiveMessageonUserDataStartonUserDataStateChangedonUserDataStoponUserJoinedonUserLeaveonUserSubStreamAudioMuteonUserSubStreamAudioStartonUserSubStreamAudioStoponUserSubStreamVideoMuteonUserSubStreamVideoStartonUserSubStreamVideoStoponUserVideoMuteonUserVideoStartonUserVideoStoponVideoDeviceStateChangedonVirtualBackgroundSourceEnabledonWarning