Interface JRTCClientCallback

基础模块相关事件回调

interface JRTCClientCallback {
    onLogin?: (result: boolean, reason: JRTCReasonCode) => void;
    onLogout?: (reason: JRTCReasonCode) => void;
    onClientStateChanged?: (
        state: JRTCClientState,
        oldState: JRTCClientState,
    ) => void;
    onOnlineMessageSendResult?: (result: boolean, operatorId: number) => void;
    onOnlineMessageReceived?: (message: string, userId: string) => void;
    onSDKEvent?: (event: JRTCSDKEvent) => void;
    onRequestFileUploadInfoResponse?: (
        operatorId: number,
        result: boolean,
        url: string,
        token: string,
        requestTimestamp: number,
        extraInfo: string,
        fileSize: number,
        offset: number,
        fileType: string,
        serverOid: string,
        reason: string,
    ) => void;
    onCompleteFileUploadResponse?: (
        operatorId: number,
        result: boolean,
        fileName: string,
        extraInfo: string,
        fileType: string,
        reason: string,
    ) => void;
    onGetUploadFileInfoResponse?: (
        operatorId: number,
        result: boolean,
        uploadFileInfoList: any,
        extraInfo: string,
        reason: string,
    ) => void;
    onFileUploadPlatformNotify?: (
        result: boolean,
        serialId: string,
        uploadFileInfo: JRTCUploadFileInfo,
    ) => void;
}

Properties

onLogin? onLogout? onClientStateChanged? onOnlineMessageSendResult? onOnlineMessageReceived? onSDKEvent? onRequestFileUploadInfoResponse? onCompleteFileUploadResponse? onGetUploadFileInfoResponse? onFileUploadPlatformNotify?

Properties

OptionalonLogin

onLogin?: (result: boolean, reason: JRTCReasonCode) => void

登录结果回调

Type declaration

    • (result: boolean, reason: JRTCReasonCode): void

    • Parameters

      • result: boolean

        登录结果 - true：表示登录成功， - false：表示登录失败

      • reason: JRTCReasonCode

        登录失败原因，当 result 为 false 时该值有效

      Returns void

OptionalonLogout

onLogout?: (reason: JRTCReasonCode) => void

登出回调

Type declaration

OptionalonClientStateChanged

onClientStateChanged?: (
    state: JRTCClientState,
    oldState: JRTCClientState,
) => void

登录状态变化通知

Type declaration

OptionalonOnlineMessageSendResult

onOnlineMessageSendResult?: (result: boolean, operatorId: number) => void

在线消息发送结果回调

Type declaration

    • (result: boolean, operatorId: number): void

    • Parameters

      • result: boolean

        发送结果是否成功 - true：发送成功 - false：发送失败

      • operatorId: number

        操作id，对应 sendOnlineMessage 的返回值

      Returns void

OptionalonOnlineMessageReceived

onOnlineMessageReceived?: (message: string, userId: string) => void

收到在线消息回调

Type declaration

    • (message: string, userId: string): void

    • Parameters

      • message: string

        消息内容

      • userId: string

        对方用户ID

      Returns void

OptionalonSDKEvent

onSDKEvent?: (event: JRTCSDKEvent) => void

上报事件回调

Type declaration

OptionalonRequestFileUploadInfoResponse

onRequestFileUploadInfoResponse?: (
    operatorId: number,
    result: boolean,
    url: string,
    token: string,
    requestTimestamp: number,
    extraInfo: string,
    fileSize: number,
    offset: number,
    fileType: string,
    serverOid: string,
    reason: string,
) => void

获取文件上传或断点续传信息响应

Type declaration

    • (
          operatorId: number,
          result: boolean,
          url: string,
          token: string,
          requestTimestamp: number,
          extraInfo: string,
          fileSize: number,
          offset: number,
          fileType: string,
          serverOid: string,
          reason: string,
      ): void

    • Parameters

      • operatorId: number

        操作id，对应 requestFileUploadInfo 的返回值

      • result: boolean

        请求是否成功 - true：请求成功 - false：请求失败

      • url: string

        上传地址，分片录制文件上传场景，首次请求分片上传信息时有效

      • token: string

        文件上传所需token，用于校验上传合法性，需要在上传文件的时候携带

      • requestTimestamp: number

        本次请求发起时间戳，用于控制上传地址有效期，需要在上传文件的时候携带

      • extraInfo: string

        随路参数

      • fileSize: number

        文件大小

      • offset: number

        偏移量

      • fileType: string

        文件类型

      • serverOid: string

        上传目标服务Oid

      • reason: string

        请求失败原因描述，当 result 为 false 时有效

      Returns void

OptionalonCompleteFileUploadResponse

onCompleteFileUploadResponse?: (
    operatorId: number,
    result: boolean,
    fileName: string,
    extraInfo: string,
    fileType: string,
    reason: string,
) => void

文件上传完成确认响应

Type declaration

    • (
          operatorId: number,
          result: boolean,
          fileName: string,
          extraInfo: string,
          fileType: string,
          reason: string,
      ): void

    • Parameters

      • operatorId: number

        操作id，对应 completeFileUpload 的返回值

      • result: boolean

        请求是否成功 - true：请求成功 - false：请求失败

      • fileName: string

        服务器合并后的文件名

      • extraInfo: string

        随路参数

      • fileType: string

        文件类型

      • reason: string

        请求失败原因描述，当 result 为 false 时有效

      Returns void

OptionalonGetUploadFileInfoResponse

onGetUploadFileInfoResponse?: (
    operatorId: number,
    result: boolean,
    uploadFileInfoList: any,
    extraInfo: string,
    reason: string,
) => void

获取上传文件信息列表响应

Type declaration

    • (
          operatorId: number,
          result: boolean,
          uploadFileInfoList: any,
          extraInfo: string,
          reason: string,
      ): void

    • Parameters

      • operatorId: number

        操作id，对应 getUploadFileInfo 的返回值

      • result: boolean

        请求是否成功 - true：请求成功 - false：请求失败

      • uploadFileInfoList: any

        文件信息对象列表，当 result 为 true 时有效

      • extraInfo: string

        随路参数，当 result 为 true 时有效

      • reason: string

        请求失败原因描述，当 result 为 false 时有效

      Returns void

OptionalonFileUploadPlatformNotify

onFileUploadPlatformNotify?: (
    result: boolean,
    serialId: string,
    uploadFileInfo: JRTCUploadFileInfo,
) => void

文件上传到影像平台结果通知

Type declaration

    • (result: boolean, serialId: string, uploadFileInfo: JRTCUploadFileInfo): void

    • Parameters

      • result: boolean

        上传是否成功 - true：上传成功 - false：上传失败

      • serialId: string

        业务id，如果是通话业务相关文件，对应的是 callId

      • uploadFileInfo: JRTCUploadFileInfo

        文件信息对象

      Returns void

Note

服务端录制文件或者本地录制文件上传到影像平台后，都会通过该接口回调通知

Settings

Member Visibility

On This Page

Properties