CallPlus-for-Android-SDK/cn.rongcloud.callplus.api/RCCallPlusClient

RCCallPlusClient

abstract class RCCallPlusClient

Constructors

RCCallPlusClient

constructor()

Functions

abstract fun accept(callId: String)

接听通话。调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onAccept 方法获取执行结果。

当发生网络断开或IM链接断开等情况导致请求失败时，该方法会根据SDK内部的策略进行重试。如果重试一直失败，最长等待时间约为47秒，然后返回失败监听。

cancelChangeMediaType

abstract fun cancelChangeMediaType(transactionId: String)

取消已经发起的切换媒体类型请求。调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onCancelChangeMediaType 方法获取执行结果。

当发生网络断开或IM链接断开等情况导致请求失败时，该方法会根据SDK内部的策略进行重试。如果重试一直失败，最长等待时间约为47秒，然后返回失败监听。

deleteAllCallRecordsFromServer

abstract fun deleteAllCallRecordsFromServer()

清除当前用户通话记录。调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onDeleteAllCallRecordsFromServer 方法获取执行结果。

deleteCallRecordsFromServer

abstract fun deleteCallRecordsFromServer(callIds: List<String>)

批量删除通话记录。调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onDeleteCallRecordsFromServer 方法获取执行结果。

enableMicrophone

abstract fun enableMicrophone(enable: Boolean): RCCallPlusResultCode

是否开启麦克风。该方法为同步方法

abstract fun enableSpeaker(enable: Boolean)

设置是否切换听筒为扬声器。该方法为同步方法

getAvailableCallRecordsFromServer

abstract fun getAvailableCallRecordsFromServer()

从服务器查询当前用户未结束的通话记录。调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onGetAvailableCallRecordsFromServer 方法获取执行结果。

getCallRecordsFromServer

abstract fun getCallRecordsFromServer(syncTime: Long, count: Int)

获取当前用户通话记录。调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onGetCallRecordsFromServer 方法获取执行结果。

getCurrentCallSession

abstract fun getCurrentCallSession(): RCCallPlusSession

获取当前通话实体，通话实体中维护着当前通话的所有信息。

open fun getInstance(): RCCallPlusClient

open fun getVersion(): String

获取SDK版本号码

abstract fun hangup()

挂断通话。调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onHangup 方法获取执行结果。

abstract fun hangup(callId: String)

挂断指定通话。调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onHangup 方法获取执行结果。

abstract fun init(config: RCCallPlusConfig): RCCallPlusResultCode

初始化并设置通话全局配置，重复调用该方法时SDK内部会重新初始化。

abstract fun invite(userIds: List<String>)

邀请用户加入通话。本端用户正在通话时，可以使用该方法邀请用户加入本通话。调用该方法后会触发以下回调：

被邀请用户会收到 onReceivedCall 回调。
该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onInvite 方法获取执行结果。

当发生网络断开或IM链接断开等情况导致请求失败时，该方法会根据SDK内部的策略进行重试。如果重试一直失败，最长等待时间约为47秒，然后返回失败监听。

isMicrophoneEnabled

abstract fun isMicrophoneEnabled(): Boolean

本地麦克风是否开启。获取的是 enableMicrophone 设置后的值该方法为同步方法

abstract fun joinCall(callId: String)

加入多人通话。方法使用场景：

场景一：A、B、C用户正在群通话时，其中一个用户挂断后，只要该群通话未结束。曾经参与过群通话的用户可以直接加入。
场景二：收到群通话呼叫后，可以使用该方法直接加入。

调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onJoinCall 方法获取执行结果。

当发生网络断开或IM链接断开等情况导致请求失败时，该方法会根据SDK内部的策略进行重试。如果重试一直失败，最长等待时间约为47秒，然后返回失败监听。

muteAllRemoteAudio

abstract fun muteAllRemoteAudio(mute: Boolean)

通话过程中，设置所有远端用户是否静音,默认否如果设置为true，后续订阅的远端用户声音也会被静音该功能只是不播放远端用户的声音，依然在接收订阅成功的音频流

removeVideoView

abstract fun removeVideoView(userIds: List<String>)

删除远端用户的视频流渲染视图

replyChangeMediaType

abstract fun replyChangeMediaType(transactionId: String, isAgreed: Boolean)

响应通话中的切换媒体类型请求。同意升级后，SDK内部会自动发布摄像头流。为了远端用户能正常观看需要开发者调用 startCamera 和 startCamera 打开摄像头调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onReplyChangeMediaType 方法获取执行结果。

当发生网络断开或IM链接断开等情况导致请求失败时，该方法会根据SDK内部的策略进行重试。如果重试一直失败，最长等待时间约为47秒，然后返回失败监听。

requestChangeMediaType

abstract fun requestChangeMediaType(mediaType: RCCallPlusMediaType)

通话中请求将音频通话切换为视频通话。远端用户同意升级后，SDK内部会自动发布摄像头流。为了远端用户能正常观看需要开发者调用 startCamera 和 startCamera 打开摄像头调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onRequestChangeMediaType 方法
当发生网络断开或IM链接断开等情况导致请求失败时，该方法会根据SDK内部的策略进行重试。如果重试一直失败，最长等待时间约为47秒，然后返回失败监听。

abstract fun setAudioConfig(config: RCCallPlusAudioConfig): RCCallPlusResultCode

设置本地音频配置。必须与 startCall、accept 和 joinCall 方法前设置才有效

setAudioFrameListener

abstract fun setAudioFrameListener(audioFrameListener: IRCCallPlusAudioFrameListener)

设置本地音频采集数据回调。多次设置会覆盖，以最后一次设置生效设置为"null"时，释放监听资源

setCallPlusEventListener

abstract fun setCallPlusEventListener(listener: IRCCallPlusEventListener)

设置通话事件监听。多次设置会覆盖，以最后一次设置生效设置为"null"时，释放监听资源如果需要通过该监听由 onReceivedCall 回调接收PUSH通知的通话。则需要在IM初始化和连接前注册

setCallPlusResultListener

abstract fun setCallPlusResultListener(listener: IRCCallPlusResultListener)

设置通话API结果回调监听。多次设置会覆盖，以最后一次设置生效设置为"null"时，释放监听资源

setCallPlusStatusReportListener

abstract fun setCallPlusStatusReportListener(statusReportListener: IRCCallPlusStatusReportListener)

设置通话质量数据监听。多次设置会覆盖，以最后一次设置生效设置为"null"时，释放监听资源

abstract fun setVideoConfig(config: RCCallPlusVideoConfig): RCCallPlusResultCode

设置视频分辨率、码率、帧率。此方法支持通话过程中动态设置。

setVideoFrameListener

abstract fun setVideoFrameListener(videoFrameListener: IRCCallPlusVideoFrameListener)

设置本地视频采集回调。多次设置会覆盖，以最后一次设置生效设置为"null"时，释放监听资源回调返回的数据类型 (RCRTCVideoFrame#getCaptureType()) 通过 RCCallPlusConfig.Builder.enableEncoderTexture(bool) 控制。


         RCCallPlusConfig config = RCCallPlusConfig.Builder.create()
                .enableEncoderTexture(false) //视频流采集方式
                .build();
         RCCallPlusResultCode resultCode = RCCallPlusClient.getInstance().init(config);

abstract fun setVideoView(localVideoView: RCCallPlusLocalVideoView)

设置本端用户摄像头采集的视频流渲染视图，要释放本端视图，再次设置null即可

abstract fun setVideoView(remoteVideoViewList: List<RCCallPlusRemoteVideoView>)

设置远端用户视频流渲染视图

abstract fun startCall(userIds: List<String>, callType: RCCallPlusType, mediaType: RCCallPlusMediaType)

发起呼叫。调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onStartCall 方法获取执行结果。

当发生网络断开或IM链接断开等情况导致请求失败时，该方法会根据SDK内部的策略进行重试。如果重试一直失败，最长等待时间约为47秒，然后返回失败监听。

abstract fun startCamera()

abstract fun startCamera(cameraId: Int, mirror: Boolean)

开启摄像头数据采集。调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onStartCamera 方法获取执行结果。

abstract fun stopCamera()

关闭摄像头。调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onStopCamera 方法获取执行结果。

abstract fun switchCamera()

切换前后摄像头。调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onSwitchCamera 方法获取执行结果。

abstract fun switchCamera(cameraId: Int, mirror: Boolean)

切换指定摄像头。调用该方法后会触发以下回调：

该方法内部为异步执行。本地用户通过注册的 setCallPlusResultListener 监听的 onSwitchCamera 方法获取执行结果。

abstract fun unInit()

反初始化通话引擎。如果在调用销毁时有正在进行的通话，销毁前SDK内部会调用挂断方法。会释放给 RCCallPlusClient 对象设置的所有监听