nim_signaling_def.h

浏览该文件的文档.

 
#ifndef NIM_SDK_DLL_EXPORT_HEADERS_NIM_SIGNALING_DEF_H_
#define NIM_SDK_DLL_EXPORT_HEADERS_NIM_SIGNALING_DEF_H_
 
#include "public_defines.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum NIMSignalingType {
    kNIMSignalingTypeAudio = 1,
    kNIMSignalingTypeVideo = 2,
    kNIMSignalingTypeCustom = 3,
};
 
struct NIMSignalingChannelInfo {
    enum NIMSignalingType channel_type_;
    char* channel_name_;
    char* channel_id_;
    char* channel_ext_;
    uint64_t create_timestamp_;
    uint64_t expire_timestamp_;
    char* creator_id_;
    bool invalid_;
    uint64_t nertc_token_ttl_;
    char* nertc_token_;
    char* nertc_join_room_resp_;
};
 
struct NIMSignalingMemberInfo {
    char* account_id_;
    int64_t uid_;
    uint64_t create_timestamp_;
    uint64_t expire_timestamp_;
};
 
struct NIMSignalingChannelDetailedinfo {
    struct NIMSignalingChannelInfo channel_info_;
    struct NIMSignalingMemberInfo* members_;
    int32_t member_size_;
};
 
struct NIMSignalingPushInfo {
    bool need_push_;
    char* push_title_;
    char* push_content_;
    char* push_payload_;
    bool need_badge_;
};
 
enum NIMSignalingEventType {
    kNIMSignalingEventTypeClose = 1,
    kNIMSignalingEventTypeJoin = 2,
    kNIMSignalingEventTypeInvite = 3,
    kNIMSignalingEventTypeCancelInvite = 4,
    kNIMSignalingEventTypeReject = 5,
    kNIMSignalingEventTypeAccept = 6,
    kNIMSignalingEventTypeLeave = 7,
    kNIMSignalingEventTypeCtrl = 8,
};
 
struct NIMSignalingNotifyInfo {
    enum NIMSignalingEventType event_type_;
    struct NIMSignalingChannelInfo channel_info_;
    char* from_account_id_;
    char* custom_info_;
    uint64_t timestamp_;
};
 
#define NIMSignalingNotifyInfoBase                \
    enum NIMSignalingEventType event_type_;       \
    struct NIMSignalingChannelInfo channel_info_; \
    char* from_account_id_;                       \
    char* custom_info_;                           \
    uint64_t timestamp_;
 
struct NIMSignalingNotifyInfoClose {
    NIMSignalingNotifyInfoBase;
};
 
struct NIMSignalingNotifyInfoJoin {
    NIMSignalingNotifyInfoBase;
    struct NIMSignalingMemberInfo member_;
};
 
struct NIMSignalingNotifyInfoInvite {
    NIMSignalingNotifyInfoBase;
    char* to_account_id_;
    char* request_id_;
    struct NIMSignalingPushInfo push_info_;
};
 
struct NIMSignalingNotifyInfoCancelInvite {
    NIMSignalingNotifyInfoBase;
    char* to_account_id_;
    char* request_id_;
};
struct NIMSignalingNotifyInfoReject {
    NIMSignalingNotifyInfoBase;
    char* to_account_id_;
    char* request_id_;
};
struct NIMSignalingNotifyInfoAccept {
    NIMSignalingNotifyInfoBase;
    char* to_account_id_;
    char* request_id_;
};
 
struct NIMSignalingNotifyInfoLeave {
    NIMSignalingNotifyInfoBase;
};
 
struct NIMSignalingNotifyInfoControl {
    NIMSignalingNotifyInfoBase;
};
 
typedef void (*nim_signaling_notify_cb_func)(const struct NIMSignalingNotifyInfo* notify_info, const void* user_data);
 
typedef void (*nim_signaling_notify_list_cb_func)(const struct NIMSignalingNotifyInfo** info_list, int32_t size, const void* user_data);
 
typedef void (*nim_signaling_channels_sync_cb_func)(const struct NIMSignalingChannelDetailedinfo* info_list, int32_t size, const void* user_data);
 
typedef void (*nim_signaling_members_sync_cb_func)(const struct NIMSignalingChannelDetailedinfo* detailed_info, const void* user_data);
 
struct NIMSignalingCreateParam {
    enum NIMSignalingType channel_type_;
    char* channel_name_;
    char* channel_ext_;
};
 
struct NIMSignalingCreateResParam {
    struct NIMSignalingChannelInfo channel_info_;
};
 
struct NIMSignalingCloseParam {
    char* channel_id_;
    char* custom_info_;
    bool offline_enabled_;
};
 
struct NIMSignalingJoinParam {
    char* channel_id_;
    char* custom_info_;
    int64_t uid_;
    bool offline_enabled_;
    char* nertc_channel_name_;
    uint64_t nertc_token_ttl_;
    char* nertc_join_room_query_param_;
};
struct NIMSignalingJoinResParam {
    struct NIMSignalingChannelDetailedinfo info_;
};
 
struct NIMSignalingLeaveParam {
    char* channel_id_;
    char* custom_info_;
    bool offline_enabled_;
};
 
struct NIMSignalingQueryChannelInfoParam {
    char* channel_name_;
};
struct NIMSignalingQueryChannelInfoResParam {
    struct NIMSignalingChannelDetailedinfo info_;
};
 
struct NIMSignalingCallParam {
    enum NIMSignalingType channel_type_;
    char* channel_name_;
    char* channel_ext_;
    int64_t uid_;
    char* account_id_;
    char* request_id_;
    char* custom_info_;
    bool offline_enabled_;
    struct NIMSignalingPushInfo push_info_;
    char* nertc_channel_name_;
    uint64_t nertc_token_ttl_;
    char* nertc_join_room_query_param_;
};
 
struct NIMSignalingCallResParam {
    struct NIMSignalingChannelDetailedinfo info_;
    uint32_t call_status_;
};
 
struct NIMSignalingJoinAndAcceptParam {
    char* channel_id_;
    char* custom_info_;
    int64_t uid_;
    char* account_id_;
    char* request_id_;
    bool offline_enabled_;
    char* nertc_channel_name_;
    uint64_t nertc_token_ttl_;
    char* nertc_join_room_query_param_;
};
 
struct NIMSignalingJoinAndAcceptResParam {
    struct NIMSignalingChannelDetailedinfo info_;
    uint32_t call_status_;
};
 
struct NIMSignalingInviteParam {
    char* channel_id_;
    char* account_id_;
    char* request_id_;
    char* custom_info_;
    bool offline_enabled_;
    struct NIMSignalingPushInfo push_info_;
};
 
struct NIMSignalingCancelInviteParam {
    char* channel_id_;
    char* account_id_;
    char* request_id_;
    char* custom_info_;
    bool offline_enabled_;
};
 
struct NIMSignalingRejectParam {
    char* channel_id_;
    char* account_id_;
    char* request_id_;
    char* custom_info_;
    bool offline_enabled_;
};
struct NIMSignalingAcceptParam {
    char* channel_id_;
    char* account_id_;
    char* request_id_;
    char* accept_custom_info_;
    bool offline_enabled_;
    bool auto_join_;
    int64_t uid_;
    char* join_custom_info_;
    char* nertc_channel_name_;
    uint64_t nertc_token_ttl_;
    char* nertc_join_room_query_param_;
};
 
typedef NIMSignalingJoinResParam NIMSignalingAcceptResParam;
 
struct NIMSignalingControlParam {
    char* channel_id_;
    char* account_id_;
    char* custom_info_;
};
 
typedef void (*nim_signaling_opt_cb_func)(int code, void* opt_res_param, const void* user_data);
 
static const char* kNIMSglEventType = "event_type";
static const char* kNIMSglChannelInfo = "channel_info";
static const char* kNIMSglFromAccountID = "from_account_id";
static const char* kNIMSglCustomInfo = "custom_info";
static const char* kNIMSglTimeStamp = "timestamp";
static const char* kNIMSglChannelType = "channel_type";
static const char* kNIMSglChannelName = "channel_name";
static const char* kNIMSglChannelID = "channel_id";
static const char* kNIMSglChannelExt = "channel_ext";
static const char* kNIMSglCreateTime = "create_timestamp";
static const char* kNIMSglExpireTime = "expire_timestamp";
static const char* kNIMSglCreatorID = "creator_id";
static const char* kNIMSglInvalid = "invalid";
static const char* kNIMSglMembers = "members";
static const char* kNIMSglAccountID = "account_id";
static const char* kNIMSglUID = "uid";
static const char* kNIMSglOfflineEnabled = "offline_enabled";
static const char* kNIMSglDetailedInfo = "info";
static const char* kNIMSglRequestID = "request_id";
static const char* kNIMSglPushInfo = "push_info";
static const char* kNIMSglNeedPush = "need_push";
static const char* kNIMSglPushTitle = "push_title";
static const char* kNIMSglPushContent = "push_content";
static const char* kNIMSglPushPlayload = "push_payload";
static const char* kNIMSglNeedBadge = "need_badge";
static const char* kNIMSglAcceptCustomInfo = "accept_custom_info";
static const char* kNIMSglAutoJoin = "auto_join";
static const char* kNIMSglJoinCustomInfo = "join_custom_info";
 
#ifdef __cplusplus
};
#endif  //__cplusplus
#endif  // NIM_SDK_DLL_EXPORT_HEADERS_NIM_SIGNALING_DEF_H_