OpenSDK  V4.2.0
Classes | Typedefs | Enumerations
OpenNetStreamDefine.h File Reference

Definition of OPEN SDK Data Structure. More...

Go to the source code of this file.

Classes

struct  _STREAM_TIME
 

Typedefs

typedef int OPENSDK_RESULT
 Return value of OPEN SDK , return 0 on success, and return non-0 on failure. More...
 
typedef struct _STREAM_TIME STREAM_TIME
 
typedef struct _STREAM_TIMELP_STREAM_TIME
 
typedef enum _AlarmNotifyType AlarmNotifyType
 

Enumerations

enum  MessageType {
  INS_PLAY_EXCEPTION = 0, INS_PLAY_RECONNECT = 1, INS_PLAY_RECONNECT_EXCEPTION = 2, INS_PLAY_START = 3,
  INS_PLAY_STOP = 4, INS_PLAY_ARCHIVE_END = 5, INS_VOICETALK_START = 16, INS_VOICETALK_STOP = 17,
  INS_VOICETALK_EXCEPTION = 18, INS_PTZ_EXCEPTION = 19, INS_RECORD_FILE = 20, INS_RECORD_SEARCH_END = 21,
  INS_RECORD_SEARCH_FAILED = 22, INS_DEFENSE_SUCCESS = 23, INS_DEFENSE_FAILED = 24, INS_PLAY_ARCHIVE_EXCEPTION = 28,
  INS_PTZCTRL_SUCCESS = 46, INS_PTZCTRL_FAILED = 47
}
 Definition of message type. More...
 
enum  AlarmType {
  ALARM_TYPE_ALL = -1, BODY_SENSOR_EVENT = 10000, EMERGENCY_BUTTON_EVENT = 10001, MOTION_DETECT_ALARM = 10002,
  BABY_CRY_ALARM = 10003, MAGNETIC_ALARM = 10004, SMOKE_DETECTOR_ALARM = 10005, COMBUSTIBLE_GAS_ALARM = 10006,
  FLOOD_IN_ALARM = 10008, EMERGENCY_BUTTON_ALARM = 10009, BODY_SENSOR_ALARM = 10010, SHELTER_ALARM = 10011,
  VIDEO_LOSS_ALARM = 10012, LINE_DETECTION_ALARM = 10013, FIELD_DETECTION_ALARM = 10014, FACE_DETECTION_ALARM = 10015,
  DOOR_BELL_ALARM = 10016, DEVOFFLINE_ALARM = 10017, CURTAIN_ALARM = 10018, MOVE_MAGNETOMETER_ALARM = 10019,
  SCENE_CHANGE_DETECTION_ALARM = 10020, DEFOCUS_ALARM = 10021, AUDIO_EXCEPTION_ALARM = 10022, LEFT_DETECTION_ALARM = 10023,
  TAKE_DETECTION_ALARM = 10024, PARKING_DETECTION_ALARM = 10025, HIGH_DENSITY_DETECTION_ALARM = 10026, LOITER_DETECTION_ALARM = 10027,
  RUN_DETECTION_ALARM = 10028, ENTER_AREA_DETECTION_ALARM = 10029, EXIT_AREA_DETECTION_ALARM = 10030, MAG_GIM_ALARM = 10031,
  UNDER_VOLTAGE_ALARM = 10032, INTRUSION_ALARM = 10033, IO_00_ALARM = 10100, IO_01_ALARM = 10101,
  IO_02_ALARM = 10102, IO_03_ALARM = 10103, IO_04_ALARM = 10104, IO_05_ALARM = 10105,
  IO_06_ALARM = 10106, IO_07_ALARM = 10107, IO_08_ALARM = 10108, IO_09_ALARM = 10109,
  IO_10_ALARM = 10110, IO_11_ALARM = 10111, IO_12_ALARM = 10112, IO_13_ALARM = 10113,
  IO_14_ALARM = 10114, IO_15_ALARM = 10115, IO_16_ALARM = 10116
}
 Alarm type definition of OPEN SDK. More...
 
enum  _AlarmNotifyType { ALARM_NOTIFY_CONNECT_EXCEPTION = 100, ALARM_NOTIFY_RECONNECT_SUCCESS, ALARM_NOTIFY_RECONNECT_FAILED }
 
enum  PTZCommand {
  UP, DOWN, LEFT, RIGHT,
  UPLEFT, DOWNLEFT, UPRIGHT, DOWNRIGHT,
  ZOOMIN, ZOOMOUT, FOCUSNEAR, FOCUSFAR,
  IRISSTARTUP, IRISSTOPDOWN, LIGHT, WIPER,
  AUTO
}
 PTZ control command. More...
 
enum  PTZAction { START, STOP }
 PTZ operation command Normally, hold down the mouse to start, and realse the mouse to stop. More...
 
enum  DefenceType {
  PIR, ATHOME, OUTDOOR, BABYCRY,
  MOTIONDETECT, GLOBAL
}
 Arnming and disarming alarm type. More...
 
enum  DefenceStatus { UN_DEFENCE, DEFENCE, UN_SUPPORT, FORCE_DEFENCE }
 Arming and disarming status. More...
 
enum  DefenceActor { D, V, I }
 
enum  DataType { NET_DVR_SYSHEAD = 1, NET_DVR_STREAMDATA = 2, NET_DVR_RECV_END = 3 }
 Data type of audio and video stream. More...
 
enum  LoginParamKey {
  LOGIN_AREAID = 1, LOGIN_VER = 2, LOGIN_AREADOMAIN = 3, LOGIN_TOKEN_EXPIRETIME = 4,
  LOGIN_ACCESS_TOKEN = 5
}
 Login the relevant parameter type. More...
 
enum  ConfigKey { CONFIG_DATA_UTF8 = 1, CONFIG_OPEN_STREAMTRANS = 2, CONFIG_CLOSE_P2P = 3, CONFIG_LOG_LEVEL = 4 }
 Config Type. More...
 
enum  EZOPENSDK_LogLevel { EZOPENSDK_ERROR = 5, EZOPENSDK_INFO = 3 }
 

Detailed Description

Definition of OPEN SDK Data Structure.

Author
panlong, peter
Date
2014/12/15
Note
history:
V0.0.1 2014/12/15 peter Added notes to header file

Typedef Documentation

typedef struct _STREAM_TIME * LP_STREAM_TIME

Return value of OPEN SDK , return 0 on success, and return non-0 on failure.

typedef struct _STREAM_TIME STREAM_TIME

Enumeration Type Documentation

Enumerator
ALARM_NOTIFY_CONNECT_EXCEPTION 

Connecting to EZVIZ exception.

ALARM_NOTIFY_RECONNECT_SUCCESS 

Reconnection succeeded.

ALARM_NOTIFY_RECONNECT_FAILED 

Reconnection failed.

enum AlarmType

Alarm type definition of OPEN SDK.

Enumerator
ALARM_TYPE_ALL 

All.

BODY_SENSOR_EVENT 

PIR event.

EMERGENCY_BUTTON_EVENT 

Emergency button event.

MOTION_DETECT_ALARM 

Motion detection alarm.

BABY_CRY_ALARM 

Baby cry alarm.

MAGNETIC_ALARM 

Magnetic contact alarm.

SMOKE_DETECTOR_ALARM 

Smoke detection alarm.

COMBUSTIBLE_GAS_ALARM 

Combustible gas alarm.

FLOOD_IN_ALARM 

Water leak alarm.

EMERGENCY_BUTTON_ALARM 

Emergency button alarm.

BODY_SENSOR_ALARM 

PIR alarm.

SHELTER_ALARM 

Video Tampering alarm.

VIDEO_LOSS_ALARM 

Video loss alarm.

LINE_DETECTION_ALARM 

Line crossing detection.

FIELD_DETECTION_ALARM 

Intrusion detection alarm.

FACE_DETECTION_ALARM 

Face detection alarm.

DOOR_BELL_ALARM 

Door bell ring alarm.

DEVOFFLINE_ALARM 

Camara offline alarm.

CURTAIN_ALARM 

Curtain alarm.

MOVE_MAGNETOMETER_ALARM 

Open-close detector alarm.

SCENE_CHANGE_DETECTION_ALARM 

Sudden scene change alarm.

DEFOCUS_ALARM 

Defocus detection alarm.

AUDIO_EXCEPTION_ALARM 

Audio exception detection.

LEFT_DETECTION_ALARM 

Unattended baggage detection.

TAKE_DETECTION_ALARM 

Object removal detection.

PARKING_DETECTION_ALARM 

Parking detection alarm.

HIGH_DENSITY_DETECTION_ALARM 

People gathering detection alarm.

LOITER_DETECTION_ALARM 

Loitering detection alarm.

RUN_DETECTION_ALARM 

Fast moving detection alarm.

ENTER_AREA_DETECTION_ALARM 

Region entrance detection alarm.

EXIT_AREA_DETECTION_ALARM 

Region exiting detection alarm.

MAG_GIM_ALARM 

Magnetic interference alarm.

UNDER_VOLTAGE_ALARM 

Low battery voltage alarm.

INTRUSION_ALARM 

Intrusion alarm.

IO_00_ALARM 

IO alarm.

IO_01_ALARM 

IO-1 alarm.

IO_02_ALARM 

IO-2 alarm.

IO_03_ALARM 

IO-3 alarm.

IO_04_ALARM 

IO-4 alarm.

IO_05_ALARM 

IO-5 alarm.

IO_06_ALARM 

IO-6 alarm.

IO_07_ALARM 

IO-7 alarm.

IO_08_ALARM 

IO-8 alarm.

IO_09_ALARM 

IO-9 alarm.

IO_10_ALARM 

IO-10 alarm.

IO_11_ALARM 

IO-11 alarm.

IO_12_ALARM 

IO-12 alarm.

IO_13_ALARM 

IO-13 alarm.

IO_14_ALARM 

IO-14 alarm.

IO_15_ALARM 

IO-15 alarm.

IO_16_ALARM 

IO-16 alarm.

enum ConfigKey

Config Type.

Enumerator
CONFIG_DATA_UTF8 

Platform Data output use UTF-8.

CONFIG_OPEN_STREAMTRANS 

The output of the stream data is transferred to the package for video storage.

CONFIG_CLOSE_P2P 

P2P Switch, use to close the P2P.

CONFIG_LOG_LEVEL 

Configure log level,see #OpenSDK_LogLevel.

enum DataType

Data type of audio and video stream.

Enumerator
NET_DVR_SYSHEAD 

Stream header.

NET_DVR_STREAMDATA 

Stream data.

NET_DVR_RECV_END 

End mark.

Enumerator

Device.

Vedio channel.

IO channel.

Arming and disarming status.

Enumerator
UN_DEFENCE 

Disarmed.

DEFENCE 

Armed.

UN_SUPPORT 

Unsupported.

FORCE_DEFENCE 

Force armed, A1 device.

Arnming and disarming alarm type.

Enumerator
PIR 

IR mode.

ATHOME 

Stay mode, A1 device.

OUTDOOR 

Away mode.

BABYCRY 

Baby cry mode.

MOTIONDETECT 

Motion detection mode.

GLOBAL 

All.

Enumerator
EZOPENSDK_ERROR 
EZOPENSDK_INFO 

Login the relevant parameter type.

Enumerator
LOGIN_AREAID 

Area ID.

LOGIN_VER 

The version information of the login page.

LOGIN_AREADOMAIN 

Redirected domain name.

LOGIN_TOKEN_EXPIRETIME 

Token's expire time.

LOGIN_ACCESS_TOKEN 

Get AccessToken After Login.

Definition of message type.

Enumerator
INS_PLAY_EXCEPTION 

Play exception, which is usually cased by device offline or network exception.

INS_PLAY_RECONNECT 

Reconnect,auto-reconnect at real-time stream playing.

INS_PLAY_RECONNECT_EXCEPTION 

Reconnect exception.

INS_PLAY_START 

Start playing.

INS_PLAY_STOP 

Stop playing.

INS_PLAY_ARCHIVE_END 

Message pop up when play ended.

INS_VOICETALK_START 

Start two-way audio.

INS_VOICETALK_STOP 

Stop two-way audio.

INS_VOICETALK_EXCEPTION 

Two-way aodio exception.

INS_PTZ_EXCEPTION 

PTZ control exception.

INS_RECORD_FILE 

Search recording files.

INS_RECORD_SEARCH_END 

Record search ended (do not enable now)

INS_RECORD_SEARCH_FAILED 

Record search failed.

INS_DEFENSE_SUCCESS 

Arming succeeded.

INS_DEFENSE_FAILED 

Arming failed.

INS_PLAY_ARCHIVE_EXCEPTION 

Playback exception, which may due to receiving data timed out.

INS_PTZCTRL_SUCCESS 

PTZ control succeeded.

INS_PTZCTRL_FAILED 

PTZ control failed.

enum PTZAction

PTZ operation command Normally, hold down the mouse to start, and realse the mouse to stop.

Enumerator
START 
STOP 
enum PTZCommand

PTZ control command.

Enumerator
UP 
DOWN 
LEFT 
RIGHT 
UPLEFT 
DOWNLEFT 
UPRIGHT 
DOWNRIGHT 
ZOOMIN 
ZOOMOUT 
FOCUSNEAR 
FOCUSFAR 
IRISSTARTUP 
IRISSTOPDOWN 
LIGHT 
WIPER 
AUTO