网络电话回调接口 JCallCallback

提供网络电话相关的回调方法,用于接收通话状态变化、邀请结果等事件通知。 应用需要实现此接口并注册到 JCallManager 才能接收到相关回调。

const callback: JCallCallback = {
onJoin: (result, reason) => {
if (result) {
console.info('加入通话成功');
} else {
console.error('加入通话失败,原因:', reason);
}
},
onInviteReceived: (param) => {
console.info('收到通话邀请,来自:', param.callerUserId);
}
};
JCallManager.getInstance().addCallback(callback);
interface JCallCallback {
    onJoin?: (result: boolean, reason: JRoomReason) => void;
    onLeave?: (serialId: string, reason: JRoomReason) => void;
    onCallPropertyChanged?: (propChangeParam: JCallPropChangeParam) => void;
    onRejectInviteResult?: (
        operatorId: number,
        result: boolean,
        reason: string,
    ) => void;
    onAcceptInviteResult?: (
        operatorId: number,
        result: boolean,
        reason: string,
    ) => void;
    onCancelInviteResult?: (
        operatorId: number,
        result: boolean,
        reason: string,
    ) => void;
    onInviteResult?: (
        operatorId: number,
        result: boolean,
        reason: string,
    ) => void;
    onInviteReceived?: (param: JCallExtraParam) => void;
    onInviteCanceled?: (param: JCallExtraParam) => void;
    onInviteRejected?: (param: JCallExtraParam) => void;
}

Hierarchy

  • unknown
    • JCallCallback

Properties

onJoin?: (result: boolean, reason: JRoomReason) => void

加入通话结果回调

Type declaration

    • (result: boolean, reason: JRoomReason): void
    • Parameters

      • result: boolean

        加入通话是否成功

      • reason: JRoomReason

        加入失败原因,当 result 为 false 时该值有效

      Returns void

调用 JCallManager.join 接口后,会收到此回调通知加入结果。

  • true: 成功加入通话
  • false: 加入通话失败,具体原因见 reason 参数

JRoomReason 错误码定义

onLeave?: (serialId: string, reason: JRoomReason) => void

离开通话结果回调

Type declaration

    • (serialId: string, reason: JRoomReason): void
    • Parameters

      • serialId: string

        业务流水号

      • reason: JRoomReason

        离开原因

      Returns void

调用 JCallManager.leave 接口后,会收到此回调通知离开结果。 离开原因可能是主动离开、被踢出、网络异常等。

JRoomReason 离开原因定义

onCallPropertyChanged?: (propChangeParam: JCallPropChangeParam) => void

通话属性改变回调

Type declaration

当通话中的属性发生变化时触发,如屏幕共享状态变化、视频状态变化等。 应用可以通过此回调更新UI显示。

onRejectInviteResult?: (
    operatorId: number,
    result: boolean,
    reason: string,
) => void

拒绝邀请结果回调

Type declaration

    • (operatorId: number, result: boolean, reason: string): void
    • Parameters

      • operatorId: number

        操作ID,对应 JCallManager.rejectInvite 的返回值

      • result: boolean

        操作是否成功

      • reason: string

        操作失败原因

      Returns void

调用 JCallManager.rejectInvite 接口后,会收到此回调通知拒绝结果。

  • true: 成功拒绝邀请
  • false: 拒绝邀请失败,具体原因见 reason 参数
onAcceptInviteResult?: (
    operatorId: number,
    result: boolean,
    reason: string,
) => void

接受邀请结果回调

Type declaration

    • (operatorId: number, result: boolean, reason: string): void
    • Parameters

      • operatorId: number

        操作ID,对应 JCallManager.acceptInvite 的返回值

      • result: boolean

        操作是否成功

      • reason: string

        操作失败原因

      Returns void

调用 JCallManager.acceptInvite 接口后,会收到此回调通知接受结果。

  • true: 成功接受邀请
  • false: 接受邀请失败,具体原因见 reason 参数
onCancelInviteResult?: (
    operatorId: number,
    result: boolean,
    reason: string,
) => void

取消邀请结果回调

Type declaration

    • (operatorId: number, result: boolean, reason: string): void
    • Parameters

      • operatorId: number

        操作ID,对应 JCallManager.cancelInvite 的返回值

      • result: boolean

        操作是否成功

      • reason: string

        操作失败原因

      Returns void

调用 JCallManager.cancelInvite 接口后,会收到此回调通知取消结果。

  • true: 成功取消邀请
  • false: 取消邀请失败,具体原因见 reason 参数
onInviteResult?: (operatorId: number, result: boolean, reason: string) => void

邀请结果回调

Type declaration

    • (operatorId: number, result: boolean, reason: string): void
    • Parameters

      • operatorId: number

        操作ID,对应 JCallManager.invite 的返回值

      • result: boolean

        操作是否成功

      • reason: string

        操作失败原因

      Returns void

调用 JCallManager.invite 接口后,会收到此回调通知邀请结果。

  • true: 成功发送邀请
  • false: 发送邀请失败,具体原因见 reason 参数
onInviteReceived?: (param: JCallExtraParam) => void

收到邀请通知回调

Type declaration

当收到其他用户的通话邀请时触发此回调。 应用可以通过此回调显示来电界面,让用户选择接听或拒绝。

JCallExtraParam 邀请参数详情

onInviteCanceled?: (param: JCallExtraParam) => void

收到邀请被取消通知回调

Type declaration

当收到其他用户取消通话邀请时触发此回调。 应用可以通过此回调关闭来电界面。

JCallExtraParam 邀请参数详情

onInviteRejected?: (param: JCallExtraParam) => void

邀请被拒绝通知回调

Type declaration

当收到其他用户拒绝通话邀请时触发此回调。 应用可以通过此回调关闭来电界面。

JCallExtraParam 邀请参数详情