类
interface	ClientState

interface	JRTCP2PSession

interface	P2PSessionState

Public 成员函数
abstract void	setForeground (boolean foreground)

abstract String	getUserId ()

abstract int	getState ()

abstract String	getDisplayName ()

abstract void	setDisplayName (String displayName)

abstract String	getServer ()

abstract void	setServer (String server)

abstract String	getAppKey ()

abstract void	setAppKey (String appKey)

abstract String	getAppName ()

abstract void	setAppName (String appName)

abstract boolean	login (String userId, String password)

abstract boolean	login (String userId, String password, JRTCClientLoginParam clientLoginParam)

abstract boolean	reLogin (String userId, String password)

abstract boolean	logout ()

abstract Context	getContext ()

abstract int	sendOnlineMessage (String message, String userId)

abstract JRTCP2PSession	createP2PSession ()

abstract boolean	getUploadUrl (String fileId)

abstract int	requestFileUploadInfo (String serialId, JRTCRequestFileUploadParam requestFileUploadParam)

abstract int	completeFileUpload (String serialId, JRTCCompleteFileUploadParam completeFileUploadParam)

abstract int	getUploadFileInfo (String serialId, Map< String, Object > extraInfo)

静态 Public 成员函数
static JRTCClient	create (Context context, JRTCClientCallback callback, JRTCClientInitParam initParam)

static JRTCClient	create (Application application, JRTCClientCallback callback, JRTCClientInitParam initParam)

static void	destroy ()

静态 Public 属性
static final int	STATE_NOT_INIT = 0

static final int	STATE_IDLE = 1

static final int	STATE_LOGINING = 2

static final int	STATE_LOGINED = 3

static final int	STATE_LOGOUTING = 4

static final int	P2P_STATE_IDLE = 0

static final int	P2P_STATE_CREATED = 1

static final int	P2P_STATE_CONNECTING = 2

static final int	P2P_STATE_CONNECTED = 3

static final int	P2P_STATE_CLOSED = 4

Protected 成员函数
abstract void	destroyObj ()

详细描述

登录登出管理

成员函数说明

◆ completeFileUpload()

abstract int completeFileUpload	(	String	serialId,
		JRTCCompleteFileUploadParam	completeFileUploadParam
	)

abstract

文件上传完成确认

参数

serialId	业务id，必选，如果是通话业务相关文件，需要传通话唯一标识 callId
completeFileUploadParam	文件上传完成确认参数，必选

返回

接口调用结果

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

注解: 通过 http 上传文件完成后，需要调用该接口确认完成，否则上传文件将无法在平台查询到

参见: JRTCCompleteFileUploadParam

◆ create() [1/2]

static JRTCClient create	(	Application	application,
		JRTCClientCallback	callback,
		JRTCClientInitParam	initParam
	)

static

创建 JRTCClient 实例

参数

application	应用对象
callback	回调接口，用于接收 JRTCClient 相关通知
initParam	初始化参数，没有则填 null

返回: JRTCClient 对象

参见: JRTCClientInitParam

◆ create() [2/2]

static JRTCClient create	(	Context	context,
		JRTCClientCallback	callback,
		JRTCClientInitParam	initParam
	)

static

创建 JRTCClient 实例

参数

context	应用上下文对象
callback	回调接口，用于接收 JRTCClient 相关通知
initParam	初始化参数，没有则填 null

返回: JRTCClient 对象

参见: JRTCClientInitParam

弃用:: 该方法即将废弃，请使用 create 代替

◆ createP2PSession()

abstract JRTCP2PSession createP2PSession ( )

abstract

创建 P2P 会话

返回: IP2PSession 接口对象

◆ destroy()

static void destroy ( )

static

销毁 JRTCClient 对象

注解

- 调用此方法后，你将无法再使用 JRTCClient 的其他方法和回调

我们不建议在 JRTCSDK 的回调中调用此方法销毁 JRTCClient 对象，否则可能出现崩溃

◆ destroyObj()

abstract void destroyObj ( )

abstractprotected

销毁对象

◆ getAppKey()

abstract String getAppKey ( )

abstract

获取 AppKey，用户从 Juphoon RTC 平台上申请的 AppKey 字符串

◆ getAppName()

abstract String getAppName ( )

abstract

获取应用名称

◆ getContext()

abstract Context getContext ( )

abstract

获得上下文对象

返回: 返回 Context 对象

弃用:: 该方法即将废弃使用

◆ getDisplayName()

abstract String getDisplayName ( )

abstract

昵称，用于通话，消息等，可以更直观的表明身份, 默认为用户ID，即 getUserId

返回: 当前昵称

◆ getServer()

abstract String getServer ( )

abstract

获取接入服务器地址

◆ getState()

abstract int getState ( )

abstract

当前登录状态

返回: 登录状态

参见: ClientState

◆ getUploadFileInfo()

abstract int getUploadFileInfo	(	String	serialId,
		Map< String, Object >	extraInfo
	)

abstract

获取上传文件信息列表

参数

serialId	业务id，必选，如果是通话业务相关文件，需要传通话唯一标识 callId
extraInfo	随路参数

返回

接口调用结果

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

注解: 查询返回所有和该业务唯一标识相关的文件信息列表

◆ getUploadUrl()

abstract boolean getUploadUrl ( String fileId )

abstract

获取文件上传路径

调用此接口，fileId 非必须指定时可传空字符串
调用成功后，文件上传路径等具体信息可通过 onGetUploadUrlResult 回调获取

参数

fileId 文件 id

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

注解: 文件 id 用于断点续传，第二次续传文件时需要传递前一次获取到的 fileId 首次新文件上传，建议传空，fileId由服务器自动生成下发

◆ getUserId()

abstract String getUserId ( )

abstract

获取用户ID

返回: 用户ID

注解: 当 state > STATE_IDLE 该值有效

◆ login() [1/2]

abstract boolean login	(	String	userId,
		String	password
	)

abstract

登录 Juphoon RTC 平台，只有登录成功后才能进行平台上的各种业务

登录结果通过 onLogin 回调通知

参数

userId	用户ID
password	密码，不能为空

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

警告: 目前只支持免鉴权模式，服务器不校验账号密码，免鉴权模式下当账号不存在时会自动去创建该账号; 用户名为英文数字和'+' '-' '_' '.'，长度不要超过64字符，'-' '_' '.'不能作为第一个字符

◆ login() [2/2]

abstract boolean login	(	String	userId,
		String	password,
		JRTCClientLoginParam	clientLoginParam
	)

abstract

登录 Juphoon RTC 平台，只有登录成功后才能进行平台上的各种业务

登录结果通过 onLogin 回调通知

参数

userId	用户ID
password	密码，不能为空
clientLoginParam	登录参数，一般不需要设置，如需设置请询问客服，传 null 则按默认值

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

警告: 目前只支持免鉴权模式，服务器不校验账号密码，免鉴权模式下当账号不存在时会自动去创建该账号; 用户名为英文数字和'+' '-' '_' '.'，长度不要超过64字符，'-' '_' '.'不能作为第一个字符

参见: JRTCClientLoginParam

◆ logout()

abstract boolean logout ( )

abstract

登出 Juphoon RTC 平台，登出后不能进行平台上的各种业务

登出结果通过 onLogout 回调通知

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ reLogin()

abstract boolean reLogin	(	String	userId,
		String	password
	)

abstract

重登录，该接口在如果有其他同类型终端登录着则会登录失败，一般用于记住了账号后重启自动登录逻辑

参数

password 密码，不能为空

返回

接口调用结果

true: 接口调用成功
false: 接口调用异常

◆ requestFileUploadInfo()

abstract int requestFileUploadInfo	(	String	serialId,
		JRTCRequestFileUploadParam	requestFileUploadParam
	)

abstract

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

参数

serialId	业务id，必选，如果是通话业务相关文件，需要传通话唯一标识 callId
requestFileUploadParam	请求文件上传信息参数，必选

返回

接口调用结果

操作id: 接口调用成功，对应 JRTCClientCallback#onRequestFileUploadInfoResponse(int, boolean, String, String, long, String, long, int, String, String, String) onRequestFileUploadInfoResponse } 回调的 operatorId 参数
-1: 接口调用异常，不会收到回调

注解: 目前仅支持视频和图片类型文件上传，服务端会通过文件后缀名判断

参见: JRTCRequestFileUploadParam

◆ sendOnlineMessage()

abstract int sendOnlineMessage	(	String	message,
		String	userId
	)

abstract

发送在线消息

参数

message	消息内容
userId	对端的用户名

返回

接口调用结果

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

注解: 消息大小不超过4k

◆ setAppKey()

abstract void setAppKey ( String appKey )

abstract

设置 AppKey，用户从 Juphoon RTC 平台上申请的 AppKey 字符串

◆ setAppName()

abstract void setAppName ( String appName )

abstract

设置应用名称

◆ setDisplayName()

abstract void setDisplayName ( String displayName )

abstract

设置昵称，用于通话，消息等，可以更直观的表明身份，默认为用户ID，即 getUserId

◆ setForeground()

abstract void setForeground ( boolean foreground )

abstract

设置是否是前台

参数

foreground

- true: 设置为前台

false: 设置为后台

◆ setServer()

abstract void setServer ( String server )

abstract

设置接入服务器地址

类成员变量说明

◆ P2P_STATE_CLOSED

final int P2P_STATE_CLOSED = 4

static

p2p通道关闭

◆ P2P_STATE_CONNECTED

final int P2P_STATE_CONNECTED = 3

static

p2p通道连接成功

◆ P2P_STATE_CONNECTING

final int P2P_STATE_CONNECTING = 2

static

p2p通道连接中

◆ P2P_STATE_CREATED

final int P2P_STATE_CREATED = 1

static

p2p通道创建

◆ P2P_STATE_IDLE

final int P2P_STATE_IDLE = 0

static

p2p未初始化

◆ STATE_IDLE

final int STATE_IDLE = 1

static

未登录

◆ STATE_LOGINED

final int STATE_LOGINED = 3

static

登录成功

◆ STATE_LOGINING

final int STATE_LOGINING = 2

static

登录中

◆ STATE_LOGOUTING

final int STATE_LOGOUTING = 4

static

登出中

◆ STATE_NOT_INIT

final int STATE_NOT_INIT = 0

static

未初始化

类

Public 成员函数

静态 Public 成员函数

静态 Public 属性

Protected 成员函数

详细描述

成员函数说明

◆ completeFileUpload()

◆ create() [1/2]

◆ create() [2/2]

◆ createP2PSession()

◆ destroy()

◆ destroyObj()

◆ getAppKey()

◆ getAppName()

◆ getContext()

◆ getDisplayName()

◆ getServer()

◆ getState()

◆ getUploadFileInfo()

◆ getUploadUrl()

◆ getUserId()

◆ login() [1/2]

◆ login() [2/2]

◆ logout()

◆ reLogin()

◆ requestFileUploadInfo()

◆ sendOnlineMessage()

◆ setAppKey()

◆ setAppName()

◆ setDisplayName()

◆ setForeground()

◆ setServer()

类成员变量说明

◆ P2P_STATE_CLOSED

◆ P2P_STATE_CONNECTED

◆ P2P_STATE_CONNECTING

◆ P2P_STATE_CREATED

◆ P2P_STATE_IDLE

◆ STATE_IDLE

◆ STATE_LOGINED

◆ STATE_LOGINING

◆ STATE_LOGOUTING

◆ STATE_NOT_INIT