实现视频通话

本文档为您展示通过 SDK 实现视频通话（座席）的相关步骤，帮助您在远程银行和视频客服的场景下实现智能排队、座席转接、全景录像、座席管理的相关能力。

1. 前提条件

请确认您已完成以下操作：

• 已获取 App Key。

AppKey 作为同个环境的分域依据，同一个域的终端才能实现互通，AppKey 由 Juphoon 视频平台提供。

TIP

请扫描下方二维码联系 Juphoon 市场售前工程师获取 AppKey。

• 集成 SDK（Android）。

  TIP

  如需集成指导，请扫描上方二维码联系 Juphoon 市场售前工程师获取相关咨询。

2. 快速跑通Sample

1. 在 Juphoon SDK RTC 文档中心，选择视频客服-访客选择项，在SDK下载页面下载体验 Sample 示例项目。访问下载地址 (opens new window)，示例如下：

1. 下载完成后，打开安装包，解压 JCCSample，然后安装 JCCSample.apk

2. 打开应用程序后，设置正确的 appkey，环境地址以及账号。

3. 1. 首先点击初始化按钮，成功后，登入按钮变为可点击。
   2. 确认座席账号输入无误之后，点击登入按钮，按钮字样变为登出，即登录成功。
   3. 点击座席按钮，即可进入对应座席页面。

1. 进入座席页面后，点击签入即可回呼访客及等待访客来电。

3. 实现视频通话

初始化

注：我们所有的方法都建议在主线程调用，否则可能会出现异常无法正常使用，回调接口也都在主线程上报。

在使用业务接口前，需对 Juphoon RTC SDK 进行初始化操作。

JRTCClient (opens new window)	基础模块	负责视频平台的登录登出，只有登录到视频平台才可以使用视频相关的业务，AppKey 作为同个环境的分域依据，同一个域的终端才能实现互通。
JRTCMediaDevice (opens new window)	媒体模块	负责本地的媒体设备操作，视频画面渲染等功能。
JRTCAgent (opens new window)	座席模块	负责座席的视频业务的处理，比如接听来电，控制音视频流等 这些模块初始化的时候需要有 callback 作为入参来监听各模块的事件

AppKey 作为同个环境的分域依据，同一个域的终端才能实现互通，AppKey 由 Juphoon 视频平台提供。

在使用业务接口前，需对 Juphoon SDK 进行初始化操作。

注意：

Guest 访客模块和 Agent 座席模块只支持初始化一个，否则会出现接收不到呼叫，接收不到邀请等现象影响正常的业务流程。

初始化参数详见 JRTCClientInitParam (opens new window)。

示例代码：

class JRTCManager implements JRTCClientCallback, JRTCAgentCallback, JRTCMediaDeviceCallback{
	public void init(){
        JRTCClientInitParam param = new JRTCClientInitParam();
        /**
         * 设置AppKey
         * 用户从 Juphoon RTC 平台上申请的 AppKey 字符串
         */
        param.setAppKey("appKey");
        /**
         * 设置应用名称，比如：JRTCCGuest JRTCSample等
         */
        param.setAppName("appName");
        /**
         * 设置是否需要自动加载so库，默认true
         */
        param.setLoadLibrary(true);
        /**
         * 设置接入服务器地址
         */
        param.setServer("server");
        /**
         * 设置SDK信息存储目录，该目录下的log目录为日志目录
         */
        param.setSdkInfoDir("sdkInfoDir");

        client = JRTCClient.create(context, this, param);
        mediaDevice = JRTCMediaDevice.create(client, this, null);
        agent = JRTCAgent.create(client, mediaDevice, this);

        //设置基本
		client.setServer("server");
		client.setAppKey("appkey");
    }
}

然后根据 Android Stduio 的提示将 interface 的接口实现补全即可。

登录

SDK 初始化之后，即可进行登录的集成，登录接口调用流程如下所示：

登录到 Juphoon 视频平台主要调用的是 JRTCClient (opens new window) 的登录接口 login (opens new window) 。

/**
  * 登录 Juphoon RTC 平台，只有登录成功后才能进行平台上的各种业务
  * 登录结果通过 {@link JRTCClientCallback#onLogin onLogin} 回调通知
  * @param userId 用户ID
  * @param password 密码，不能为空
  * @return 接口调用结果
  * - true: 接口调用成功
  * - false: 接口调用异常
  * @warning 目前只支持免鉴权模式，服务器不校验账号密码，免鉴权模式下当账号不存在时会自动去创建该账号
  * @warning 用户名为英文数字和'+' '-' '_' '.'，长度不要超过64字符，'-' '_' '.'不能作为第一个字符
  */
public abstract boolean login(String userId, String password);

/**
  * 登录 Juphoon RTC 平台，只有登录成功后才能进行平台上的各种业务
  * 登录结果通过 {@link JRTCClientCallback#onLogin onLogin} 回调通知
  *
  * @param userId            用户ID
  * @param password          密码，不能为空
  * @param clientLoginParam  登录参数，一般不需要设置，如需设置请询问客服，传 null 则按默认值
  * @see JRTCClientLoginParam
  * @return 接口调用结果
  * - true: 接口调用成功
  * - false: 接口调用异常
  * @warning 目前只支持免鉴权模式，服务器不校验账号密码，免鉴权模式下当账号不存在时会自动去创建该账号
  * @warning 用户名为英文数字和'+' '-' '_' '.'，长度不要超过64字符，'-' '_' '.'不能作为第一个字符
  */
public abstract boolean login(String userId, String password, JRTCClientLoginParam clientLoginParam);

/**
 * 重登录，该接口在如果有其他同类型终端登录着则会登录失败，一般用于记住了账号后重启自动登录逻辑
 *
 * @param password 密码，免鉴权模式密码可以随意输入，但不能为空
 * @return 返回 true 表示正常执行调用流程，false 表示调用异常，异常错误通过 JRTCClientCallback 通知
 */
public abstract boolean reLogin(String userId, String password);

JRTCClientLoginParam (opens new window)参数介绍

accelerateKey	加速云 KEY
accelerateKeySecret	加速云 KEY 密钥
accountEntry	账户分录参数，如果支持国密S3则需要设置 certificate 参数，否则可以不设置 certificate 参数
certificate	S3 国密证书 Base64 编码内容
autoCreateAccount	是否自动创建账号（免鉴权使用），默认 true
deviceId	设备 id
token	token
tokenType	token 校验类型
tokenExtraParam	token 校验拓展参数
logFilter	日志过滤标签（用于日志管理平台过滤终端日志使用）
terminalType	终端登录类型，支持多终端登录，默认所有终端相同会导致互踢
optimizeDataRouter	是否开启数据路由优化，默认 true

登录的结果将会通过 JRTCClientCallback (opens new window) 中的 onLogin (opens new window) 接口上报。

/**
 * 登录结果回调
 *
 * @param result true 表示登录成功，false 表示登录失败
 * @param reason 当 result 为 false 时该值有效
 */
void onLogin(boolean result, @ReasonCode int reason);

示例代码：

// 创建登录配置参数
JRTCClientLoginParam loginParam = new JRTCClientLoginParam();
// 登录
client.login("6666", "123456", loginParam);

public void onLogin(boolean result, @ReasonCode int reason) {
    if(result) {
        // 登录成功
    } else {
        // 登录失败，具体原因查询 reason 错误码
    } 
}

获取业务号列表

调用 queryAllGroups (opens new window) 可以获取业务号列表。

/**
 * 获取业务号列表
 *
 * @return 接口调用结果
 * - true: 接口调用成功，返回结果通过 {@link JRTCAgentCallback#onGetAllGroups onGetAllGroups} 回调上报
 * - false: 接口调用异常
 */
public abstract boolean queryAllGroups();

获取业务号信息通过实现 JRTCAgentCallback (opens new window) 中的 onGetAllGroups (opens new window) 接口上报。

/**
 * 获取业务号列表回调
 *
 * 座席调用 {@link JRTCAgent#queryAllGroups queryAllGroups} 接口获取业务号列表，会收到此回调。
 * @param groups 座席业务实体对象列表，获取失败时为 null
 * @param result 获取结果
 * - true: 获取成功
 * - false: 获取失败
 */
void onGetAllGroups(boolean result, List<JRTCCallCenterGroupItem> groups);

示例代码：

// 获取业务号列表
agent.queryAllGroups();

public void onGetAllGroups(boolean result, List<JRTCCallCenterGroupItem> groups) {
    if(result) {
        // 获取成功
    } else {
        // 获取失败
    }
}

查询指定业务号的空闲座席

通过业务号查询空闲的座席。

/**
 * 查询指定业务号的空闲座席
 *
 * 查询结果通过 {@link JRTCAgentCallback#onQueryAvailableAgentList onQueryAvailableAgentList} 回调上报
 * @param businessNumber 业务号，例如 10087
 * @return 操作id，与 {@link JRTCAgentCallback#onQueryAvailableAgentList onQueryAvailableAgentList} 的 operationId 参数对应
 */
public abstract int queryAvailableAgentList(String businessNumber);

指定业务号的空闲座席查询结果通过实现 JRTCAgentCallback (opens new window) 中的 onQueryAvailableAgentList (opens new window) 接口上报。

/**
 * 查询空闲座席回调
 *
 * 座席调用 {@link JRTCAgent#queryAvailableAgentList queryAvailableAgentList} 接口查询空闲座席成功时，会收到此回调。
 * @param operationId 操作id，对应 {@link JRTCAgent#queryAvailableAgentList queryAvailableAgentList} 接口的返回值
 * @param result 查询结果
 * - true: 查询成功
 * - false: 查询失败
 * @param userIds 查询到的空闲座席列表
 */
void onQueryAvailableAgentList(int operationId, boolean result, List<String> userIds);

示例代码：

// 查询空闲座席
agent.queryAvailableAgentList("10086");

void onQueryAvailableAgentList(int operationId, boolean result, List<String> userIds) {
    if (result) {
        // 查询成功，具体查看 userIds
    } else {
     	// 查询失败   
    }
}

座席签入

登录视频能力平台成功后，需要调用 checkIn (opens new window) 签入到排队机才能由排队机进行路由分配。

/**
 * 签入
 * <p>
 * 签入到排队机，签入后示忙/示闲状态由 busy 参数决定 <br>
 * 示闲状态下正常呼叫进线 <br>
 * 调用接口前确定 JRTCClient 登录成功 <br>
 * 调用该接口前需先确定 {@link #getOperatorState operatorState} 来获取到当前的签入状态
 *
 * @param userId 座席用户ID，需与业务管理平台上配置的座席staffId对应，如果传空，则默认用当前登录用户ID签入
 * @param busy   签入后示忙/示闲状态
 *               - true: 示忙
 *               - false: 示闲
 * @return 接口调用结果
 * - true: 接口调用成功，签入结果会触发 {@link JRTCAgentCallback#onCheckin onCheckin} 回调上报
 * - false: 接口调用异常
 * @oaram checkinParam 签入其他参数
 */
public abstract boolean checkin(String userId, boolean busy, JRTCAgentCheckinParam checkInParam);

/**
 * 签入
 * <p>
 * 签入到排队机，签入后示忙/示闲状态由 busy 参数决定 <br>
 * 示闲状态下正常呼叫进线 <br>
 * 调用接口前确定 JRTCClient 登录成功 <br>
 * 调用该接口前需先确定 {@link #getOperatorState operatorState} 来获取到当前的签入状态
 *
 * @param userId 座席用户ID，需与业务管理平台上配置的座席staffId对应
 * @param role   座席角色类型，目前该参数已有服务端控制，不再通过终端设置，可忽略
 * @param busy   签入后示忙/示闲状态
 *               - true: 示忙
 *               - false: 示闲
 * @return 接口调用结果
 * - true: 接口调用成功，签入结果会触发 {@link JRTCAgentCallback#onCheckIn onCheckIn} 回调上报
 * - false: 接口调用异常
 * @deprecated 请使用 {@link #checkin(String, boolean, JRTCAgentCheckinParam) checkin} 代替
 */
@Deprecated
public abstract boolean checkIn(String userId, @AgentRoleType int role, boolean busy);

/**
 * 签入
 * <p>
 * 签入到排队机，签入后默认示闲状态 <br>
 * 示闲状态下正常呼叫进线 <br>
 * 调用接口前确定 JRTCClient 登录成功 <br>
 * 调用该接口前需先确定 {@link #getOperatorState operatorState} 来获取到当前的签入状态
 *
 * @param userId 座席用户ID，需与业务管理平台上配置的座席staffId对应
 * @param role   座席角色类型，目前该参数已有服务端控制，不再通过终端设置，可忽略
 * @return 接口调用结果
 * - true: 接口调用成功，签入结果会触发 {@link JRTCAgentCallback#onCheckIn onCheckIn} 回调上报
 * - false: 接口调用异常
 * @deprecated 请使用 {@link #checkin(String, boolean, JRTCAgentCheckinParam) checkin} 代替
 */
@Deprecated
public abstract boolean checkIn(String userId, @AgentRoleType int role);

/**
 * 签入
 * <p>
 * 签入到排队机，签入后默认示闲状态 <br>
 * 示闲状态下正常呼叫进线 <br>
 * 调用接口前确定 JRTCClient 登录成功 <br>
 * 调用该接口前需先确定 {@link #getOperatorState operatorState} 来获取到当前的签入状态 <br>
 * 该方法座席用户ID默认为 {@link JRTCClient#getUserId userId} ，与业务管理平台上配置的座席staffId对应
 *
 * @param role 座席角色类型，目前该参数已有服务端控制，不再通过终端设置，可忽略
 * @return 接口调用结果
 * - true: 接口调用成功，签入结果会触发 {@link JRTCAgentCallback#onCheckIn onCheckIn} 回调上报
 * - false: 接口调用异常
 * @deprecated 请使用 {@link #checkin(String, boolean, JRTCAgentCheckinParam) checkin} 代替
 */
@Deprecated
public abstract boolean checkIn(@AgentRoleType int role);

/**
 * 签出
 * <p>
 * 签出后将不会收到排队机的呼叫分配 <br>
 * 签出排队机不影响 JRTCClient 的登录状态 <br>
 * 调用 {@link #getOperatorState operatorState} 可获取当前签入状态
 *
 * @return 接口调用结果
 * - true: 接口调用成功，签出结果通过 {@link JRTCAgentCallback#onCheckout onCheckout} 回调上报
 * - false: 接口调用异常
 */

签入方法包含几个重载，用来适应各种可配置的参数，比如签入后默认为示闲还是示忙、比如座席的角色。这些方法的需结合具体的需求来使用。

签入结果通过实现 JRTCAgentCallback (opens new window) 中的 onCheckIn (opens new window) 接口上报。

/**
 * 签入回调
 *
 * 座席调用 {@link JRTCAgent#checkIn checkIn} 接口成功，会收到此回调。
 * @param result 签入结果
 * - true: 签入成功
 * - false: 签入失败
 * @param pause 签入后的示闲/示忙状态
 * - true: 签入后示忙
 * - false: 签入后示闲
 * @param onlineTime 座席累计在线时长
 * @param breakTime 座席累计示忙时长
 * @param callTimes 通话次数
 * @param reason 签入失败原因
 */
void onCheckIn(boolean result, boolean pause, long onlineTime, long breakTime, long callTimes, int reason);

示例代码：

// 签入
agent.checkIn(JRTCAgent.AGENT_ROLE_MANAGER);
// 签入结果回调
public void onCheckIn(boolean result, boolean pause, long onlineTime, long breakTime, long callTimes, int reason) {
    if(result) {
        // 签入成功
    } else {
        // 签入失败，具体原因查询 reason 错误码
    }
}

座席签出

当所有业务处理完毕，座席可以使用 Agent 对象中的 checkout (opens new window) 签出排队机，签出后将不会分发访客到这个座席终端，业务管理平台上该座席的状态将变为离线。

/**
 * 签出
 *
 * 签出后将不会收到排队机的呼叫分配 <br>
 * 签出排队机不影响 JCClient 的登录状态 <br>
 * 调用 {@link #getOperatorState operatorState} 可获取当前签入状态
 * @return 接口调用结果
 * - true: 接口调用成功，签出结果通过 {@link JRTCAgentCallback#onCheckout onCheckout} 回调上报
 * - false: 接口调用异常
 */
public abstract boolean checkout();

签出结果通过实现 JRTCAgentCallback (opens new window) 中的 onCheckout (opens new window) 接口上报。

/**
 * 签出回调
 *
 * 座席调用 {@link JRTCAgent#checkout checkout} 接口签出排队机，会收到此回调。
 * @param result 签出结果
 * - true: 签出成功
 * - false: 签出失败
 * @param reason 签出原因
 */
void onCheckout(boolean result, @AgentCheckoutReason int reason);

座席签出原因详见 AgentCheckoutReason (opens new window)

示例代码：

// 座席签出
agent.checkout();

void onCheckout(boolean result, @AgentCheckoutReason int reason) {
    if(result) {
        // 签出成功
    } else {
        // 签出失败，具体原因查询 reason 错误码
    }
}

座席签入签出状态改变

座席签入签出状态发生变化都会通过 JRTCAgentCallback (opens new window) 中 onCheckStateChanged (opens new window)接口上报。

/**
  * 签出状态改变
  * @param currState 当前座席状态
  * @param oldState 旧的座席状态
  */
void onCheckStateChanged(@AgentOperatorState int currState, @AgentOperatorState int oldState);

座席签入签出状态详见 AgentOperatorState (opens new window)

示例代码：

public void onCheckStateChanged(@AgentOperatorState int currState, @AgentOperatorState int oldState) {
    if (currState == AGENT_OPERATOR_CHECKING_IN) {
            //正在签入中
    } else if (currState == AGENT_OPERATOR_CHECKED_IN) {
            //已签入
    } else if (currState == AGENT_OPERATOR_CHECKING_OUT) {
            //已签出
    } else if (currState == AGENT_OPERATOR_IDLE) {
            //签入失败
    }
}

获取座席签入状态

通过调用 getOperatorState (opens new window) 获取座席签入状态。

/**
 * 获取座席签入状态
 * @return 座席签入状态
 */
@AgentOperatorState
public abstract int getOperatorState();

示忙示闲

通过调用 Agent (opens new window) 对象的 ApplyStatePause (opens new window) 方法来切换该状态。

• 示忙：座席暂停服务，访客无法呼到该座席。
• 示闲：座席保持服务，访客可以呼到该座席。

/**
 * 示忙/示闲
 *
 * 示忙状态下不会收到呼叫来电，示闲状态下正常呼叫进线 <br>
 * 通话过程中调用该接口不会影响当前通话，从下个通话开始状态生效 <br>
 * 示忙/示闲的结果通过 {@link JRTCAgentCallback#onApplyResult onApplyResult} 回调上报
 * @param pause 示忙或是示闲
 * - true: 示忙
 * - false: 示闲
 * @return 接口调用结果
 * - > 0: 操作id，对应 {@link JRTCAgentCallback#onApplyResult onApplyResult} 回调的 operationId 参数
 * - -1:接口调用异常
 */
public abstract int applyStatePause(boolean pause);

如果需要在通话结束后设置默认示闲示忙，可以通过调用调用 JRTCAgent (opens new window) 对象的 setTermState (opens new window) 方法实现。

/**
 * 获取结束通话后的示闲/示忙状态，默认为示闲状态
 *
 * @return 通话结束后状态
 * @note 示忙状态下不会收到呼叫来电，示闲状态下正常呼叫进线
 */
public abstract int getTermState();

/**
 * 设置通话结束后示闲/示忙状态，默认为示闲状态
 *
 * @param state 状态
 */
public abstract void setTermState(@AgentTermState int state);

示忙示闲结果通过实现 JRTCAgentCallback (opens new window) 中的 onApplyResult (opens new window) 接口上报。

/**
 * 示忙/示闲回调
 *
 * 座席示忙/示闲状态发生改变时，会收到此回调，例如调用 {@link JRTCAgent#applyStatePause applyStatePause} 接口修改忙闲状态。 <br>
 * 可以通过 {@link JRTCAgent#isPause pause} 获取当前的忙闲状态。
 * @param operationId  对应 {@link JRTCAgent#applyStatePause applyStatePause} 接口的返回值
 * @param result 示忙/示闲操作结果
 * - true: 示忙/示闲成功
 * - false: 示忙/示闲失败
 */
void onApplyResult(int operationId, boolean result);

还可以调用 isPause (opens new window) 查询当前示闲示忙的状态。

/**
 * 获取示忙/示闲状态
 *
 * 调用 {@link #checkIn(int)} 或 {@link #checkIn(String, int)} 接口签入，状态为示闲 <br>
 * 调用 {@link #checkIn(String, int, boolean)} 接口签入，状态与 busy 参数一致 <br>
 * 调用 {@link #applyStatePause} 接口主动发起示忙示闲，状态与 pause 参数一致 <br>
 * @return 示忙/示闲状态
 * - true: 示忙状态
 * - false: 示闲状态
 */
public abstract boolean isPause();

示例代码：

//座席示忙
agent.applyStatePause(false);

//座席示忙示闲结果
public void onApplyResult(int operationId, boolean result) {
    if (result) {
        // 示忙示闲的操作成功
    }
    // 可以通过_agent对象获取当前的忙闲状态
    agent.isPause();
}

座席回呼

座席可以通过调用 recall (opens new window) 接口回呼访客。

/**
 * 座席回呼
 *
 * @param userId 访客用户ID
 * @param callParam 呼叫参数设置，此参数可传 null 则使用默认配置，详见 {@link JRTCCallCenterCallParam}
 * @return 接口调用结果
 * - true: 接口调用成功，通话状态会通过 {@link JRTCAgentCallback#onCallStateChanged onCallStateChanged} 回调上报
 * - false: 接口调用异常
 */
public abstract boolean recall(String userId, JRTCCallCenterCallParam callParam);

示例代码：

// 创建呼叫参数配置
JRTCCallCenterCallParam callParam = new JRTCCallCenterCallParam();
......
callParam.setExtraInfo("extraInfo"); // 设置随路参数
callParam.setSvcResolution("1 180 250 360 600 720 1400"); // 设置SVC参数
......
agent.recall("guestUserId", callParam);

接听来电

在座席收到来电的通知后，可以通过调用 answer (opens new window) 接口来接起访客的呼叫。

来电类型详见 CallIncomingType (opens new window)

CALL_INCOMING_TYPE_CALL (opens new window)：普通来电，访客调用 call (opens new window) 接口呼叫；

CALL_INCOMING_TYPE_INVITE (opens new window)：三方邀请来电，座席调用 inviteThirdAgent (opens new window) 接口邀请三方座席；

CALL_INCOMING_TYPE_FORWARD (opens new window)：转接来电，座席调用 transferCall (opens new window) 接口转接当前通话；

CALL_INCOMING_TYPE_DIRECT_CALL (opens new window)：直呼来电，访客调用 oneToOneCall (opens new window) 接口进行直呼座席；

 /**
 * 接听
 *
 * 主座席、第三方座席或是被转接的座席，都调用此接口接听通话 <br>
 * @return 接口调用结果
 * - true: 接口调用成功，会收到 {@link JRTCAgentCallback#onCallStateChanged onCallStateChanged} 回调
 * - false: 接口调用异常
 */
 public abstract boolean answer();

示例代码：

public void onCallStateChanged(@JRTCAgent.AgentCallStateChangeType int type, @JRTCAgent.CallIncomingType int incomingType, JRTCInviter inviter, @JRTCAgent.CallTermReason int reason) {
    if (type == AGENT_CHANGE_TYPE_INCOMING) {
        if (incomingType == CALL_INCOMING_TYPE_CALL) {
            // 普通呼叫来电
        } else if (incomingType == CALL_INCOMING_TYPE_INVITE) {
            // 三方邀请来电
        } else if (incomingType == CALL_INCOMING_TYPE_FORWARD) {
            // 转接来电
        } else if (incomingType == CALL_INCOMING_TYPE_DIRECT_CALL) {
            // 直呼来电
        }
        // 接听
		agent.answer();
    }
}

接听的结果同样通过 JRTCAgentCallback (opens new window) 的 onCallStateChanged (opens new window) 接口上报通话状态改变。

通话状态通知

座席签入成功后即为一个等待通话接入的状态，具体的通话由排队机进行分配，

• 访客呼叫场景：

1. 1. 座席收到来电，通话状态就改变为 AGENT_CHANGE_TYPE_INCOMING (opens new window)；
   2. 座席接听，成功进入通话，通话状态改变为 AGENT_CHANGE_TYPE_TALKING (opens new window)；
   3. 座席挂断或者其他成员挂断导致通话结束，通话状态改变为 AGENT_CHANGE_TYPE_TERMED (opens new window)；

• 回呼场景

• • 座席回呼访客，通话状态就改变为 AGENT_CHANGE_TYPE_CALLING (opens new window)
  • 访客接听，成功进入通话，通话状态改变为 AGENT_CHANGE_TYPE_TALKING (opens new window)；
  • 座席挂断或者其他成员挂断导致通话结束，通话状态改变为 AGENT_CHANGE_TYPE_TERMED (opens new window)

通过实现 JRTCAgentCallback (opens new window) 中的 onCallStateChanged (opens new window) 接口上报。

/**
 * 通话状态改变回调
 * @param type 通话状态改变类型，即以下情况会收到此回调：
 * - {@link JRTCAgent#AGENT_CHANGE_TYPE_INCOMING AGENT_CHANGE_TYPE_INCOMING} 收到来电（访客呼叫、坐席邀请、转接）
 * - {@link JRTCAgent#AGENT_CHANGE_TYPE_TALKING AGENT_CHANGE_TYPE_TALKING} 通话接通
 * - {@link JRTCAgent#AGENT_CHANGE_TYPE_TERMED AGENT_CHANGE_TYPE_TERMED} 通话挂断或被挂断
 * @param incomingType 来电类型，当 type == {@link JRTCAgent#AGENT_CHANGE_TYPE_INCOMING AGENT_CHANGE_TYPE_INCOMING} 时有效
 * @param inviter 邀请成员对象，当 type == {@link JRTCAgent#AGENT_CHANGE_TYPE_INCOMING AGENT_CHANGE_TYPE_INCOMING} 时有效
 * @param reason 挂断原因，只在 type 为 {@link JRTRTCCallCenter#AGENT_CHANGE_TYPE_TERMED AGENT_CHANGE_TYPE_TERMED} 时需要关注，详见 {@link JRTCAgent.CallTermReason CallTermReason}
 */
void onCallStateChanged(@AgentCallStateChangeType int type, @CallIncomingType int incomingType, JRTCInviter inviter, @CallTermReason int reason);

通话状态详见 AgentCallStateChangeType (opens new window)

通话结束原因详见 CallTermReason (opens new window)

示例代码：

public void onCallStateChanged(@GuestCallStateChangeType int type, @CallIncomingType int incomingType, JRTCInviter inviter, @CallTermReason int reason) {
    switch (type) {
        case GUEST_CHANGE_TYPE_CALLING:
            // 呼叫(座席回呼)
            break;
        case AGENT_CHANGE_TYPE_TALKING:
            // 通话建立
            break;        
        case AGENT_CHANGE_TYPE_TERMED:
            // 通话挂断
            break;           
        case AGENT_CHANGE_TYPE_INCOMING:
            // 收到来电
            break;          
    }
}

获取通话状态

/**
 * 获取当前通话状态
 *
 * @return 当前通话状态
 */
@CallState
public abstract int getCallState();

示例代码：

@CallState int callState = agent.getCallState();
if (callState == CALL_STATE_IDLE) {
    // 空闲状态
} else if (callState == CALL_STATE_INCOMING) {
    // 收到来电
} else if (callState == CALL_STATE_TALKING) {
    // 通话中
} else if (callState == CALL_STATE_CALLING) {
    // 呼叫中（回呼场景）
}

创建本地视频画面

初始化成功后，可以创建本地的视频画面，创建本地视频画面的时机没有具体要求，在通话前通话中皆可。

1. 通过调用 JRTCMediaDevice (opens new window) 里的 startCameraVideo (opens new window) 方法获取本地的视频对象。
2. 通过 startCameraVideo (opens new window) 方法里传入渲染的画布的句柄进行视频画面渲染。

/**
 * 开始本端视频渲染
 *
 * 获取本端视频预览对象 JRTCMediaDeviceVideoCanvas，通过此对象能获得视图用于UI显示
 * @note
 * 调用此方法时需要保证默认摄像头不为空，即 {@link #defaultCamera} 不为空，否则将直接返回 null
 * @param renderType 渲染模式:
 * - {@link #RENDER_FULL_SCREEN RENDER_FULL_SCREEN} : 铺满窗口，会有裁剪
 * - {@link #RENDER_FULL_CONTENT RENDER_FULL_CONTENT} : 全图像显示，会有黑边
 * - {@link #RENDER_FULL_AUTO RENDER_FULL_AUTO} : 自适应
 * @return
 * - JRTCMediaDeviceVideoCanvas 对象: 开始自身视频渲染成功
 * - null: 开始自身视频渲染失败
 */
public abstract JRTCMediaDeviceVideoCanvas startCameraVideo(@RenderType int renderType);

/**
 * 开始本端视频渲染
 *
 * 获取本端视频预览对象 JRTCMediaDeviceVideoCanvas，通过此对象能获得视图用于UI显示
 * @note
 * 调用此方法时需要保证默认摄像头不为空，即 {@link #defaultCamera} 不为空，否则将直接返回 null
 * @param renderType 渲染模式:
 * - {@link #RENDER_FULL_SCREEN RENDER_FULL_SCREEN} : 铺满窗口，会有裁剪
 * - {@link #RENDER_FULL_CONTENT RENDER_FULL_CONTENT} : 全图像显示，会有黑边
 * - {@link #RENDER_FULL_AUTO RENDER_FULL_AUTO} : 自适应
 * @param useTextureView 是否使用TextureView作为视图控件，默认SurfaceView作为视图控件
 * @return
 * - JRTCMediaDeviceVideoCanvas 对象: 开始自身视频渲染成功
 * - null: 开始自身视频渲染失败
 */
public abstract JRTCMediaDeviceVideoCanvas startCameraVideo(@RenderType int renderType, boolean useTextureView);

RenderType (opens new window) 决定了视频的渲染模式：

• RENDER_FULL_SCREEN (opens new window) 为填充模式：即将画面内容居中等比缩放以充满整个显示区域，超出显示区域的部分将会被裁剪掉，此模式下画面可能不完整；
• RENDER_FULL_CONTENT (opens new window) 为适应模式：即按画面长边进行缩放以适应显示区域，短边部分会被填充为黑色，此模式下图像完整但可能留有黑边。

代码示例：

// 创建本端视图渲染对象
JRTCMediaDeviceVideoCanvas localCanvas = 
    mediaDevice.startCameraVideo(JRTCMediaDevice.RENDER_FULL_SCREEN);
// 获取视频渲染组件
SurfaceView view = localCanvas.getVideoView();
// 将渲染视图添加到界面上
viewGroup.addView(view);

创建远端视频画面

当通话建立后，除了本地的视频画面，还有通话成员的远端视频画面，如果通话成员有视频流的上传，访客端可以获取到座席的视频流并进行渲染。

座席可在收到以下回调时进行界面处理：

• 收到 onCallStateChanged (opens new window) 回调且通话状态改为 AGENT_CHANGE_TYPE_TALKING (opens new window) 时，表示访客加入了通话。
• 收到 onMemberJoin (opens new window) 回调时，表示有其他成员加入通话。
• 收到 onMemberUpdate (opens new window) 回调时，表示通话中用户的通话状态变化。例如，可通过 changeParam.video (opens new window) 属性判断用户视频流状态是否发送改变；当 JRTCRoomParticipant.isVideo() (opens new window) 的值为 true ，表示远端用户已上传视频流，本端通过订阅远端视频流，获取远端视图渲染对象。

调用 startVideo (opens new window) 接口在界面画布上渲染远端视频对象画面。

/**
 * 开始其他端的视频渲染
 *
 * 获取其他端的视频预览对象 JRTCMediaDeviceVideoCanvas，通过此对象能获得视图用于UI显示
 *
 * @param streamId 视频流ID
 * @param renderType  渲染模式:
 * - {@link #RENDER_FULL_SCREEN RENDER_FULL_SCREEN} : 铺满窗口，会有裁剪
 * - {@link #RENDER_FULL_CONTENT RENDER_FULL_CONTENT} : 全图像显示，会有黑边
 * - {@link #RENDER_FULL_AUTO RENDER_FULL_AUTO} : 自适应
 * @return
 * - JRTCMediaDeviceVideoCanvas 对象: 开始自身视频渲染成功
 * - null: 开始自身视频渲染失败
 */
public abstract JRTCMediaDeviceVideoCanvas startVideo(String streamId, @RenderType int renderType);

/**
 * 开始其他端的视频渲染
 *
 * 获取其他端的视频预览对象 JRTCMediaDeviceVideoCanvas，通过此对象能获得视图用于UI显示
 *
 * @param renderId 视频流ID
 * @param renderType  渲染模式:
 * - {@link #RENDER_FULL_SCREEN RENDER_FULL_SCREEN} : 铺满窗口，会有裁剪
 * - {@link #RENDER_FULL_CONTENT RENDER_FULL_CONTENT} : 全图像显示，会有黑边
 * - {@link #RENDER_FULL_AUTO RENDER_FULL_AUTO} : 自适应
 * @param useTextureView 是否使用TextureView作为视图控件，默认SurfaceView作为视图控件
 * @return
 * - JRTCMediaDeviceVideoCanvas 对象: 开始自身视频渲染成功
 * - null: 开始自身视频渲染失败
 */
public abstract JRTCMediaDeviceVideoCanvas startVideo(String streamId, @RenderType int renderType, boolean useTextureView);

渲染其他用户视图画面的方法法与渲染摄像头画面的用法基本一致，需关注 RenderType (opens new window) 渲染模式。

示例代码:

// 创建其他端视图渲染对象
JRTCMediaDeviceVideoCanvas remoteCanvas = 
    mediaDevice.startVideo("视频流ID",JRTCMediaDevice.RENDER_FULL_SCREEN);
// 将渲染视图添加到界面上
viewGroup.addView(remoteCanvas.getVideoView());

结束通话

访客可以在呼叫等待或者通话中调用调用 term (opens new window) 接口主动结束通话。

/**
 * 结束通话
 *
 * 来电过程中调用此接口拒绝接听，访客分配到其他座席继续呼叫等待不会挂断。<br>
 * 主座席调用此接口会结束通话，通话中所有成员都会离开，此通通话销毁，所有成员会收到 {@link JRTCAgentCallback#onCallStateChanged onCallStateChanged} 或 {@link JRTCGuestCallback#onCallStateChanged onCallStateChanged} 通话结束回调。<br>
 * 第三方座席调用此接口仅自身离开通话，通话中其他成员会收到该成员离开的回调 {@link JRTCGuestCallback#onMemberLeave onMemberLeave} 或 {@link JRTCAgentCallback#onMemberLeave onMemberLeave} 回调，通话继续进行。
 * @return 接口调用结果
 * - true: 接口调用成功，会收到 {@link JRTCAgentCallback#onCallStateChanged onCallStateChanged} 回调
 * - false: 接口调用异常
 */
public abstract boolean term();

主动和被动的挂断事件与来电、接通一样，都通过 onCallStateChanged (opens new window) 接口上报，其中 CallTermReason (opens new window)可以用来判断挂断原因，如：主动挂断、对端挂断等，详细可参考 API 文档。

示例代码：

// 座席主动结束通话
agent.term();

// 通话状态改变回调
public void onCallStateChanged(@GuestCallStateChangeType int type, @CallIncomingType int incomingType, JRTCInviter inviter, @CallTermReason int reason) {
    if (type == JRTCCallCenter.AGENT_CHANGE_TYPE_TERMED) {
     	// 通话结束，结束原因查看 reason
    }
}

销毁本地和远端画面

当不再需要查看视频画面，包括通话其他成员离开，或者通话结束，需要调用 JRTCMediaDevice (opens new window) 中的 stopVideo (opens new window) 方法来释放渲染的资源；该方法需传入要释放的 JRTCMediaDeviceVideoCanvas (opens new window)对象；必须进行这步操作，不然会造成渲染内存不释放。

/**
 * 停止视频渲染
 * @param canvas JRTCMediaDeviceVideoCanvas 对象，由 {@link #startVideo startVideo} 或 {@link #startCameraVideo startCameraVideo} 接口返回
 */
public abstract void stopVideo(JRTCMediaDeviceVideoCanvas canvas);

示例代码：

// 通话结束
public void onCallStateChanged(@GuestCallStateChangeType int type, @CallIncomingType int incomingType, JRTCInviter inviter, @CallTermReason int reason) {
    if (type == JRTCCallCenter.GUEST_CHANGE_TYPE_TERMED) {
     	mediaDevice.stopVideo(localCanvas);
		mediaDevice.stopVideo(remoteCanvas);
    }
}
// 成员离开
public void onMemberLeave(JRTCRoomParticipant part) {
     // 停止该成员画面渲染
     mediaDevice.stopVideo(remoteCanvas);
 }

登出

座席结束通话后，可以做登出操作；登出接口调用流程如下所示：

座席可以登出视频平台，与平台断开一切连接。

/**
  * 登出 Juphoon RTC 平台，登出后不能进行平台上的各种业务
  *
  * 登出结果通过 {@link JRTCClientCallback#onLogout onLogout} 回调通知
  * @return 接口调用结果
  * - true: 接口调用成功
  * - false: 接口调用异常
  */
public abstract boolean logout();

登出结果通过 JRTCClientCallback (opens new window) 中的 onLogout (opens new window) 接口上报。

/**
 * 登出回调
 *
 * @param reason 登出原因
 */
void onLogout(@ReasonCode int reason);

示例代码：

// 调用登出接口
client.logout();

// 监听登出结果回调
public void onLogout(@ReasonCode int reason) {
    // 登出完成   
}

登录状态改变通知

登录状态通过 JRTCClientCallback (opens new window) 中的 onClientStateChanged (opens new window) 接口上报：

/**
 * 登录状态变化通知
 *
 * @param state    当前状态值
 * @param oldState 之前状态值
 */
void onClientStateChanged(@ClientState int state, @ClientState int oldState);

登录状态码见 ClientState (opens new window)

示例代码：

//登录状态改变通知
public void onClientStateChanged(@ClientState int state, @ClientState int oldState) {
    //state 当前状态
    //oldState 之前状态
}

销毁SDK

每个模块都有对应的销毁接口。如不需再使用 SDK 的相关功能，可以强制释放 SDK 的资源。 注：该方法为同步调用，调用此方法后，你将无法再使用该模块的其它方法和回调。 我们不建议在 JRTCSDK 的所有回调方法中调用此方法销毁对象，否则可能出现崩溃现象。

public static void destroy()

示例代码：

JRTCAgent.destroy();
JRTCMediaDevice.destroy();
JRTCClient.destroy();