会议控制模块 更多...

Public 成员函数

int QueryGoingConf (string confNumber)
 查询进行中的会议,结果回调 onQueryGoingConfResult 更多...
 
bool Start (string confNumber, bool video, Dictionary< string, string > config)
 创建并加入一个会议,结果回调 onConferenceJoin 更多...
 
bool Stop ()
 结束会议,主持人才能调用该接口结束会议,结果回调 onConferenceLeave 更多...
 
bool Join (string confNumber, bool video, Dictionary< string, string > config)
 加入会议,结果回调 onConferenceJoin 更多...
 
bool Leave ()
 离开会议,结果回调 onConferenceLeave 兼容新的服务 更多...
 
int Lock ()
 锁定会议 / 解除锁定,主持人才能调用该接口 会议被锁定后无法加入该会议,须再次调用该接口来解锁,JCConferenceInfo.Lock表示当前会议是否被锁定 操作结果(成功或失败)通过 onLockResult 回调。 操作成功后会议中所有成员收到onCommandReceivedResult的回调,对应的JCConferenceCommandInfo.type为COMMANDINFO_LOCK,JCConferenceInfo.Lock表示当前会议是否被锁定。 更多...
 
int ChangeChairman (JCConferenceParticipant participant)
 移交主持人,主持人才能调用该接口,结果回调onChangeChairmanResult 成功后会议所有成员会收到onCommandReceivedResult 回调,对应的Type 为 JCConferenceCommandInfoType.ChangeChariman 更多...
 
bool Kick (List< JCConferenceParticipant > participants)
 踢出成员,主持人才能调用该接口,成功后被踢的成员收到onConferenceLeave(reason为Kicked),其他成员收到 onConferenceParticipantLeft。 更多...
 
bool Mute (bool mute, JCConferenceParticipant participant)
 成员静音/解除静音,主持人才能调用该接口。 成功后会议所有成员收到 onConferenceParticipantUpdate 回调,JCConferenceParticipant.isMute 查看成员是否被静音 更多...
 
bool MuteAll (bool mute)
 全场静音/解除全场静音,主持人才能调用该接口。 静音后除主持人外都无法发言。全场静音后可以通过再次调用该接口来解除,也可以单个对用户进行解除静音。 成功后会议所有成员收到onCommandReceivedResult的回调,对应的JCConferenceCommandInfo.type为JCConferenceCommandInfoType.AllMute。 JCConferenceInfo.allMute 表示当前会议是否被静音。 更多...
 
int Delay (int time)
 延长预约会议的时长,主持人才能调用该接口 当预约的会议即将结束(结束前5分钟),主持人会收到回调 onCommandReceivedResult(Type为JCConferenceCommandInfoType.DelayRemind),主持人可以调用该接口延长会议。 更多...
 
int UpdateParticipantExpandInfo (string expandInfo)
 更新成员(自己)扩展信息,会议中的成员会收到 onConferenceParticipantUpdate 回调 更多...
 
bool FocusParticipant (List< string > userId)
 设置焦点成员,主持人才能调用该接口,界面可以对焦点成员在视频布局中展示。 设置成功会议中所有成员收到onCommandReceivedResult的回调,对应的JCConferenceCommandInfo.type为JCConferenceCommandInfoType.Focus 更多...
 
bool HandUpParticipant (List< string > userId, bool handUp)
 成员举手/取消举手 普通成员可以调用该接口举手或取消举手 如有成员举手,主持人可以调用该接口取消成员举手 设置成功会议中所有成员会收到onCommandReceivedResult的回调 更多...
 
bool SetChairman (bool isChairman)
 设置主持人(自己) 更多...
 
int ExportParticipantsLog ()
 导出参会成员的信息记录,结果回调 onExportParticipantsLogResult 更多...
 
bool ChangeParticipantRole (List< string > userId, JCConferenceParticipantType type)
 设置会议中的成员角色 设置成功会议中所有成员收到onCommandReceivedResult的回调,对应的JCConferenceCommandInfo.type为JCConferenceCommandInfoType.ChangeRole 设置失败自己收到onCommandReceivedResult回调 更多...
 
bool SetLocalRatio (float ratio)
 设置本地宽高比 更多...
 
bool EnableUploadAudioStream (bool enable)
 开启/关闭音频发送,会议中的成员会收到 onConferenceParticipantUpdate 回调,JCConferenceParticipant.IsAudio 表示该成员是否开启了音频发送 当前的状态 更多...
 
bool EnableUploadVideoStream (bool enable)
 开启/关闭视频发送,会议中的成员会收到 onConferenceParticipantUpdate 回调,JCConferenceParticipant.IsVideo 表示该成员是否开启了音频发送 当前的状态 更多...
 
bool EnableAudioOutput (bool enable)
 开启/关闭本端会议音频输出 当前的状态 更多...
 
bool SubscribeUserAudio (string userId, bool subscribe)
 订阅/取消订阅某个成员的音频,取消订阅时不会播放该成员的声音。成员的对应状态 JCConferenceParticipant 对象的IsSubscribeAudio 更多...
 
bool SetVideoStream (string stream)
 设置本地发送的视频流,在会议加入成功后调用 更多...
 
bool RequestVideo (string userId, JCConferencePictureSize pictureSize)
 请求用户的视频流 当 pictureSize 为 PictureSizeNone 标识关闭请求。 更多...
 
bool RequestVideo (JCConferenceParticipant participant, JCConferencePictureSize pictureSize)
 订阅会议成员视频 JCConferenceParticipant.IsVideo 如果成员开启了视频发送,就可以调用该接口订阅该成员的视频。 更多...
 
bool RequestScreenVideo (string screenUri, JCConferencePictureSize pictureSize)
 订阅屏幕共享的视频 更多...
 
bool EnableCdn ()
 开关Cdn推流,内部根据状态决定是否开启 更多...
 
bool EnableRemoteRecord (bool enable, JCConferenceRecordRemoteParams recordRemoteParams)
 开关会议录制(服务端录制) 更多...
 
bool EnableRemoteRecordMember (bool enable, List< string > userIdList)
 服务器录制开启后,指定/取消录制某成员音视频数据 更多...
 
bool EnableLocalRecord (bool enable, JCConferenceRecordLocalParams recordLocalParams)
 开关会议录制(本地录制) 更多...
 
bool EnableScreenShare (bool enable)
 开关桌面共享,会议中的成员会收到回调 onCommandReceivedResult(type为JCConferenceCommandInfoType.ScreenShareStart或ScreenShareStop) 更多...
 
bool EnableScreenShare (bool enable, string videoSource, string config)
 开关屏幕共享,会议中的成员会收到回调 onCommandReceivedResult(type为JCConferenceCommandInfoType.ScreenShareStart或ScreenShareStop) 注意:开启共享时,必须先开启视频采集接口enableScreenOrWindowCapture(JCMediaDevice的接口)。关闭共享时,须关闭视频采集。 更多...
 
bool SetCustomProperty (string key, string value)
 设置会议自定义属性,会议中的成员会收到回调 onCommandReceivedResult(type为JCConferenceCommandInfoType.CustomPropertyChanged) 更多...
 
string GetCustomProperty (string key)
 获取会议自定义属性 更多...
 
int ChangeDisplayName (string userId, string changeName)
 用户昵称修改 更多...
 
bool SendMessage (string type, string content, string toUserId)
 发送消息,其他成员会收到回调 onMessageReceive 更多...
 
bool SendCommand (string name, string param)
 发送会议指令 更多...
 
string GetStatistics ()
 获得统计信息,以Json字符串形式返回,其中包含 "Config", "Network","Transport" 和 "Participants" 4个节点 更多...
 
bool SetVideoCapture (string path)
 设置本地视频文件替代摄像头(目前支持视频文件格式有限制,仅支持mp4,avi格式,并且只支持视频编解码H264,和音频格式PCMA) 更多...
 
int Invite (List< string > users)
 邀请成员加入会议,被邀请成员收到 onInviteReceived 回调 更多...
 
int InviteEx (List< JCConferenceInviteInfo > users)
 邀请成员加入会议,被邀请成员收到 onInviteReceived 回调 JCConferenceInviteInfo.expandInfo 可携带自定义信息并发送给被邀请人 更多...
 
bool CancelInvite (List< string > userIds)
 取消邀请,被邀请方收到 OnCancelInviteReceived 回调 更多...
 
bool DeclineInvite (string confNumber, string inviterUserId, string reason)
 拒绝邀请,邀请方收到 OnDeclineInviteReceived 回调 更多...
 
int InviteSipUser (JCConferenceSipInviteInfo sipParam)
 邀请Sip用户,一般用于对接落地网关等 更多...
 
int ImportCandidates (List< JCConferenceCandidate > candidates, string info)
 设置待加入成员,会议成员收到 onConferenceCandidatesChanged 回调。 该接口配合 Invite 接口使用,在邀请成员后同时设置这些成员,界面可以显示这些被邀请的成员 更多...
 
int RejectCandidate (string confNumber)
 删除待加入成员,会议成员收到 onConferenceCandidatesChanged 回调。 如果发起邀请时调用 ImportCandidates 接口,被邀请成员收到邀请后拒绝邀请,则需调用该接口。 更多...
 
bool InviteToScreenShare (string toUserId)
 主持人指定人员共享桌面 更多...
 
bool InviteToSpeak (string toUserId)
 主持人指定人员发言 更多...
 
bool RejectToScreenShare (string toUserId)
 被主持人邀请屏幕共享后,拒绝共享 更多...
 
bool TransferToAudioConf ()
 转语音会议 更多...
 
bool IsAudioConf ()
 是否音频会议 更多...
 
bool StartOrUpdateSubTitle (JCConferenceSubTitleInfo subTitleInfo)
 开启或者变更会议字幕 更多...
 
bool StopSubTitle ()
 关闭会议字幕 更多...
 
bool StartDoodle ()
 开启涂鸦 更多...
 
bool StopDoodle ()
 关闭涂鸦 更多...
 
int Reserve (JCConferenceReserveInfo reserveInfo)
 预约会议,结果回调 onReserveResult 更多...
 
int CancelReserve (string reserveId)
 取消预约,结果回调 onCancelReserveResult 更多...
 
int EditReserve (JCConferenceReserveInfo reserveInfo)
 更新预约信息,只有创建者才能更新,结果回调 onEditReserveResult 更多...
 
int RefreshReservedConf (long lastUpdateTime)
 获取预约会议列表,结果回调 onRefreshReservedConfResult。 lastUpdateTime 传0,获取所有预约会议列表,界面要保存 onRefreshConfListResult 回调返回的 lastUpdateTime 值。 下一次调用该接口刷新时,lastUpdateTime 传界面保存的值,获取该时间点到当前时间点这段时间内变更(新增、更新、删除)的会议列表。 该接口适用于数据库存储数据。 更多...
 
int RefreshReservedConf2 ()
 获取预约会议列表,结果回调 onRefreshReservedConfResult。 第一次调用获取所有预约会议列表,下一次调用该接口刷新时, 在上一次的刷新时间基础上获取该时间点到当前时间点这段时间内变更(新增、更新、删除)的会议列表。 该接口适用于数据库存储数据。 更多...
 
int RefreshReservedConf ()
 获取预约会议列表,结果回调 onRefreshReservedConfResult。 第一次调用获取所有预约会议列表,下一次调用该接口刷新时, 在上一次的刷新时间基础上获取该时间点到当前时间点这段时间内变更(新增、更新、删除)的会议列表。 该接口适用于数据库存储数据。 更多...
 
int QueryReservedConf (JCConferenceReserveInfoState state, int page, int count)
 查询预约会议列表,结果回调onQueryConfResult。不使用数据库存储数据的可用该接口。 更多...
 
int QueryReservedConf (JCConferenceReserveInfo reserveInfo, int count)
 查询指定预约会议会议记录之前的预约会议列表,结果回调onQueryConfResult 更多...
 
int QuerySingleConf (string confUuid)
 查询单个预约会议,查询结果回调 onQuerySingleConfResult 更多...
 
void OnLogin (bool result, JCClientReason reason)
 登陆结果回调 更多...
 
void OnLogout (JCClientReason reason)
 登出回调 更多...
 
void OnClientStateChange (JCClientState state, JCClientState oldState)
 登陆状态变化通知 更多...
 
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)
 抓拍开始 更多...
 

静态 Public 成员函数

static JCConference Create (JCClient.JCClient client, JCMediaDevice.JCMediaDevice mediaDevice, JCConferenceCallback callback)
 创建JCConference对象 更多...
 
static JCConference Create (JCClient.JCClient client, JCMediaDevice.JCMediaDevice mediaDevice, JCDoodle.JCDoodle doodle, JCConferenceCallback callback)
 创建JCConference对象 更多...
 
static void Destroy ()
 销毁 JCConference 对象 更多...
 

静态 Public 属性

const int ValueInit = -1
 初始值 更多...
 

属性

JCConferenceInfo ConferenceInfo [get]
 当前会议信息对象 更多...
 
string RefreshLastUpdateTime [get]
 
JCConferenceState State [get, set]
 

详细描述

会议控制模块

成员函数说明

◆ CancelInvite()

bool JMSDK.JCConference.JCConference.CancelInvite ( List< string >  userIds)
inline

取消邀请,被邀请方收到 OnCancelInviteReceived 回调

参数
userIds被邀请方userId
返回
接口调用成功失败

◆ CancelReserve()

int JMSDK.JCConference.JCConference.CancelReserve ( string  reserveId)
inline

取消预约,结果回调 onCancelReserveResult

参数
reserveId预约成功生成的唯一id
返回
操作id,返回-1表示接口调用失败

◆ ChangeChairman()

int JMSDK.JCConference.JCConference.ChangeChairman ( JCConferenceParticipant  participant)
inline

移交主持人,主持人才能调用该接口,结果回调onChangeChairmanResult 成功后会议所有成员会收到onCommandReceivedResult 回调,对应的Type 为 JCConferenceCommandInfoType.ChangeChariman

参数
participant会议中的成员对象
返回
返回操作id,返回-1表示接口调用失败

◆ ChangeDisplayName()

int JMSDK.JCConference.JCConference.ChangeDisplayName ( string  userId,
string  changeName 
)
inline

用户昵称修改

参数
userId修改用户
changeName修改用户的昵称
返回
返回操作id,返回-1表示接口调用失败

◆ ChangeParticipantRole()

bool JMSDK.JCConference.JCConference.ChangeParticipantRole ( List< string >  userId,
JCConferenceParticipantType  type 
)
inline

设置会议中的成员角色 设置成功会议中所有成员收到onCommandReceivedResult的回调,对应的JCConferenceCommandInfo.type为JCConferenceCommandInfoType.ChangeRole 设置失败自己收到onCommandReceivedResult回调

参数
userId对应成员的userId
type成员类型
返回
返回true表示接口调用成功

◆ Create() [1/2]

static JCConference JMSDK.JCConference.JCConference.Create ( JCClient.JCClient  client,
JCMediaDevice.JCMediaDevice  mediaDevice,
JCConferenceCallback  callback 
)
inlinestatic

创建JCConference对象

参数
clientJCClient 对象
mediaDeviceJCMediaDevice 对象
callback实现 JCConferenceCallback 接口的对象,用于接收 JCConference 相关通知
返回
JCConference对象

◆ Create() [2/2]

static JCConference JMSDK.JCConference.JCConference.Create ( JCClient.JCClient  client,
JCMediaDevice.JCMediaDevice  mediaDevice,
JCDoodle.JCDoodle  doodle,
JCConferenceCallback  callback 
)
inlinestatic

创建JCConference对象

参数
clientJCClient 对象
mediaDeviceJCMediaDevice 对象
doodleJCDoodle 对象
callback实现 JCConferenceCallback 接口的对象,用于接收 JCConference 相关通知
返回
JCConference对象

◆ DeclineInvite()

bool JMSDK.JCConference.JCConference.DeclineInvite ( string  confNumber,
string  inviterUserId,
string  reason 
)
inline

拒绝邀请,邀请方收到 OnDeclineInviteReceived 回调

参数
confNumber收到邀请的会议号
inviterUserId发起邀请成员userId
reason自定义原因
返回
接口调用成功失败

◆ Delay()

int JMSDK.JCConference.JCConference.Delay ( int  time)
inline

延长预约会议的时长,主持人才能调用该接口 当预约的会议即将结束(结束前5分钟),主持人会收到回调 onCommandReceivedResult(Type为JCConferenceCommandInfoType.DelayRemind),主持人可以调用该接口延长会议。

参数
time延长的时间,单位分钟
返回
返回操作id,返回-1表示接口调用失败

◆ Destroy()

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

销毁 JCConference 对象

◆ EditReserve()

int JMSDK.JCConference.JCConference.EditReserve ( JCConferenceReserveInfo  reserveInfo)
inline

更新预约信息,只有创建者才能更新,结果回调 onEditReserveResult

参数
reserveInfo预约信息参数
返回
操作id,返回-1表示接口调用失败

◆ EnableAudioOutput()

bool JMSDK.JCConference.JCConference.EnableAudioOutput ( bool  enable)
inline

开启/关闭本端会议音频输出 当前的状态

参见
JCConferenceInfo 对象属性 AudioOutput
参数
enabletrue 开启,false 关闭
返回
true 成功,false 失败

◆ EnableCdn()

bool JMSDK.JCConference.JCConference.EnableCdn ( )
inline

开关Cdn推流,内部根据状态决定是否开启

返回
接口调用成功失败

◆ EnableLocalRecord()

bool JMSDK.JCConference.JCConference.EnableLocalRecord ( bool  enable,
JCConferenceRecordLocalParams  recordLocalParams 
)
inline

开关会议录制(本地录制)

参数
enable是否开启视频录制, true开始录制, false结束录制
recordLocalParams录制参数
返回

◆ EnableRemoteRecord()

bool JMSDK.JCConference.JCConference.EnableRemoteRecord ( bool  enable,
JCConferenceRecordRemoteParams  recordRemoteParams 
)
inline

开关会议录制(服务端录制)

参数
enabletrue表示开启,false表示关闭
recordRemoteParams录制参数
返回
表示接口是否调用成功

◆ EnableRemoteRecordMember()

bool JMSDK.JCConference.JCConference.EnableRemoteRecordMember ( bool  enable,
List< string >  userIdList 
)
inline

服务器录制开启后,指定/取消录制某成员音视频数据

参数
enabletrue指定录制该成员音视频数据,false取消录制该成员音视频数据
userIdList指定录制成员用户Id列表
返回

◆ EnableScreenShare() [1/2]

bool JMSDK.JCConference.JCConference.EnableScreenShare ( bool  enable)
inline

开关桌面共享,会议中的成员会收到回调 onCommandReceivedResult(type为JCConferenceCommandInfoType.ScreenShareStart或ScreenShareStop)

参数
enabletrue 开启,false 关闭
返回
接口调用成功失败

◆ EnableScreenShare() [2/2]

bool JMSDK.JCConference.JCConference.EnableScreenShare ( bool  enable,
string  videoSource,
string  config 
)
inline

开关屏幕共享,会议中的成员会收到回调 onCommandReceivedResult(type为JCConferenceCommandInfoType.ScreenShareStart或ScreenShareStop) 注意:开启共享时,必须先开启视频采集接口enableScreenOrWindowCapture(JCMediaDevice的接口)。关闭共享时,须关闭视频采集。

参数
enabletrue 开启,false 关闭
videoSource桌面或窗口id
config一般传null,可设置MtcConf.MtcConfScreenVideoFramerateKey(发送帧数)、MtcConf.MtcConfScreenVideoSizeKey(分辨率,值=width*height),以key-value形式组成json字符串传入
返回
接口调用成功失败

◆ EnableUploadAudioStream()

bool JMSDK.JCConference.JCConference.EnableUploadAudioStream ( bool  enable)
inline

开启/关闭音频发送,会议中的成员会收到 onConferenceParticipantUpdate 回调,JCConferenceParticipant.IsAudio 表示该成员是否开启了音频发送 当前的状态

参见
JCConferenceInfo 对象属性 UploadAudio
参数
enabletrue 开启发送,false 关闭发送
返回
接口调用成功失败

◆ EnableUploadVideoStream()

bool JMSDK.JCConference.JCConference.EnableUploadVideoStream ( bool  enable)
inline

开启/关闭视频发送,会议中的成员会收到 onConferenceParticipantUpdate 回调,JCConferenceParticipant.IsVideo 表示该成员是否开启了音频发送 当前的状态

参见
JCConferenceInfo 对象属性 UploadVideo
参数
enabletrue 开启发送,false 关闭发送
返回
接口调用成功失败

◆ ExportParticipantsLog()

int JMSDK.JCConference.JCConference.ExportParticipantsLog ( )
inline

导出参会成员的信息记录,结果回调 onExportParticipantsLogResult

返回
返回操作Id,返回-1表示接口调用失败

◆ FocusParticipant()

bool JMSDK.JCConference.JCConference.FocusParticipant ( List< string >  userId)
inline

设置焦点成员,主持人才能调用该接口,界面可以对焦点成员在视频布局中展示。 设置成功会议中所有成员收到onCommandReceivedResult的回调,对应的JCConferenceCommandInfo.type为JCConferenceCommandInfoType.Focus

参数
userId成员UserId,传 null 取消所有焦点成员
返回
返回 true 接口调用成功

◆ GetCustomProperty()

string JMSDK.JCConference.JCConference.GetCustomProperty ( string  key)
inline

获取会议自定义属性

参数
key自定义 key 值
返回
自定义 value 值

◆ GetStatistics()

string JMSDK.JCConference.JCConference.GetStatistics ( )
inline

获得统计信息,以Json字符串形式返回,其中包含 "Config", "Network","Transport" 和 "Participants" 4个节点

返回
返回统计信息字符串

◆ HandUpParticipant()

bool JMSDK.JCConference.JCConference.HandUpParticipant ( List< string >  userId,
bool  handUp 
)
inline

成员举手/取消举手 普通成员可以调用该接口举手或取消举手 如有成员举手,主持人可以调用该接口取消成员举手 设置成功会议中所有成员会收到onCommandReceivedResult的回调

参数
userId
handUp
返回
返回 true 接口调用成功

◆ ImportCandidates()

int JMSDK.JCConference.JCConference.ImportCandidates ( List< JCConferenceCandidate candidates,
string  info 
)
inline

设置待加入成员,会议成员收到 onConferenceCandidatesChanged 回调。 该接口配合 Invite 接口使用,在邀请成员后同时设置这些成员,界面可以显示这些被邀请的成员

参数
candidates待加入成员信息
info界面自定义info,Json格式字符串
返回
返回操作id,返回-1表示接口调用失败,成功则返回操作id

◆ Invite()

int JMSDK.JCConference.JCConference.Invite ( List< string >  users)
inline

邀请成员加入会议,被邀请成员收到 onInviteReceived 回调

参数
usersList中的元素为被邀请者UserId
返回
返回操作id,返回-1表示接口调用失败

◆ InviteEx()

int JMSDK.JCConference.JCConference.InviteEx ( List< JCConferenceInviteInfo users)
inline

邀请成员加入会议,被邀请成员收到 onInviteReceived 回调 JCConferenceInviteInfo.expandInfo 可携带自定义信息并发送给被邀请人

参数
users被邀请人的List
返回
返回操作id,返回-1表示接口调用失败

◆ InviteSipUser()

int JMSDK.JCConference.JCConference.InviteSipUser ( JCConferenceSipInviteInfo  sipParam)
inline

邀请Sip用户,一般用于对接落地网关等

参数
sipParam邀请sip用户入会的配置参数
返回
返回操作id,返回-1表示接口调用失败

◆ InviteToScreenShare()

bool JMSDK.JCConference.JCConference.InviteToScreenShare ( string  toUserId)
inline

主持人指定人员共享桌面

参数
toUserId指定人员用户id
返回
true表示成功,false表示失败

◆ InviteToSpeak()

bool JMSDK.JCConference.JCConference.InviteToSpeak ( string  toUserId)
inline

主持人指定人员发言

参数
toUserId接收者id
返回
true表示成功,false表示失败

◆ IsAudioConf()

bool JMSDK.JCConference.JCConference.IsAudioConf ( )
inline

是否音频会议

返回
true表示音频会议,false表示视频会议

◆ Join()

bool JMSDK.JCConference.JCConference.Join ( string  confNumber,
bool  video,
Dictionary< string, string >  config 
)
inline

加入会议,结果回调 onConferenceJoin

参数
confNumber会议号
video接口暂时没用该参数
config会议的其他配置,具体查看JCConferenceConfig的配置参数
返回
true 表示接口调用成功

◆ Kick()

bool JMSDK.JCConference.JCConference.Kick ( List< JCConferenceParticipant participants)
inline

踢出成员,主持人才能调用该接口,成功后被踢的成员收到onConferenceLeave(reason为Kicked),其他成员收到 onConferenceParticipantLeft。

参数
participants会议中的成员对象
返回
返回 true 发起请求,false 失败

◆ Leave()

bool JMSDK.JCConference.JCConference.Leave ( )
inline

离开会议,结果回调 onConferenceLeave 兼容新的服务

返回
true 表示接口调用成功

◆ Lock()

int JMSDK.JCConference.JCConference.Lock ( )
inline

锁定会议 / 解除锁定,主持人才能调用该接口 会议被锁定后无法加入该会议,须再次调用该接口来解锁,JCConferenceInfo.Lock表示当前会议是否被锁定 操作结果(成功或失败)通过 onLockResult 回调。 操作成功后会议中所有成员收到onCommandReceivedResult的回调,对应的JCConferenceCommandInfo.type为COMMANDINFO_LOCK,JCConferenceInfo.Lock表示当前会议是否被锁定。

返回
返回操作id,返回-1表示接口调用失败

◆ Mute()

bool JMSDK.JCConference.JCConference.Mute ( bool  mute,
JCConferenceParticipant  participant 
)
inline

成员静音/解除静音,主持人才能调用该接口。 成功后会议所有成员收到 onConferenceParticipantUpdate 回调,JCConferenceParticipant.isMute 查看成员是否被静音

参数
mutetrue 静音,false 解除静音
participant会议中的成员对象
返回
返回 true 发起请求,false 失败

◆ MuteAll()

bool JMSDK.JCConference.JCConference.MuteAll ( bool  mute)
inline

全场静音/解除全场静音,主持人才能调用该接口。 静音后除主持人外都无法发言。全场静音后可以通过再次调用该接口来解除,也可以单个对用户进行解除静音。 成功后会议所有成员收到onCommandReceivedResult的回调,对应的JCConferenceCommandInfo.type为JCConferenceCommandInfoType.AllMute。 JCConferenceInfo.allMute 表示当前会议是否被静音。

参数
mutetrue 静音,false 解除静音
返回
返回 true 发起请求,false 失败

◆ OnAudioInputTypeChange()

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

音频输入设备变化

参数
audioInputType音频输入类型

实现了 JMSDK.JCMediaDevice.JCMediaDeviceCallback.

◆ OnAudioOutputTypeChange()

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

音频输出设备变化回调函数

参数
audioOutputType音频输出类型

实现了 JMSDK.JCMediaDevice.JCMediaDeviceCallback.

◆ OnCameraUpdate()

void JMSDK.JCConference.JCConference.OnCameraUpdate ( )
inline

摄像头变化回调函数

实现了 JMSDK.JCMediaDevice.JCMediaDeviceCallback.

◆ OnClientStateChange()

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

登陆状态变化通知

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

实现了 JMSDK.JCClient.JCClientCallback.

◆ OnDeviceError()

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

设备异常

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

实现了 JMSDK.JCMediaDevice.JCMediaDeviceCallback.

◆ OnLogin()

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

登陆结果回调

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

实现了 JMSDK.JCClient.JCClientCallback.

◆ OnLogout()

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

登出回调

参数
reason登出原因

实现了 JMSDK.JCClient.JCClientCallback.

◆ OnRenderReceived()

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

收到第一帧数据

参数
canvas渲染对象

实现了 JMSDK.JCMediaDevice.JCMediaDeviceCallback.

◆ OnRenderStart()

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

渲染开始

参数
canvas渲染对象

实现了 JMSDK.JCMediaDevice.JCMediaDeviceCallback.

◆ OnVideoCaptureDidStart()

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

抓拍开始

参数
capture抓拍信息

实现了 JMSDK.JCMediaDevice.JCMediaDeviceCallback.

◆ QueryGoingConf()

int JMSDK.JCConference.JCConference.QueryGoingConf ( string  confNumber)
inline

查询进行中的会议,结果回调 onQueryGoingConfResult

参数
confNumber会议Id
返回
返回操作Id,返回-1表示接口调用失败

◆ QueryReservedConf() [1/2]

int JMSDK.JCConference.JCConference.QueryReservedConf ( JCConferenceReserveInfo  reserveInfo,
int  count 
)
inline

查询指定预约会议会议记录之前的预约会议列表,结果回调onQueryConfResult

参数
reserveInfo指定预约会议
count查询条数
返回
操作id,返回-1表示接口调用失败

◆ QueryReservedConf() [2/2]

int JMSDK.JCConference.JCConference.QueryReservedConf ( JCConferenceReserveInfoState  state,
int  page,
int  count 
)
inline

查询预约会议列表,结果回调onQueryConfResult。不使用数据库存储数据的可用该接口。

  1. state参数传JCConferenceConfState.CONF_STATE_ALL,先查询所有预约会议的总数(查询所有时,参数page和count传0)
  2. 根据查询总数,再次查询对应状态下的预约会议列表详情(如果总数过大,可分页查询,比如总数100个,查询10次,每次10个)
参数
state预约会议状态,具体查看 JCConferenceReserveInfoState
page分页查询,从1开始递增
count每一页的总数
返回
操作id,返回-1表示接口调用失败

◆ QuerySingleConf()

int JMSDK.JCConference.JCConference.QuerySingleConf ( string  confUuid)
inline

查询单个预约会议,查询结果回调 onQuerySingleConfResult

参数
confUuid会议的预约id
返回
操作id,返回-1表示接口调用失败

◆ RefreshReservedConf() [1/2]

int JMSDK.JCConference.JCConference.RefreshReservedConf ( )
inline

获取预约会议列表,结果回调 onRefreshReservedConfResult。 第一次调用获取所有预约会议列表,下一次调用该接口刷新时, 在上一次的刷新时间基础上获取该时间点到当前时间点这段时间内变更(新增、更新、删除)的会议列表。 该接口适用于数据库存储数据。

返回
操作id,返回-1表示接口调用失败

◆ RefreshReservedConf() [2/2]

int JMSDK.JCConference.JCConference.RefreshReservedConf ( long  lastUpdateTime)
inline

获取预约会议列表,结果回调 onRefreshReservedConfResult。 lastUpdateTime 传0,获取所有预约会议列表,界面要保存 onRefreshConfListResult 回调返回的 lastUpdateTime 值。 下一次调用该接口刷新时,lastUpdateTime 传界面保存的值,获取该时间点到当前时间点这段时间内变更(新增、更新、删除)的会议列表。 该接口适用于数据库存储数据。

参数
lastUpdateTime最近获取会议列表的时间
返回
操作id,返回-1表示接口调用失败

◆ RefreshReservedConf2()

int JMSDK.JCConference.JCConference.RefreshReservedConf2 ( )
inline

获取预约会议列表,结果回调 onRefreshReservedConfResult。 第一次调用获取所有预约会议列表,下一次调用该接口刷新时, 在上一次的刷新时间基础上获取该时间点到当前时间点这段时间内变更(新增、更新、删除)的会议列表。 该接口适用于数据库存储数据。

返回
操作id,返回-1表示接口调用失败

◆ RejectCandidate()

int JMSDK.JCConference.JCConference.RejectCandidate ( string  confNumber)
inline

删除待加入成员,会议成员收到 onConferenceCandidatesChanged 回调。 如果发起邀请时调用 ImportCandidates 接口,被邀请成员收到邀请后拒绝邀请,则需调用该接口。

参数
confNumber收到邀请的会议号
返回
操作id,返回-1表示接口调用失败

◆ RejectToScreenShare()

bool JMSDK.JCConference.JCConference.RejectToScreenShare ( string  toUserId)
inline

被主持人邀请屏幕共享后,拒绝共享

参数
toUserId主持人id
返回
true表示成功,false表示失败

◆ RequestScreenVideo()

bool JMSDK.JCConference.JCConference.RequestScreenVideo ( string  screenUri,
JCConferencePictureSize  pictureSize 
)
inline

订阅屏幕共享的视频

参数
screenUri屏幕分享uri
pictureSize订阅视频的分辨率,传 None 取消订阅
返回
接口调用成功失败

◆ RequestVideo() [1/2]

bool JMSDK.JCConference.JCConference.RequestVideo ( JCConferenceParticipant  participant,
JCConferencePictureSize  pictureSize 
)
inline

订阅会议成员视频 JCConferenceParticipant.IsVideo 如果成员开启了视频发送,就可以调用该接口订阅该成员的视频。

参数
participant会议成员
pictureSize订阅视频的分辨率,传 None 取消订阅
返回
接口调用成功失败

◆ RequestVideo() [2/2]

bool JMSDK.JCConference.JCConference.RequestVideo ( string  userId,
JCConferencePictureSize  pictureSize 
)
inline

请求用户的视频流 当 pictureSize 为 PictureSizeNone 标识关闭请求。

参数
userId用户对象userId
pictureSize视频请求尺寸类型
返回
回 true 表示正常执行调用流程,false 表示调用异常

◆ Reserve()

int JMSDK.JCConference.JCConference.Reserve ( JCConferenceReserveInfo  reserveInfo)
inline

预约会议,结果回调 onReserveResult

参数
reserveInfo预约信息参数
返回
操作id,返回-1表示接口调用失败

◆ SendCommand()

bool JMSDK.JCConference.JCConference.SendCommand ( string  name,
string  param 
)
inline

发送会议指令

指令名:ReplayApplyMode 指令作用:设置推流布局模式 指令参数格式:{"MtcConfCompositeModeKey": 参数值} 参数值: 1 平铺模式,所有视频均分平铺 2 讲台模式,共享为大图,其他视频为小图 3 演讲模式,共享为大图,共享者视频为小图,其他不显示 4 自定义模式,由ReplayApplyLayout指令设置所有视频布局 5 智能模式。 举例:输入指令参数{"MtcConfCompositeModeKey": 2}就是讲台模式

指令名:ReplayApplyLayout 指令作用:为多用户设置自定义推流布局 指令参数格式:{[{"MtcConfUserUriKey": "用户uri", "MtcConfPictureSizeKey": 视频尺寸,"MtcConfRectangleKey": 图像矩形的具体方位和长宽}],...} 用户uri:通过调用底层Mtc接口获取MtcUser.Mtc_UserFormUri((uint)EN_MTC_USER_ID_TYPE.EN_MTC_USER_ID_USERNAME,userId) 视频尺寸:一共5个枚举值,具体枚举值请参考底层mtc_conf.h下的MtcConfPs枚举 图像矩形的具体方位和长宽:这是一个Json格式的Array对象表示这个图像的位置和大小,第一个值是图像左上角的x坐标(0~1) 第二个值是图像左上角的y坐标(0~1)。第三个值是图像的宽(0~1)。第四个值是图像的高(0~1)。比如[0.5,0.5,0.5,0.5]表示图像在右下角长宽是原始屏幕的一半 举例: [{"MtcConfUserUriKey":"[username:zhang@xxxx.cloud.justalk.com]","MtcConfPictureSizeKey":512,"MtcConfRectangleKey":[0.5,0.5,0.5,0.5]}] 表示成员zhang小尺寸的视频在屏幕右下角位置,长宽是原始屏幕的一半

参数
name指令名
param指令参数
返回
是否发送成功

◆ SendMessage()

bool JMSDK.JCConference.JCConference.SendMessage ( string  type,
string  content,
string  toUserId 
)
inline

发送消息,其他成员会收到回调 onMessageReceive

参数
type消息类型
content消息内容,当 toUserId 不为 null 时,content 不能大于 4k
toUserId传 null 发送给所有人
返回
是否发送成功

◆ SetChairman()

bool JMSDK.JCConference.JCConference.SetChairman ( bool  isChairman)
inline

设置主持人(自己)

参数
isChairman是否为主持人
返回
返回 true 接口调用成功

◆ SetCustomProperty()

bool JMSDK.JCConference.JCConference.SetCustomProperty ( string  key,
string  value 
)
inline

设置会议自定义属性,会议中的成员会收到回调 onCommandReceivedResult(type为JCConferenceCommandInfoType.CustomPropertyChanged)

参数
key自定义 key 值
value自定义 value 值
返回
接口调用成功失败

◆ SetLocalRatio()

bool JMSDK.JCConference.JCConference.SetLocalRatio ( float  ratio)
inline

设置本地宽高比

参数
ratio宽高比
返回

◆ SetVideoCapture()

bool JMSDK.JCConference.JCConference.SetVideoCapture ( string  path)
inline

设置本地视频文件替代摄像头(目前支持视频文件格式有限制,仅支持mp4,avi格式,并且只支持视频编解码H264,和音频格式PCMA)

参数
path视频文件路径
返回
接口调用成功失败

◆ SetVideoStream()

bool JMSDK.JCConference.JCConference.SetVideoStream ( string  stream)
inline

设置本地发送的视频流,在会议加入成功后调用

参数
stream摄像头的视频流,也可以是自定义的视频流
返回
接口调用成功失败

◆ Start()

bool JMSDK.JCConference.JCConference.Start ( string  confNumber,
bool  video,
Dictionary< string, string >  config 
)
inline

创建并加入一个会议,结果回调 onConferenceJoin

参数
confNumber传 "0" 由服务器生成10位的会议号,可传字母或数字作为自定义会议号
videotrue 视频会议,false 语音会议
config会议的其他配置,具体查看JCConferenceConfig的配置参数
返回
true 表示接口调用成功

◆ StartDoodle()

bool JMSDK.JCConference.JCConference.StartDoodle ( )
inline

开启涂鸦

◆ StartOrUpdateSubTitle()

bool JMSDK.JCConference.JCConference.StartOrUpdateSubTitle ( JCConferenceSubTitleInfo  subTitleInfo)
inline

开启或者变更会议字幕

参数
subTitleInfo字幕对象
返回
true成功,false表示失败

◆ Stop()

bool JMSDK.JCConference.JCConference.Stop ( )
inline

结束会议,主持人才能调用该接口结束会议,结果回调 onConferenceLeave

返回
true 表示接口调用成功

◆ StopDoodle()

bool JMSDK.JCConference.JCConference.StopDoodle ( )
inline

关闭涂鸦

◆ StopSubTitle()

bool JMSDK.JCConference.JCConference.StopSubTitle ( )
inline

关闭会议字幕

返回
true成功,false表示失败

◆ SubscribeUserAudio()

bool JMSDK.JCConference.JCConference.SubscribeUserAudio ( string  userId,
bool  subscribe 
)
inline

订阅/取消订阅某个成员的音频,取消订阅时不会播放该成员的声音。成员的对应状态 JCConferenceParticipant 对象的IsSubscribeAudio

参数
userId其他成员userId
subscribetrue订阅,false取消订阅
返回
返回 true 成功,false 失败

◆ TransferToAudioConf()

bool JMSDK.JCConference.JCConference.TransferToAudioConf ( )
inline

转语音会议

返回
true表示成功,false表示失败

◆ UpdateParticipantExpandInfo()

int JMSDK.JCConference.JCConference.UpdateParticipantExpandInfo ( string  expandInfo)
inline

更新成员(自己)扩展信息,会议中的成员会收到 onConferenceParticipantUpdate 回调

参数
expandInfo扩展信息
返回
返回操作Id,返回-1表示接口调用失败

类成员变量说明

◆ ValueInit

const int JMSDK.JCConference.JCConference.ValueInit = -1
static

初始值

属性说明

◆ ConferenceInfo

JCConferenceInfo JMSDK.JCConference.JCConference.ConferenceInfo
get

当前会议信息对象


该类的文档由以下文件生成:
  • C:/code/Windows/SDK/Windows/JMSDK/JMSDK/JCConference/JCConference.cs