Message notification

Typedefs
typedef void(CALLBACK *	OpenSDK_Push_MessageHandler) (const char *szDesc, const char *szContent, const char *szDetail, void *pUser)
	Alarm notification callback function. More...

Functions
OPENSDK_API OPENSDK_RESULT CALLBACK	OpenSDK_Push_SetAlarmCallBack (OpenSDK_Push_MessageHandler pHandle, void *pUser)
	Set alarm notification callback. More...
OPENSDK_API OPENSDK_RESULT CALLBACK	OpenSDK_Push_SetDeviceStatusCallBack (OpenSDK_Push_MessageHandler pHandle, void *pUser)
	Set device online/ offline notification. More...
OPENSDK_API OPENSDK_RESULT CALLBACK	OpenSDK_Push_SetTransparentChannelCallBack (OpenSDK_Push_MessageHandler pHandle, void *pUser)
	Set device online/ offline notification. More...
OPENSDK_API OPENSDK_RESULT CALLBACK	OpenSDK_Push_StartRecvEx (const char *szPushSecret)
	Start receiving alarm. More...
OPENSDK_API OPENSDK_RESULT CALLBACK	OpenSDK_Push_StopRecv ()
	Stop receiving alarm. More...

Detailed Description

Typedef Documentation

typedef void(CALLBACK * OpenSDK_Push_MessageHandler) (const char *szDesc, const char *szContent, const char *szDetail, void *pUser)

Alarm notification callback function.

Parameters

szDesc	Description
szContent	Content
szDetail	Whole message
pUser	User-defined data

See also

OpenSDK_Push_SetAlarmCallBack()

OpenSDK_Push_SetDeviceStatusCallBack()

OpenSDK_Push_SetTransparentChannelCallBack()

Note

See the JSON format of alarm message below:

{
    "msgType": "1",                         // Message type 
    "alarmTime": "2012-12-25 15:25:42",     // Alarm time 
    "deviceSeril": "421877673",             // Device serial No.
    "channelID": "1",                       // Channel ID:
    "alarmType": "11",                      // Alarm type 
    "picUrl": "http://www.hikvision.com/",  // Picture URL
    "videoUrl": "http://www.hikvision.com/",// Video URL
    "custominfo":"sn=507669173^cn=30",      // Custom content, including zone. 
    "custominfoType":"CS-A1-32W_01"         // Type of custom content
}

See the JSON format of alarm content below:

{
    "msgType": "3",                         // message type, 3-device status triggering
    "devMsgType": "1",                      // Notification type No., 1-offline 
    "msgTime": "2016-01-27 16:09:39",       // Message time 
    "deviceSeril": "421877673",             // Device serial No.
    "channelID": "1"                        // Channel ID 
}

See the JSON format of transparent channel notification below:

{
    "msgType": "com,hikvision.open.transparent",    // Message type, transparent data type 
    "msgSeq": "123456789",                          // Message serial No. 
    "createDate": 1456070400000.0,                  // Message time,time stamp (date)
    "data": "hello",                                // Message content, i.e., transparently transmited data
    "sn": "421877673",                              // Device serial No.
}

Function Documentation

OPENSDK_API OPENSDK_RESULT CALLBACK OpenSDK_Push_SetAlarmCallBack	(	OpenSDK_Push_MessageHandler	pHandle,
		void *	pUser
	)

Set alarm notification callback.

Parameters

[in]	pHandle	Alarm notification founction
[in]	pUser	User-defined data, callback function will be thrown out.

Returns

Return 0 on success, -1 on failure

See also

OpenSDK_Push_AlarmHandler

OPENSDK_API OPENSDK_RESULT CALLBACK OpenSDK_Push_SetDeviceStatusCallBack	(	OpenSDK_Push_MessageHandler	pHandle,
		void *	pUser
	)

Set device online/ offline notification.

Parameters

[in]	pHandle	Device status notification function
[in]	pUser	User-defined data, callback function will be thrown out.

Returns

Return 0 on success, -1 on failure

See also

OpenSDK_Push_MessageHandler

OPENSDK_API OPENSDK_RESULT CALLBACK OpenSDK_Push_SetTransparentChannelCallBack	(	OpenSDK_Push_MessageHandler	pHandle,
		void *	pUser
	)

Set device online/ offline notification.

Parameters

[in]	handle	Alarm notification function
[in]	publishHandle	Notification function
[in]	pUser	User-defined data, callback function will be thrown out.

Returns

Return 0 on success, -1 on failure

See also

OpenSDK_Push_MessageHandler

OPENSDK_API OPENSDK_RESULT CALLBACK OpenSDK_Push_StartRecvEx

(

const char *

szPushSecret

)

Start receiving alarm.

Parameters

[in]	szAccessToken	Verification Token
[in]	szPushSecret	Access the key used by Push, system will generate when creating application.

Returns

Return 0 on success, -1 on failure. If returning failed, call GetLastErrorCode() to get the error code.

See also

OpenSDK_Push_StopRecv()

OPENSDK_API OPENSDK_RESULT CALLBACK OpenSDK_Push_StopRecv

(

)

Stop receiving alarm.

Returns

Return 0 on success, -1 on failure

See also

OpenSDK_Push_StartRecv()