interface  CallState
 
interface  CallStateChangeType
 
interface  CallTermReason
 
interface  GuestPartRole
 
interface  JCGuestCallType
 
interface  RoleType
 
interface  StorageFileType
 

Public 成员函数

abstract boolean queryAllGroups ()
 
abstract boolean call (String number, JCGuestCallParam param)
 
abstract boolean oneToOneCall (String userId, JCGuestCallParam param)
 
abstract boolean term ()
 
abstract boolean enableAudio (boolean enable)
 
abstract boolean enableVideo (boolean enable)
 
abstract boolean sendVideoEmptyPack (boolean empty)
 
abstract boolean sendAudioEmptyPack (boolean empty)
 
abstract boolean enableScreenShare (boolean enable)
 
abstract int getCallState ()
 
abstract JCMediaChannelParticipant getAgentParticipant ()
 
abstract JCMediaChannelParticipant getSelfParticipant ()
 
abstract String getStatistics ()
 
abstract List< JCMediaChannelParticipantgetParticipants ()
 
abstract String getShareRenderId ()
 
abstract String getShareUserId ()
 
abstract int getSpkLevel ()
 
abstract int getMicLevel ()
 
abstract boolean setScreenMode (JCMediaChannel.JCConfMergeModeParam jcConfMergeModeParam)
 
abstract boolean setRatio (float ratio)
 
abstract boolean requestUrgent ()
 
abstract boolean requestVideo (JCMediaChannelParticipant participant, @JCMediaChannel.PictureSize int pictureSize)
 
abstract int getRequestSize ()
 
abstract void setRequestSize (@JCMediaChannel.PictureSize int size)
 
abstract boolean enableLocalRecord (boolean enable, JCMediaChannel.RecordLocalParams recordParam)
 
abstract boolean enableRemoteRecord (boolean enable, JCMediaChannel.RecordRemoteParams recordParam)
 
abstract boolean sendMessage (String type, String content)
 
abstract boolean sendMessage (String type, String content, String toUserId)
 
abstract boolean insertStorageRecord (String url, @StorageFileType int fileType, int fileSize, int expireTime)
 
abstract boolean setLineUpTag (@JCGuest.GuestTAGType int tagType)
 
abstract String getSerialNumber ()
 
abstract boolean getHoldState ()
 
abstract void turnCallType (@JCGuestCallType int calltype)
 
abstract int getCallType ()
 
abstract void sendTextMessage (String content, String userId)
 

静态 Public 成员函数

static JCGuest create (JCClient client, JCMediaDevice mediaDevice, JCGuestCallback callback)
 
static void destroy ()
 

静态 Public 属性

static final int CHANGE_TYPE_CALLING = 0
 
static final int CHANGE_TYPE_WAITING = 1
 
static final int CHANGE_TYPE_TALKING = 2
 
static final int CHANGE_TYPE_TERMED = 3
 
static final int CALL_STATE_IDLE = 0
 
static final int CALL_STATE_CALLING = 1
 
static final int CALL_STATE_WAITING = 2
 
static final int CALL_STATE_TALKING = 3
 
static final int TERM_REASON_NONE = 0
 
static final int TERM_REASON_QUIT = 1
 
static final int TERM_REASON_OVER = 2
 
static final int TERM_REASON_OFFLINE = 3
 
static final int TERM_REASON_NO_RESOUCE = 4
 
static final int TERM_REASON_INVALID_PARAM = 97
 
static final int TERM_REASON_CALL_FUNCATION_ERROR = 98
 
static final int TERM_REASON_NOT_LOGINED = 99
 
static final int TERM_REASON_OTHER = 100
 
static final int GUEST_PART_ROLE_AGENT = 0x40
 
static final int GUEST_PART_ROLE_GUEST = 0x80
 
static final int ROLE_TYPE_UNKNOWN = -1
 
static final int ROLE_TYPE_GENERAL = 0
 
static final int ROLE_TYPE_VIP = 1
 
static final int GUEST_STORAGE_FILE_TYPE_VIDEO = 0
 
static final int GUEST_STORAGE_FILE_TYPE_AUDIO = 1
 
static final int GUEST_STORAGE_FILE_TYPE_PICTURE = 2
 
static final int GUEST_STORAGE_FILE_TYPE_DOC = 3
 
static final int GUEST_STORAGE_FILE_TYPE_OTHER = 4
 
static final int GUEST_STORAGE_FILE_TYPE_MAX = 5
 
static final int GUEST_TAG_UNKNOWN = -1
 
static final int GUEST_TAG_OFFLINE = 0
 
static final int GUEST_TAG_CANCEL_OFFLINE = 1
 
static final int GUEST_TAG_GOBACK_OFFLINE = 2
 
static final int CALL_TYPE_VIDEO = 1
 
static final int CALL_TYPE_AUDIO = 0
 

Protected 成员函数

abstract void destroyObj ()
 
abstract void addCallback (JCGuestCallback callback)
 
abstract void removeCallback (JCGuestCallback callback)
 

详细描述

访客模块

成员函数说明

◆ addCallback()

abstract void com.juphoon.cloud.JCGuest.addCallback ( JCGuestCallback  callback)
abstractprotected

添加回调

参数
callbackJCGuestCallback 接口对象

◆ call()

abstract boolean com.juphoon.cloud.JCGuest.call ( String  number,
JCGuestCallParam  param 
)
abstract

发起呼叫

注解
参数
number呼叫号码段,如10086
param设置创建会议参数,可以设置通话分辨率、全局宽高比等参数
返回
接口调用成功失败

◆ create()

static JCGuest com.juphoon.cloud.JCGuest.create ( JCClient  client,
JCMediaDevice  mediaDevice,
JCGuestCallback  callback 
)
static

创建 JCGuest 对象,重复调用返回同一对象

注解
  • JCGuest的所有接口函数,如无特殊说明,都建议再主线程调用
  • 请确保在调用其他 API 前先调用该方法创建并初始化 JCClient 对象, JCMediaDevice 对象, JCGuestCallback 对象
  • 调用此方法前确保 JCClient 已完成初始化,即 getState 方法获取的状态值不等于 STATE_NOT_INIT
  • 调用此方法创建 JCGuest 对象后,期间没有调用过 destroy 方法销毁对象,然后又重复调用此方法,会直接返回第一次创建的 JCGuest 对象
参数
clientJCClient 对象
mediaDeviceJCMediaDevice 对象
callbackJCGuestCallback 回调接口,用于接收 JCGuest 相关通知
返回
返回 JCGuest 对象

◆ destroy()

static void com.juphoon.cloud.JCGuest.destroy ( )
static

销毁 JCGuest 对象 该方法为异步调用,需要等待 JCGuest 实例资源释放后才能执行其他操作, 调用此方法后,你将无法再使用 JCGuest 的其他方法和回调。 我们不建议再JCSDK的回调中调用此方法销毁 JCGuest 对象,否则会出现崩溃 如需在销毁后再次创建 JCGuest 实例,需要等待方法执行结束后再创建实例

◆ destroyObj()

abstract void com.juphoon.cloud.JCGuest.destroyObj ( )
abstractprotected

销毁对象

◆ enableAudio()

abstract boolean com.juphoon.cloud.JCGuest.enableAudio ( boolean  enable)
abstract

开启关闭发送本地音频流

注解
参数
enable是否开启本地音频流
返回
接口调用成功返回 true,失败返回 false

◆ enableLocalRecord()

abstract boolean com.juphoon.cloud.JCGuest.enableLocalRecord ( boolean  enable,
JCMediaChannel.RecordLocalParams  recordParam 
)
abstract

开关本地会议录制

参数
enable开启或者关闭录制
recordParam录制参数
返回
返回 true 表示正常执行调用流程,false 表示调用异常
参见
JCMediaChannel.RecordLocalParams

◆ enableRemoteRecord()

abstract boolean com.juphoon.cloud.JCGuest.enableRemoteRecord ( boolean  enable,
JCMediaChannel.RecordRemoteParams  recordParam 
)
abstract

开关远程视频录制

注解
  • 视频客服场景下由CD自动开启录制,即无特殊情况无需调用此接口即可在服务器生成录制文件
参数
enable是否开启视频录制
recordParam录制参数,当 enable 为 true 时,可以更改由 join 时传入的录制参数,不需更改则填 null
返回
返回 true 表示正常执行调用流程,false 表示调用异常
参见
JCMediaChannel.RecordRemoteParams

◆ enableScreenShare()

abstract boolean com.juphoon.cloud.JCGuest.enableScreenShare ( boolean  enable)
abstract

开启关闭屏幕共享

注解
参数
enable是否开启 true开启共享,false关闭共享
返回
接口调用成功返回 true,失败返回 false

◆ enableVideo()

abstract boolean com.juphoon.cloud.JCGuest.enableVideo ( boolean  enable)
abstract

开启关闭发送本地视频流

注解
参数
enable是否开启本地视频流
返回
接口调用成功返回 true,失败返回 false

◆ getAgentParticipant()

abstract JCMediaChannelParticipant com.juphoon.cloud.JCGuest.getAgentParticipant ( )
abstract

通话中可以取得正在通话的座席对象,可以获取到 UserId , RenderId 等属性

返回
坐席对象

◆ getCallState()

abstract int com.juphoon.cloud.JCGuest.getCallState ( )
abstract

获取当前通话状态

返回
当前通话状态
参见
JCGuest.CallState

◆ getCallType()

abstract int com.juphoon.cloud.JCGuest.getCallType ( )
abstract

获取当前通话类型

返回
当前通话类型
  • Video:视频通话
  • Audio:语音通话
参见
JCGuestCallType

◆ getHoldState()

abstract boolean com.juphoon.cloud.JCGuest.getHoldState ( )
abstract

当前通话是否保持

返回
当前通话是否保持
  • true:当前通话状态为保持
  • false:当前童虎状态为取回

◆ getMicLevel()

abstract int com.juphoon.cloud.JCGuest.getMicLevel ( )
abstract

获取麦克风音量,区间0-100

返回
麦克风音量

◆ getParticipants()

abstract List<JCMediaChannelParticipant> com.juphoon.cloud.JCGuest.getParticipants ( )
abstract

获取当前通话中的全体成员

返回
当前通话中的全体成员

◆ getRequestSize()

abstract int com.juphoon.cloud.JCGuest.getRequestSize ( )
abstract

视频请求质量,影响自己看其他成员的视频分辨率

返回
视频尺寸大小

◆ getSelfParticipant()

abstract JCMediaChannelParticipant com.juphoon.cloud.JCGuest.getSelfParticipant ( )
abstract

获取自己对象

返回
自己对象

◆ getSerialNumber()

abstract String com.juphoon.cloud.JCGuest.getSerialNumber ( )
abstract

获取服务唯一标识,上层可使用该参数通过portal第三方接口查询到话务信息,如录制视频文件的URL

返回
服务唯一标识

◆ getShareRenderId()

abstract String com.juphoon.cloud.JCGuest.getShareRenderId ( )
abstract

屏幕共享渲染ID,无屏幕共享时为空

返回
渲染ID

◆ getShareUserId()

abstract String com.juphoon.cloud.JCGuest.getShareUserId ( )
abstract

屏幕共享时的共享成员id,无屏幕共享时为空

返回
共享成员id

◆ getSpkLevel()

abstract int com.juphoon.cloud.JCGuest.getSpkLevel ( )
abstract

获取扬声器音量,区间0-100

返回
返回扬声器音量

◆ getStatistics()

abstract String com.juphoon.cloud.JCGuest.getStatistics ( )
abstract

获取媒体统计信息

返回
媒体统计信息

◆ insertStorageRecord()

abstract boolean com.juphoon.cloud.JCGuest.insertStorageRecord ( String  url,
@StorageFileType int  fileType,
int  fileSize,
int  expireTime 
)
abstract

把文件绑定到当前的服务,以便通过 portal 查看文件

参数
url文件服务器路径,在文件通过 UploadFile 上传至文件服务后,由 onFileResult 返回
fileType文件类型
fileSize文件大小
expireTime超时时间
返回
接口调用成功失败

◆ oneToOneCall()

abstract boolean com.juphoon.cloud.JCGuest.oneToOneCall ( String  userId,
JCGuestCallParam  param 
)
abstract

点对点呼叫

注解
参数
userId坐席useridid,如agent1
param设置创建会议参数,可以设置通话分辨率、全局宽高比等参数
返回
接口调用成功失败

◆ queryAllGroups()

abstract boolean com.juphoon.cloud.JCGuest.queryAllGroups ( )
abstract

查询业务组号 结果通过 onGetAllGroups 通知

返回
调用接口成功失败

◆ removeCallback()

abstract void com.juphoon.cloud.JCGuest.removeCallback ( JCGuestCallback  callback)
abstractprotected

删除回调

参数
callbackJCGuestCallback 接口对象

◆ requestUrgent()

abstract boolean com.juphoon.cloud.JCGuest.requestUrgent ( )
abstract

请求加急 管理员权限的坐席收到请求后会触发 onUrgentRequestRecv 回调 坐席同意加急后将会插队到队列最前

返回
接口调用成功返回 true,失败返回 false

◆ requestVideo()

abstract boolean com.juphoon.cloud.JCGuest.requestVideo ( JCMediaChannelParticipant  participant,
@JCMediaChannel.PictureSize int  pictureSize 
)
abstract

按设定质量请求指定成员视频流 影响自己看其他成员的视频分辨率 当 pictureSize 为 JCMediaChannel.PictureSize PICTURESIZE_NONE 时表示关闭请求

参数
participant频道中其他成员对象
pictureSize视频请求的尺寸类型
返回
返回 true 表示正常执行调用流程,false 表示调用异常
参见
JCMediaChannel.PictureSize

◆ sendAudioEmptyPack()

abstract boolean com.juphoon.cloud.JCGuest.sendAudioEmptyPack ( boolean  empty)
abstract

音频发送空包 该接口不会导致成员的 audio 属性变化

参数
empty
返回
音频发送包是否空包
  • true:发送音频空包
  • false:发送正常音频包

◆ sendMessage() [1/2]

abstract boolean com.juphoon.cloud.JCGuest.sendMessage ( String  type,
String  content 
)
abstract

透明通道发送全员消息,消息内容不能大于4K

注解
接收端会触发 onMessageReceive
参数
type消息类型
content消息内容,当 toUserId 不为 null 时,content 不能大于 4k
返回
true表示成功,false表示失败

◆ sendMessage() [2/2]

abstract boolean com.juphoon.cloud.JCGuest.sendMessage ( String  type,
String  content,
String  toUserId 
)
abstract

透明通道发送消息给某个成员,UserId传空则发送给所有成员,消息内容不能大于4K

注解
接收端会触发 onMessageReceive
参数
type消息类型
content消息内容,当 toUserId 不为 null 时,content 不能大于 4k
toUserId指定成员id
返回
true表示成功,false表示失败

◆ sendTextMessage()

abstract void com.juphoon.cloud.JCGuest.sendTextMessage ( String  content,
String  userId 
)
abstract

发送文本消息,消息内容不能大于4K

注解
通话中的其他成员会收到 onTextMessageRecvNotify 事件
参数
content消息内容
userId三人及三人以上时可以指定要发送的ID,传空即发送给所有人

◆ sendVideoEmptyPack()

abstract boolean com.juphoon.cloud.JCGuest.sendVideoEmptyPack ( boolean  empty)
abstract

视频发送空包 该接口不会导致成员的video 属性变化

参数
empty
返回
视频发送包是否空包
  • true:发送视频空包
  • false:发送正常视频包

◆ setLineUpTag()

abstract boolean com.juphoon.cloud.JCGuest.setLineUpTag ( @JCGuest.GuestTAGType int  tagType)
abstract

设置排队标签

参数
tagType排队标签
返回
接口调用成功失败

◆ setRatio()

abstract boolean com.juphoon.cloud.JCGuest.setRatio ( float  ratio)
abstract

设置视频本地宽高比 会将自己的视频采集根据宽高比裁剪后进行发送

注解
参数
ratio视频本地宽高比
返回
接口调用是否成功

◆ setRequestSize()

abstract void com.juphoon.cloud.JCGuest.setRequestSize ( @JCMediaChannel.PictureSize int  size)
abstract

设置视频请求质量

参数
size视频尺寸等级
参见
JCMediaChannel.PictureSize

◆ setScreenMode()

abstract boolean com.juphoon.cloud.JCGuest.setScreenMode ( JCMediaChannel.JCConfMergeModeParam  jcConfMergeModeParam)
abstract

设置分屏模式

参数
jcConfMergeModeParam设置媒体推流的视频合并模式参数

◆ term()

abstract boolean com.juphoon.cloud.JCGuest.term ( )
abstract

结束通话

返回
接口调用成功返回 true,失败返回 false

◆ turnCallType()

abstract void com.juphoon.cloud.JCGuest.turnCallType ( @JCGuestCallType int  calltype)
abstract

音视频通话切换 可以通过 @ ref getCallType "GetCallType" 接口获取到当前的通话类型

注解
参数
calltype
  • Video:视频通话
  • Audio:语音通话
参见
JCGuestCallType

类成员变量说明

◆ CALL_STATE_CALLING

final int com.juphoon.cloud.JCGuest.CALL_STATE_CALLING = 1
static

发起方呼叫成功

◆ CALL_STATE_IDLE

final int com.juphoon.cloud.JCGuest.CALL_STATE_IDLE = 0
static

空闲状态

◆ CALL_STATE_TALKING

final int com.juphoon.cloud.JCGuest.CALL_STATE_TALKING = 3
static

双方通话中

◆ CALL_STATE_WAITING

final int com.juphoon.cloud.JCGuest.CALL_STATE_WAITING = 2
static

发起方等待接听

◆ CALL_TYPE_AUDIO

final int com.juphoon.cloud.JCGuest.CALL_TYPE_AUDIO = 0
static

语音通话

◆ CALL_TYPE_VIDEO

final int com.juphoon.cloud.JCGuest.CALL_TYPE_VIDEO = 1
static

视频通话

◆ CHANGE_TYPE_CALLING

final int com.juphoon.cloud.JCGuest.CHANGE_TYPE_CALLING = 0
static

发起方呼叫成功

◆ CHANGE_TYPE_TALKING

final int com.juphoon.cloud.JCGuest.CHANGE_TYPE_TALKING = 2
static

通话建立

◆ CHANGE_TYPE_TERMED

final int com.juphoon.cloud.JCGuest.CHANGE_TYPE_TERMED = 3
static

通话挂断

◆ CHANGE_TYPE_WAITING

final int com.juphoon.cloud.JCGuest.CHANGE_TYPE_WAITING = 1
static

发起方等待接听

◆ GUEST_PART_ROLE_AGENT

final int com.juphoon.cloud.JCGuest.GUEST_PART_ROLE_AGENT = 0x40
static

坐席

◆ GUEST_PART_ROLE_GUEST

final int com.juphoon.cloud.JCGuest.GUEST_PART_ROLE_GUEST = 0x80
static

访客

◆ GUEST_STORAGE_FILE_TYPE_AUDIO

final int com.juphoon.cloud.JCGuest.GUEST_STORAGE_FILE_TYPE_AUDIO = 1
static

音频

◆ GUEST_STORAGE_FILE_TYPE_DOC

final int com.juphoon.cloud.JCGuest.GUEST_STORAGE_FILE_TYPE_DOC = 3
static

文档

◆ GUEST_STORAGE_FILE_TYPE_MAX

final int com.juphoon.cloud.JCGuest.GUEST_STORAGE_FILE_TYPE_MAX = 5
static

最大文件

◆ GUEST_STORAGE_FILE_TYPE_OTHER

final int com.juphoon.cloud.JCGuest.GUEST_STORAGE_FILE_TYPE_OTHER = 4
static

其他类型

◆ GUEST_STORAGE_FILE_TYPE_PICTURE

final int com.juphoon.cloud.JCGuest.GUEST_STORAGE_FILE_TYPE_PICTURE = 2
static

图片

◆ GUEST_STORAGE_FILE_TYPE_VIDEO

final int com.juphoon.cloud.JCGuest.GUEST_STORAGE_FILE_TYPE_VIDEO = 0
static

视频

◆ GUEST_TAG_CANCEL_OFFLINE

final int com.juphoon.cloud.JCGuest.GUEST_TAG_CANCEL_OFFLINE = 1
static

取消后台排队

◆ GUEST_TAG_GOBACK_OFFLINE

final int com.juphoon.cloud.JCGuest.GUEST_TAG_GOBACK_OFFLINE = 2
static

回到后台排队

◆ GUEST_TAG_OFFLINE

final int com.juphoon.cloud.JCGuest.GUEST_TAG_OFFLINE = 0
static

开启后台排队

◆ GUEST_TAG_UNKNOWN

final int com.juphoon.cloud.JCGuest.GUEST_TAG_UNKNOWN = -1
static

未知

◆ ROLE_TYPE_GENERAL

final int com.juphoon.cloud.JCGuest.ROLE_TYPE_GENERAL = 0
static

普通

◆ ROLE_TYPE_UNKNOWN

final int com.juphoon.cloud.JCGuest.ROLE_TYPE_UNKNOWN = -1
static

未知

◆ ROLE_TYPE_VIP

final int com.juphoon.cloud.JCGuest.ROLE_TYPE_VIP = 1
static

VIP


该类的文档由以下文件生成:
  • JCGuest.java