YYClientSDK  beta 1.15
 全部  函数 枚举 枚举值
yy-api-client.h
1 
2 
18 #ifndef _DW_OPENPLATFORM_CLIENT_API_H_
19 #define _DW_OPENPLATFORM_CLIENT_API_H_
20 
21 #include "yy-api-types.h"
22 #include "yy-api-events.h"
23 
24 namespace yy
25 {
26  extern "C"
27  {
28  struct IYY;
29 
30  struct IIM;
31  struct IUser;
32  struct IAudio;
33 
34  struct IChannel;
35  struct IChannelAppMsg;
36  struct IChannelTabPage;
37  struct IChannelUserController;
38 
39  // 公开IChannelUserList
40  struct IChannelUserList;
41  typedef IMicListItem IUserItem;
42 
43  // 以下网络相关
44  struct INet;
45  struct ICloud;
46  struct ISecurity;
47 
48  struct IInteraction;
49  struct ITempAudioSession;
50 
51  struct IChannelTemplate;
52 
53  //财务接口
54  struct IFinance;
55 
58  struct IYY : public IYYUnk
59  {
61 
64  virtual IUser * GetUser() = 0;
65 
67 
70  virtual IChannel * GetChannel() = 0;
71 
73 
76  virtual IIM * GetIM() = 0;
77 
79 
82  virtual IAudio * GetAudio() = 0;
83 
85 
88  virtual INet * GetNet() = 0;
89 
91 
94  virtual ICloud * GetCloud() = 0;
95 
97 
100  virtual int GetVersion() = 0;
101 
103 
106  virtual int Initialize() = 0;
107 
109 
112  virtual int RegisterYYEvent(IYYEvent * event) = 0;
113 
115 
118  virtual int UnRegisterYYEvent(IYYEvent * event) = 0;
119 
121 
124  virtual ISecurity * GetSecurity() = 0;
125 
127 
130  virtual ITempAudioSession * GetTempAudioSession() = 0;
131 
133 
136  virtual IInteraction * GetInteraction() = 0;
137  };
138 
141  struct ISecurity
142  {
144  /*
145  * \param char* strToken [in][out] 令牌字符地址
146  * \param unsigned int &size [in][out] 用户id 字符串大小为 (0, 128]
147  * \return int, 0 success, 其他值错误,请查看错误代码表
148  */
149  virtual int GetToken(char* strToken, unsigned int &size) = 0;
150 
152  /*
153  * \return int, 0 success, 其他值错误,请查看错误代码表
154  */
155  virtual int ReportAbuse() = 0;
156 
158  /*
159  * \param boo &pass [in][out]
160  * \return int, 0 success, 其他值错误,请查看错误代码表
161  */
162  virtual int KeywordFilter( const char* words, bool& pass ) = 0;
163  };
164 
167  struct IUser
168  {
170 
173  virtual IUserInfo * GetCurrnetUserInfo() = 0;
174 
176 
180  virtual IUserInfo * GetUserInfo(unsigned int uid) = 0;
181 
183 
187  virtual int RegisterUserEvent(IUserEvent *e) = 0;
188 
190 
194  virtual int UnRegisterUserEvent(IUserEvent *e) = 0;
195  };
196 
200  {
202 
207  virtual int SetPopMenu(const char *str,
208  unsigned int size) = 0;
209 
211 
214  virtual int UnSetPopMemu() = 0;
215 
217 
221  virtual int RegisterPopMenuEvent(IChannelUserPopMenuEvent * e) = 0;
222 
224 
229  };
230 
234  {
236 
245  virtual int SendMsgToSubChannel(unsigned int sub_channel_id,
246  const char *view_str,
247  unsigned int link_begin_pos,
248  unsigned int link_end_pos,
249  unsigned int cookie) = 0;
250 
252 
262  virtual int SendMsgToUsers(const unsigned int *users,
263  unsigned int size,
264  const char *view_str,
265  unsigned int link_begin_pos,
266  unsigned int link_end_pos,
267  unsigned int cookie) = 0;
268 
270 
275 
277 
282 
284 
288  virtual IAppMsg * CreateAppMsg(unsigned int cookie) = 0;
289 
291 
296  virtual int SendMsgToSubChannelEx(unsigned int sub_channel_id, IAppMsg *msg) = 0;
297 
299 
305  virtual int SendMsgToUsersEx(const unsigned int *users, unsigned int size, IAppMsg *msg) = 0;
306  };
307 
311  {
313 
316  virtual const IMicListItem * GetMicList() = 0;
317 
319 
323  virtual int RegisterMicListEvent(IMicListEvent *e) = 0;
324 
326 
330  virtual int UnRegisterMicListEvent(IMicListEvent *e) = 0;
331 
333 
336  virtual int JoinMicList() = 0;
337 
339 
342  virtual int LeaveMicList() = 0;
343 
345 
349  virtual int MoveUserToTop(unsigned int uid) = 0;
350 
352 
356  virtual int PullUserToMicList(unsigned int uid) = 0;
357 
359 
363  virtual int KickMicListUser(unsigned int uid) = 0;
364 
366 
369  virtual int ClearMicList() = 0;
370 
372 
376  virtual int GetLinkedMicList( const IMicListItem** h) = 0;
377 
379 
383  virtual int LinkMicToTheQueueHead(unsigned int uid) = 0;
384 
386 
390  virtual int RemoveFromLinkedMicList(unsigned int uid) = 0;
391 
393 
397  virtual int GetMicListMode(YYEnums::EMicListMode &mode) = 0;
398 
400 
404  virtual int SetMicListMode(YYEnums::EMicListMode m) = 0;
405 
407 
411  virtual int RegisterMicListEvent2(IMicListEvent2 *e) = 0;
412 
414 
418  virtual int UnRegisterMicListEvent2(IMicListEvent2 *e) = 0;
419 
421 
425  virtual int MoveUpOnePosition(unsigned int uid) = 0;
426 
428 
432  virtual int MoveDownOnePosition(unsigned int uid) = 0;
433 
435 
439  virtual int GetFirstMicSeconds(unsigned int &seconds) = 0;
440 
442 
445  virtual int DoubleFirstMicSeconds() = 0;
446 
448 
451  virtual int EnableJoinMicList() = 0;
452 
454 
457  virtual int DisableJoinMicList() = 0;
458 
460 
463  virtual int IsJoinMicListEnabled( bool& enabled ) = 0;
464 
466 
469  virtual int ControlMic() = 0;
470 
472 
475  virtual int ReleaseMic() = 0;
476 
478 
481  virtual int IsMicListControlled( bool& controlled ) = 0;
482 
484 
487  virtual int SendMicListNotification() = 0;
488 
490 
493  virtual int RegisterMicListMgrEvent(IMicListMgrEvent *e) = 0;
494 
496 
499  virtual int UnRegisterMicListMgrEvent(IMicListMgrEvent *e) = 0;
500  };
501 
505  {
507 
516  virtual int CreateSubWindow(unsigned long &h,
517  unsigned int &x,
518  unsigned int &y,
519  unsigned int &width,
520  unsigned int &height,
521  bool &visible) = 0;
522 
524 
527  virtual int CloseSubWindow() = 0;
528 
530 
534  virtual int RegisterChannelSubWinEvent(ISubWindowEvent *e) = 0;
535 
537 
541  virtual int UnRegisterChannelSubWinEvent(ISubWindowEvent *e) = 0;
542  };
543 
547  {
549 
553  virtual int EnableMsg(unsigned int uid) = 0;
554 
556 
560  virtual int DisableMsg(unsigned int uid) = 0;
561 
563 
567  virtual int EnableSpeak(unsigned int uid) = 0;
568 
570 
574  virtual int DisableSpeak(unsigned int uid) = 0;
575 
577 
581  virtual int JumpToSubChannel(unsigned int cid) = 0;
582 
584 
589  virtual int PullToSubChannel(unsigned int uid, unsigned int cid) = 0;
590 
592 
596  virtual int GetUserSubChannelId(unsigned int uid, unsigned int &cid) = 0;
597 
599 
605  virtual int SetUserRole(unsigned int cid, unsigned int uid, IUserInfo::EUserRole role) = 0;
606 
608 
612  virtual int IsMsgEnabled( unsigned int uid, bool& enabled ) = 0;
613 
615 
619  virtual int IsSpeakEnabled( unsigned int uid, bool& enabled ) = 0;
620  };
621 
625  {
627 
631  virtual int GetReceptionChannel(unsigned int &cid) = 0;
632 
634 
638  virtual int SetReceptionChannel(unsigned int cid) = 0;
639 
641 
644  virtual int UnSetReceptionChannel() = 0;
645  };
646 
649  struct IChannel
650  {
652 
655  virtual IChannelInfo * GetCurrentSubChannelInfo() = 0;
656 
658 
661  virtual IChannelInfo * GetCurrentChannelInfo() = 0;
662 
664 
668  virtual IChannelInfo * GetChannelInfo(unsigned int cid) = 0;
669 
671 
674  virtual const IChannelNode * GetChannelTree() = 0;
675 
677 
680  virtual IChannelMicList * GetMicList() = 0;
681 
683 
687 
689 
692  virtual IChannelAppMsg * GetAppMsg() = 0;
693 
695 
698  virtual IChannelSubWindow * GetSubWin() = 0;
699 
701 
705  virtual int RegisterChannelEvent(IChannelEvent *e) = 0;
706 
708 
712  virtual int UnRegisterChannelEvent(IChannelEvent *e) = 0;
713 
715 
718  virtual IChannelTabPage *GetTabPage() = 0;
719 
721 
725 
727 
730  virtual IReceptionChannel *GetReceptionChannel() = 0;
731 
733 
736  virtual IChannelTemplate *GetTemplate() = 0;
737  };
738 
741  struct IIM
742  {
744 
750  virtual int ChatTo(unsigned int uid, const char *msg, unsigned int size) = 0;
751 
753 
757  virtual int IsFriend(unsigned int uid) = 0;
758 
760 
764  virtual int AddFriend(unsigned int uid) = 0;
765 
767 
771  virtual int OpenChannelGroup(unsigned int cid) = 0;
772  };
773 
776  struct IAudio
777  {
779 
783  virtual int StartRecord(const char *file_name) = 0;
784 
786 
789  virtual int StopRecord() = 0;
790 
792 
796  virtual int RegisterAudioEvent(IAudioEvent *e) = 0;
797 
799 
802  virtual int UnRegisterAudioEvent(IAudioEvent *e) = 0;
803 
805 
808  virtual int OpenKaraoke() = 0;
809 
811 
814  virtual int CloseKaraoke() = 0;
815 
817 
820  virtual int EnableAudioMixing() = 0;
821 
823 
826  virtual int DisableAudioMixing() = 0;
827 
829 
836  virtual int SetKaraokePlayerPath(const char *player_path,
837  char *origin_player_path, unsigned int &origin_player_path_size,
838  bool &origin_software_mix_enable) = 0;
839 
841  /*
842  * \param const char *player_path [in], 要恢复的播放器路径
843  * \param bool software_mix_enable [in], 是否开启混音
844  * \return int, 0 success, 其他值错误,请查看错误代码表
845  */
846  virtual int ResetKaraokePlayerPath(const char *player_path, bool software_mix_enable) = 0;
847  };
848 
852  struct INet
853  {
855 
858  virtual int Connect() = 0;
859 
861 
864  virtual int Close() = 0;
865 
867 
874  virtual int BroadcastToSubChannel(unsigned int sub_channel_id, const char *data, unsigned int size) = 0;
875 
877 
883  virtual int BroadcastToAllChannel(const char *data, unsigned int size) = 0;
884 
886 
894  virtual int BroadcastToUsers(const char *data, unsigned int size, unsigned int *u_array, unsigned int count) = 0;
895 
897 
901  virtual int RegisterNetEvent(INetEvent *e) = 0;
902 
904 
907  virtual int UnRegisterNetEvent(INetEvent *e) = 0;
908  };
909 
913  struct ICloud
914  {
916 
921 
924 
929 
932 
936 
939 
943 
946 
949 
952 
955 
963 
968 
971 
977 
986 
995 
1003 
1006 
1009 
1013 
1016 
1020 
1023 
1026 
1035 
1039 
1042 
1046 
1049 
1052 
1055 
1058 
1061 
1064 
1067 
1071 
1074 
1078 
1081 
1085 
1088 
1092 
1095 
1099 
1113 
1117 
1120 
1124 
1127 
1132 
1135 
1139 
1142 
1146 
1150 
1154 
1157 
1162 
1180 
1190 
1193 
1197 
1200 
1204 
1221 
1243 
1262 
1272 
1275 
1278 
1281 
1284 
1287 
1299 
1312 
1316 
1319 
1323 
1331 
1334 
1337 
1340 
1343 
1348 
1351 
1356 
1359 
1362 
1365 
1369 
1372 
1376