JMSDK Windows  v2.6.1
Public 成员函数 | 静态 Public 成员函数 | 属性 | 所有成员列表
JMSDK.JCCall.JCCall类 参考

一对一通话模块 更多...

Public 成员函数

bool Call (string userId, bool video, string extraParam)
 一对一呼叫 更多...
 
bool Term (JCCallItem item, JCCallReason reason, string description)
 挂断 更多...
 
bool Answer (JCCallItem item, bool video)
 接听 更多...
 
bool Mute (JCCallItem item)
 静音,通过JCCallItem中的静音状态来决定开启关闭 更多...
 
bool Hold (JCCallItem item)
 呼叫保持,通过JCCallItem对象中的呼叫保持状态来决定开启关闭 更多...
 
bool AudioRecord (JCCallItem item, bool enable, string filePath)
 通话录音,通过JCCallItem对象中的呼叫保持状态来决定开启关闭呼叫保持 更多...
 
bool VideoRecord (JCCallItem item, bool enable, bool remote, int width, int height, string filePath)
 视频通话录制,通过JCCallItem对象中的localVideoRecord,remoteVideoRecord状态来决定开启关闭录制 更多...
 
bool BecomeActive (JCCallItem item)
 切换活跃通话 更多...
 
bool EnableUploadVideoStream (JCCallItem item)
 开启关闭视频流发送,用于视频通话中 更多...
 
bool SendMessage (JCCallItem item, string type, string content)
 通过通话建立后的通道发送数据 更多...
 
String Statistics ()
 获得当前通话统计信息,以Json字符串形式返回,其中包含 "Audio" 和 "Video" 两个节点 更多...
 
void AddCallback (JCCallCallback callback)
 添加回调 更多...
 
void RemoveCallback (JCCallCallback callback)
 删除回调 更多...
 
void OnCameraUpdate ()
 摄像头变化 更多...
 
void OnAudioOutputTypeChange (string audioOutputType)
 音频输出设备变化 更多...
 
void OnAudioInputTypeChange (string audioInputType)
 音频输入设备变化 更多...
 
void OnRenderReceived (JCMediaDeviceVideoCanvas canvas)
 收到第一帧数据 更多...
 
void OnRenderStart (JCMediaDeviceVideoCanvas canvas)
 渲染开始 更多...
 
void OnDeviceError (bool isCameraDevice)
 设备异常 更多...
 
void OnVideoCaptureDidStart (JCMediaDeviceVideoCapture capture)
 抓拍开始 更多...
 
void OnLogin (bool result, JCClientReason reason)
 登陆结果回调 更多...
 
void OnLogout (JCClientReason reason)
 登出回调 更多...
 
void OnClientStateChange (JCClientState state, JCClientState oldState)
 登陆状态变化通知 更多...
 

静态 Public 成员函数

static JCCall Create (JCClient.JCClient client, JCMediaDevice.JCMediaDevice mediaDevice, JCCallCallback callback)
 创建JCCall实例 更多...
 
static void Destroy ()
 销毁JCCall实例 更多...
 

属性

List< JCCallItemcallItems [get]
 通话对象列表 更多...
 
int maxCallNum [get, set]
 最大通话数,当通话超过最大数呼出会失败,收到来电会自动拒绝 更多...
 
bool Conference [get, set]
 会议模式,只针对语音 更多...
 

详细描述

一对一通话模块

成员函数说明

◆ AddCallback()

void JMSDK.JCCall.JCCall.AddCallback ( JCCallCallback  callback)
inline

添加回调

◆ Answer()

bool JMSDK.JCCall.JCCall.Answer ( JCCallItem  item,
bool  video 
)
inline

接听

参数
itemJCCallItem对象
video针对视频呼入可选择视频接听和音频接听
返回
返回true表示正常执行调用流程,false表示调用异常

◆ AudioRecord()

bool JMSDK.JCCall.JCCall.AudioRecord ( JCCallItem  item,
bool  enable,
string  filePath 
)
inline

通话录音,通过JCCallItem对象中的呼叫保持状态来决定开启关闭呼叫保持

参数
itemJCCallItem对象
enable开启关闭录音
filePath录音文件路径
返回
返回true表示正常执行调用流程,false表示调用异常

◆ BecomeActive()

bool JMSDK.JCCall.JCCall.BecomeActive ( JCCallItem  item)
inline

切换活跃通话

参数
item需要变活跃的JCCallItem对象
返回
返回true表示正常执行调用流程,false表示调用异常

◆ Call()

bool JMSDK.JCCall.JCCall.Call ( string  userId,
bool  video,
string  extraParam 
)
inline

一对一呼叫

参数
userId用户标识
video是否为视频呼叫
extraParam透传参数,设置后被叫方可获取该参数

>

返回
返回true表示正常执行调用流程,false表示调用异常

◆ Create()

static JCCall JMSDK.JCCall.JCCall.Create ( JCClient.JCClient  client,
JCMediaDevice.JCMediaDevice  mediaDevice,
JCCallCallback  callback 
)
inlinestatic

创建JCCall实例

参数
clientJCClient实例
mediaDeviceJCMediaDevice实例
callback回调接口,用于接收JCCall相关回调事件
返回
JCCall实例

◆ Destroy()

static void JMSDK.JCCall.JCCall.Destroy ( )
inlinestatic

销毁JCCall实例

◆ EnableUploadVideoStream()

bool JMSDK.JCCall.JCCall.EnableUploadVideoStream ( JCCallItem  item)
inline

开启关闭视频流发送,用于视频通话中

参数
itemJCCallItem对象
返回
返回true表示正常执行调用流程,false表示调用异常

◆ Hold()

bool JMSDK.JCCall.JCCall.Hold ( JCCallItem  item)
inline

呼叫保持,通过JCCallItem对象中的呼叫保持状态来决定开启关闭

参数
itemJCCallItem对象
返回
返回true表示正常执行调用流程,false表示调用异常

◆ Mute()

bool JMSDK.JCCall.JCCall.Mute ( JCCallItem  item)
inline

静音,通过JCCallItem中的静音状态来决定开启关闭

参数
itemJCCallItem对象
返回
返回true表示正常执行调用流程,false表示调用异常

◆ OnAudioInputTypeChange()

void JMSDK.JCCall.JCCall.OnAudioInputTypeChange ( string  audioInputType)
inline

音频输入设备变化

参数
audioInputType音频输入类型

实现了 JMSDK.JCMediaDevice.JCMediaDeviceCallback.

◆ OnAudioOutputTypeChange()

void JMSDK.JCCall.JCCall.OnAudioOutputTypeChange ( string  audioOutputType)
inline

音频输出设备变化

参数
audioOutputType音频输出类型

实现了 JMSDK.JCMediaDevice.JCMediaDeviceCallback.

◆ OnCameraUpdate()

void JMSDK.JCCall.JCCall.OnCameraUpdate ( )
inline

摄像头变化

实现了 JMSDK.JCMediaDevice.JCMediaDeviceCallback.

◆ OnClientStateChange()

void JMSDK.JCCall.JCCall.OnClientStateChange ( JCClientState  state,
JCClientState  oldState 
)
inline

登陆状态变化通知

参数
state当前状态值
oldState之前状态值

实现了 JMSDK.JCClient.JCClientCallback.

◆ OnDeviceError()

void JMSDK.JCCall.JCCall.OnDeviceError ( bool  isCameraDevice)
inline

设备异常

参数
isCameraDevicetrue 摄像头异常;false 音频设备异常

实现了 JMSDK.JCMediaDevice.JCMediaDeviceCallback.

◆ OnLogin()

void JMSDK.JCCall.JCCall.OnLogin ( bool  result,
JCClientReason  reason 
)
inline

登陆结果回调

参数
resulttrue 表示登陆成功,false 表示登陆失败
reason当 result 为 false 时该值有效,了解具体原因

实现了 JMSDK.JCClient.JCClientCallback.

◆ OnLogout()

void JMSDK.JCCall.JCCall.OnLogout ( JCClientReason  reason)
inline

登出回调

参数
reason登出原因

实现了 JMSDK.JCClient.JCClientCallback.

◆ OnRenderReceived()

void JMSDK.JCCall.JCCall.OnRenderReceived ( JCMediaDeviceVideoCanvas  canvas)
inline

收到第一帧数据

参数
canvas渲染对象

实现了 JMSDK.JCMediaDevice.JCMediaDeviceCallback.

◆ OnRenderStart()

void JMSDK.JCCall.JCCall.OnRenderStart ( JCMediaDeviceVideoCanvas  canvas)
inline

渲染开始

参数
canvas渲染对象

实现了 JMSDK.JCMediaDevice.JCMediaDeviceCallback.

◆ OnVideoCaptureDidStart()

void JMSDK.JCCall.JCCall.OnVideoCaptureDidStart ( JCMediaDeviceVideoCapture  capture)
inline

抓拍开始

参数
capture抓拍信息

实现了 JMSDK.JCMediaDevice.JCMediaDeviceCallback.

◆ RemoveCallback()

void JMSDK.JCCall.JCCall.RemoveCallback ( JCCallCallback  callback)
inline

删除回调

◆ SendMessage()

bool JMSDK.JCCall.JCCall.SendMessage ( JCCallItem  item,
string  type,
string  content 
)
inline

通过通话建立后的通道发送数据

参数
item需要发送数据的JCCallItem对象
type文本消息类型,用户可以自定义,例如text,xml等
content文本内容
返回
返回 true 表示正常执行调用流程,false 表示调用异常

◆ Statistics()

String JMSDK.JCCall.JCCall.Statistics ( )
inline

获得当前通话统计信息,以Json字符串形式返回,其中包含 "Audio" 和 "Video" 两个节点

返回
返回统计信息字符串

◆ Term()

bool JMSDK.JCCall.JCCall.Term ( JCCallItem  item,
JCCallReason  reason,
string  description 
)
inline

挂断

参数
itemJCCallItem对象
reason挂断原因,参考
description挂断描述
返回
返回true表示正常执行调用流程,false表示调用异常

◆ VideoRecord()

bool JMSDK.JCCall.JCCall.VideoRecord ( JCCallItem  item,
bool  enable,
bool  remote,
int  width,
int  height,
string  filePath 
)
inline

视频通话录制,通过JCCallItem对象中的localVideoRecord,remoteVideoRecord状态来决定开启关闭录制

参数
itemJCCallItem对象
enable开启关闭录制
remote是否为远端视频源
width录制视频宽像素
height录制视频高像素
filePath录制视频文件存储路径
返回
返回true表示正常执行调用流程,false表示调用异常

属性说明

◆ callItems

List<JCCallItem> JMSDK.JCCall.JCCall.callItems
get

通话对象列表

◆ Conference

bool JMSDK.JCCall.JCCall.Conference
getset

会议模式,只针对语音

◆ maxCallNum

int JMSDK.JCCall.JCCall.maxCallNum
getset

最大通话数,当通话超过最大数呼出会失败,收到来电会自动拒绝


该类的文档由以下文件生成: