NIM PC Cross Platform SDK
nim_signaling_helper.h
Go to the documentation of this file.
1
8#ifndef _NIM_SDK_CPP_SIGNALING_HELPER_H_
9#define _NIM_SDK_CPP_SIGNALING_HELPER_H_
10
11#include <functional>
12#include <list>
13#include <memory>
14#include <string>
17#include "nim_define_include.h"
18
23namespace nim {
27struct NIM_SDK_CPPWRAPPER_DLL_API SignalingChannelInfo {
31 std::string channel_name_;
33 std::string channel_id_;
35 std::string channel_ext_;
41 std::string creator_id_;
45 uint64_t nertc_token_ttl_{600};
47 std::string nertc_token_;
51 channel_type_ = kNIMSignalingTypeAudio;
52 create_timestamp_ = 0;
53 expire_timestamp_ = 0;
54 invalid_ = true;
55 }
57 if (info) {
58 channel_type_ = info->channel_type_;
59 channel_name_ = info->channel_name_;
60 channel_id_ = info->channel_id_;
61 channel_ext_ = info->channel_ext_;
62 create_timestamp_ = info->create_timestamp_;
63 expire_timestamp_ = info->expire_timestamp_;
64 creator_id_ = info->creator_id_;
65 invalid_ = info->invalid_;
66 nertc_token_ttl_ = info->nertc_token_ttl_;
67 nertc_token_ = info->nertc_token_;
68 nertc_join_room_resp_ = info->nertc_join_room_resp_;
69 }
70 }
71};
72
76struct NIM_SDK_CPPWRAPPER_DLL_API SignalingMemberInfo {
78 std::string account_id_;
80 int64_t uid_;
86 uid_ = 0;
87 create_timestamp_ = 0;
88 expire_timestamp_ = 0;
89 }
92 if (info) {
93 account_id_ = info->account_id_;
94 uid_ = info->uid_;
95 create_timestamp_ = info->create_timestamp_;
96 expire_timestamp_ = info->expire_timestamp_;
97 }
98 }
99};
100
104struct NIM_SDK_CPPWRAPPER_DLL_API SignalingChannelDetailedinfo {
108 std::list<SignalingMemberInfo> members_;
111 if (info) {
112 channel_info_ = SignalingChannelInfo(&info->channel_info_);
113 for (int32_t i = 0; i < info->member_size_; ++i) {
114 SignalingMemberInfo member(&info->members_[i]);
115 members_.push_back(member);
116 }
117 }
118 }
119};
120
124struct NIM_SDK_CPPWRAPPER_DLL_API SignalingPushInfo {
128 std::string push_title_;
130 std::string push_content_;
132 std::string push_payload_;
136 need_push_ = false;
137 need_badge_ = true;
138 }
141 if (info) {
142 need_push_ = info->need_push_;
143 if (need_push_) {
144 push_title_ = info->push_title_;
145 push_content_ = info->push_content_;
146 push_payload_ = info->push_payload_;
147 need_badge_ = info->need_badge_;
148 }
149 }
150 }
156 info.need_push_ = need_push_;
157 info.push_title_ = (char*)push_title_.c_str();
158 info.push_content_ = (char*)push_content_.c_str();
159 info.push_payload_ = (char*)push_payload_.c_str();
160 info.need_badge_ = need_badge_;
161 return info;
162 }
163};
164
177struct NIM_SDK_CPPWRAPPER_DLL_API SignalingNotifyInfo {
181 struct SignalingChannelInfo channel_info_;
183 std::string from_account_id_;
185 std::string custom_info_;
187 uint64_t timestamp_;
191 static std::shared_ptr<SignalingNotifyInfo> GetSharedPtr(const NIMSignalingNotifyInfo* c_info);
192};
193
197struct NIM_SDK_CPPWRAPPER_DLL_API SignalingNotifyInfoClose : SignalingNotifyInfo {};
198
202struct NIM_SDK_CPPWRAPPER_DLL_API SignalingNotifyInfoJoin : SignalingNotifyInfo {
205};
206
210struct NIM_SDK_CPPWRAPPER_DLL_API SignalingNotifyInfoInvite : SignalingNotifyInfo {
212 std::string to_account_id_;
214 std::string request_id_;
217};
218
222struct NIM_SDK_CPPWRAPPER_DLL_API SignalingNotifyInfoCancelInvite : SignalingNotifyInfo {
224 std::string to_account_id_;
226 std::string request_id_;
227};
231struct NIM_SDK_CPPWRAPPER_DLL_API SignalingNotifyInfoReject : SignalingNotifyInfo {
233 std::string to_account_id_;
235 std::string request_id_;
236};
240struct NIM_SDK_CPPWRAPPER_DLL_API SignalingNotifyInfoAccept : SignalingNotifyInfo {
242 std::string to_account_id_;
244 std::string request_id_;
245};
246
250struct NIM_SDK_CPPWRAPPER_DLL_API SignalingNotifyInfoLeave : SignalingNotifyInfo {};
251
255struct NIM_SDK_CPPWRAPPER_DLL_API SignalingNotifyInfoControl : SignalingNotifyInfo {};
256
260struct NIM_SDK_CPPWRAPPER_DLL_API SignalingResParam {
264 static std::shared_ptr<SignalingResParam> GetOptParam(void* opt_res_param) { return nullptr; }
265};
266
270struct NIM_SDK_CPPWRAPPER_DLL_API SignalingCreateParam {
274 std::string channel_name_;
276 std::string channel_ext_;
282 param.channel_type_ = channel_type_;
283 param.channel_name_ = (char*)channel_name_.c_str();
284 param.channel_ext_ = (char*)channel_ext_.c_str();
285 return param;
286 }
287};
288
292struct NIM_SDK_CPPWRAPPER_DLL_API SignalingCreateResParam : SignalingResParam {
298 static std::shared_ptr<SignalingResParam> GetOptParam(void* opt_res_param) {
299 if (opt_res_param == nullptr) {
300 return nullptr;
301 }
302 std::shared_ptr<SignalingCreateResParam> res_param(new SignalingCreateResParam);
303 res_param->channel_info_ = SignalingChannelInfo(&((NIMSignalingCreateResParam*)opt_res_param)->channel_info_);
304 return res_param;
305 }
306};
307
311struct NIM_SDK_CPPWRAPPER_DLL_API SignalingCloseParam {
313 std::string channel_id_;
315 std::string custom_info_;
323 param.channel_id_ = (char*)channel_id_.c_str();
324 param.custom_info_ = (char*)custom_info_.c_str();
325 param.offline_enabled_ = offline_enabled_;
326 return param;
327 }
328};
332struct NIM_SDK_CPPWRAPPER_DLL_API SignalingCloseResParam : SignalingResParam {};
333
337struct NIM_SDK_CPPWRAPPER_DLL_API SignalingJoinParam {
339 std::string channel_id_;
341 std::string custom_info_;
343 int64_t uid_;
349 uint64_t nertc_token_ttl_{600};
357 param.channel_id_ = (char*)channel_id_.c_str();
358 param.custom_info_ = (char*)custom_info_.c_str();
359 param.uid_ = uid_;
360 param.offline_enabled_ = offline_enabled_;
361 param.nertc_channel_name_ = (char*)nertc_channel_name_.c_str();
362 param.nertc_token_ttl_ = nertc_token_ttl_;
363 param.nertc_join_room_query_param_ = (char*)nertc_join_room_query_param_.c_str();
364 return param;
365 }
366};
370struct NIM_SDK_CPPWRAPPER_DLL_API SignalingJoinResParam : SignalingResParam {
376 static std::shared_ptr<SignalingResParam> GetOptParam(void* opt_res_param) {
377 if (opt_res_param == nullptr) {
378 return nullptr;
379 }
380 std::shared_ptr<SignalingJoinResParam> res_param(new SignalingJoinResParam);
381 res_param->info_ = SignalingChannelDetailedinfo(&((NIMSignalingJoinResParam*)opt_res_param)->info_);
382 return res_param;
383 }
384};
385
389struct NIM_SDK_CPPWRAPPER_DLL_API SignalingLeaveParam {
391 std::string channel_id_;
393 std::string custom_info_;
401 param.channel_id_ = (char*)channel_id_.c_str();
402 param.custom_info_ = (char*)custom_info_.c_str();
403 param.offline_enabled_ = offline_enabled_;
404 return param;
405 }
406};
407
411struct NIM_SDK_CPPWRAPPER_DLL_API SignalingLeaveResParam : SignalingResParam {};
412
416struct NIM_SDK_CPPWRAPPER_DLL_API SignalingQueryChannelInfoParam {
418 std::string channel_name_;
424 param.channel_name_ = (char*)channel_name_.c_str();
425 return param;
426 }
427};
431struct NIM_SDK_CPPWRAPPER_DLL_API SignalingQueryChannelInfoResParam : SignalingResParam {
437 static std::shared_ptr<SignalingResParam> GetOptParam(void* opt_res_param) {
438 if (opt_res_param == nullptr) {
439 return nullptr;
440 }
441 std::shared_ptr<SignalingQueryChannelInfoResParam> res_param(new SignalingQueryChannelInfoResParam);
442 res_param->info_ = SignalingChannelDetailedinfo(&((NIMSignalingQueryChannelInfoResParam*)opt_res_param)->info_);
443 return res_param;
444 }
445};
446
450struct NIM_SDK_CPPWRAPPER_DLL_API SignalingCallParam {
454 std::string channel_name_;
456 std::string channel_ext_;
458 int64_t uid_;
460 std::string account_id_;
462 std::string request_id_;
464 std::string custom_info_;
472 uint64_t nertc_token_ttl_{600};
480 param.channel_type_ = channel_type_;
481 param.channel_name_ = (char*)channel_name_.c_str();
482 param.channel_ext_ = (char*)channel_ext_.c_str();
483 param.uid_ = uid_;
484 param.account_id_ = (char*)account_id_.c_str();
485 param.request_id_ = (char*)request_id_.c_str();
486 param.custom_info_ = (char*)custom_info_.c_str();
487 param.offline_enabled_ = offline_enabled_;
488 param.push_info_ = push_info_.GetCParam();
489 param.nertc_channel_name_ = (char*)nertc_channel_name_.c_str();
490 param.nertc_token_ttl_ = nertc_token_ttl_;
491 param.nertc_join_room_query_param_ = (char*)nertc_join_room_query_param_.c_str();
492 return param;
493 }
494};
495
499struct NIM_SDK_CPPWRAPPER_DLL_API SignalingCallResParam : SignalingJoinResParam {};
500
501struct NIM_SDK_CPPWRAPPER_DLL_API SignalingCallExResParam : SignalingResParam {
504 uint32_t call_status_;
508 static std::shared_ptr<SignalingResParam> GetOptParam(void* opt_res_param) {
509 if (opt_res_param == nullptr) {
510 return nullptr;
511 }
512 std::shared_ptr<SignalingCallExResParam> res_param(new SignalingCallExResParam);
513 res_param->info_ = SignalingChannelDetailedinfo(&((NIMSignalingCallResParam*)opt_res_param)->info_);
514 res_param->call_status_ = ((NIMSignalingCallResParam*)opt_res_param)->call_status_;
515 return res_param;
516 }
517};
518
519struct NIM_SDK_CPPWRAPPER_DLL_API SignalingJoinAndAcceptParam {
521 std::string channel_id_;
523 std::string custom_info_;
525 int64_t uid_;
529 std::string account_id_;
531 std::string request_id_;
535 uint64_t nertc_token_ttl_{600};
540 param.channel_id_ = (char*)channel_id_.c_str();
541 param.custom_info_ = (char*)custom_info_.c_str();
542 param.uid_ = uid_;
543 param.offline_enabled_ = offline_enabled_;
544 param.account_id_ = (char*)account_id_.c_str();
545 param.request_id_ = (char*)request_id_.c_str();
546 param.nertc_channel_name_ = (char*)nertc_channel_name_.c_str();
547 param.nertc_token_ttl_ = nertc_token_ttl_;
548 param.nertc_join_room_query_param_ = (char*)nertc_join_room_query_param_.c_str();
549 return param;
550 }
551};
552
553struct NIM_SDK_CPPWRAPPER_DLL_API SignalingJoinAndAcceptResParam : SignalingResParam {
556 uint32_t call_status_{0};
560 static std::shared_ptr<SignalingResParam> GetOptParam(void* opt_res_param) {
561 if (opt_res_param == nullptr) {
562 return nullptr;
563 }
564 std::shared_ptr<SignalingJoinAndAcceptResParam> res_param(new SignalingJoinAndAcceptResParam);
565 res_param->info_ = SignalingChannelDetailedinfo(&((NIMSignalingJoinAndAcceptResParam*)opt_res_param)->info_);
566 res_param->call_status_ = ((NIMSignalingJoinAndAcceptResParam*)opt_res_param)->call_status_;
567 return res_param;
568 }
569};
570
574struct NIM_SDK_CPPWRAPPER_DLL_API SignalingInviteParam {
576 std::string channel_id_;
578 std::string account_id_;
580 std::string request_id_;
582 std::string custom_info_;
586 struct SignalingPushInfo push_info_;
592 param.channel_id_ = (char*)channel_id_.c_str();
593 param.account_id_ = (char*)account_id_.c_str();
594 param.request_id_ = (char*)request_id_.c_str();
595 param.custom_info_ = (char*)custom_info_.c_str();
596 param.offline_enabled_ = offline_enabled_;
597 param.push_info_ = push_info_.GetCParam();
598 return param;
599 }
600};
604struct NIM_SDK_CPPWRAPPER_DLL_API SignalingInviteResParam : SignalingResParam {};
605
609struct NIM_SDK_CPPWRAPPER_DLL_API SignalingCancelInviteParam {
611 std::string channel_id_;
613 std::string account_id_;
615 std::string request_id_;
617 std::string custom_info_;
625 param.channel_id_ = (char*)channel_id_.c_str();
626 param.account_id_ = (char*)account_id_.c_str();
627 param.request_id_ = (char*)request_id_.c_str();
628 param.custom_info_ = (char*)custom_info_.c_str();
629 param.offline_enabled_ = offline_enabled_;
630 return param;
631 }
632};
633
637struct NIM_SDK_CPPWRAPPER_DLL_API SignalingCancelInviteResParam : SignalingResParam {};
638
642struct NIM_SDK_CPPWRAPPER_DLL_API SignalingRejectParam {
644 std::string channel_id_;
646 std::string account_id_;
648 std::string request_id_;
650 std::string custom_info_;
658 param.channel_id_ = (char*)channel_id_.c_str();
659 param.account_id_ = (char*)account_id_.c_str();
660 param.request_id_ = (char*)request_id_.c_str();
661 param.custom_info_ = (char*)custom_info_.c_str();
662 param.offline_enabled_ = offline_enabled_;
663 return param;
664 }
665};
669struct NIM_SDK_CPPWRAPPER_DLL_API SignalingRejectResParam : SignalingResParam {};
675 std::string channel_id_;
677 std::string account_id_;
679 std::string request_id_;
687 int64_t uid_;
689 std::string join_custom_info_;
693 uint64_t nertc_token_ttl_{600};
701 param.channel_id_ = (char*)channel_id_.c_str();
702 param.account_id_ = (char*)account_id_.c_str();
703 param.request_id_ = (char*)request_id_.c_str();
704 param.accept_custom_info_ = (char*)accept_custom_info_.c_str();
706 param.auto_join_ = auto_join_;
707 param.uid_ = uid_;
708 param.join_custom_info_ = (char*)join_custom_info_.c_str();
709 param.nertc_channel_name_ = (char*)nertc_channel_name_.c_str();
712 return param;
713 }
714};
715
719struct NIM_SDK_CPPWRAPPER_DLL_API SignalingAcceptResParam : SignalingJoinResParam {};
720
724struct NIM_SDK_CPPWRAPPER_DLL_API SignalingControlParam {
726 std::string channel_id_;
728 std::string account_id_;
730 std::string custom_info_;
736 param.channel_id_ = (char*)channel_id_.c_str();
737 param.account_id_ = (char*)account_id_.c_str();
738 param.custom_info_ = (char*)custom_info_.c_str();
739 return param;
740 }
741};
745struct NIM_SDK_CPPWRAPPER_DLL_API SignalingControlResParam : SignalingResParam {};
746
747} // namespace nim
748
749#endif //_NIM_SDK_CPP_SIGNALING_HELPER_H_
namespace nim
NIM 公共数据类型定义总的包含文件
定义导出宏
加载 NIM SDK 的帮助类头文件
NIMSignalingEventType
频道事件,包含在线,同步,离线等
Definition: nim_signaling_def.h:102
NIMSignalingType
频道类型
Definition: nim_signaling_def.h:20
@ kNIMSignalingTypeAudio
音频类型
Definition: nim_signaling_def.h:22
接受邀请接口nim_signaling_accept的传入参数
Definition: nim_signaling_def.h:472
int64_t uid_
自己在频道中对应的uid,大于零有效,无效时服务器会分配随机唯一的uid,可缺省填0
Definition: nim_signaling_def.h:486
uint64_t nertc_token_ttl_
云信G2-RTC的token有效期, 单位秒
Definition: nim_signaling_def.h:492
char * channel_id_
服务器生成的频道ID
Definition: nim_signaling_def.h:474
char * request_id_
邀请者邀请的请求id
Definition: nim_signaling_def.h:478
char * accept_custom_info_
操作的扩展字段
Definition: nim_signaling_def.h:480
bool offline_enabled_
是否存离线
Definition: nim_signaling_def.h:482
char * join_custom_info_
加入频道的自定义扩展信息,将在加入频道通知中带给其他频道成员,可缺省
Definition: nim_signaling_def.h:488
char * account_id_
邀请者的账号
Definition: nim_signaling_def.h:476
bool auto_join_
是否加入,默认不打开,打开后后续参数uid_、join_custom_info_有效
Definition: nim_signaling_def.h:484
char * nertc_channel_name_
云信G2-RTC的房间名,不为空则返回对应token
Definition: nim_signaling_def.h:490
char * nertc_join_room_query_param_
云信G2-RTC加入房间的请求参数
Definition: nim_signaling_def.h:494
呼叫接口nim_signaling_call的传入参数
Definition: nim_signaling_def.h:357
bool offline_enabled_
是否存离线
Definition: nim_signaling_def.h:373
char * nertc_channel_name_
云信G2-RTC的房间名,不为空则返回对应token
Definition: nim_signaling_def.h:377
struct NIMSignalingPushInfo push_info_
推送属性
Definition: nim_signaling_def.h:375
char * request_id_
邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该request_id_
Definition: nim_signaling_def.h:369
char * channel_ext_
创建时传入的扩展字段,可缺省
Definition: nim_signaling_def.h:363
char * custom_info_
操作的扩展字段,透传给被邀请者,可缺省
Definition: nim_signaling_def.h:371
enum NIMSignalingType channel_type_
通话类型,1:音频;2:视频;3:其他
Definition: nim_signaling_def.h:359
char * channel_name_
创建时传入的频道名,可缺省
Definition: nim_signaling_def.h:361
int64_t uid_
自己在频道中对应的uid,大于零有效,无效时服务器会分配随机唯一的uid
Definition: nim_signaling_def.h:365
char * account_id_
被邀请者的账号
Definition: nim_signaling_def.h:367
uint64_t nertc_token_ttl_
云信G2-RTC的token有效期, 单位秒
Definition: nim_signaling_def.h:379
char * nertc_join_room_query_param_
云信G2-RTC加入房间的请求参数
Definition: nim_signaling_def.h:381
Definition: nim_signaling_def.h:387
取消邀请接口nim_signaling_cancel_invite的传入参数
Definition: nim_signaling_def.h:441
char * custom_info_
操作的扩展字段,可缺省
Definition: nim_signaling_def.h:449
bool offline_enabled_
是否存离线
Definition: nim_signaling_def.h:451
char * channel_id_
服务器生成的频道ID
Definition: nim_signaling_def.h:443
char * request_id_
邀请者邀请的请求id
Definition: nim_signaling_def.h:447
char * account_id_
被邀请者的账号
Definition: nim_signaling_def.h:445
频道的详细信息,包含频道信息及成员列表
Definition: nim_signaling_def.h:74
struct NIMSignalingChannelInfo channel_info_
频道信息
Definition: nim_signaling_def.h:76
int32_t member_size_
频道内成员个数
Definition: nim_signaling_def.h:80
struct NIMSignalingMemberInfo * members_
频道内成员信息数组
Definition: nim_signaling_def.h:78
频道属性
Definition: nim_signaling_def.h:32
uint64_t nertc_token_ttl_
云信G2-RTC的token的有效期
Definition: nim_signaling_def.h:50
char * channel_name_
创建时传入的频道名
Definition: nim_signaling_def.h:36
char * creator_id_
创建者的accid
Definition: nim_signaling_def.h:46
char * nertc_join_room_resp_
云信G2-RTC加入房间的响应,可以转成json
Definition: nim_signaling_def.h:54
uint64_t expire_timestamp_
失效时间点
Definition: nim_signaling_def.h:44
bool invalid_
频道是否有效
Definition: nim_signaling_def.h:48
char * channel_ext_
创建时传入的扩展字段
Definition: nim_signaling_def.h:40
uint64_t create_timestamp_
创建时间点
Definition: nim_signaling_def.h:42
char * channel_id_
服务器生成的频道ID
Definition: nim_signaling_def.h:38
enum NIMSignalingType channel_type_
通话类型,1:音频;2:视频;3:其他
Definition: nim_signaling_def.h:34
char * nertc_token_
云信G2-RTC的token
Definition: nim_signaling_def.h:52
关闭频道接口nim_signaling_close的传入参数
Definition: nim_signaling_def.h:291
bool offline_enabled_
是否存离线
Definition: nim_signaling_def.h:297
char * custom_info_
操作的扩展字段
Definition: nim_signaling_def.h:295
char * channel_id_
服务器生成的频道ID
Definition: nim_signaling_def.h:293
控制通知接口nim_signaling_control的传入参数
Definition: nim_signaling_def.h:505
char * channel_id_
服务器生成的频道ID
Definition: nim_signaling_def.h:507
char * custom_info_
操作的扩展字段
Definition: nim_signaling_def.h:511
char * account_id_
对方accid,如果为空,则通知所有人
Definition: nim_signaling_def.h:509
创建频道接口nim_signaling_create的传入参数
Definition: nim_signaling_def.h:271
enum NIMSignalingType channel_type_
通话类型,1:音频;2:视频;3:其他
Definition: nim_signaling_def.h:273
char * channel_name_
创建时传入的频道名,可缺省
Definition: nim_signaling_def.h:275
char * channel_ext_
创建时传入的扩展字段,可缺省
Definition: nim_signaling_def.h:277
创建频道结果回调信息
Definition: nim_signaling_def.h:283
邀请接口nim_signaling_invite的传入参数
Definition: nim_signaling_def.h:423
char * custom_info_
操作的扩展字段,透传给被邀请者,可缺省
Definition: nim_signaling_def.h:431
char * account_id_
被邀请者的账号
Definition: nim_signaling_def.h:427
char * request_id_
邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该request_id_
Definition: nim_signaling_def.h:429
char * channel_id_
服务器生成的频道ID
Definition: nim_signaling_def.h:425
bool offline_enabled_
是否存离线
Definition: nim_signaling_def.h:433
struct NIMSignalingPushInfo push_info_
推送属性
Definition: nim_signaling_def.h:435
Definition: nim_signaling_def.h:393
char * nertc_channel_name_
云信G2-RTC的房间名,不为空则返回对应token
Definition: nim_signaling_def.h:407
char * custom_info_
操作者附加的自定义信息,透传给其他人,可缺省
Definition: nim_signaling_def.h:397
char * channel_id_
服务器生成的频道ID
Definition: nim_signaling_def.h:395
char * request_id_
邀请者邀请的请求id
Definition: nim_signaling_def.h:403
bool offline_enabled_
是否存离线
Definition: nim_signaling_def.h:405
int64_t uid_
自己在频道中对应的uid,大于零有效,无效时服务器会分配随机唯一的uid
Definition: nim_signaling_def.h:399
char * account_id_
邀请者的账号
Definition: nim_signaling_def.h:401
char * nertc_join_room_query_param_
云信G2-RTC加入房间的请求参数
Definition: nim_signaling_def.h:411
uint64_t nertc_token_ttl_
云信G2-RTC的token有效期, 单位秒
Definition: nim_signaling_def.h:409
Definition: nim_signaling_def.h:414
加入频道接口nim_signaling_join的传入参数
Definition: nim_signaling_def.h:303
char * nertc_join_room_query_param_
云信G2-RTC加入房间的请求参数
Definition: nim_signaling_def.h:317
char * channel_id_
服务器生成的频道ID
Definition: nim_signaling_def.h:305
char * nertc_channel_name_
云信G2-RTC的房间名,不为空则返回对应token
Definition: nim_signaling_def.h:313
char * custom_info_
操作者附加的自定义信息,透传给其他人,可缺省
Definition: nim_signaling_def.h:307
uint64_t nertc_token_ttl_
云信G2-RTC的token有效期, 单位秒
Definition: nim_signaling_def.h:315
int64_t uid_
自己在频道中对应的uid,大于零有效,无效时服务器会分配随机唯一的uid
Definition: nim_signaling_def.h:309
bool offline_enabled_
是否存离线
Definition: nim_signaling_def.h:311
加入频道结果回调信息
Definition: nim_signaling_def.h:322
离开频道接口nim_signaling_leave的传入参数
Definition: nim_signaling_def.h:330
char * custom_info_
操作的扩展字段
Definition: nim_signaling_def.h:334
char * channel_id_
服务器生成的频道ID
Definition: nim_signaling_def.h:332
bool offline_enabled_
是否存离线
Definition: nim_signaling_def.h:336
成员属性
Definition: nim_signaling_def.h:60
uint64_t expire_timestamp_
失效时间点,失效后认为离开频道
Definition: nim_signaling_def.h:68
int64_t uid_
成员的 uid,大于零有效,无效时服务器会分配随机频道内唯一的uid
Definition: nim_signaling_def.h:64
char * account_id_
成员的 accid
Definition: nim_signaling_def.h:62
uint64_t create_timestamp_
加入时间点
Definition: nim_signaling_def.h:66
事件通知信息基类
Definition: nim_signaling_def.h:124
推送属性
Definition: nim_signaling_def.h:86
bool need_push_
是否需要推送,默认false,
Definition: nim_signaling_def.h:88
char * push_title_
推送标题
Definition: nim_signaling_def.h:90
char * push_content_
推送内容
Definition: nim_signaling_def.h:92
bool need_badge_
是否计入未读计数,默认true
Definition: nim_signaling_def.h:96
char * push_payload_
推送自定义字段
Definition: nim_signaling_def.h:94
查询频道接口nim_signaling_query_channel_info的传入参数
Definition: nim_signaling_def.h:342
char * channel_name_
创建时传入的频道名
Definition: nim_signaling_def.h:344
查询频道结果回调信息
Definition: nim_signaling_def.h:349
拒绝接口nim_signaling_reject的传入参数
Definition: nim_signaling_def.h:457
char * custom_info_
操作的扩展字段
Definition: nim_signaling_def.h:465
char * account_id_
邀请者的账号
Definition: nim_signaling_def.h:461
char * channel_id_
服务器生成的频道ID
Definition: nim_signaling_def.h:459
char * request_id_
邀请者邀请的请求id
Definition: nim_signaling_def.h:463
bool offline_enabled_
是否存离线
Definition: nim_signaling_def.h:467
接受邀请接口nim_signaling_accept的传入参数
Definition: nim_signaling_helper.h:673
std::string accept_custom_info_
操作的扩展字段
Definition: nim_signaling_helper.h:681
int64_t uid_
自己在频道中对应的uid,大于零有效,无效时服务器会分配随机唯一的uid,可缺省填0
Definition: nim_signaling_helper.h:687
std::string join_custom_info_
加入频道的自定义扩展信息,将在加入频道通知中带给其他频道成员,可缺省
Definition: nim_signaling_helper.h:689
std::string nertc_join_room_query_param_
云信G2-RTC加入房间的请求参数
Definition: nim_signaling_helper.h:695
std::string nertc_channel_name_
云信G2-RTC的房间名,不为空则返回对应token
Definition: nim_signaling_helper.h:691
std::string account_id_
邀请者的账号
Definition: nim_signaling_helper.h:677
std::string request_id_
邀请者邀请的请求id
Definition: nim_signaling_helper.h:679
bool offline_enabled_
是否存离线
Definition: nim_signaling_helper.h:683
NIMSignalingAcceptParam GetCParam()
将C++的传入参数转成C的结构体
Definition: nim_signaling_helper.h:699
std::string channel_id_
服务器生成的频道ID
Definition: nim_signaling_helper.h:675
bool auto_join_
是否加入,打开后后续参数uid_、join_custom_info_有效
Definition: nim_signaling_helper.h:685
uint64_t nertc_token_ttl_
云信G2-RTC的token有效期, 单位秒
Definition: nim_signaling_helper.h:693
接受邀请结果回调信息,在自动加入成功后返回有效
Definition: nim_signaling_helper.h:719
Definition: nim_signaling_helper.h:501
SignalingChannelDetailedinfo info_
频道详细信息
Definition: nim_signaling_helper.h:503
static std::shared_ptr< SignalingResParam > GetOptParam(void *opt_res_param)
将C的返回结构体转换成C++
Definition: nim_signaling_helper.h:508
呼叫接口nim_signaling_call的传入参数
Definition: nim_signaling_helper.h:450
std::string account_id_
被邀请者的账号
Definition: nim_signaling_helper.h:460
std::string nertc_join_room_query_param_
云信G2-RTC加入房间的请求参数
Definition: nim_signaling_helper.h:474
SignalingPushInfo push_info_
推送属性
Definition: nim_signaling_helper.h:468
std::string custom_info_
操作的扩展字段,透传给被邀请者,可缺省
Definition: nim_signaling_helper.h:464
std::string channel_name_
创建时传入的频道名,可缺省
Definition: nim_signaling_helper.h:454
std::string channel_ext_
创建时传入的扩展字段,可缺省
Definition: nim_signaling_helper.h:456
NIMSignalingType channel_type_
通话类型,1:音频;2:视频;3:其他
Definition: nim_signaling_helper.h:452
std::string nertc_channel_name_
云信G2-RTC的房间名,不为空则返回对应token
Definition: nim_signaling_helper.h:470
NIMSignalingCallParam GetCParam()
将C++的传入参数转成C的结构体
Definition: nim_signaling_helper.h:478
int64_t uid_
自己在频道中对应的uid,大于零有效,无效时服务器会分配随机唯一的uid
Definition: nim_signaling_helper.h:458
std::string request_id_
邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该request_id_
Definition: nim_signaling_helper.h:462
bool offline_enabled_
是否存离线
Definition: nim_signaling_helper.h:466
呼叫结果回调信息
Definition: nim_signaling_helper.h:499
取消邀请接口nim_signaling_cancel_invite的传入参数
Definition: nim_signaling_helper.h:609
std::string channel_id_
服务器生成的频道ID
Definition: nim_signaling_helper.h:611
std::string request_id_
邀请者邀请的请求id
Definition: nim_signaling_helper.h:615
NIMSignalingCancelInviteParam GetCParam()
将C++的传入参数转成C的结构体
Definition: nim_signaling_helper.h:623
bool offline_enabled_
是否存离线
Definition: nim_signaling_helper.h:619
std::string account_id_
被邀请者的账号
Definition: nim_signaling_helper.h:613
std::string custom_info_
操作的扩展字段,可缺省
Definition: nim_signaling_helper.h:617
取消邀请结果回调信息,暂时为空
Definition: nim_signaling_helper.h:637
频道的详细信息,包含频道信息及成员列表
Definition: nim_signaling_helper.h:104
std::list< SignalingMemberInfo > members_
频道内成员信息数组
Definition: nim_signaling_helper.h:108
SignalingChannelInfo channel_info_
频道信息
Definition: nim_signaling_helper.h:106
频道属性
Definition: nim_signaling_helper.h:27
std::string nertc_token_
云信G2-RTC的token
Definition: nim_signaling_helper.h:47
NIMSignalingType channel_type_
通话类型,1:音频;2:视频;3:其他
Definition: nim_signaling_helper.h:29
std::string channel_name_
创建时传入的频道名
Definition: nim_signaling_helper.h:31
std::string creator_id_
创建者的accid
Definition: nim_signaling_helper.h:41
uint64_t expire_timestamp_
失效时间点
Definition: nim_signaling_helper.h:39
std::string channel_ext_
创建时传入的扩展字段
Definition: nim_signaling_helper.h:35
uint64_t create_timestamp_
创建时间点
Definition: nim_signaling_helper.h:37
bool invalid_
频道是否有效
Definition: nim_signaling_helper.h:43
std::string channel_id_
服务器生成的频道ID
Definition: nim_signaling_helper.h:33
std::string nertc_join_room_resp_
云信G2-RTC加入房间的响应,可以转成json
Definition: nim_signaling_helper.h:49
关闭频道接口nim_signaling_close的传入参数
Definition: nim_signaling_helper.h:311
std::string channel_id_
服务器生成的频道ID
Definition: nim_signaling_helper.h:313
NIMSignalingCloseParam GetCParam()
将C++的传入参数转成C的结构体
Definition: nim_signaling_helper.h:321
std::string custom_info_
操作的扩展字段
Definition: nim_signaling_helper.h:315
bool offline_enabled_
是否存离线
Definition: nim_signaling_helper.h:317
关闭频道结果回调信息
Definition: nim_signaling_helper.h:332
控制通知接口nim_signaling_control的传入参数
Definition: nim_signaling_helper.h:724
NIMSignalingControlParam GetCParam()
将C++的传入参数转成C的结构体
Definition: nim_signaling_helper.h:734
std::string channel_id_
服务器生成的频道ID
Definition: nim_signaling_helper.h:726
std::string account_id_
对方accid,如果为空,则通知所有人
Definition: nim_signaling_helper.h:728
std::string custom_info_
操作的扩展字段
Definition: nim_signaling_helper.h:730
控制通知结果回调信息,暂时为空
Definition: nim_signaling_helper.h:745
创建频道接口nim_signaling_create的传入参数
Definition: nim_signaling_helper.h:270
NIMSignalingType channel_type_
通话类型,1:音频;2:视频;3:其他
Definition: nim_signaling_helper.h:272
std::string channel_name_
创建时传入的频道名,可缺省
Definition: nim_signaling_helper.h:274
NIMSignalingCreateParam GetCParam()
将C++的传入参数转成C的结构体
Definition: nim_signaling_helper.h:280
std::string channel_ext_
创建时传入的扩展字段,可缺省
Definition: nim_signaling_helper.h:276
创建频道结果回调信息
Definition: nim_signaling_helper.h:292
static std::shared_ptr< SignalingResParam > GetOptParam(void *opt_res_param)
将C的返回结构体转换成C++
Definition: nim_signaling_helper.h:298
SignalingChannelInfo channel_info_
频道信息
Definition: nim_signaling_helper.h:294
邀请接口nim_signaling_invite的传入参数
Definition: nim_signaling_helper.h:574
bool offline_enabled_
是否存离线
Definition: nim_signaling_helper.h:584
std::string custom_info_
操作的扩展字段,透传给被邀请者,可缺省
Definition: nim_signaling_helper.h:582
std::string channel_id_
服务器生成的频道ID
Definition: nim_signaling_helper.h:576
NIMSignalingInviteParam GetCParam()
将C++的传入参数转成C的结构体
Definition: nim_signaling_helper.h:590
std::string account_id_
被邀请者的账号
Definition: nim_signaling_helper.h:578
std::string request_id_
邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该request_id_
Definition: nim_signaling_helper.h:580
邀请结果回调信息,暂时为空
Definition: nim_signaling_helper.h:604
Definition: nim_signaling_helper.h:519
int64_t uid_
自己在频道中对应的uid,大于零有效,无效时服务器会分配随机唯一的uid
Definition: nim_signaling_helper.h:525
bool offline_enabled_
是否存离线
Definition: nim_signaling_helper.h:527
std::string custom_info_
操作者附加的自定义信息,透传给其他人,可缺省
Definition: nim_signaling_helper.h:523
std::string account_id_
邀请者的账号
Definition: nim_signaling_helper.h:529
std::string nertc_channel_name_
云信G2-RTC的房间名,不为空则返回对应token
Definition: nim_signaling_helper.h:533
std::string nertc_join_room_query_param_
云信G2-RTC的query请求
Definition: nim_signaling_helper.h:537
std::string request_id_
邀请者邀请的请求id
Definition: nim_signaling_helper.h:531
std::string channel_id_
服务器生成的频道ID
Definition: nim_signaling_helper.h:521
Definition: nim_signaling_helper.h:553
SignalingChannelDetailedinfo info_
频道详细信息
Definition: nim_signaling_helper.h:555
static std::shared_ptr< SignalingResParam > GetOptParam(void *opt_res_param)
将C的返回结构体转换成C++
Definition: nim_signaling_helper.h:560
加入频道接口nim_signaling_query_channel_info的传入参数
Definition: nim_signaling_helper.h:337
std::string nertc_channel_name_
云信G2-RTC的房间名,不为空则返回对应token
Definition: nim_signaling_helper.h:347
NIMSignalingJoinParam GetCParam()
将C++的传入参数转成C的结构体
Definition: nim_signaling_helper.h:355
std::string custom_info_
操作者附加的自定义信息,透传给其他人,可缺省
Definition: nim_signaling_helper.h:341
int64_t uid_
自己在频道中对应的uid,大于零有效,无效时服务器会分配随机唯一的uid
Definition: nim_signaling_helper.h:343
bool offline_enabled_
是否存离线
Definition: nim_signaling_helper.h:345
std::string nertc_join_room_query_param_
云信G2-RTC的query请求
Definition: nim_signaling_helper.h:351
std::string channel_id_
服务器生成的频道ID
Definition: nim_signaling_helper.h:339
加入频道结果回调信息
Definition: nim_signaling_helper.h:370
SignalingChannelDetailedinfo info_
频道详细信息
Definition: nim_signaling_helper.h:372
static std::shared_ptr< SignalingResParam > GetOptParam(void *opt_res_param)
将C的返回结构体转换成C++
Definition: nim_signaling_helper.h:376
离开频道接口nim_signaling_leave的传入参数
Definition: nim_signaling_helper.h:389
bool offline_enabled_
是否存离线
Definition: nim_signaling_helper.h:395
std::string custom_info_
操作的扩展字段
Definition: nim_signaling_helper.h:393
NIMSignalingLeaveParam GetCParam()
将C++的传入参数转成C的结构体
Definition: nim_signaling_helper.h:399
std::string channel_id_
服务器生成的频道ID
Definition: nim_signaling_helper.h:391
离开频道结果回调信息,暂时为空
Definition: nim_signaling_helper.h:411
成员属性
Definition: nim_signaling_helper.h:76
uint64_t create_timestamp_
加入时间点
Definition: nim_signaling_helper.h:82
int64_t uid_
成员的 uid,大于零有效,无效时服务器会分配随机频道内唯一的uid
Definition: nim_signaling_helper.h:80
uint64_t expire_timestamp_
失效时间点,失效后认为离开频道
Definition: nim_signaling_helper.h:84
std::string account_id_
成员的 accid
Definition: nim_signaling_helper.h:78
接收邀请事件通知信息,event_type_=kNIMSignalingEventTypeAccept
Definition: nim_signaling_helper.h:240
std::string to_account_id_
邀请者的账号
Definition: nim_signaling_helper.h:242
std::string request_id_
邀请者邀请的请求id
Definition: nim_signaling_helper.h:244
取消邀请事件通知信息,event_type_=kNIMSignalingEventTypeCancelInvite
Definition: nim_signaling_helper.h:222
std::string request_id_
邀请者邀请的请求id
Definition: nim_signaling_helper.h:226
std::string to_account_id_
被邀请者的账号
Definition: nim_signaling_helper.h:224
频道关闭事件通知信息,event_type_=kNIMSignalingEventTypeClose
Definition: nim_signaling_helper.h:197
控制事件通知信息,event_type_=kNIMSignalingEventTypeCtrl
Definition: nim_signaling_helper.h:255
事件通知信息基类
Definition: nim_signaling_helper.h:177
uint64_t timestamp_
操作的时间戳
Definition: nim_signaling_helper.h:187
std::string from_account_id_
操作者
Definition: nim_signaling_helper.h:183
std::string custom_info_
操作的扩展字段
Definition: nim_signaling_helper.h:185
enum NIMSignalingEventType event_type_
通知类型
Definition: nim_signaling_helper.h:179
邀请事件通知信息,event_type_=kNIMSignalingEventTypeInvite
Definition: nim_signaling_helper.h:210
SignalingPushInfo push_info_
推送信息
Definition: nim_signaling_helper.h:216
std::string request_id_
邀请者邀请的请求id,用于被邀请者回传request_id_作对应的回应操作
Definition: nim_signaling_helper.h:214
std::string to_account_id_
被邀请者的账号
Definition: nim_signaling_helper.h:212
加入频道事件通知信息,event_type_=kNIMSignalingEventTypeJoin
Definition: nim_signaling_helper.h:202
SignalingMemberInfo member_
加入成员的信息,用于获得uid
Definition: nim_signaling_helper.h:204
退出频道事件通知信息,event_type_=kNIMSignalingEventTypeLeave
Definition: nim_signaling_helper.h:250
拒绝邀请事件通知信息,event_type_=kNIMSignalingEventTypeReject
Definition: nim_signaling_helper.h:231
std::string to_account_id_
邀请者的账号
Definition: nim_signaling_helper.h:233
std::string request_id_
邀请者邀请的请求id
Definition: nim_signaling_helper.h:235
推送属性
Definition: nim_signaling_helper.h:124
std::string push_content_
推送内容
Definition: nim_signaling_helper.h:130
NIMSignalingPushInfo GetCParam()
将C++的结构体转成C的结构体
Definition: nim_signaling_helper.h:154
bool need_push_
是否需要推送,默认false,
Definition: nim_signaling_helper.h:126
std::string push_title_
推送标题
Definition: nim_signaling_helper.h:128
std::string push_payload_
推送自定义字段
Definition: nim_signaling_helper.h:132
bool need_badge_
是否计入未读计数,默认true
Definition: nim_signaling_helper.h:134
查询频道接口nim_signaling_join的传入参数
Definition: nim_signaling_helper.h:416
NIMSignalingQueryChannelInfoParam GetCParam()
将C++的传入参数转成C的结构体
Definition: nim_signaling_helper.h:422
std::string channel_name_
创建时传入的频道名
Definition: nim_signaling_helper.h:418
查询频道结果回调信息
Definition: nim_signaling_helper.h:431
SignalingChannelDetailedinfo info_
频道详细信息
Definition: nim_signaling_helper.h:433
static std::shared_ptr< SignalingResParam > GetOptParam(void *opt_res_param)
将C的返回结构体转换成C++
Definition: nim_signaling_helper.h:437
拒绝接口nim_signaling_reject的传入参数
Definition: nim_signaling_helper.h:642
NIMSignalingRejectParam GetCParam()
将C++的传入参数转成C的结构体
Definition: nim_signaling_helper.h:656
std::string account_id_
邀请者的账号
Definition: nim_signaling_helper.h:646
std::string request_id_
邀请者邀请的请求id
Definition: nim_signaling_helper.h:648
bool offline_enabled_
是否存离线
Definition: nim_signaling_helper.h:652
std::string custom_info_
操作的扩展字段
Definition: nim_signaling_helper.h:650
std::string channel_id_
服务器生成的频道ID
Definition: nim_signaling_helper.h:644
拒绝邀请结果回调信息,暂时为空
Definition: nim_signaling_helper.h:669
独立信令操作回调参数基类
Definition: nim_signaling_helper.h:260
static std::shared_ptr< SignalingResParam > GetOptParam(void *opt_res_param)
将C的返回结构体转换成C++
Definition: nim_signaling_helper.h:264