独立信令接口相关的常量函数等定义头文件 More...

#include "public_defines.h"

Classes
struct	NIMSignalingChannelInfo
	频道属性 More...

struct	NIMSignalingMemberInfo
	成员属性 More...

struct	NIMSignalingChannelDetailedinfo
	频道的详细信息，包含频道信息及成员列表 More...

struct	NIMSignalingPushInfo
	推送属性 More...

struct	NIMSignalingNotifyInfo
	事件通知信息基类 More...

struct	NIMSignalingNotifyInfoClose
	频道关闭事件通知信息，event_type_=kNIMSignalingEventTypeClose More...

struct	NIMSignalingNotifyInfoJoin
	加入频道事件通知信息，event_type_=kNIMSignalingEventTypeJoin More...

struct	NIMSignalingNotifyInfoInvite
	邀请事件通知信息，event_type_=kNIMSignalingEventTypeInvite More...

struct	NIMSignalingNotifyInfoCancelInvite
	取消邀请事件通知信息，event_type_=kNIMSignalingEventTypeCancelInvite More...

struct	NIMSignalingNotifyInfoReject
	拒绝邀请事件通知信息，event_type_=kNIMSignalingEventTypeReject More...

struct	NIMSignalingNotifyInfoAccept
	接收邀请事件通知信息，event_type_=kNIMSignalingEventTypeAccept More...

struct	NIMSignalingNotifyInfoLeave
	退出频道事件通知信息，event_type_=kNIMSignalingEventTypeLeave More...

struct	NIMSignalingNotifyInfoControl
	控制事件通知信息，event_type_=kNIMSignalingEventTypeCtrl More...

struct	NIMSignalingCreateParam
	创建频道接口nim_signaling_create的传入参数 More...

struct	NIMSignalingCreateResParam
	创建频道结果回调信息 More...

struct	NIMSignalingCloseParam
	关闭频道接口nim_signaling_close的传入参数 More...

struct	NIMSignalingJoinParam
	加入频道接口nim_signaling_join的传入参数 More...

struct	NIMSignalingJoinResParam
	加入频道结果回调信息 More...

struct	NIMSignalingLeaveParam
	离开频道接口nim_signaling_leave的传入参数 More...

struct	NIMSignalingQueryChannelInfoParam
	查询频道接口nim_signaling_query_channel_info的传入参数 More...

struct	NIMSignalingQueryChannelInfoResParam
	查询频道结果回调信息 More...

struct	NIMSignalingCallParam
	呼叫接口nim_signaling_call的传入参数 More...

struct	NIMSignalingCallResParam

struct	NIMSignalingJoinAndAcceptParam

struct	NIMSignalingJoinAndAcceptResParam

struct	NIMSignalingInviteParam
	邀请接口nim_signaling_invite的传入参数 More...

struct	NIMSignalingCancelInviteParam
	取消邀请接口nim_signaling_cancel_invite的传入参数 More...

struct	NIMSignalingRejectParam
	拒绝接口nim_signaling_reject的传入参数 More...

struct	NIMSignalingAcceptParam
	接受邀请接口nim_signaling_accept的传入参数 More...

struct	NIMSignalingControlParam
	控制通知接口nim_signaling_control的传入参数 More...

Macros
#define	NIMSignalingNotifyInfoBase
	NIMSignalingNotifyInfo 的宏定义基类 More...

Typedefs
typedef void(*	nim_signaling_notify_cb_func) (const struct NIMSignalingNotifyInfo notify_info, const void user_data)
	事件回调函数，用于在线通知和多端同步通知 More...

typedef void(*	nim_signaling_notify_list_cb_func) (const struct NIMSignalingNotifyInfo *info_list, int32_t size, const void user_data)
	事件回调函数，用于离线通知 More...

typedef void(*	nim_signaling_channels_sync_cb_func) (const struct NIMSignalingChannelDetailedinfo info_list, int32_t size, const void user_data)
	频道列表同步回调函数 More...

typedef void(*	nim_signaling_members_sync_cb_func) (const struct NIMSignalingChannelDetailedinfo detailed_info, const void user_data)
	频道成员变更同步回调函数 More...

typedef NIMSignalingJoinResParam	NIMSignalingAcceptResParam
	接受邀请结果回调信息，在自动加入成功后返回有效

typedef void(*	nim_signaling_opt_cb_func) (int code, void opt_res_param, const void user_data)
	操作回调，通用的操作回调接口 More...

Enumerations
enum	NIMSignalingType { kNIMSignalingTypeAudio = 1 , kNIMSignalingTypeVideo = 2 , kNIMSignalingTypeCustom = 3 }
	频道类型 More...

enum	NIMSignalingEventType { kNIMSignalingEventTypeClose = 1 , kNIMSignalingEventTypeJoin = 2 , kNIMSignalingEventTypeInvite = 3 , kNIMSignalingEventTypeCancelInvite = 4 , kNIMSignalingEventTypeReject = 5 , kNIMSignalingEventTypeAccept = 6 , kNIMSignalingEventTypeLeave = 7 , kNIMSignalingEventTypeCtrl = 8 }
	频道事件，包含在线，同步，离线等 More...

Variables
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"
	通话类型,1:音频;2:视频;3:其他

static const char *	kNIMSglChannelName = "channel_name"
	创建时传入的频道名

static const char *	kNIMSglChannelID = "channel_id"
	服务器生成的频道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"
	创建者的accid

static const char *	kNIMSglInvalid = "invalid"
	频道是否有效

static const char *	kNIMSglMembers = "members"
	频道内成员信息数组

static const char *	kNIMSglAccountID = "account_id"
	成员的 accid

static const char *	kNIMSglUID = "uid"
	成员的 uid，大于零有效，无效时服务器会分配随机频道内唯一的uid

static const char *	kNIMSglOfflineEnabled = "offline_enabled"
	是否存离线

static const char *	kNIMSglDetailedInfo = "info"
	频道详细信息

static const char *	kNIMSglRequestID = "request_id"
	邀请者邀请的请求id，需要邀请者填写，之后取消邀请、拒绝、接受需要复用该request_id_

static const char *	kNIMSglPushInfo = "push_info"
	推送属性

static const char *	kNIMSglNeedPush = "need_push"
	是否需要推送，默认false

static const char *	kNIMSglPushTitle = "push_title"
	推送标题

static const char *	kNIMSglPushContent = "push_content"
	推送内容

static const char *	kNIMSglPushPlayload = "push_payload"
	推送自定义字段

static const char *	kNIMSglNeedBadge = "need_badge"
	是否计入未读计数,默认true

static const char *	kNIMSglAcceptCustomInfo = "accept_custom_info"
	扩展字段

static const char *	kNIMSglAutoJoin = "auto_join"
	是否加入，打开后后续参数uid_、join_custom_info_有效

static const char *	kNIMSglJoinCustomInfo = "join_custom_info"
	加入频道的自定义扩展信息，将在加入频道通知中带给其他频道成员，可缺省

Detailed Description

独立信令接口相关的常量函数等定义头文件

Copyright: (c) 2015-2018, NetEase Inc. All rights reserved

Author: gq

Date: 2018/10/31

Macro Definition Documentation

◆ NIMSignalingNotifyInfoBase

#define NIMSignalingNotifyInfoBase

Value:

    enum NIMSignalingEventType event_type_;       \
    struct NIMSignalingChannelInfo channel_info_; \
    char* from_account_id_;                       \
    char* custom_info_;                           \
    uint64_t timestamp_;

NIMSignalingNotifyInfo 的宏定义基类

Typedef Documentation

◆ nim_signaling_channels_sync_cb_func

void(* nim_signaling_channels_sync_cb_func)(const struct NIMSignalingChannelDetailedinfo *info_list, int32_t size, const void *user_data)

频道列表同步回调函数

Note: 在login或者relogin后，会通知该设备账号还未退出的频道列表，用于同步；如果没有在任何频道中，也会返回该同步通知，list为空

Parameters

[out]	info_list	频道的详细信息NIMSignalingChannelDetailedinfo的数组，可能为空
[out]	size	info_list数组的长度
[out]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns: void 无返回值

◆ nim_signaling_members_sync_cb_func

void(* nim_signaling_members_sync_cb_func)(const struct NIMSignalingChannelDetailedinfo *detailed_info, const void *user_data)

频道成员变更同步回调函数

Note: 用于同步频道内的成员列表变更，当前该接口为定时接口，2分钟同步一次，成员有变化时才上报由于一些特殊情况，导致成员在离开或掉线前没有主动调用离开频道接口，使得该成员的离开没有对应的离开通知事件，由该回调接口【频道成员变更同步通知】告知用户。

Parameters

[out]	detailed_info	频道的详细信息
[out]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns: void 无返回值

◆ nim_signaling_notify_cb_func

void(* nim_signaling_notify_cb_func)(const struct NIMSignalingNotifyInfo *notify_info, const void *user_data)

事件回调函数，用于在线通知和多端同步通知

Parameters

[out]	notify_info	事件回调的信息指针，根据NIMSignalingNotifyInfo.event_type_指向对应NIMSignalingNotifyInfo扩展，如NIMSignalingNotifyInfoAccept
[out]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns: void 无返回值

◆ nim_signaling_notify_list_cb_func

void(* nim_signaling_notify_list_cb_func)(const struct NIMSignalingNotifyInfo **info_list, int32_t size, const void *user_data)

事件回调函数，用于离线通知

Parameters

[out]	info_list	事件回调的信息NIMSignalingNotifyInfo指针的数组，根据NIMSignalingNotifyInfo.event_type_指向对应NIMSignalingNotifyInfo扩展，如NIMSignalingNotifyInfoAccept
[out]	size	info_list数组的长度
[out]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns: void 无返回值

◆ nim_signaling_opt_cb_func

void(* nim_signaling_opt_cb_func)(int code, void *opt_res_param, const void *user_data)

操作回调，通用的操作回调接口

Parameters

[out]	code	操作返回码NIMResCode，见nim_res_code_def.h
[out]	opt_res_param	操作结果返回信息
[out]	user_data	APP的自定义用户数据，SDK只负责传回给回调函数cb，不做任何处理！

Returns: void 无返回值

Enumeration Type Documentation

◆ NIMSignalingEventType

enum NIMSignalingEventType

频道事件，包含在线，同步，离线等

Enumerator
kNIMSignalingEventTypeClose	返回NIMSignalingNotifyInfoClose，支持在线、离线通知
kNIMSignalingEventTypeJoin	返回NIMSignalingNotifyInfoJoin，支持在线、离线通知
kNIMSignalingEventTypeInvite	返回NIMSignalingNotifyInfoInvite，支持在线、离线通知
kNIMSignalingEventTypeCancelInvite	返回NIMSignalingNotifyInfoCancelInvite，支持在线、离线通知
kNIMSignalingEventTypeReject	返回NIMSignalingNotifyInfoReject，支持在线、多端同步、离线通知
kNIMSignalingEventTypeAccept	返回NIMSignalingNotifyInfoAccept，支持在线、多端同步、离线通知
kNIMSignalingEventTypeLeave	返回NIMSignalingNotifyInfoLeave，支持在线、离线通知
kNIMSignalingEventTypeCtrl	返回NIMSignalingNotifyInfoControl，支持在线通知

◆ NIMSignalingType

enum NIMSignalingType

频道类型

Enumerator
kNIMSignalingTypeAudio	音频类型
kNIMSignalingTypeVideo	视频类型
kNIMSignalingTypeCustom	自定义

Classes

Macros

Typedefs

Enumerations

Variables

Detailed Description

Macro Definition Documentation

◆ NIMSignalingNotifyInfoBase

Typedef Documentation

◆ nim_signaling_channels_sync_cb_func

◆ nim_signaling_members_sync_cb_func

◆ nim_signaling_notify_cb_func

◆ nim_signaling_notify_list_cb_func

◆ nim_signaling_opt_cb_func

Enumeration Type Documentation

◆ NIMSignalingEventType

◆ NIMSignalingType