ISAPI登录logIn

logIn

接口描述

投屏时调用此接口,若使用投屏码投屏通过投屏码服务器获取大屏信息;若使用非投屏码投屏时(IP映射码或列表投屏),则需要通过算法将IP映射码解析成大屏IP。 该接口中会给传入的用户ID和布防句柄赋值,故这两个参数可看做输出参数。 之后调用发起投屏请求接口和登出接口时都需要传入这两个参数

函数声明

`HPR_INT32 logIn(CODESERVERINFO_S codeServerInfo, DEVICE_LISTUNIT_INFO_S &pDisplayInfo, HPR_INT64 &userID, HPR_INT64 &alarmHandle, void* pUser, ClientDeviceType type = PC, const char* deviceName = nullptr);`

函数参数

参数名
类型
描述
必填
codeServerInfo
CODESERVERINFO_S
结构体类型,存储投屏码服务器信息
必填
pDisplayInfo
DEVICE_LISTUNIT_INFO_S &
结构体类型,存储显示端信息
必填
userID
HPR_INT64 &
即signed __int64,用户ID
必填
alarmHandle
HPR_INT64 &
即signed __int64,告警句柄
必填
pUser
void*
布防的用户参数
必填
type
ClientDeviceType
缺省参数,枚举类型,默认为PC表示客户端设备类型
必填
deviceName
const char*
缺省参数,枚举类型,上层传入设备名称,默认为nullptr
必填

函数返回值

类型
描述
必填
HPR_INT32
即signed int类型
必填

结构体或枚举声明

`typedef struct tagCodeServerInfo_ { /*投屏码服务器IP*/ char szCMSIP[DEVICE_IP_LEN]; /* 投屏码服务器端口 */ unsigned short usCMSPort; }CODESERVERINFO_S;` `typedef struct tagDeviceListUnitInfo_ { /* 大屏端IP */ char szCMSIP[DEVICE_IP_LEN]; /* 大屏端名称 */ char szCMSName[MC_MAX_HOSTNAME_LEN]; /* 大屏端端口 */ unsigned short usCMSPort; /* 连接码 */ char szConnectCode[MEETING_CODE_LEN]; /*Http 交互结果*/ char szHttpCode[ERRCODE_LEN]; }DEVICE_LISTUNIT_INFO_S;` `enum ClientDeviceType { PC = 0, // PC AnroidMobile = 1, // 安卓 AnroidHD = 2, // 安卓大屏 Ios = 3, // IOS设备 Mac = 4, // Mac设备 };`