Class JCallManagerAbstract

网络电话管理类 JCallManager

Implements

Remarks

提供网络电话相关的功能，包括加入/离开通话、邀请/接受/拒绝通话等操作。 采用单例模式，通过 JCallManager.getInstance 方法获取实例。

Example

// 获取JCallManager实例
const callManager = JCallManager.getInstance();

// 加入通话
const joinParam = new JCallJoinParam();
joinParam.video = true;
callManager.join("call-123", joinParam);

// 邀请其他用户加入通话
const extraParam = new JCallExtraParam();
extraParam.video = true;
callManager.invite("user-456", extraParam);

Implements

Methods

getInstance setForeground setUIContext setNavPathStack login logout destroy getClientLoginState sendOnlineMessage sendMessageInCall uploadFile getCallId setCustomConfig setVideoAngle miniTalkingWindow restoreTalkingWindow getVersion getSDKVersion enableRemoteCollaboration getClient getMediaDevice getCall addCallback removeCallback join leave getCallState acceptInvite rejectInvite cancelInvite invite

Methods

StaticgetInstance

  • getInstance(): JCallManager

    获取JCallManager单例实例

    Returns JCallManager

    JCallManager实例

    Remarks

    如果实例不存在，则创建一个新实例并返回。 应用应始终通过此方法获取JCallManager实例，而不是直接创建。

AbstractsetForeground

  • setForeground(foreground: boolean): void

    设置应用前台状态

    Parameters

    • foreground: boolean

      是否为前台状态

    Returns void

    Remarks

    当应用切换到前台或后台时调用此方法，用于优化资源使用和通知处理。

AbstractsetUIContext

  • setUIContext(uiContext: UIContext): void

    设置UI上下文对象

    Parameters

    • uiContext: UIContext

      UI上下文对象

    Returns void

    Remarks

    如果设置了，我们的通话界面会往该对象获取的 Router 对象中添加页面

AbstractsetNavPathStack

  • setNavPathStack(pathStack: any, navId: undefined | string): void

    设置 NavPathStack 实例

    Parameters

    • pathStack: any

      NavPathStack实例

    • navId: undefined | string

      Navigation容器绑定的id

    Returns void

    Remarks

    如果设置了，我们的通话界面会通过这个实例去进行路由跳转

Abstractlogin

  • login(
        applicationContext: ApplicationContext,
        loginParam: JCCLoginParam,
    ): boolean

    登录到服务器

    Parameters

    • applicationContext: ApplicationContext

      应用上下文

    • loginParam: JCCLoginParam

      登录参数

    Returns boolean

    登录请求是否成功发送

    Remarks

    登录结果将通过 JCallCallback#onLogin 回调通知。 登录成功后，才能使用其他通话相关功能。

Abstractlogout

  • logout(): boolean

    登出服务器

    Returns boolean

    登出请求是否成功发送

    Remarks

    登出结果将通过 JCallCallback#onLogout 回调通知。 登出后，所有通话相关功能将不可用，直到重新登录。

Abstractdestroy

  • destroy(): void

    销毁管理器实例

    Returns void

    Remarks

    销毁实例，释放资源。 销毁实例后，不能再使用本实例，需要重新创建。

AbstractgetClientLoginState

  • getClientLoginState(): JClientState

    获取客户端登录状态

    Returns JClientState

    当前登录状态

    See

    JClientState 登录状态定义

AbstractsendOnlineMessage

  • sendOnlineMessage(message: string, userId: string): number

    发送在线消息

    Parameters

    • message: string

      消息内容

    • userId: string

      接收者用户ID

    Returns number

    消息ID，可用于后续跟踪消息状态

    Remarks

    发送在线消息给指定用户，不需要建立通话连接。

AbstractsendMessageInCall

  • sendMessageInCall(type: string, content: string, userId: string): boolean

    在通话中发送消息

    Parameters

    • type: string

      消息类型

    • content: string

      消息内容

    • userId: string

      接收者用户ID

    Returns boolean

    消息是否成功发送

    Remarks

    在已建立的通话中发送消息给指定用户。 需要先调用 JCallManager#join 加入通话才能使用此功能。

AbstractuploadFile

  • uploadFile(param: JCCUploadFileParam): void

    上传文件

    Parameters

    • param: JCCUploadFileParam

      上传文件参数

    Returns void

    Remarks

    上传文件到服务器，上传进度和结果将通过回调通知。

AbstractgetCallId

  • getCallId(): undefined | string

    获取当前通话ID

    Returns undefined | string

    当前通话ID，如果未加入通话则返回undefined

AbstractsetCustomConfig

  • setCustomConfig(customConfig: JCallCustomConfig): void

    设置自定义配置

    Parameters

    Returns void

    Remarks

    设置通话相关的自定义配置，如视频质量、音频质量等。 应在加入通话前调用此方法。

AbstractsetVideoAngle

  • setVideoAngle(angle: number): void

    设置视频角度

    Parameters

    • angle: number

      视频旋转角度，单位为度

    Returns void

    Remarks

    设置视频画面的旋转角度，用于适配不同设备的摄像头方向。

AbstractminiTalkingWindow

  • miniTalkingWindow(): void

    最小化通话窗口

    Returns void

    Remarks

    将通话窗口最小化，但保持通话连接。

AbstractrestoreTalkingWindow

  • restoreTalkingWindow(): void

    恢复通话窗口

    Returns void

    Remarks

    将最小化的通话窗口恢复到正常大小。

AbstractgetVersion

  • getVersion(): JCCVersion

    获取SDK版本信息

    Returns JCCVersion

    SDK版本信息

AbstractgetSDKVersion

  • getSDKVersion(): string

    获取SDK版本

    Returns string

    SDK版本号

    Remarks

    获取当前SDK的版本号。

AbstractenableRemoteCollaboration

  • enableRemoteCollaboration(enable: boolean): boolean

    开启/关闭远程协作

    Parameters

    • enable: boolean

      true: 开启

      • false: 关闭

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用失败

AbstractgetClient

  • getClient(): any

    获取JRTCClient实例

    Returns any

    JRTCClient实例

    Remarks

    获取JRTCClient实例，用于访问JRTCClient的API。

AbstractgetMediaDevice

  • getMediaDevice(): any

    获取JRTCMediaDevice实例

    Returns any

    获取JRTCMediaDevice实例

    Remarks

    获取JRTCMediaDevice实例，用于访问JRTCMediaDevice的API。

AbstractgetCall

  • getCall(): any

    获取 JRTCCall 实例

    Returns any

    获取JRTCCall实例

    Remarks

    获取JRTCCall实例，用于访问JRTCCall的API。

AbstractaddCallback

  • addCallback(callback: JCallCallback): void

    添加回调监听

    Parameters

    Returns void

    Remarks

    添加回调监听，用于接收通话状态变化、邀请结果等事件通知。 同一个回调对象只能添加一次，重复添加无效。

AbstractremoveCallback

  • removeCallback(callback: JCallCallback): void

    移除回调监听

    Parameters

    Returns void

    Remarks

    移除之前添加的回调监听，不再接收相关事件通知。

Abstractjoin

  • join(serialId: string, joinParam: JCallJoinParam): boolean

    加入通话

    Parameters

    • serialId: string

      业务流水号，保证唯一，必选

    • joinParam: JCallJoinParam

      加入通话参数，传undefined则使用默认参数

    Returns boolean

    接口调用结果

    Remarks

    该方法让用户加入通话，在同一个通话内的用户可以互相通话。 如果用户已在通话中，必须退出当前通话，即处于空闲状态，才能进入其他通话， 否则将直接返回false，且不会收到回调通知。

    加入结果将通过 JCallCallback.onJoin 回调通知。

    • true: 接口调用成功，会收到回调
    • false: 接口调用异常，不会收到回调

    See

    JCallJoinParam 加入参数详情

Abstractleave

  • leave(): boolean

    离开通话

    Returns boolean

    接口调用结果

    Remarks

    离开当前通话，回到空闲状态。 离开结果将通过 JCallCallback.onLeave 回调通知。

    • true: 接口调用成功，非空闲状态下，会收到回调
    • false: 接口调用异常，不会收到回调

AbstractgetCallState

  • getCallState(): JRoomState

    获取当前通话状态

    Returns JRoomState

    当前通话状态

    See

    JRoomState 通话状态定义

AbstractacceptInvite

  • acceptInvite(video: boolean, callAcceptParam?: JCallAcceptParam): number

    接受通话邀请

    Parameters

    • video: boolean

      是否需要视频

    • OptionalcallAcceptParam: JCallAcceptParam

      接受邀请参数，可选

    Returns number

    操作ID

    Remarks

    接受其他用户的通话邀请。 接受结果将通过 JCallCallback.onAcceptInviteResult 回调通知。

    • 操作ID: 接口调用成功，对应回调的operatorId参数
    • -1: 接口调用异常，不会收到回调

    See

    JCallAcceptParam 接受参数详情

AbstractrejectInvite

  • rejectInvite(): number

    拒绝通话邀请

    Returns number

    操作ID

    Remarks

    拒绝其他用户的通话邀请。 拒绝结果将通过 JCallCallback#onRejectInviteResult 回调通知。

    • 操作ID: 接口调用成功，对应回调的operatorId参数
    • -1: 接口调用异常，不会收到回调

AbstractcancelInvite

  • cancelInvite(): number

    取消通话邀请

    Returns number

    操作ID

    Remarks

    取消已发送的通话邀请。 取消结果将通过 JCallCallback.onCancelInviteResult 回调通知。

    • 操作ID: 接口调用成功，对应回调的operatorId参数
    • -1: 接口调用异常，不会收到回调

Abstractinvite

  • invite(calleeUserId: string, param: undefined | JCallExtraParam): number

    邀请其他成员加入通话

    Parameters

    • calleeUserId: string

      被邀请者用户ID

    • param: undefined | JCallExtraParam

      邀请参数

    Returns number

    操作ID

    Remarks

    邀请其他用户加入当前通话。 需要已经加入通话才能调用此方法。 邀请结果将通过 JCallCallback.onInviteResult 回调通知。

    • 操作ID: 接口调用成功，对应回调的operatorId参数
    • -1: 接口调用异常，不会收到回调

    See

    JCallExtraParam 邀请参数详情

设置

主题