Home

Toshiba Toshiba Security Camera User Manual

1. Item Menu API name Alarm In List Operation Get Alarm In List wblistalarm cgi Delete Alarm In List All 5 Delete Alarm In List Date and Time o Normal List Operation Get Normal List wblistnormal cgi g Delete Normal List All a Delete Normal List Date and Time S Ext Control In List Operation Get Ext Control In List wblistextcontrol cgi Delete Ext Control In List All Delete Ext Control In List Date and Time External Storage Operations Notify Inserting Status wbstoragestatus cgi Mount Unmount wbstoragemount cgi Q Notify Mounting Status wbstoragemountstatus cgi gt Format wbstorageformat cgi amp PTZ Operation PAN TILT Operation wbpantiltapi cgi ZOOM Operation wbsetzoom cgi Get current Pan Tilt Zoom Position wbgetptzposition cgi OTOSHIBA Corp TOSHIBA Network Camera IK WB15A V API Termination Status SDK Ver 1 00 SC Termination status classification gt This API group notifies Termination code and Termination status except where image audio data is notified to the client in the specified format when the getstream type API is successful The API termination status is not notified in the HTML format but a message such as shown above is notified in units of lines If there is data that is notified from the camera the message is sent starting from the next line of this termination status IK WB15A recommends the client who has executed this AP
2. WEB operation API operation Function list Setting Reference Setting Reference Admin User Admin User Admin User Admin User Camera Settings Basic O O O Xx O X Frame Rate O X O X O Xx O X Alarm O X O X O X O X Recording O X O Xx O Xx O Xx FTP Recording O X O X O X O X E mail O X O X O X O X Audio O X O O O OTOSHIBA Corp To the next page TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page OTOSHIBA Corp To the next page WEB operation API operation Function list Setting Reference Setting Reference Admin User Admin User Admin User Admin User PAN TILT Settings Basic O X O X O X O X Preset O X O X O X O Xx Auto Patrol O X O X O X O Xx Operation Range O Xx O X O X O X Network Settings Basic O X O X O X O Xx Bandwidth Control O Xx O Xx O Xx O X DDNS O X O X O X O X FTP Server O X O X O X O X Multi Screen Settings Adding and Removing Cameras O X O X O X O X Admin Functions Changing Admin O X O X X X X X ID Password User O X O X X X X X User Operation Restriction O Xx O Xx O X O Xx Date and Time O X O X O X O Xx FW Update O X O X O X O X Import O X X X Configuration apon D x de X i Reset to Default O X O X O Xx O Xx Camera O X O X O X O X Log management Filter Settings O X O X O X O Xx Browse O X O Xx O X O Xx
3. 9 4 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 9 4 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetcamrecord cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Wednesday value r n Win Thursday value r n Camera Recording r n Friday value r n lt Alarm gt r n Saturday value r n AlarminRecMode value r n ExtControllnRecMode value r n Sunday value r n Pattern Start value r n MotionRecMode value r n NumberOfPrePicture value r n NumberOfPostPicture value r n Interval value r n lt Normal gt r n Mode value r n Monday value r n Tuesday value r n 9 4 4 Example 1 http 10 1 0 1 api wbgetcamrecord cgi 9 45 Notes Pattern1End value r n Pattern2Start value n n Pattern2End value r n Interval value r n lt RecOverwriting gt Mode value r n 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 79 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 9 5 Reference of FTP Recording Settings wbgetcamftprecord cgi 9 5 1 Syntax 1 http lt camip gt api wbgetcamftprecord cgi 9 5 2 In
4. 5 2 4 Example 1 http 10 1 0 1 api wbsetadminuserfunctions cgi type Default 2 http 10 1 0 1 api wbsetadminuserfunctions cgi type FunctionRestiction Mode 2 3 http 10 1 0 1 api wbsetadminuserfunctions cgi type Function amp Resolution 3 amp CompressionRatio 5 amp AEControl 19 5 2 5 Notes OTOSHIBA Corp 51 For only entered items setting is performed For the other items their existing values are held When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes Item Type Entry name Entry value Std val Unit Audio receive from camera operation type Function Audio 1 disable 2 enable 1 Image save operation PictureSaving 1 disable 2 enable 1 PAN TILT operation PanTilt 1 disable 2 enable 1 Auto patrol operation AutoPatrol 1 disable 2 enable 1 Scanning operation Scan 1 disable 2 enable 1 Preset operation Preset 1 disable 2 enable 1 Alarm replay operation PlayAlarm 1 disable 2 enable 1 Normal replay operation PlayNormal 1 disable 2 enable 1 Ext Control In replay operation PlayControl 1 disable 2 enable 1 Log output control of cgi common to all types OpeLog No Yes default Yes omissible 5 2 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData If only type lt value gt is entered and then lt entry gt lt value gt is not en
5. Item No Item Sun number Menu Api name Function type 16 External Storage 16 1 Insert notification wbstoragestatus cgi E 16 2 Mount Unmount execute wbstoragemount cgi 2 types 16 3 Mount status notification wbstoragemountstatus cgi 16 4 Format wbstorageformat cgi OTOSHIBA Corp 114 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 16 External Storage wbstoragestatus cgi Check Storage Inserted Status wbstoragemount cgi Execute Storage Mount Unmount wbstoragemountstatus cgi Check Storage Mount Status wbstorageformat cgi Format Storage wbstorage func cal 1 2 3 1 Indicates a storage operation API 2 Indicates a storage operation type API 3 Every API is started and executed as cgi On and after the next page the camera reference API is shown TOSHIBA Corp 115 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 16 1 Check Storage Inserted Status wbstoragestatus cgi 16 1 1 Syntax 1 http lt camip gt api wbstoragestatus cgi 16 1 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 16 1 3 Output Code Status 21 Inserted 71 NotInserted 16 1 4 Example 1 http 10 1 0 1 api wbstoragestatus cgi 16 1 5 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded
6. Item No Item Sub number Menu API name Function type 1 Camera Settings 1 1 Basic wbsetcambasic cgi 2 types 1 2 Frame Rate wbsetcamframerate cgi 2 types 1 3 Alarm wbsetcamalarm cgi 4 types 1 4 Recording wbsetcamrecord cgi 4 types 1 5 FTP Recording wbsetcamftprecord cgi 10 types 1 6 E mail wbsetcammail cgi 16 types 1 7 Audio wbsetcamsound cgi 3 types 2 PANTILT Settings 2 1 Basic Operation Range wbsetptbasic cgi 7 types 2 2 Preset wbsetptpreset cgi 65 types 2 3 Auto Patrol wbsetptautopatrol cgi 3 types 3 Network Settings 3 1 Basic wbsetnwkbasic cgi 2 types 3 2 Bandwidth Control wbsetnwkbandwidth cgi 2 types 3 3 DDNS wbsetnwkddns cgi 2 types 3 4 FTP Server wbsetnwkftpserver cgi 2 types Multi Screen Settings 4 1 Adding and Removing Selecting Cameras wbsetmultiscreen cgi 33 types 5 Admin Functions 5 1 User Login Restriction wbsetadminuserinfo cgi 2 types 5 2 User Operation Restriction wbsetadminuserfunctions cgi 3 types 5 3 Date and Time NTP wbsetadminTaD cgji 4 types 5 4 Manual wbsetadmintime cgi 1 type FW Update z Configuration Import Export 5 5 Reset to Default wbsetadminsetdefault cgi 1 type 5 6 Camera Rebooting wbsetadmincamreboot cgi 1 type 6 Log Management 6 1 Filter Settings wbsetlogconditions cgi 2 types 6 2 Delete wbsetlogclear cgi 1 type TOSHIBA Corp TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 1 Camera Settings wbsetcambasic cgi Basic
7. normal Stream distribution has been forcibly terminated by streaming exec task an abort5 10 request TOSHIBA Corp 127 Appendix A TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC Appendix B Output of wbgetallinfo cgi Version Ver RB0 50 000 Camera General Resolution 3 CompressionRatio 3 AEControl 0 Mounting 1 AutoBW 1 WhiteBalance 1 WBManualGainR 0 WBManualGainB 0 AWBOffsetYeCy 0 AWBOffsetMgG 0 AWBRange 1 AutoGainControl 2 SlowShutterMax 3 BackLightCompensation 7 Sharpness 2 GainRY 0 GainBY 0 NoiseReduction 1 Camera FrameRate Rate 1 Camera Alarm lt AlarmType gt Mode 1 InputPolarity 1 lt MotionDetection gt Mode 1 Sensitivity 1 lt HoldingOutTime gt Time 5 Camera Recording lt Alarm gt AlarminRecMode 1 ExtControllnRecMode 1 MotionRecMode 1 NumberOfPrePicture 3 NumberOfPostPicture 10 Interval 10 lt Normal gt Mode 1 Monday 1 Tuesday 1 Wednesday 1 Thursday 1 Friday 1 Saturday 1 Sunday 1 Pattern1Start 8 PatterntEnd 17 Pattern2Start 8 Pattern2End 17 Interval 60 lt RecOverwriting gt Mode 1 Camera FTPclient lt FTPCondition gt Mode 1 AlarminMode 1 MotionMode 1 lt Server 1 gt Name LoginID Password FTPcPortNumber 21 FTPMode 1
8. TOSHIBA Corp 139 Appendix C TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC Appendix D Simultaneous Connection getstream cgi lt streamType 0 gt 1 2 3 10 OK JOK JOK OK Le getstream cgi lt streamType 1 gt 1 2 3 10 OK JOK OK OK Le OTOSHIBA Corp 140 getstream cgi lt streamType 0 gt 1 2 3 OK JOK JOK Le OK JOK JOK 10 OK OK Eat oa num 11 12 13 getstream cgi lt streamType 1 gt 20 Appendix D TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC getstream cgi lt streamType 0 gt getstream cgi lt streamType 1 gt 1 2 3 10 11 1 2 3 10 11 OK OK JOK OK No JPEG OK JOK JOK Le e getstream cgi lt streamType 0 gt 1 2 3 10 11 OK lok OK OK _ INOJPEG Le OK OK TOK OK E No WAV 11 12 13 20 21 getstream cgi lt streamType 1 gt TOSHIBA Corp Appendix D 141 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC Le I lll Up to 30fps OK attps 32tps Not recommended EE at Up to 30fps at 640x480 VGA 320x240 QVGA 160x120 QQVGA resolution Up to 7 5fps at 1280x960 SXVGA resolution 1second s al rom 1fps OK 2fps 3fps NG TOSHIBA Corp Appendix D 142 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC getstream cgi getstream cgi getstream cgi Le per 1 second live pg Kim live jpg number of getstream cgi numb
9. wbgetcambasic cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n r n Camera General r n Resolution va ue r n CompressionRatio va ue r n AEControl va ue r n Mounting va ue r n AutoBW value r n WhiteBalance value r n WBManualGainR value r n WBManualGainB val ue r n 9 1 4 Example 1 http 10 1 0 1 api wbgetcambasic cgi 9 1 5 Notes AWBOffsetYeCy value r n AWBOffsetMgG value r n AWBRange value r n AutoGainControl va ue r n SlowShutterMAX value r n BackLightCompensation value r n Sharpness va ue r n GainRY value r n GainBY value r n NoiseReduction value r n 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 76 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 9 2 Reference of Frame Rate Settings wbgetcamframerate cgi 9 2 1 Syntax 1 http lt camip gt api wogetnwkframerate cgi 9 2 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 9 2 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetcamframerate cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Mn
10. 2 5 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 2 5 4 Example 1 http 10 1 0 1 api wbpresetapi cgi cont 4 769 amp savesysvar 2 http 10 1 0 1 api wbpresetapi cgi cont 4 769 amp presetname_1 amp savesysvar 2 5 5 Note 1 This API deletes assigned Preset Number and or Position Name without giving caution 2 If given such as http 10 1 0 1 api wbpresetapi cgi cont_4 770 amp presetname_9 amp savesysvar the position of preset 2 will be deleted and Position Name of preset 9 will be gone OTOSHIBA Corp 36 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 2 6 Easy collective Preset Name assignment wbpresetapi cgi 2 6 1 Syntax 1 http lt camip gt apiAvbpresetapi cgi presetname 1 lt value gt amp presetname 2 lt value gt amp J amp savesysvar 2 6 2 Input Item Entry name Entry value Std val Unit Preset name of 1 presetname_1 any max 12 bytes Preset name of 64 presetname_64 any max 12 bytes Save this preset information savesysvar Log output control of cgi common to all types OpeLog No Yes default Yes omissible 2 6 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 2
11. ConnectMode 1 lt Server 2 gt Name LoginID Password FTPcPoriNumber 21 FTPMode 1 ConneciMode 1 lt AttachedPicture gt Size 2 FileNameMode 1 lt HowToUse gt Detail 1 lt bySchedule gt Monday 1 Tuesday 1 Wednesday 1 Thursday 1 Friday 1 Saturday 1 Sunday 1 Pattern1 Start 8 Patterni End 17 Pattern2Start 8 Pattern2End 17 Interval 1 FileName Server1 Path Server2Path lt byAlarm gt NumberOfPrePicture 10 NumberOfPostPicture 10 Interval 1 AiFileName MdFileName Serveri Path Server2Path lt byExtControlln gt Interval 60 FileName Servert Path Server2Path lt Accumulation gt Mode 1 Interval 60 OverWriting 1 Camera Mail lt Authentication gt Mode 1 SMTPServer POP3Server POP3ID POP3Password AdminMailAdar lt ConditionByAlarmIn gt Mode 1 Subject Body URLMode 1 URLInfo AttachMode 1 lt ConditionByMotion gt Mode 1 Subject Body URLMode 1 URLInfo AttachMode 1 lt AttachSize gt AttachSize 1 lt Recipient gt TOSHIBA Corp 128 To the next page Appendix B TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page lt MailTo 1 gt RecipientAdar Alarmin 1 Motion 1 lt Ma
12. Explanation of lt clientID gt 68 Modified 7 4 5 Notes 4 70 Modified 7 6 2 Input Explanation of lt clientID gt 71 Modified 7 7 2 Input Explanation of lt clientID gt 107 Typo Refenrece gt Reference 111 Modified 15 2 5 Notes 2 113 Modified 15 3 5 Notes 2 127 Modified Note of Normal 1 OUT Error 2 Out and Emergency Normal 1 OUT 1 00 Release 1 00 SC T Hamada Thu Jul 27 2006 TOSHIBA Corp TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC Contents About AR od di disipa cbt DOR R 1 Firmware version corresponding to this specification gt ri nn RR RR e t ee t anna a nana 1 API PROTO CO gt cardo A A A A A A A eed maa hagas cea 1 RFC2068 HTTP error code Sencor nan a ES ba ai 1 II Comparison between WEB Setting Page and API functions cece eee e enter eee eee eee ener sere edna eeee eee eaaaeeeeeeeeeeaaaaaeneeeees 2 PAPE RY DOS gt icc atid esa A A ee a it Se ev 2 APLEUNCUIONS S cion a ia tias 2 ill SRestrictlons on the APLI A A ev cee ee ed 5 IV API LIS tin lina aid 6 V API Termination Status icon A ee sl ees 9 Terminatl n status classlfticatiON gt 00 A A A A A e 9 Input parameter and record Control to log gt rn cnn RR RR ee etet lete 10 VI IK WB15A Setting Type API List oia it a e A A dai 12 T Camera Settings sico A At tdi 13
13. eee teeter reer eee EEE Rene eee RAR RRA RR RR ee ee ee ee ee ee ee eeeee 99 1 3 3 Reference of Time and Date Settingss cee side teenies aaa 100 13 4 Reference of Current Camera Time siri eee aba eee RR ezt kesek sen an kies s 101 14 Reference of Log Management Setting 0 ccc ce cece een eee eee eee eee RRA RAR ee ee ee ee ee ee aaa nana e ee ee 102 14 1 Reference of Log Filtering Settings asian a os 103 14 27 Reference Of LOG E ISIS cease Sevens a a a a T aa E dea dieca ii 104 IX IK WB15A List Operation type API List nenene iri iea kaea a aiaa pasa di 106 15 List Operation ia 107 15 1 Reference Deletion of Alarm In Lit ii oa 108 15 2 Reference Deletion of Normal List sersa e ion gz EE 110 15 3 Reference Deletion of Ext Control In List 0 0 0 cece cece cece teeter eee renee nena ner RR RRA eee aaa ee ee nana anna nanda 112 X IK WB15A External Storage Operation Type API List reer etree rere senate eee eeeaaaaeeeeeeeeeeeaaaaaeees 114 16 External Storage ssc E E heh a bagel deleg akol Shon etes lelet ET kt es ee indi Dina ab Math li 115 16 1 Check Storage Inserted Status cess a ee zeke deviate eecnadieds ses ba 116 16 2 Execute Storage Mount UNMOUN tees ss 5 2828 elb ae leenetedts A tse ls E iai esti nas ell sarees 117 16 3 Check Storage Mount Status adds 118 eY E e LAANE LEEN LOIA Te EEE E AAT hs A Se Ld bee ots Le eae po DA SOLDA Dinda
14. lt Camera 16 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 17 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 18 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 19 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 20 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 21 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 22 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 TOSHIBA Corp 132 To the next page Appendix B TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page lt Camera 23 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 24 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 25 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 26 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 27 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 30 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 User Info LoginRestriction 2 Admin Use
15. 14 2 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 14 2 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetloglist cgi indicates the notification data format to the client when data has been obtained normally success Total log messages n1 r n Show all log messages Wn list r n Appeared log messages n2 n1 n3 r n fail 40 FailToGet rin i q both cases of success and failure the format is not the HTML format The output format of each log list is as follows First line Indicates the total number of logs saved in the IK WB15A by n1 Second line Indicates the conditions entered by log filter display condition setting Third line Indicates the actual log list in and after this line Last line Indicates the number of logs filtered in the condition shown in the second line by n2 The ratio occupied in the whole is indicated by n3 The output format of each log list is as follows 1 Sat Sep 10 05 01 34 2005 2000221 rgst gt Success to save Camera info 1 2 3 4 TOSHIBA Corp 104 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 5 Log item number 6 Date time of log output ASCII time 7 Log control number 8 Contents of detailed log message 14 2 4 Example 1 http 10 1 0 1 api wbgetloglist cgi 14 2 5 Notes 1 Whe
16. Live Picture stream Playback Picture stream Live Audio stream and Abort stream are common APIs However the meaning of each parameter varies depending on the target to be executed 3 Itis desirable that the stream should be stopped by abort5 or abort10 This will reduce the network load of the IK WB15A 4 The number of getstream cgi lt streamType gt 1 connections is up to 10 clients simultaneously JPEG and WAV are independent respectively For details refer to Appendix D TOSHIBA Corp 68 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 7 5 One shot Live Audio __live wav 7 51 Syntax 1 http lt camip gt admin __live wav 7 5 2 Input N A 7 5 3 Output Only one frame of audio data for 1 second is downloaded in WAV format 7 54 Example 1 http 10 1 0 1 api __live wav 7 5 5 Notes 1 The audio data that can be obtained by this API is a WAV file of one second unit To obtain multiple audio data start this API in succession 2 Note that the directory of this API is different from those of the other APIs 3 Must be 1fps For details refer to Appendix D TOSHIBA Corp 69 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 7 6 Abort stream abort5 getstream cgi 7 6 1 Syntax 1 http lt camip gt api getstream cgi lt clientID gt amp lt uniquelD gt amp lt ID gt amp lt PW gt amp lt stream Type gt amp lt interval gt amp l
17. 52 OKbutExtControlOFF r n Though the registration related to the Ext Control In was executed the Ext Control In function is set to OFF Input parameter and record control to log gt The API checks whether the input parameter Input has an appropriate format For a request that does not meet the specified format one of codes 30 to 35 will be notified Each API can specify an option by parameter as to whether the execution result is to be recorded in the log This function can be specified as the entry OpeLog and can be specified at any position that is behind the type attribute Namely the following two indicates all the same setting operation http 10 1 0 1 wbsetcambasic cgi type Set amp OpeLog No amp Resolution 3 1 http 10 1 0 1 wbsetcambasic cgi type Set amp Resolution 3 amp OpeLog No OTOSHIBA Corp 10 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC However for the following an error is notified because OpeLog is specified ahead of the type attribute as described before http 10 1 0 1 wbsetcambasic cgi OpeLog No amp type Set amp Resolution 3 For an API without the type attribute like wogetcambasic cgi there is no limitation on the arrangement of the entry OpeLog OpeLog is specified by Yes or No For the other specification an error is notified OpeLog is an optional entry If omitted it is recognized as OpeLog Yes by
18. Camera FrameRate r n Rate value r n 9 2 4 Example 1 http 10 1 0 1 api wbgetcamframerate cgi 9 2 5 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 77 TOSHIBA Network Camera IK WB15A 9 3 Reference of Alarm Settings wbgetcamalarm cgi 9 3 1 Syntax 1 http lt camip gt api wogetcamalarm cgi SDK Ver 1 00 SC 9 3 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 9 3 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetcamalarm cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n r n Camera Alarm r n lt AlarmType gt r n Mode value r n InputPolarity va ue r n lt MotionDetection gt r n Mode value r n Sensitivity value r n lt HoldingOutTime gt r n Time value r n 9 3 4 Example 1 http 10 1 0 1 api wbgetcamalarm cgi 9 3 5 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 78 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 9 4 Reference of Recording Settings wbgetcamrecord cgi 9 4 1 Syntax 1 http lt camip gt api wbgetcamrecord cgi
19. Every API is started and executed as cgi HS YS NH On and after the next page the camera reference API is shown TOSHIBA Corp 89 TOSHIBA Network Camera IK WB15A 11 1 Reference of Network Basic Settings wbgetnwkbasic cgi 11 1 1 Syntax 1 http lt camip gt api wbgetnwkbasic cgi SDK Ver 1 00 SC 11 1 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 11 1 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgeinwkbasic cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Mn Network General r n CameraName value r n DHCPMode value r n IPAddress value r n SubnetMask va ue r n DefaultGateway value r n 11 1 4 Example 1 http 10 1 0 1 api wbgetnwkbasic cgi 11 1 5 Notes PrimaryDNS value r n SecondaryDNS value r n CameraAutoDetection value r n 1 HTTPPortNumber va ue r n HostName value r n DomainName value r n DNSUpdate value r n DHCPOption value r n 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 90 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 11 2 Reference of Bandwidth Control Settings wbgetnwkbandwidth cgi 11 2
20. Sunday Sunday 1 Schedule 1 start time Pattern1 Start 0 23 8 hour Schedule 1 end ume Pattern1End Fidan Tita a Miriam AZoM 17 hour Schedule 2 start time Pattern2Start 13 1pm 22 10pm 23 11pm 8 hour Schedule 2 end time Pattern2End 17 hour OTOSHIBA Corp To the next page TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page Item Type Entry name Entry value Std val Unit Recording Cycle type Normal Interval 1 2 3 5 10 30 60 120 180 60 second Overwrite type RecOverwriting Mode 1 0FF 2 0N 1 Log output control of cgi common to all types OpeLog No Yes default Yes omissible 1 4 3 Output Code Status Code Status Code Status 20 OK 33 InvalidOperand 52 OKbutExtControlOFF 30 InvalidType 34 NoEntryData 92 CriticalError 31 InvalidEntry 50 OKbutExtAlarmOFF 32 InvalidValue 51 OKbutMotionOFF 50 Although registration succeeded under conditions of both type alarm and AlarminRecMode 2 the Alarm In function is set to OFF Ref Alarm Settings 51 Although registration succeeded under conditions of both type alarm and MotionRecMode 2 the Motion Detection function is set to OFF Ref Alarm Settings 52 Although registration succeeded under conditions of both type alarm and ExtControllnRecMode 2 the Ext Control In function is set to OFF Ref Alarm Settings
21. 1 Reset all the camera information to the factory set status provided at delivery from the factory 2 Because the network information is changed the client may not receive the normal termination status 20 OK r n at completion of this API execution 3 If any error is found in an input parameter to the API the camera information is not reset to the factory set status provided at delivery from the factory Accordingly the client can receive all the status described in the output 4 It may take about 30 seconds to complete the operation 5 After completion of the operation the camera is not rebooted automatically The power supply of the camera must be turned on off or the camera must be separately rebooted by wbsetadmincamreboot cgi 6 Inside the camera the information is reset to the factory set status provided at delivery step by step For details refer to Appendix B OTOSHIBA Corp 54 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 5 6 Reboot Camera wbsetadmincamreboot cgi 5 6 1 Syntax 1 http lt camip gt api wbsetadmincamreboot cgi type Reboot 5 6 2 Input Item Type Entry name Entry value Std val Unit Reboot Camera type Reboot Log output control of cgi common to all types OpeLog No Yes default Yes omissible 5 6 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand
22. Delete O X O X O X O Xx Picture Audio LIVE Picture Stream X O O O O O O LIVE Picture One Shot Since the Viewer autom O O O O O O PLAY Picture Stream atically calculates the O X O X O X LIVE Audio Stream parameters ssercannst Ty O O O O O adjust the stream Abort O O O O TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page WEB operation API operation Setting Reference Setting Reference Admin User Admin User Admin User Admin User Reference All Information O Configuration O Configuration o x o x General Operation Information Information List Operation O O Camera Recording Camera Recording o x o X Controller Replay list Controller Replay list X X External Storage Operation O X O X O X O X PTZ Operation O O O O OTOSHIBA Corp TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC lll Restrictions on the API When using this API group take the following items into consideration 1 Method type 2 3 4 5 6 Method type APIYE GET POST Information setting type API wbset type O X Information reference type API wbget type O X Image audio type API getstream type O X List operation type API wblist type O O External storage operation type API wbstorage type O O PTZ operation type API pantiltapi wbset type O O O Supported by the API X No
23. cr ree ea Gea aa a ra aaa aa a aca E RE RESE 46 5 Administrator Functlons aisinn o e pi aE wage Breads t l a a ne edar as tonta 48 5 1 User bogim RES HG N ia a A adicta 49 5 2 User Operation Restriction Control el 50 5 3 NTRA A ia c 52 5 4 Set Time Manually 2 A Ai de 53 5 5 Reset All Camera Informations to Default rir rice ae ana a rrraaaa RR eee seca eeee eee 54 5 6 Reboot Camera 6 Eog Management ici A aia 6 1 Filter Set nd 5 sree A RENA KET aN Sates Meet ni SU Domes NG eee oes ie Mata na te 6 2 Clear LOQS e eeeseeeenteeeeeeeeees Vil IK WB15A Picture Audio type API List cece ere eee RR snari insense 60 7 Get Pictures AUd O 225 sz re stee EGE Telep dica 61 7 1 Get Live Rictures Dy SiteamING szeszet zet ve t s pias Chee Tenet Teese da 62 7 2 One Shot Live Pitu a ia 64 7 3 Get Playback Pictures by Streaming iii alias 65 7 4 Get Live Audio pY SIEM dlrs 67 7 5 One shot Live A CIO io A A QU pay Pes eis A A A 69 7 6 Abort stream aDO leen a A A A e a id A A 70 7 7 Abort stream abortt OJ zs egesze cdta ba 71 Vill IK WB15A Data Reference Type API LlSt ooo ct e ines 72 8 Reference of All Setting Information eee RR RARA RR ee ee ee ee ee eeee 73 8 1 Reference Of All Setting NO Mati cc a A anda 74 9 Reference of Camera Setting mii oia 75 9 1 Reference of Camera Basic SettingS nica at aa 76 9 2 Reference of Frame Ra
24. r n lt NTP gt nn 13 3 4 Example 1 http 10 1 0 1 api wogetadminTaD cgi 13 3 5 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 100 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 13 4 Reference of Current Camera Time wbgetadmintime cgi 13 4 1 Syntax 1 http lt camip gt api wbgetadmintime cgi 13 4 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 13 4 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetadmintime cgi indicates the notification data format to the client when data has been obtained normally 20 OKWn Mn 2006 6 30 13 25 03Mn 13 4 4 Example 1 http 10 1 0 1 api wbgetadmintime cgi 13 4 5 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 101 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 14 Reference of Log Management Setting wbgetlogconditions cgji Reference of Log Filtering Settings wbgetloglist cgi Reference of Log Lists wbget log func cgi 1 2 3 4 1 2 3 4 Indicates a reference API Indicates a log type reference API Indicates the function matched to th
25. wbgetnwkmac cgi indicates the notification data format to the client when data has been obtained normally MAC 01 23 45 67 89 ab 11 5 4 Example 1 http 10 1 0 1 api wbgetnwkmac cgi 11 5 5 Notes 1 This API does not require any parameter OTOSHIBA Corp TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 12 Reference of Administrator Functions wbgetmultiscreen cgi Reference of Multi Screen Information wbget multiscree cgi 1 2 3 1 Indicates a reference API 2 Indicates an Multi Screen reference API 3 Every API is started and executed as cgi On the next page the camera reference API is shown TOSHIBA Corp 95 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 12 1 Reference of Multi Screen Information wbgetmultiscreen cgi 12 1 1 Syntax 1 http lt camip gt api wbgetmultiscreen cgi 12 1 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 12 1 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetmultiscreen cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Mn Mulsti Screen Display in lt DisplayMode gt nn Mode value r n lt MyCameralnfo gt r n Name value r n Addr value r n HTTPPortNumber va ue r n Kind value r n Selection
26. 1 65535 21 FTP mode FTPMode 1 PORT 2 PASV 1 Connecting method ConnectMode 1 Reconnect 1 2 Continuous Connection OTOSHIBA Corp 21 To the next page TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page Item Type Entry name Entry value Std val Unit 29 FTP server server name type Server 2 Name any max 128 bytes Login ID LoginID any max 32 bytes Password Password any max 32 bytes Port number FTPcPortNumber any 1 65535 21 FTP mode FTPMode 1 PORT 2 PASV 1 Connecting method ConnectMode 1 Reconnect 1 2 Continuous Connection Transfer image type AttachedPicture Size 1 160x120 QQVGA 2 E 2 320x240 QVGA 3 640x480 VGA 5 1280x960 SXVGA FileNameMode 1 with Time Stamp 1 2 Fixed FTP server usage mode type HowToUse Detail Primary Switch 1 E 1 Server 1 OFF 2 Server 1 ON 3 Server 2 OFF 4 Server 2 ON Schedule Monday type bySchedule Monday 1 OFF 1 2 All Day T T 1 pesa Esti 3 Schedule 1 Wednesday Wednesday 4 Schedule 2 1 Thursday Thursday 1 Friday Friday 1 Saturday Saturday 1 Sunday Sunday 1 Schedule 1 start time Pattern1 Start 0 23 8 hour Schedule 1 end ti P 1E 17 h chedule 1 en mie attern1 End Foam dam iiiam our Schedule 2 start time Pattern2Start 12 0pm 13 1pm 22 10pm 8 hour Sch
27. 1 Syntax 1 http lt camip gt api wbgetnwkbandwidth cgi 11 2 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 11 23 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgeinwkbandwidth cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Mn Network BandWidth r n Mode value r n Numeric value r n BandWidth value r n 11 2 4 Example 1 http 10 1 0 1 api wbgetnwkbandwidth cgi 11 2 5 Note 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 91 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 11 3 Reference of DDNS Settings wbgetnwkddns cgi 11 3 1 Syntax 1 http lt camip gt api wogetnwkddns cgi 11 3 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 11 3 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgeinwkddns cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Mn Network DDNSj r n Mode va ue r n Server value r n UserlD value r n
28. 128 bytes E Backup mode type Accumulation Mode 1 OFF 2 0N 1 Accumulation Cycle Interval 1 2 5 10 15 30 60 120 300 600 900 60 second 1800 3600 Overwrite OverWriting 1 OFF 2 0N 1 Log output control of cgi common to all types OpeLog No Yes default Yes omissible TOSHIBA Corp 23 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 1 5 3 Output Code Status Code Status Code Status 20 OK 33 InvalidOperand 52 OKbutExtControlOFF 30 InvalidType 34 NoEntryData 92 CriticalError 31 InvalidEntry 50 OKbutExtAlarmOFF 32 InvalidValue 51 OKbutMotionOFF 50 Although registration succeeded under conditions of type FTPCondition Mode 3 and AlarminMode 2 the Alarm In function is set to OFF Ref Alarm Settings 51 Although registration succeeded under conditions of type FTPCondition Mode 3 and MotionMode 2 the Motion Detection function is set to OFF Ref AlarmSettings 52 Although registration succeeded under conditions of both type FTPCondition and Mode 4 the Ext Control In function is set to OFF Ref Alarm Settings Example http 10 1 0 1 api wbsetcamfiprecord cgi type Default http 10 1 0 1 api wbsetcamftprecord cgi type FT PCondition amp Mode 3 amp AlarmlInMode 2 amp MotionMode 2 http 10 1 0 1 api wbsetcamftprecord cgi type Server 1 amp Name F TPs amp LoginID lt base64enc gt amp P assword lt basee64enc gt http 10 1 0 1 api wbsetcamft
29. 2310 54 47 34 519 14 990 3 1391 23 1862 43 2334 53 71 33 542 13 1014 4 1414 24 1886 44 2357 52 94 32 566 12 1037 5 1438 25 1909 45 2381 51 118 31 589 11 1061 6 1461 26 1933 46 2404 50 141 30 613 10 1084 7 1485 27 1956 47 2428 49 165 29 636 9 1108 8 1509 28 1980 48 2451 48 189 28 660 8 1131 9 1532 29 2004 49 2475 47 212 27 684 7 1155 10 1556 30 2027 50 2499 46 236 26 707 6 1179 11 1579 31 2051 51 2522 45 259 25 731 5 1202 12 1603 32 2074 52 2546 44 283 24 754 4 1226 13 1626 33 2098 53 2569 43 306 23 778 3 1249 14 1650 34 2121 54 2593 42 330 22 801 2 1273 15 1674 35 2145 55 2616 41 354 21 825 1 1296 16 1697 36 2169 56 2640 40 377 20 849 Center 17 1721 37 2192 39 401 19 872 0 1320 18 1744 38 2216 38 424 18 896 19 1768 39 2239 TOSHIBA Corp Appendix C 138 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 6 Relation between TILT degree and value in API Degree Value Degree Value Degree Value Degree Value Tilt Up 35 889 20 555 5 221 49 1200 34 866 19 533 4 199 48 1178 33 844 18 510 3 177 47 1156 32 822 17 488 2 154 46 1133 31 800 16 466 1 132 45 1111 30 777 15 444 Level 44 1089 29 755 14 421 110 43 1067 28 733 13 399 Tilt Down 42 1044 27 711 12 377 1 88 41 1022 26 688 11 355 2 66 40 1000 25 666 10 332 3 44 39 978 24 644 9 310 4 22 38 955 23 622 8 288 5 0 37 933 22 599 7 266 36 911 21 577 6 243
30. 31 InvalidEntry 34 NoEntryData 5 6 4 Example 1 http 10 1 0 1 api wbsetadmincamreboot cgi type Reboot 5 6 5 Notes 1 Reboot the camera 2 The client may not receive the normal termination status 20 OK r n at completion of this API execution 3 If an error is found in an input parameter to the API the camera is not rebooted Accordingly the client can receive all the status described in the output OTOSHIBA Corp 55 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 6 Log Management wbsetlogconditions cgi Filter Settings wbsetlogclear cgi Clear Logs wbset log func cgi 1 2 3 4 1 Indicates a setting API 2 Indicates a log management API 3 Indicates the function matched to the WEB setting page 4 Every API is started and executed as cgi On and after the next page the network setting API is shown TOSHIBA Corp 56 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 6 1 Filter Settings wbsetlogconditions cgi 6 1 1 Syntax 1 http lt camip gt api wbsetlogconditions cgi type Default 2 http lt camip gt api wbsetlogconditions cgi type Set amp Display lt value gt amp Filter lt value gt 8 6 1 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default Display mode type Set
31. 34 PresetNumber 35 PresetNumber 36 PresetNumber 37 PresetNumber 38 PresetNumber 39 PresetNumber 40 PresetNumber 41 PresetNumber 42 PresetNumber 43 PresetNumber 44 1 PresetNumber 45 1 PresetNumber 46 1 PresetNumber 47 1 PresetNumber 48 1 PresetNumber 49 1 PresetNumber 50 1 PresetNumber 51 1 PresetNumber 52 1 PresetNumber 53 1 PresetNumber 54 1 PresetNumber 55 1 PresetNumber 56 1 PresetNumber 57 1 PresetNumber 58 1 PresetNumber 59 1 PresetNumber 60 1 PresetNumber 61 1 PresetNumber 62 1 PresetNumber 63 1 PresetNumber 64 1 Network General CameraName nwcam15 DHCPMode 2 IPAddress 192 168 0 30 SubnetMask 255 255 255 0 DefaultGateway PrimaryDNS SecondaryDNS CameraAutoDetection 1 HTTPPortNumber 80 HostName DomainName DNSUpdate 1 DHCPOption 1 Network BandWidthControl Mode 1 TOSHIBA Corp 131 To the next page Appendix B TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page Numeric 100 BandWidth 2 Network DDNS Mode 1 Server UserlD Password Network FTPserver Mode 1 LoginID cm9vdA Password aWt3Yg MaxConnection 1 Mulsti Screen Display lt DisplayMode gt Mode 1 lt MyCameralnto gt Name nwcam15 Addr 192 168 0 30 HTTPPortNum
32. 6 4 Example 1 http 10 1 0 1 api wbpresetapi cgi presetname_1 Neigbor 1 amp presetname_2 Garage amp presetname_55 Wall amp savesysvar 2 http 10 1 0 1 api wbpresetapi cgi presetname_33 ParkingArea amp savesysvar 2 6 5 Note 1 The position name can be specified at random 2 The Position Name which is not specified by this API will remain unchanged OTOSHIBA Corp 37 TOSHIBA Network Camera IK WB15A 2 7 Easy Preset Move wbpresetapi cgi 2 7 1 Syntax 1 http lt camip gt api wbpresetapi cgi cont_4 lt preset D gt SDK Ver 1 00 SC 2 7 2 Input Item Entry name Entry value Std val Unit Preset Number where to go to cont_4 lt presetlD gt 3 Log output control of cgi common to all types OpeLog No Yes default Yes omissible lt presetID gt is determined by the following method lt presetID gt 256 lt presetNumber gt For example to go to Preset Number 1 the parameter would be cont_4 257 2 7 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 2 7 4 Example 1 http 10 1 0 1 api wbpresetapi cgi cont_4 257 2 7 5 Note N A OTOSHIBA Corp 38 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 3 Network Settings wbsetnwkbasic cgi Basic Settings wbsetnwkbandwitdh cgi Bandwidth Control Settings whbsetnwkddns
33. 64 bytes Message Body any max 128 bytes URL Send URL URLMode 1 OFF 2 0N 1 URL Information URLInfo any max 128 bytes Attach Image AttachMode 1 OFF 2 0N 1 E mail sending by Alarm In type ConditionByMotion Mode 1 OFF 2 0N 1 Subject Subject any max 64 bytes Message Body any max 128 bytes URL Send URL URLMode 1 OFF 2 0N 1 URL Information URLInfo any max 128 bytes Attach Image AttachMode 1 OFF 2 0N 1 OTOSHIBA Corp 25 To the next page TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page Item Type Entry name Entry value Std val Unit Attached image size type AttachSize AttachSize 1 160x120 QQVGA 1 2 320x240 QVGA 3 640x480 VGA 5 1280x960 SXVGA Always send to administrator type Recipient MustSendAdminMode 1 OFF 2 0N 1 e mail address Send to mail address 1 type MailTo 1 RecipientAddr any max 64 bytes Send when Alarm IN Alarmin 1 OFF 2 Checked 1 Send when Motion detected Motion 1 OFF 2 Checked 1 Send to mail address 2 type MailTo 2 RecipientAddr any max 64 bytes Send when Alarm IN Alarmin 1 OFF 2 Checked 1 Send when Motion detected Motion 1 OFF 2 Checked 1 Send to mail address 3 type MailTo 3 RecipientAddr any max 64 bytes Send when Alarm IN Alarmin 1 OFF 2 Checked 1 Send when Motion detected Motion 1 OFF 2 Chec
34. API If an entry has an error the recognition of the OpeLog specification by API depends on whether the error occurs before OpeLog is recognized or not Namely http 10 1 0 1 wbsetcambasic cgi type Set amp OpeLog No amp Resolution ABCDEFG In the above case the API detects the illegal value of Resolution after detecting OpeLog No Accordingly if an error is detected by the API it is not output to the log However http 10 1 0 1 wbsetcambasic cgi type Set amp Resolution ABCDEFG amp OpeLog No In the above case the API detects the illegal value of Resolution before detecting OpeLog No When detecting an error in the Input parameter the API proceeds internally to error notifying processing Accordingly OpeLog No is ignored so that it is output to the log For this reason when the output to the log is controlled by the client it is recommended to describe the entry OpeLog after the type attribute as shown in 1 Lastly exceptions about the entry OpeLog are shown below In the getstream type API the OpeLog option cannot be specified wbstorage type API wblist type API and wosetadmincamreboot cgi are free from the above restrictions having a free format TOSHIBA Corp 11 TOSHIBA Network Camera IK WB15A VI IK WB15A Setting Type API List SDK Ver 1 00 SC
35. Example Picture 3 amp NumberOfPostPicture 10 Notes akhWwWNnN NU rer aH 4 http 10 1 0 1 api wbsetcamrecord cgi type Default http 10 1 0 1 api wbsetcamrecord cgi type AlarmgAlarmInRecMode 18 ExtControllnRecMode 28MotionRecMode 28NumberOfPre http 10 1 0 1 api wbsetcamrecord cgi type Normal8Mode 1 http 10 1 0 1 api wbsetcamrecord cgi type RecOverwritingaMode 1 If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting is performed Multiple type lt value gt cannot be enumerated simultaneously This API must be started for each type For only entered item setting is performed For the other items their existing values are held OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes If both AlarminRecMode 2 and MotionRecMode 2 are simultaneously specified in the alarm setting OFF status at type Alarm the Alarm In status always has priority at status notification OTOSHIBA Corp 20 type Default is an exception SDK Ver 1 00 SC TOSHIBA Network Camera IK WB15A 1 5 FTP Recording Settings wbsetcamftprecord cgi 1 5 1 Syntax 1 http lt camip gt api wbsetcamftprecord cgi type Default 2 http lt camip gt api wbsetcamftprecord cgi type FTPCondition amp Mode lt value gt amp AlarminMode lt value gt amp 3 http lt
36. ID that is base64 encoded or the Originally lt ID gt can be left blank only when the user limitation setting is administrator ID Invalid OFF at obtaining the image data of a LIVE image _live jpg In the IK WB15A it can be left blank as a parameter lt PW gt Enter the user ID that is base64 encoded or the Originally lt PW gt can be left blank only when the user limitation setting is administrator ID Invalid OFF at obtaining a LIVE image In the IK WB15A it can be left blank as a parameter lt streamType gt Specify 0 for the type of the LIVE image to be obtained _live jpg 0 lt interval gt Set the image distribution interval in ms This value cannot exceed camera s capability If the specified distribution interval exceeds the capability on the camera side the camera performs image distribution with its maximum capability at that time lt mode gt Specify a fixed number of images or a fixed period as the Fixed number of images 0 LIVE image obtaining method Fixed period 1 lt value gt Set the numeric value for the mode specified in lt mode gt When lt mode gt is O set the number of images in lt value gt When lt mode gt is 1 set the time interval in lt value gt lt timeout gt Set the execution timeout value in ms Set the execution timeout value in ms for the case where a non communication status is continued over a certain period with the client while lt image field gt is output 7 1 3 Outp
37. IV API List The APIs available for the IK WB15A are shown below as each of the 5 types Item Menu API name Camera Settings Basic wbsetcambasic cgi Frame Rate wbsetcamframerate cgi Alarm wbsetcamalarm cgi Recording wbsetcamrecord cgi FTP Recording wbsetcamftprecord cgi E mail wbsetcammail cgi Audio wbsetcamsound cgi PAN TILT Settings Basic wbsetptbasic cgi Operation Range Preset wbsetptpreset cgi Auto Patrol wbsetptautopatrol cgi F Easy Preset Operations wbpresetapi cgi D Network Settings Basic wbsetnwkbasic cgi 2 Bandwidth Control wbsetnwkbandwidth cgi a DDNS wbsetnwkddns cgi FTP Server wbsetnwkftpserver cgi Multi Screen Settings Adding and Removing Cameras wbsetmultiscreen cgi Admin Functions User Login Restrinction wbsetadminuserinfo cgi User Operation Restriction wbsetadminuserfunctions cgi Date and Time NTP wbsetadminTaD cgi Manual Setting wbsetadmintime cgi FW Update Configuration Import Export Reset to Default wbsetadminsetdefault cgi Camera Rebooting wbsetcamreboot cgi Log Management Filter Settings wbsetlogconditions cgi Delete wbsetlogclear cgi LIVE Picture LIVE Picture Stream getstream cgi gt I LIVE Picture One Shot __live jpg a 2 Alam Picture PLAY Picture Stream getstream cgi 5 8 LIVE Audio LIVE Audio Stream getstream cgi Abort Abo
38. Password value r n 11 34 Example 1 http 10 1 0 1 api wbgetnwkddns cgi 11 3 5 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 92 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 11 4 Reference of FTP Server Settings wbgetnwkftpserver cgi 11 4 1 Syntax 1 http lt camip gt api wbgetnwkftpserver cgi 11 4 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 11 43 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgeinwkftpserver cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Mn Network FTPserver r n Mode va ue r n LoginID va ue r n Password value r n MaxConnection value r n 11 4 4 Example 1 http 10 1 0 1 api wbgetnwkftpserver cgi 1145 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 93 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 115 Get MAC Address wbgetnwkmac cgi 11 5 1 Syntax 2 http lt camip gt api wbgetnwkmac cgi 11 5 2 Input Item Type Entry name Value 11 5 3 Output Code Status
39. SDK Ver 1 00 SC 15 1 Reference Deletion of Alarm In List wblistalarm cgi 15 1 1 Syntax 1 http lt camip gt api wblistalarm cgi type Show 2 http lt camip gt api wblistalarm cgi type RemoveAll 3 http lt camip gt api wblistalarm cgi type RemoveSpangStartDT lt yyyymmddHHMMSS gt 8EndDT lt yyyymmdadHHMMSS gt 15 1 2 Input Item Type Entry name Value Reference of all list type Show All deletion of list type RemoveAll Deletion of list by Time and Date type RemoveSpan StartDT yyyymmddHHMMSS format EndDT yyyymmddHHMMSS format Log output control of cgi common to all types OpeLog No Yes default Yes omissible 15 1 3 Output 1 When at type Show Code Status Code Status 20 OK 60 FailAction 31 InvalidEntry 32 InvalidValue wblistalarm cgi type Show indicates the notification data format to the client when data has been obtained normally 20 OKinn Mn alarmlist r n alarmlist r n In both cases of success and failure the format is not the HTML format At success the list output format is as follows 1 motion Thu Fe1 005 01 34 2003 1 2 3 OTOSHIBA Corp 108 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 1 List item number 2 Type of alarm list exalarm Alarm In motion Motion Detection 3 List recoding date time ASCII time When a list is to be output or when a list is being output an error may occur a
40. TILT position Action Formula Range of n Panning to n degree from the center n 56 x24 56 lt n lt 56 Tilting to n degree from the level n 5 x22 5 lt N lt 49 Refer to Tables in 5 and 6 below 3 Formula to get approximate Value of Left Right Top Bottom Limit Setting Formula Range of n Left Limit n 56 x24 56 lt Nn lt 56 Right Limit n 56 x24 56 lt Nn lt 56 Top Limit n 5 x22 49 lt n lt 5 Bottom Limit n 5 x22 49 lt n lt 5 TOSHIBA Corp Appendix 134 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 4 Value for wbpantiltapi cgi when using Ceiling Mount option Value Pan Left wbpantiltapi cgi cont 2 1 Pan Right wbpantiltapi cgi cont 2 2 Tilt Up wbpantiltapi cgi cont_2 4 Tilt Down wbpantiltapi cgi cont 2 8 5 Relation between PAN degree and value in API Degree Value Degree Value Degree Value Degree Value Degree Value Degree Value Pan Left 37 448 17 919 Pan Right 20 1791 40 2263 56 0 36 471 16 943 1 1344 21 1815 41 2286 55 24 35 495 15 966 2 1367 22 1839 42 2310 54 47 34 519 14 990 3 1391 23 1862 43 2334 53 71 33 542 13 1014 4 1414 24 1886 44 2357 52 94 32 566 12 1037 5 1438 25 1909 45 2381 51 118 31 589 11 1061 6 1461 26 1933 46 2404 50 141 30 613 10
41. Tilt type reference API 3 Indicates the function matched to the WEB setting page 4 Every API is started and executed as cgi On and after the next page the camera reference API is shown TOSHIBA Corp 85 TOSHIBA Network Camera IK WB15A 10 1 Reference of Pan Tilt Basic Settings wbgetptbasic cgi 10 1 1 Syntax 1 http lt camip gt api wbgetptbasic cgi SDK Ver 1 00 SC 10 1 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 10 1 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetptbasic cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n ResumeTime va ue r n Mn lt LeftLimitSetting gt n n PanTilt General r n Mode value r n lt PTCondition gt r n Degree value r n ScanSpeed va ue r n PowerUp value r n FreezeFrame value r n lt AssociationToAlarm gt r n Mode value r n PTByAlarmin value r n PTByMotion va ue r n PresetNumber va ue r n Resume value r n 10 1 4 Example 1 http 10 1 0 1 api wbgetptbasic cgi 10 15 Notes lt RightLimitSetting gt r n Mode value r n Degree va ue r n lt TopLimitSetting gt r n Mode value r n Degree va ue r n lt BottomLimitSetting gt Wn Mode value r n Degree va ue r n 1 Wh
42. Ver 1 00 SC 1 http lt camip gt api wblistnormal cgi type Show 2 http lt camip gt api wblistnormal cgi type RemoveAll 3 http lt camip gt api wblistnormal cgi type RemoveSpan amp StartD T lt yyyymmddHHMMSS gt amp EndDT lt yyyymmddHHMMSS gt 15 2 2 Input Item Typ e Entry name Value Reference of all list type Show All deletion of list type RemoveAll Deletion of list by Time and Date type RemoveSpan StartDT yyyymmddHHMMSS format EndDT yyyymmddHHMMSS format Log output control of cgi common to all types OpeLog No Yes default Yes omissible 15 2 3 Output 1 When at type Show Code Status Code Status 20 OK 60 FailAction 31 InvalidEntry 32 InvalidValue wblistnormal cgi type Show indicates the notification data format to the client when data has been obtained normally 20 OK r n Mn normallist r n normallist r n In both cases of success and failure the format is not the HTML format The list output format is as follows 1 normal Thu Fe1 005 01 34 2003 1 2 3 TOSHIBA Corp 110 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 1 List item number 2 Type of normal list normal Normal list 3 List recoding date time ASCII time When a list is to be output or when a list is being output an error may occur and the list output may be stopped half
43. api wblistextcontrol cgi type Show SDK Ver 1 00 SC 2 http lt camip gt api wblistextcontrol cgi type RemoveAll 3 http lt camip gt api wblistextcontrol cgi type RemoveSpang StartDT lt yyyymmddHHMMSS gt 8EndDT lt yyyymmddHHMMSS gt 15 3 2 Input Item Type Entry name Value Reference of all list type Show All deletion of list type RemoveAll Deletion of list by Time and Date type RemoveSpan StartDT yyyymmddHHMMSS format EndDT yyyymmddHHMMSS format Log output control of cgi common to all types OpeLog No Yes default Yes omissible 15 3 3 Output 1 When at type Show Code Status Code Status 20 OK 60 FailAction 31 InvalidEntry 32 InvalidValue wblistextcontrol cgi type Show indicates the notification data format to the client when data has been obtained normally 20 OK r n r n extcontrollist r n extcontrollist r n In both cases of success and failure the format is not the HTML format The list output format is as follows 1 extcontrol 1 2 Thu Fe1 005 01 34 2003 3 OTOSHIBA Corp 112 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 1 List item number 2 Type of Ext Control In list extcontrol Ext Control In 3 List recoding date time ASCII time When a list is to be output or when a list is being output an error may occur and the list output ma
44. apiwbpantiltapi cgi cont_2 32 amp id 20050910011600 17 1 5 Notes 1 This API requires designated values for cont_2 2 id is used to prevent the browser from reading the cache If the cache is not used for the development application id may have any value 3 All the parameters are based on Ceiling Mount Therefore in case of a Desktop Mount set a reversed parameter for right left and top bottom sides respectively Refer to Appendix C for details OTOSHIBA Corp 122 TOSHIBA Network Camera IK WB15A 17 2 17 2 1 Syntax 1 Zoom Operation wbsetzoom cgi SDK Ver 1 00 SC http lt camip gt api wbsetzoom cgi type Set amp Zoom lt value gt 17 2 2 Input Item Type Entry name Entry value Std val Unit Zoom operation type Set Zoom Tele Wide 17 2 3 Output Code Status Code Status 20 OK 90 CriticalError 91 InvalidEntry 32 InvalidValue 17 2 4 Example 1 http 10 1 0 1 api wbsetzoom cgi type Set8 Zoom Tele 2 http 10 1 0 1 api wbsetzoom cgi type Sets Zoom Wide 17 2 5 Notes N A OTOSHIBA Corp 123 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 17 3 Get Current Pan Tilt Zoom Position wbgetptzposition cgi 17 3 1 Syntax 1 http lt camip gt api wbgetptzposition cgi 17 3 2 Input N A 17 3 3 Output Code Status 20 OK 91 FatalError wbgetptzposition cgi indicates the notifica
45. camip gt api wbsetcamftprecord cgi type Server 1 amp Name lt value gt amp LoginID lt value gt amp 4 http lt camip gt api wbsetcamftprecord cgi type Server 2 amp Name lt value gt amp LoginID lt value gt amp 5 http lt camip gt api wbsetcamfiprecord cgi type AttachedPicture amp Size lt value gt 6 http lt camip gt api wbsetcamftprecord cgi type How ToUse amp Detail lt value gt 7 http lt camip gt api wbsetcamftprecord cgi type bySchedule amp Monday lt value gt amp Tuesday lt value gt amp 8 http lt camip gt api wbsetcamftprecord cgi type byAlarm 8NumberOfPrePicture lt value gt 8 9 http lt camip gt api wbsetcamftprecord cgi type byExtControlln amp lnterval lt value gt amp FileName lt value gt amp 10 http lt camip gt apifwbsetcamftprecord cgi type Accumulation amp Mode lt value gt amp Interval lt value gt amp 1 5 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default z FTP Record Conditions type FTPCondition Mode 1 0FF 1 2 Scheduled Recording 3 Recording by Alarm In 4 Recoding by Ext Control In Alarm In mode when Alarm Rec is AlarminMode 1 OFF 2 Checked 1 checked Motion Detection mode when Alarm Rec MotionMode 1 OFF 2 Checked 1 is checked 1 FTP server server name type Server 1 Name any max 128 bytes Login ID LoginID any max 32 bytes Password Password any max 32 bytes Port number FTPcPortNumber any
46. details refer to Appendix A 7 7 4 Example 1 http 10 1 0 1 api getstream cgi 3087 amp 3087 amp cm9vdA amp aWt3Y g amp 1080808089000 7 7 5 Notes 1 abort10 stops all the streams that are currently distributed 2 The 4 interfaces of Live Picture stream Playback Picture stream Live Audio stream and Abort stream are common APIs However the meaning of each parameter varies depending on the target to be executed 3 It is desirable that the stream should be stopped by abort5 or abort10 This will reduce the network load of the IK WB15A OTOSHIBA Corp 71 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC Vill IK WB15A Data Reference Type API List Item No Item Sub number Menu API name Function type 8 Reference of all setting 8 1 wbgetallinfo cgi Information 9 Reference of Camera 9 1 Basic wbgetcambasic cgi a Settings 9 2 Frame Rate wbgetcamframerate cgi 5 9 3 Alarm wbgetcamalarm cgi 9 4 Recording wbgetcamrecord cgi 9 5 FTP Recording wbgetcamftprecord cgi gt 9 6 E mail wbgetcammail cgi z 9 7 Audio wbgetcamsound cgi 10 Reference of PAN TILT 10 1 Basic Operation Range wbgetptbasic cgi Settings 10 2 Preset wbgetptpreset cgi 10 3 Auto Patrol wbgetptautopatrol cgi 11 Reference of Network 11 1 Basic wbgetnwkbasic cgi z Settings 11 2 Bandwidth Control wbgetnwkbandwidth cgi 11 3 DDNS w
47. hoe Cu DOU lira incl US La ke kae ind Savi ezeket 119 Xi PTZ Operation Type API List E ange ete PST Sede teen oid et AA A tania 120 17 PTZ Operation iii o MC gee ds oe peg as Sn oe ht dee RE La Rese SE so RU ost A desk pad eset pea a Sanath loa he 121 Pt SS O 122 17 2 Zoom Operation 1 3 Get Current Pan Pilt ZOOM Position A ib 124 Appendix A OU puto gelsem Og a A A easton seal 125 Appendix B Output of wbgetallinfo COl xo A E A A ria 128 Appendix C PAN TILT direction and coordinate on Desktop Wall Mount Ceiling Mount oooooconnccccnnncnnnnnncnncnnnnnnonnnnncnnnononnnnnnnnnnnnnnnnnnnnannnnnnanons 134 Appendix D Simultan ous GonhectiOn a r z a 140 The end of the DocU MEN A A A eu ete va ee A tae Sa ec i eS eee de ee 144 TOSHIBA Corp TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC I About API Firmware version corresponding to this specification gt The firmware version to which this specification is applicable is Version 0 16 10 018 115 or later API protocol gt The base protocol of this API group is HTTP The HTTP server specifications of the IK WB15A are as follows HTTP Version 1 0 Supports Keep Alive RFC2068 HTTP error code gt The error code to be notified from the HTTP server of the IK WB15A is as follows Response code RFC2068 Meaning Result Message 200 Success HTTP 1 0 200 OK r n 301 Redirection HTTP 1 0 301 Moved Perma
48. is performed type Default is an exception Multiple type lt value gt cannot be enumerated simultaneously This API must be started for each type For only entered items setting is performed For the other items their existing values are held When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 28 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 2 PAN TILT Settings wbsetptbasic cgi Basic Settings wbsetptpreset cgi Preset Settings wbsetptautopatrol cgi Auto Patrol Settings wbpresetapi cgi Easy Preset Operations wbset pt func cgi 1 2 3 4 1 Indicates a setting API 2 Indicates a PAN TILT type setting API 3 Indicates the function matched to the WEB setting page 4 Every API is started and executed as cgi wbpresetapi cqi 5 6 5 Indicates an Easy Preset operation API 6 This API is executed as cgi The Pan Tilt setting API is shown on following pages TOSHIBA Corp 29 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 2 1 Basic Settings wbsetptbasic cgi 21 1 Syntax 1 http lt camip gt api wbsetptbasic cgi type Default 2 http lt camip gt api wbsetptbasic cgi type P T Condition amp ScanSpeed lt value gt amp PowerUp lt value gt amp 3 http lt camip gt api wbsetptbasic
49. limit type BottomLimitSetting Mode 1 OFF 2 0N 1 Bottom limit position Degree O 1200 0 Log output control of cgi common to all types OpeLog No Yes default Yes omissible 2 1 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData TOSHIBA Network Camera IK WB15A 2 2 Preset Settings wbsetptpreset cgi 2 2 1 Syntax SDK Ver 1 00 SC 1 http lt camip gt api wbsetptpreset cgi type Default 2 http lt camip gt api wbsetptpreset cgi type PresetNumber 1 amp PresetName lt value gt amp PanPostion lt value gt amp 3 http lt camip gt api wbsetptpreset cgi type PresetNumber 64 amp PresetName lt value gt amp PanPostion lt value gt amp 2 2 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default E Preset name type PresetNumber 1 PresetName any max 12 bytes Pan position PanPosition O 2640 32767 32767 degree Tilt position TiltPosition O 1200 32767 32767 degree Zoom position ZoomPosition 0 5 Preset name type PresetNumber 64 PresetName any max 12 bytes Pan position PanPosition O 2640 32767 32767 degree Tilt position TiltPosition O 1200 32767 32767 degree Zoom position ZoomPosition 0 5 Log output control of cgi common to all types
50. omitted it is regarded as OpeLog Yes OTOSHIBA Corp 18 TOSHIBA Network Camera IK WB15A 1 4 Recording Settings wbsetcamrecord cgi 1 4 1 Syntax SDK Ver 1 00 SC 1 http lt camip gt api wbsetcamrecord cgi type Default 2 http lt camip gt api wbsetcamrecord cgi type Alarm amp AlarmlInRecMode lt value gt amp MotionRecMode lt value gt amp 3 http lt camip gt api wbsetcamrecord cgi type Normal amp Mode lt value gt amp Monday lt value gt amp 4 http lt camip gt api wbsetcamrecord cgi type RecOverwriting 8Mode lt value gt 1 4 2 Input Item Type Entry name Entry value Unit Reset to Default type Default Alarm In Rec ON OFF type Alarm AlarminRecMode 1 0FF 2 0N 1 Ext Control In Rec ON OFF ExtControllnRecMode 1 0FF 2 0N 1 Motion Detection Rec ON OFF MotionRecMode 1 0FF 2 0N 1 Pre Recording NumberOfPrePicture 0 3 5 10 3 frames Post Recording NumberOfPostPicture 0 3 5 10 20 10 frames Recording Cycle Interval 33 66 100 200 333 500 10 second 1 2 3 5 10 30 60 1 20 180 33 1 30 66 1 15 100 1 10 200 1 5 333 1 3 500 1 2 Continuous Rec ON OFF type Normal Mode 1 0FF 2 0N 1 Schedule Monday Monday 1 OFF 1 Tuesday Tuesday ae 1 1 Wednesday Wednesday 4 Schedule 2 1 Thursday Thursday 1 Friday Friday 1 Saturday Saturday 1
51. value r n lt Camera 1 gt r n 12 1 4 Example 1 http 10 1 0 1 api wbgetmultiscreen cgi 12 1 5 Notes Name va ue r n Addr value r n HTTPPortNumber va ue r n Kind value r n Selection value r n lt Camera 30 gt r n Name value r n Addr value r n HTTPPortNumber va ue r n Kind value r n Selection value r n 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 96 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 13 Reference of Administrator Functions wbgetadminuserinfo cgi Reference of User Information wbgetadminuserfunctions cgi Reference of User Operation Restrinction whbgetadminTaD cgi Reference of Date and Time Settings wbgetadmintime cgi Reference of Current Camera Time wbget admin func cgi 1 2 3 4 1 Indicates a reference API 1 2 Indicates an admin type reference API 3 Indicates the function matched to the WEB setting page 4 Every API is started and executed as cgi On and after the next page the camera reference API is shown TOSHIBA Corp 97 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 13 1 Reference of User Information wbgetadminuserinfo cgi 13 1 1 Syntax 1 http lt camip gt api wbogetadminuserinfo cgi 13 1 2 Input Item Type Entry name Value Log output control of cgi commo
52. 1 1 B sic Settings aanne to A AR toe de O da aro di 14 1 2 Frame Rate Set ng iia A A a acs eae onc eet ra ed een 17 1 3 A Seran neinean iaa a fact hob A incre and taAteaatacue lead z SELL ORAL SARL fag heated fated a aeee ahah its hak tees RALADO adden Ed UC ou adido gua nda 18 1 4 Recording Settings can ni tr nh eee i ee ested es 19 1 5 ETP RECOrdING SOttlnGS td eier ash DSO RUI ote ong a SODA AA A ETA DEA O 21 1 6 Mail Setting gise hei eth ed aie Aes A ee ee ee 25 1 7 Audio Setting visir A Add 28 2 PAN TILT Settings coito A i se te ie A s 29 2 1 Basie SetingS sd asas penas E a EAE Eaa NE Eaa L sas dio nabo SUDO ea dh ven abe ag fe q aa a tansy ene aaae e a GRU tae tata GNE G ZT 30 2 2 Preset Settings ii ee a a eee ee eed ec eet 32 2 3 Auto Patrol Settings rimini r eie uddehs ate oh il iio 34 2 4 Easy Preset Assignmentas assinei A A A se Lado ea a ee es 35 2 5 Easy Preset Deletion 2 6 Easy collective Preset Name assi Medi a Medea 37 2 7 Easy Preset MOVE ici a AA its 38 3 gt Network SettingS iiiaiiai A ch aig A ne ot nea A dl 39 3 1 A o 5 fan on sida na SEE o tent toe cau ga faut LOURA TU de RE ego Sae secrete vee dae aa Sada sta an 40 3 2 Bandwidth Control Settings iii A li dois 42 3 3 DDNS SENOS seas asa ii iba aiii 43 3 4 FTP Serv r SONS iii A A id ee esd 44 TOSHIBA Corp TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 4 Multi Screen Display Settings 45 4 1 Multi Screen Display Settings
53. 1084 7 1485 27 1956 47 2428 49 165 29 636 9 1108 8 1509 28 1980 48 2451 48 189 28 660 8 1131 9 1532 29 2004 49 2475 47 212 27 684 7 1155 10 1556 30 2027 50 2499 46 236 26 707 6 1179 11 1579 31 2051 51 2522 45 259 25 731 5 1202 12 1603 32 2074 52 2546 44 283 24 754 4 1226 13 1626 33 2098 53 2569 43 306 23 778 3 1249 14 1650 34 2121 54 2593 42 330 22 801 2 1273 15 1674 35 2145 55 2616 41 354 21 825 1 1296 16 1697 36 2169 56 2640 40 377 20 849 Center 17 1721 37 2192 39 401 19 872 o 1320 18 1744 38 2216 38 424 18 896 19 1768 39 2239 TOSHIBA Corp Appendix C 135 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 6 Relation between TILT degree and value in API Degree Value Degree Value Degree Value Degree Value Tilt Up 7 266 22 599 37 933 5 0 8 288 23 622 38 955 4 22 9 310 24 644 39 978 3 44 10 332 25 666 40 1000 2 66 11 355 26 688 41 1022 1 88 12 377 27 711 42 1044 Level 13 399 28 733 43 1067 0 110 14 421 29 755 44 1089 Tilt Down 15 444 30 777 45 1111 1 132 16 466 31 800 46 1133 2 154 17 488 32 822 47 1156 3 177 18 510 33 844 48 1178 4 199 19 533 34 866 49 1200 5 221 20 555 35 889 6 243 21 577 36 911 TOSHIBA Corp 136 Appendix C TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 2 PAN TILT when using Ceiling Mount installation method 1 Di
54. 2767 ZoomPosition 0 lt PresetNumber 56 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 57 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 58 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 59 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 60 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 61 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 62 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 63 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 64 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 PanTilt AutoPatrol lt StayTime gt StayTime 1 lt AutoPatrolStopNumber gt PresetNumber 1 1 PresetNumber 2 PresetNumber 3 PresetNumber 4 PresetNumber 5 PresetNumber 6 PresetNumber 7 PresetNumber 24 PresetNumber 25 PresetNumber 26 PresetNumber 27 PresetNumber 28 PresetNumber 29 PresetNumber 30 PresetNumber 31 PresetNumber 32 PresetNumber 33 PresetNumber
55. 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 20 OK r n r n This output format is common to other status and all other setting type APIs TOSHIBA Corp 15 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC Note that the information to be notified from the IK WB15A has a format to display such text data as shown above in units of lines but not the HTML format 4 Example http 10 1 0 1 api wbsetcambasic cgi type Default http 10 1 0 1 apiAwbsetcambasic cgi type Set amp Resolution 3 amp CompressionRatio 5 amp AEControl 19 1 1 5 Notes 1 If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception 2 Multiple type lt va ue gt cannot be enumerated simultaneously This API must be started for each type 3 For only entered item setting is performed For the other items their existing values are held 4 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes TOSHIBA Corp TOSHIBA Network Camera IK WB15A 1 2 Frame Rate Setting wbsetcamframerate cgi 1 2 1 Syntax SDK Ver 1 00 SC 1 http lt camip gt api wbsetcamframerate cgi type Default 2 http lt camip gt api wbsetcamframerate cgi type Set amp Rate lt value gt 1 2 2 Input Item Typ
56. Data 5 3 4 Example 1 http 10 1 0 1 api wbsetadminTaD cgi type Default 2 http 10 1 0 1 api wbsetadminTaD cgi type TimeZoneg8Location 8 3 http 10 1 0 1 apiAwbsetadminTaD cgi type NTP amp Mode 2 amp Server ntp hoge com amp AdjustingCycle 2 4 http 10 1 0 1 apiAwbsetadminTaD cgi type DaylightSaving amp Mode 2 5 3 5 Notes 1 If only type NTP is entered and then lt entry gt lt value gt is not entered no setting is performed 2 Multiple type lt value gt cannot be enumerated simultaneously This API must be started for each type 3 For only entered items setting is performed For the other items their existing values are held 4 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 52 TOSHIBA Network Camera IK WB15A 5 4 Set Time Manually wbsetadmintime cgi 5 4 1 Syntax SDK Ver 1 00 SC 1 http lt camip gt api wbsetadmintime cgi type Set amp Year lt value gt amp Month lt value gt amp Day lt value gt amp Hour lt value gt amp Minute lt value gt amp Sec ond lt value gt 5 4 2 Input Item Type Entry name Entry value Std val Unit Year type Set Year 5 29 year Month Month 1 12 month Day Day 1 31 day Hour Hour 0 23 hour Minute Minute 0 59 minute Second Second 0 59 second Log output control of cgi
57. Display 1 Display all 1 2 Set conditions Display condition settings Filter 1 Number of logs 1 2 Keyword 3 Indicate time and date Display Most recent Old Which 1 Most recent 1 2 Old nlogs NumberOf 1 9999 16 Keyword Keyword any max 128 bytes Year Year 20 00 20 99 5 year Month Month 1 12 1 month Day Day 1 31 1 day Hour Hour 0 23 0 hour Minute Minute 0 59 0 minute Second Second 0 59 0 second Display After Before logs BcAd 1 Before 2 After 2 Log output control of cgi common to all types OpeLog No Yes default Yes omissible 6 1 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData OTOSHIBA Corp 57 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 6 1 4 Example 1 http 10 1 0 1 api wbsetlogconditions cgi type Default 2 http 10 1 0 1 api wbsetlogconditions cgi type Set8Display 1 6 1 5 Notes If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception 2 For only entered items setting is performed For the other items their existing values are held When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes TOSHIBA Corp 58 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 6 2 Clear Logs wbsetlogclear cgi 6 2 1 Synta
58. I to reference this termination status However regarding termination status except 20 Ok the API notifies only a single termination status even if multiple errors occur inside and outside the API For this reason there is a possibility that the client may receive a different status from the intended status Accordingly we recommend checking the general purpose termination status without expecting the status indicated by the output of each API Each termination status that is generally notified from the API group is shown below Terminate code Meaning Termination status Details 20 Success 20 OK r n Normal termination 30 Client Error 30 InvalidType r n Illegal lt type gt was specified 31 Client Error 31 InvalidEntry r n Illegal lt entry gt name was specified 32 Client Error 32 InvalidValue r n Illegal lt value gt was set for lt entry gt 33 Client Error 33 InvalidOperand r n The argument format to the API is illegal 34 Client Error 34 NoEntryData r n lt entry gt lt value gt is not specified 35 Client Error 35 TooManyEntry r n lt entry gt lt value gt was specified exceeding the necessary number 40 Server Error 40 FailToSave r n Data registration failed 41 Server Error 41 FailToGet r n Data acquisition failed 90 Server Error Critical 90 CriticalError r n A fatal error occurred inside the camera 91 Server Error Critical 91 FatalError r n 92 Server Error Critical 92 Criti
59. Name any DNS Update function DNSUpdate 1 0FF 2 0N 1 DHCP Option function DHCPOption 1 0FF 2 0N 1 Camera rebooting control of cgi common to all types Reboot No Yes default No omissible Log output control of cgi common to all types OpeLog No Yes default Yes omissible 3 1 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData OTOSHIBA Corp 40 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC Example http 10 1 0 1 api wbsetnwkbasic cgi type Default http 10 1 0 1 api wbsetnwkbasic cgi type Set amp DHCPMode 2 amp Reboot Yes Notes If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception Multiple type lt va ue gt cannot be enumerated simultaneously This API must be started for each type When a blank character is included in lt value gt it must be URL encoded For only entered items setting is performed For the other items their existing values are held When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes To validate a setting by this API the camera must be rebooted When Reboot Yes is entered and setting can be performed according to other entered value the camera performs reboot processing as it is Accordingly the client may n
60. OpeLog No Yes default Yes omissible OTOSHIBA Corp 46 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 4 1 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 4 1 4 Example 1 http 10 1 0 1 api wbsetmultiscreen cgi type Default 2 http 10 1 0 1 api wbsetmultiscreen cgi type DisplayModegMode 2 3 http 10 1 0 1 api wbsetmultiscreen cgi type Camera 238Name HarryGayer 4 1 5 Note If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception Multiple type lt value gt cannot be enumerated simultaneously This API must be started for each type For only entered items setting is performed For the other items their existing values are held When a blank character is included in lt value gt it must be URL encoded When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes N A 0 DDD OTOSHIBA Corp 47 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 5 Administrator Functions wbsetadminuserinfo cgi Uer Login Restriction wbsetadminuserfunctions cgi User Operation Restriction Control wbsetadminTaD cgi NTP Settings wbsetadmintime cgi Set Time Manually wbsetadmins
61. OpeLog No Yes default Yes omissible 2 2 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 2 2 4 Example 1 http 10 1 0 1 api wbsetptpreset cgi type Default 2 http 10 1 0 1 api wbsetptpreset cgi type PresetNumber 1 amp PresetName One 20Ein Note 1 If only type Set is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception TOSHIBA Corp 32 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 2 Multiple type lt value gt cannot be enumerated simultaneously This API must be started for each type 3 For only entered items setting is performed For the other items their existing values are held 4 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes 5 Setting values of PanPosition and TiltPosition is defined in Appendix C 6 This API defines preset number by indicating both Pan and Tilt positions This function is different from webpresetapi cgi which sets current position as assigned preset number TOSHIBA Corp 33 TOSHIBA Network Camera IK WB15A 2 3 Auto Patrol Settings wbsetptautopatrol cgi SDK Ver 1 00 SC 2 3 1 Syntax 1 http lt camip gt api wbsetptautopat
62. SHIBA Corp 60 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 7 Get Pictures Audio getstream cgi Get Live Pictures by streaming live jpg One shot Live Picture __live wav One shot Live Audio getstream cgi Get Playback Pictures by streaming getstream cgi Get Live Audio by streaming getstream cgi Abort Streaming abort5 getstream cgi Abort Streaming abort10 On and after the next page the network setting API is shown TOSHIBA Corp 61 SDK Ver 1 00 SC TOSHIBA Network Camera IK WB15A 7 1 Get Live Pictures by streaming getstream cgi 7 1 1 Syntax 1 http lt camip gt api getstream cgi lt clientID gt amp lt uniquelD gt amp lt ID gt amp lt PW gt amp lt stream Type gt amp lt interval gt amp lt mode gt amp lt value gt amp lt timeOut gt 7 1 2 Input Parameter Value Explanation lt clientID gt Enter a unique ID of up to 15 digits This lt clientiD gt is used as an index to forcibly terminate abort the streaming execution task from the outside It cannot be omitted lt uniquelD gt Enter a unique ID of up to 15 digits Embed the current time data of the client on each occasion Originally this is used as a cache reading preventive means in using the browser by continuously changing the value If there is not any problem similar to the browser in an application this parameter can be left blank lt ID gt Enter the user
63. Settings wbsetcamframerate cgi Frame Rate Settings wbsetcamalarm cgi Alarm Settings wosetcamrecord cgi Recording Settings wbsetcamftprecord cgi FTP Recording Settings wosetcammail cgi E mail Settings wosetcamsound cgi Audio Settings wbset cam func cgi 1 2 3 4 1 2 3 4 Indicates a setting API Indicates a camera type setting API Indicates the function matched to the WEB setting page Every API is started and executed as cgi YS DD LY NH On and after the next page the camera setting API is shown TOSHIBA Corp TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 1 1 Basic Settings wbsetcambasic cgi 1 1 1 Syntax 1 http lt camip gt api wbsetcambasic cgi type Default 2 http lt camip gt api wbsetcambasic cgi type Set amp Resolution lt value gt amp CompressionRatio lt value gt amp Note Parentheses shown above is for description only and not used in actual command 1 1 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default Resolution type Set Resolution 1 160x120 QQVGA 3 E 2 320x240 QVGA 3 640x480 VGA 5 1280x960 SXVGA CompressionRatio CompressionRatio 1 Low 3 2 mid Low 3 Standard 4 mid High 5 High Brightness adjustment AEControl 99 99 0 gt Mounting method Mounting 1 Desktop Wall 1 3 Ceiling mount Auto B W AutoBW 1 0FF 2 0N 1 W
64. Software Development Kit er 1 00 SC C TOSHIBA Corp Jun 2006 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC History Version Page Topics Creator T amp D Notes B 71 SC Release VerB 71 SC T Hamada Mon May 29 2006 B 72 SC All Typo PTZF gt PTZ T Hamada Thu Jun 08 2006 30 31 Modified wbsetptbasic cgi lt Degree gt values 32 Modified wbsetptpreset cgi lt Pan Tilt ZoomPosition gt values 35 38 Added OpeLog Yes No 54 Modified Notes 6 Appendix C gt Appendix B 59 Modified logclear cgi amp type Set gt cgi type Set 63 66 68 Typo lt stremType gt gt lt streamType gt 90 Modified wogetnwkbasic cgi Output 99 Modified wogetadminuserfunctions cgi Output 101 Modified wogetadmintime cgi Output Appendix B Modified output values Camera Mail Camera Sound PanTilt General PanTilt Preset Multi Screen Display 143 Modified livewav gt live jpg B 73 SC 5 Review this page T Hamada Thu Jun 15 2006 22 Typo Swi2tch gt Switch 24 Modified 1 5 4 Example 7 8 8 30 Typo CENETER gt CENTER autoPatrol gt AUTO PATROL 59 Modified 6 2 5 Notes 1 62 Modified 7 1 2 Input Explanation of lt clientID gt 63 Modified 7 1 5 Notes 4 65 Modified 7 3 2 Input Explanation of lt clientID gt 66 Modified 7 3 5 Notes 5 67 Modified 7 4 2 Input
65. ZoomPosition 0 lt PresetNumber 4 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 5 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 6 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 7 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 8 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 9 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 10 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 11 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 12 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 13 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 14 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 15 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 16 gt PresetName PanPosition 82767 TiltPosition 32767 ZoomPosition 0 lt PresetNumbe
66. ammail cgi 9 6 5 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes TOSHIBA Corp 83 TOSHIBA Network Camera IK WB15A 9 7 Reference of Audio Settings wbgetcamsound cgi 9 7 1 Syntax 1 http lt camip gt api wogetcamsound cgi SDK Ver 1 00 SC 9 7 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 9 7 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetcamsound cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Mn Camera Sound r n lt Input gt r n Mode va ue r n Level value r n lt Output gt r n Mode va ue r n Level value r n 9 7 4 Example 1 http 10 1 0 1 api wbgetcamsound cgi 9 7 5 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 84 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 10 Reference of Pan Tilt Setting wbgetptbasic cgi Reference of Pan Tilt Basic Settings wbgetptpreset cgi Reference of Preset Settings wbgetptautopatrol cgi Reference of Auto Patrol Settings wbget pt func cgi 1 2 3 4 1 Indicates a reference API 2 Indicates a Pan
67. as OpeLog Yes 2 This API does not check any argument other than OpeLog No Yes Accordingly if there are illegal arguments other than these they are ignored OTOSHIBA Corp 116 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 16 2 Execute Storage Mount Unmount wbstoragemount cgi 16 2 1 Syntax 1 http lt camip gt api wbstoragemount cgi type lt value gt 16 2 2 Input Item Type Entry name Value Execute mount type Mount Execute unmount type Unmount Log output control of cgi common to all types OpeLog No Yes default Yes omissible 16 2 3 Output Code Status 20 OK 30 InvalidType 73 FailedToMount 16 2 4 Example 1 http 10 1 0 1 api wbstoragemount cgi type Mount 2 http 10 1 0 1 api wbstoragemount cgi type Unmount 16 2 5 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes 2 This API does not check any argument other than OpeLog No Yes and type Mount Unmount Accordingly if there are illegal arguments other than these they are ignored OTOSHIBA Corp 117 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 16 3 Check Storage Mount Status wbstoragemountstatus cgi 16 3 1 Syntax 1 http lt camip gt api wbstoragemountstatus cgi 16 3 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes de
68. ber 80 Kind 12 Selection 1 lt Camera 1 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 2 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 3 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 4 gt Name gt Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 5 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 6 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 7 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 8 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 9 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 10 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 11 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 12 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 13 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 14 gt Name Addr HTTPPortNumber 80 Kind 1 Selection 1 lt Camera 15 gt Name Addr HTTPPortNumber 80 gt Kind 1 Selection 1
69. bgetnwkddns cgi 11 4 FTP Server wbgetnwkftpserver cgi 11 5 MAC Address wbgetnwkmac cgi gt 12 Reference of Multi Screen 12 1 Multi Screen wbgetmultiscreen cgi 13 Reference of 13 1 User Login Restriction wbgetadminuserinfocgi Administrator Functions 13 2 User Operation Restriction wbgetadminserfunctions cgi 13 3 Date and Time Settings wbgetadminTaD cgi 13 4 Get Current Camera Time wbgetadmintime cgi 14 Reference of Log 14 1 Log Filtering Conditions wbgetlogconditions cgi z Management Settings 14 2 Log Lists wbgetloglist cgi OTOSHIBA Corp 72 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 8 Reference of All Setting Information wbgetallinfo cgi Reference of all setting information wbget allinfo cgi 1 2 3 1 Indicates a reference type API 2 Indicates all configuration reference API 3 Every API is started and executed as cgi On and after the next page the camera setting API is shown TOSHIBA Corp 73 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 8 1 Reference of All Setting Information wbgetallinfo cgi 8 1 1 Syntax 1 http lt camip gt api wbgetallinfo cgi 8 1 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 8 1 3 Output For details refer to Appendix B 8 1 4 Example 1 http 10 1 0 1 api wbgetallinfo cgi 8 1 5 Notes 1 The same result as that obtained b
70. calError r n Next the termination status limited to an API is shown below This termination status may be notified by this API in addition to the above termination status OTOSHIBA Corp TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 1 Termination status limited to wblist type cgi Terminate code Meaning Termination status Details 60 Server Error 60 FailAction r n List acquisition failed 2 Termination status limited to wbstorage type cgi Terminate code Meaning Termination status Details 21 Notify 21 Inserted r n The storage is inserted 22 Notify 22 Mounted r n The storage is mounted Available status 71 Notify 71 Notinserted r n The storage is not inserted 72 Notify 72 NotMounted r n The storage is not mounted Inserted 73 Storage Error 73 FailedToMount r n Mounting the storage failed 74 Storage Error 74 FailedToFormat r n Storage formatting failed 3 Termination status limited to wbsetcamrecord cgi wbsetcamftprecord cgi Terminate code Meaning Termination status Details 50 Client Warning 50 OKbutExtAlarmOFF r n Though the registration related to the Alarm In was executed the Alarm In function is set to OFF 51 Client Warning 51 OKbutMotionOFF r n Though the registration related to motion detection was executed the Motion Detecting function is set to OFF 52 Client Warning
71. cgi DDNS Settings wbseinwkftpserver cgi FTP Server Settings wbset nwk func cqi 1 2 3 4 1 2 3 4 Indicates a setting API Indicates a network type setting API Indicates the function matched to the WEB setting page Every API is started and executed as cgi Ye DD WH On and after the next page the network setting API is shown TOSHIBA Corp 39 TOSHIBA Network Camera IK WB15A 3 1 Basic Settings wbsetnwkbasic cgi 3 1 1 Syntax 1 http lt camip gt api wbsetnwkbasic cgi type Default SDK Ver 1 00 SC 2 http lt camip gt api wbsetnwkbasic cgi type Set amp CameraName lt value gt amp DHCPMode lt values amp 3 1 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default Camera name type Set CameraName any Nwcam15 DHCP DHCPMode 1 0FF 2 0N 2 IP address IPAddress Dot notation n n n n 0 lt n lt 255 Subnet mask SubnetMask Dot notation n n n n 0 lt n lt 255 Default gateway DefaultGateway Dot notation n n n n 0 lt n lt 255 Primary DNS PrimaryDNS Dot notation n n n n 0 lt n lt 255 Secondary DNS SecondaryDNS Dot notation n n n n 0 lt n lt 255 Auto camera detection CameraAutoDetection 1 OFF 2 0N 1 HTTP port number HTTPPortNumber 80 1025 65535 80 Network Host Name HostName any Network Domain Name Prefix Domain
72. cgi type AssociationToAlarm amp Mode lt value gt amp PTByAlarmIn lt value gt amp 4 http lt camip gt api wbsetptbasic cgi type LeftLimitSetting amp Mode lt value gt amp Degree lt value gt 5 http lt camip gt api wbsetptbasic cgi type RightLimitSetting amp Mode lt value gt amp Degree lt value gt 6 http lt camip gt api wbsetptbasic cgi type TopLimitSetting amp Mode lt value gt amp Degree lt value gt 7 http lt camip gt api wbsetptbasic cgi type BottomLimitSetting amp Mode lt value gt amp Degree lt value gt 2 1 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default E a E Scan Speed type PTCondition ScanSpeed 1 Slow 2 Fast 1 Power on default position PowerUp 1 CENTER 1 E 2 HOME 3 SCAN 4 AUTO PATROL Freeze Frame FreezeFrame 1 OFF 2 ON 1 Alarm association type AssociationToAlarm Mode 1 OFF 2 Preset 3 Auto Patrol 1 Alarm association Alarm In PTByAlarmin 1 OFF 2 checked 1 E type Motion PTByMotion 1 OFF 2 checked 1 PresetNumber PresetNumber select from 1 to 64 1 Resume function Resume 1 0FF 2 ON 1 Resume time ResumeTime 10 30 60 60 second Left limit type LeftLimitSetting Mode 1 OFE 2 ON 1 Left limit position Degree 0 2640 0 Right limit type RightLimitSetting Mode 1 0FF 2 ON 1 Right limit position Degree 0 2640 2640 Top limit type TopLimitSetting Mode 1 OFF 2 ON 1 Top limit position Degree 0 1200 1200 OTOSHIBA Co
73. cked 1 Send when Motion detected Motion 1 OFF 2 Checked 1 Log output control of cgi common to all types OpeLog No Yes default Yes omissible 1 6 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 1 6 4 Example 1 http 10 1 0 1 api wbsetcammail cgi type Default 2 http 10 1 0 1 api wbsetcammail cgi type AuthenticationgMode 18SMTPServer www hogehoge com 3 http 10 1 0 1 api iwbsetcammail cgi type ConditionByAlarmin amp Mode 1 4 http 10 1 0 1 apiAwbsetcammail cgi type ConditionByMotion amp Mode 2 amp Subject Motion amp Body Detection 5 http 10 1 0 1 api wbsetcammail cgi type AttachSizeg AttachSize 3 6 http 10 1 0 1 apiAwbsetcammail cgi type Recipient amp MustSendAdminMode 2 7 http 10 1 0 1 apiAwbsetcammail cgi type MailTo 1 amp RecipientAddr hoge hogehoge com amp AlarmIn 1 amp Motion 2 1 6 5 Notes 1 If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception 2 Multiple type lt value gt cannot be enumerated simultaneously This API must be started for each type 3 When POP3 ID POP3 Password is specified at type Authentication these must be base64 encoded 4 When a blank character is included in lt value gt it must be URL encoded 5 For only entered items setting is performed For the other items their existing values are held 6 Wh
74. common to all types OpeLog No Yes default Yes omissible 5 4 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 5 44 Example 1 http 10 1 0 1 api wbsetadmintime cgi type Set amp Year 5 amp Month 9 amp Day 1 0 amp Hour 1 amp Minute 16 amp Second 17 5 4 5 Notes Dors TOSHIBA Corp All lt entry gt lt value gt are recommended Multiple type lt value gt cannot be enumerated simultaneously This API must be started for each type API wbgetadmintime cgi can get current time and date of camera When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes 53 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 5 5 Reset All Camera Informations to Default wbsetadminsetdefault cgi 5 5 1 Syntax 1 http lt camip gt api wbsetadminsetdefault cgi type Default 5 5 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default Log output control of cgi common to all types OpeLog No Yes default Yes omissible 5 5 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 5 5 4 Example 1 http 10 1 0 1 api wbsetadminsetdefault cgi type Default 5 5 5 Notes
75. dWidth 1 3 25 Notes If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception Multiple type lt va ue gt cannot be enumerated simultaneously This API must be started for each type For only entered items setting is performed For the other items their existing values are held When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes eno OTOSHIBA Corp 42 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 3 3 DDNS Settings wbsetnwkddns cgi 3 3 1 Syntax 1 http lt camip gt api wbsetnwkddns cgi type Default 2 http lt camip gt api wbosetnwkddns cgi type Set amp Mode lt value gt amp Server lt value gt amp 3 3 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default z DDNS mode type Set Mode 1 OFF 2 0N 1 DDNS server Server any max 128 bytes User ID UserID any max 32 bytes Password Password any max 32 bytes Log output control of cgi common to all types OpeLog No Yes default Yes omissible 3 3 3 Output Code Status Code Status Code Status 32 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 3 3 4 Example 1 http 10 1 0 1 api wbsetnwkddns cgi type Default 2
76. e Entry name Entry value Std val Unit Reset to Default type Default Frame rate type Set Rate 1 30 2 15 3 75 4 3 5 2 6 1 1 frame 7 1 2 8 1 5 94 10 second Log output control of cgi common to all types OpeLog No Yes default Yes omissible 1 2 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 1 2 4 Example 1 http 10 1 0 1 api wbsetcamframerate cgi type Default 2 http 10 1 0 1 api wbsetcamframerate cgi type Set8 Rate 30 1 2 5 Notes 1 If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception 2 Multiple type lt value gt cannot be enumerated simultaneously This API must be started for each type 3 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 1 3 Alarm Settings wbsetcamalarm cgi 1 3 1 Syntax 1 http lt camip gt api wbsetcamalarm cgi type Default 2 http lt camip gt api wbsetcamalarm cgi type AlarmType 8 Mode lt value gt 8InputPolarity lt value gt 3 http lt camip gt api wbsetcamalarm cgi type MotionDetection S Mode lt value gt 4 http lt cam
77. e WEB setting page Every API is started and executed as cgi On and after the next page the camera reference API is shown TOSHIBA Corp 102 TOSHIBA Network Camera IK WB15A 14 1 Reference of Log Filtering Settings wbgetlogconditions cgi 14 1 1 Syntax SDK Ver 1 00 SC 1 http lt camip gt api wbgetlogconditions cgi 14 1 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 14 1 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetlogconditions cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Year value r n r n Month value r n Log Condition r n Day value r n Display value r n Hour value r n Filter value r n Which value r n NumberOf value r n Keyword value r n 14 1 4 Example 1 http 10 1 0 1 api wbgetlogconditions cgi 14 1 5 Notes Minute value r n Second value r n BcAd value r n 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 103 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 14 2 Reference of Log Lists wbgetloglist cgi 14 2 1 Syntax 1 http lt camip gt api wbgetloglist cgi
78. e held When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 2 4 Easy Preset Assignment wbpresetapi cgi 2 41 Syntax 1 http lt camip gt api wbpresetapi cgi cont 4 lt PresetiID gt amp savesysvar 2 http lt camip gt api wbpresetapi cgi cont 4 lt PresetiID gt amp lt presetnamelD gt lt value gt amp savesysvar 2 4 2 Input Item Entry name Entry value Std val Unit Preset ID for registration cont_4 lt presetID gt Preset name for registration lt presetnamelD gt any max 12 bytes Save this preset information savesysvar Log output control of cgi common to all types OpeLog No Yes default Yes omissible lt presetlD gt is determined by the following method lt presetID gt 512 lt presetNumber gt For example to assign Preset Number 1 the parameter would be cont_4 513 Next the indication of the lt presetnamelD gt is shown presetname_n where nis the Preset Number n 1 64 For example to name Preset Number 2 type presetname 2 name 2 43 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 2 44 Example 1 http 10 1 0 1 api wbpresetapi cgi cont 4 513 amp savesysvar 2 http 10 1 0 1 api wbpres
79. edule 2 end time Pattern2End 23 11pm 17 hour TOSHIBA Corp 22 To the next page TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page Item Type Entry name Entry value Std val Unit Recording Cycle type bySchedule Interval 33 66 100 200 333 500 1 2 3 5 1 second 10 30 60 120 180 33 1 30 66 1 15 100 1 10 200 1 5 333 1 3 500 1 2 Record file name FileName any max 16 bytes Server path 1 FTP server Server1Path any max 128 bytes 2 FTP server Server2Path any max 128 bytes Pre Recording type byAlarm NumberOfPrePicture 0 3 5 10 10 frames Post Recording NumberOfPostPicture 0 3 5 10 20 10 frames Recording Cycle Interval 33 66 100 200 333 500 1 2 3 5 1 second 10 30 60 120 180 33 1 30 66 1 15 100 1 10 200 1 5 333 1 3 500 1 2 Recording file Alarm In AiFileName any max 16 bytes name Motion Detection MdFileName any max 16 bytes Server path 1 FTP server Server1Path any max 128 bytes 2 FTP server Server2Path any max 128 bytes a Recording Cycle type byExtControlln Interval 33 66 100 200 333 500 1 2 3 5 1 second 10 30 60 120 180 33 1 30 66 1 15 100 1 10 200 1 5 333 1 3 500 1 2 Record file name FileName any max 16 bytes Server path 1 FTP server Server1Path any max 128 bytes 2 FTP server Server2Path any max
80. em Type Entry name Entry value Std val Unit Reset to Default type Default User Operation Restriction type FunctionRestriction Mode 1 OFF 2 0N Resolution change type Function Resolution 1 disable 2 enable Compression ratio change Brightness adjustment change Mounting method change Auto B W change White Balance WB change WB manual GAIN change AWB offset change AWB range change Auto gain control change Slow shutter change Backlight compensation change Sharpness change Color difference GAIN change Noise reduction change Zoom operation CompressionRatio 1 disable 2 enable AEControl 1 disable 2 enable NoiseReduction 1 disable 2 enable 1 1 1 1 Mounting 1 disable 2 enable 1 AutoBW 1 disable 2 enable 1 E WhiteBalance 1 disable 2 enable 1 WBManualGain 1 disable 2 enable 1 AWBOffset 1 disable 2 enable 1 E AWBRange 1 disable 2 enable 1 AutoGainControl 1 disable 2 enable 1 SlowShutterMax 1 disable 2 enable 1 BackLightCompensation 1 disable 2 enable 1 si Sharpness 1 disable 2 enable 1 Gain 1 disable 2 enable 1 1 1 Zoom 1 disable 2 enable OTOSHIBA Corp 50 To the next page TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page
81. en OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 27 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 1 7 Audio Settings wbsetcamsound cgi 1 7 1 Syntax 1 http lt camip gt api wbsetcamsound cgi type Default 2 http lt camip gt api wbsetcamsound cgi type Input amp Mode lt value gt amp Level lt value gt 3 http lt camip gt api wbsetcamsound cgi type Output amp Mode lt value gt amp Level lt value gt 1 7 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default z E z Audio input type Input Mode 1 OFF 2 ON 1 Audio input level Level 1 HIGH 2 MIDDLE 3 LOW 2 Audio output type Output Mode 1 0FF 2 ON 1 Audio output level Level 1 HIGH 2 MIDDLE 3 LOW 2 Log output control of cgi common to all types OpeLog No Yes default Yes omissible 1 7 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 1 7 4 Example 1 http 10 1 0 1 api wbsetcamsound cgi type Default 2 http 10 1 0 1 api wbsetcamsound cgi type Input amp Mode 2 amp Level 1 3 http 10 1 0 1 apiAwbsetcamsound cgi type Output amp Mode 1 1 7 5 Notes If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting
82. en OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes 2 All the parameters given to Degree are based on Ceiling Mount Refer to Appendix C for details OTOSHIBA Corp 86 TOSHIBA Network Camera IK WB15A 10 2 Reference Preset Settings wbgetptpreset cgi 10 2 1 Syntax 1 http lt camip gt api wbgetptpreset cgi SDK Ver 1 00 SC 10 2 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 10 2 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetptpreset cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Mn PanTilt Preset r n lt PresetNumber 1 gt r n PresetName va ue r n PanPosition va ue r n TiltPosition va ue r n ZoomPosition value r n 10 24 Example 1 http 10 1 0 1 api wbgetptpreset cgi 10 25 Notes lt PresetNumber 64 gt r n PresetName value r n PanPosition va ue r n TiltPosition value An ZoomPosition value in 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 87 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 10 3 Reference of Auto Patrol Settings wbgetptautopatr
83. er of __live jpg A If A lt 10 then OK da If A gt 10 th __live jpg E pd NG live jpg TOSHIBA Corp Appendix D 143 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC The end of the Document TOSHIBA Corp 144
84. etapi cgi cont 4 51 3 amp presetname_1 Garage 20A amp savesysvar 2 4 5 Note 1 This API defines the location where the IK WB15A is currently facing as preset position 2 If given such as http 10 1 0 1 apiAwbpresetapi cgi cont 4 514 amp presetname 9 Garage 20A amp savesysvar current position is set to preset 2 and preset 9 is named Garage A OTOSHIBA Corp 35 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 2 5 Easy Preset Deletion wbpresetapi cgi 2 5 1 Syntax 1 http lt camip gt api wbpresetapi cgi cont 4 lt PresetiID gt amp savesysvar 2 http lt camip gt api wbpresetapi cgi cont 4 lt PresetiID gt amp lt presetname lD gt lt value gt amp savesysvar 2 5 2 Input Item Entry name Entry value Std val Unit Preset ID for deletion cont 4 lt presetID gt Preset name for deletion lt presetnamelD gt any max 12 bytes Save this preset information savesysvar Log output control of cgi common to all types OpeLog No Yes default Yes omissible lt presetlD gt is determined by the following method lt presetID gt 768 lt PresetNumber gt For example to delete Preset Number 1 the parameter would be cont_4 769 Next indication of the lt presetnamelD gt is shown presetname n where n is the Preset Number n 1 64 When deleting Position Name of Preset Number 2 the parameter of presetname 2 has to be given
85. etdefault cgi Reset All Camera Informations to Default wbsetadmincamreboot cgi Reboot Camera wbset admin func cgi 1 2 3 4 1 Indicates a setting API 2 Indicates an administrator s API 1 2 3 Indicates the function matched to the WEB setting page 4 Every API is started and executed as cgi On and after the next page the network setting API is shown TOSHIBA Corp 48 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 5 1 5 1 1 User Login Restriction wbsetadminuserinfo cgi Syntax 1 http lt camip gt api wbsetadminuserinfo cgi type Default amp Reboot lt va ue gt 2 http lt camip gt api wbsetadminuserinfo cgi type Set amp LoginRestriction lt value gt 5 1 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default Login restriction type Set LoginRestriction 1 0FF 2 0N 2 Camera rebooting control of cgi common to all types Reboot No Yes default No omissible Log output control of cgi common to all types OpeLog No Yes default Yes omissible 5 1 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 5 1 4 Example http 10 1 0 1 api wbsetadminuserinfo cgi type Default amp Reboot Yes 2 http 10 1 0 1 api wbsetadminuserinfo cgi type Set amp LoginRestriction 2 a
86. execution task from the outside It cannot be omitted lt uniquelD gt Enter a unique ID of up to 15 digits Embed the current time data of the client on each occasion Originally this is used as a cache reading preventive means in using the browser by continuously changing the value If there is not any problem similar to the browser in an application this parameter can be left blank lt ID gt Enter the administrator ID that is base64 encoded Originally it is mandatory to enter the administrator ID In the IK WB15A it can be left blank lt PW gt Enter the administrator PW that is base64 encoded Originally it is mandatory to enter the administrator PW In the IK WB15A it can be left blank lt streamT ype gt Specify 10 for the type of abort10 Termination of external abort 10 lt interval gt 0 When lt streamType gt is 10 this parameter may have any value However enter 0 lt mode gt 0 When lt streamType gt is 10 this parameter may have any value However enter 0 lt value gt o When lt streamType gt is 10 this parameter may have any value However enter 0 lt timeout gt Set the execution timeout value in ms Set the execution timeout value in ms for the case where a non communication status is continued over a certain period with the client while lt image field gt is output 7 7 3 Output The format is the same as that for getting Live Pictures by streaming For
87. fault Yes omissible 16 3 3 Output Code Status 22 Mounted 72 NotMounted 16 3 4 Example 1 http 10 1 0 1 api wbstoragemountstatus cgi 16 3 5 Notes 1 In the IK WB15A auto mount of an external storage is not executed Accordingly the user must execute one of the followings after mounting the external storage in the IK WB15A Execute mount by SD in out wizard on the WEB setting page Execute mount by using API wbstoragemount cgi 2 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes This API does not check any argument other than OpeLog No Yes are ignored OTOSHIBA Corp 118 Accordingly if there are illegal arguments other than these they TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 16 4 Format Storage wbstorageformat cgi 16 4 1 Syntax 1 http lt camip gt api wbstorageformat cgi 16 4 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 16 4 3 Output Code Status 20 OK 74 FailedToFormat 16 4 4 Example 1 http 10 1 0 1 api wbstorageformat cgi 16 4 5 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes 2 This API does not check any argument other than OpeLog No Yes Accordingly if t
88. here are illegal arguments other than these they are ignored OTOSHIBA Corp 119 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC XI PTZ Operation Type API List Item No Item Sub number Menu API name Function type 17 PTZ Operation 17 1 PAN TILT Operation wbpantiltapi cgi 17 2 Zoom Operation wbsetzoom cgi 1 type 17 3 Get Current Pan Tilt Zoom Position wbgetptzposition cgi 1 type TOSHIBA Corp 120 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 17 PTZ Operation wbpantiltapi cgi Pan Tile Operation wbsetzoom cgi Zoom Operation wbgetptzposition cgi Get current Pan Tilt Zoom Position wb func cqi 1 2 3 1 Indicate a camera operation API 2 Indicate a PTZ operation type API 3 Every API is started and executed as cgi The camera reference API is shown on the following pages TOSHIBA Corp 121 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 17 1 Pan Tilt Operation wbpantiltapi cgi 17 1 1 Syntax 1 http lt camip gt api wbpantiltapi cgi cont_2 lt value gt amp id lt value gt 17 1 2 Input Item Type Entry name Entry value Std val Unit PT operation cont_2 1 Pan Left 2 Pan Right 4 Tilt Up 8 Tilt Down 16 Center 32 Scan 64 Auto Patrol id any 17 1 3 Output Code Status 20 OK 32 InvalidValue 90 CriticalError 17 1 4 Example 1 http 10 1 0 1
89. hite Balance WB WhiteBalance 1 Auto AWB 1 2 Indoor Incandescent light color 3 Indoor Fluorescent light color 4 Outdoor sunlight 5 Hold 6 Manual WB manual GAIN R WBManualGainR 99 99 0 E WB manual GAIN B WBManualGainB 99 99 0 AWB Ye Cy offset AWBOffsetYeCy 20 20 0 OTOSHIBA Corp To the next page TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page Item Type Entry name Entry value Std val Unit AWB Mg G offset type Set AWBOffsetMgG 20 20 0 AWB range AWBRange 1 Standard 2 Wide 1 z Auto gain control AutoGainControl 1 OFF 2 Standard 3 Max 2 Slow shutter SlowShutterMax 1 OFF x1 3 2 1 7 5s x4 3 1 3 75s x8 4 1 2 5s x12 5 1 1 8s x16 6 1s x30 7 2s x60 8 4s x120 Backlight compensation BackLightCompensation 1 0FF 7 2 Upper 2 3 Area designation 3 Lower 2 3 Area designation 4 Center 1 3 Area designation 5 Center 1 6 Area designation 6 Left and Right Area designation 7 Auto Sharpness Sharpness 1 LOW 2 MIDDLE 3 HIGH 2 Color difference GAIN R Y GainRY 20 20 0 Color difference GAIN B Y GainBY 20 20 0 Noise reduction NoiseReduction 1 LOW 2 MIDDLE 3 HIGH 1 Log output control of cgi common to all types OpeLog No Yes default Yes omissible 1 1 3 Output Code Status Code Status Code Status 20 OK
90. http 10 1 0 1 apiAwbsetnwkddns cgi type Set amp Mode 28 amp UserlD lt base64enc gt amp Password lt base64enc gt 3 3 5 Notes QABON If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception Multiple type lt va ue gt cannot be enumerated simultaneously This API must be started for each type When LoginlD Password is specified these must be base64 encoded When a blank character is included in lt value gt it must be URL encoded For only entered items setting is performed For the other items their existing values are held When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 43 TOSHIBA Network Camera IK WB15A 3 4 FTP Server Settings wbsetnwkftpserver cgi 3 4 1 Syntax SDK Ver 1 00 SC 1 http lt camip gt api wbsetnwkftpserver cgi type Default 2 http lt camip gt api wbsetnwkftpserver cgi type Set amp Mode lt value gt amp LoginID lt value gt amp 3 4 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default E FTP function type Set Mode 1 OFF 2 0N 1 Login name LoginID any max 32 bytes root Password Password any max 32 bytes ikwb Max simultaneous connections MaxConnection 1 10 1 Log out
91. ilTo 2 gt RecipientAdar Alarmin 1 Motion 1 Alarmin 1 Motion 1 lt MailTo 4 gt RecipientAdar Alarmin 1 Motion 1 lt MailTo 5 gt RecipientAdar Alarmin 1 Motion 1 lt MailTo 6 gt RecipientAdar Alarmin 1 Motion 1 lt MailTo 7 gt RecipientAdar Alarmin 1 Motion 1 lt MailTo 8 gt RecipientAdar Alarmin 1 Motion 1 lt MailTo 9 gt RecipientAdar Alarmin 1 Motion 1 lt MailTo 10 gt RecipientAdar Alarmin 1 MustSendAdminMode 1 lt MailTo 3 gt RecipientAdar Motion 1 Camera Sound lt Input gt Mode 1 Level 2 lt Output gt Mode 1 Level 2 PanTilt General lt PTCondition gt ScanSpeed 1 PowerUp 1 FreezeFrame 1 lt AssociationToAlarm gt Mode 1 PTByAlarmin 1 PTByMotion 1 PresetNumber 1 Resume 1 ResumeTime 60 lt LeftLimitSetting gt Mode 1 Degree 0 lt RightLimitSetting gt Mode 1 Degree 7716 lt TopLimitSetting gt Mode 1 Degree 0 lt BottomLimitSetting gt Mode 1 Degree 2617 PanTilt Preset lt PresetNumber 1 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 2 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 3 gt PresetName PanPosition 32767 TiltPosition 32767
92. ip gt api wbsetcamalarm cgi type HoldingOutTime amp Time lt value gt 1 3 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default Alarm functions type AlarmType Mode 1 0FF 2 Alarm In 3 Ext Control In 1 Input type InputPolarity 1 Normal Opened 2 Normal Closed 1 Motion detection type MotionDetection Mode 1 0FF 2 ON 1 Motion sensitivity Sensitivity HIGH 2 MIDDLE 3 LOW 1 Output hold time type HoldingOutTime Time 1 5 10 15 30 60 5 second Log output control of cgi common to all types OpeLog No Yes default Yes omissible 1 3 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 1 3 4 Example 1 http 10 1 0 1 api wbsetcamalarm cgi type Default 2 http 10 1 0 1 api wbsetcamalarm cgi type Alarm Type amp Mode 28 amp InputPolarity 1 3 http 10 1 0 1 api wbsetcamalarm cgi type MotionDetectiongMode 2 4 http 10 1 0 1 api wbsetcamalarm cgi type HoldingOutTimegTime 10 1 3 5 Notes 1 If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception 2 Multiple type lt value gt cannot be enumerated simultaneously This API must be started for each type 3 For only entered item setting is performed For the other items their existing values are held 4 When OpeLog No is entered a log related to API start end is not output When it is
93. ked 1 Send to mail address 4 type MailTo 4 RecipientAddr any max 64 bytes Send when Alarm IN Alarmin 1 OFF 2 Checked 1 Send when Motion detected Motion 1 OFF 2 Checked 1 Send to mail address 5 type MailTo 5 RecipientAddr any max 64 bytes Send when Alarm IN Alarmin 1 OFF 2 Checked 1 Send when Motion detected Motion 1 OFF 2 Checked 1 Send to mail address 6 type MailTo 6 RecipientAddr any max 64 bytes Send when Alarm IN Alarmin 1 OFF 2 Checked 1 Send when Motion detected Motion 1 OFF 2 Checked 1 Send to mail address 7 type MailTo 7 RecipientAddr any max 64 bytes Send when Alarm IN Alarmin 1 OFF 2 Checked 1 Send when Motion detected Motion 1 OFF 2 Checked 1 OTOSHIBA Corp 26 To the next page TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page Item Type Entry name Entry value Std val Unit Send to mail address 8 type MailTo 8 RecipientAddr any max 64 bytes Send when Alarm IN Alarmin 1 OFF 2 Checked 1 Send when Motion detected Motion 1 OFF 2 Checked 1 Send to mail address 9 type MailTo 9 RecipientAddr any max 64 bytes Send when Alarm IN Alarmin 1 OFF 2 Checked 1 Send when Motion detected Motion 1 OFF 2 Checked 1 Send to mail address 10 type MailTo 10 RecipientAddr any max 64 bytes Send when Alarm IN Alarmin 1 OFF 2 Che
94. l Settings SDK Ver 1 00 SC wbsetcammail cgi 1 6 1 Syntax 1 http lt camip gt api wbsetcammail cgi type Default 2 http lt camip gt api wbsetcammail cgi type Authentication amp Mode lt value gt amp SMT PServer lt value gt amp 3 http lt camip gt api wbsetcammail cgi type ConditionByAlarmIn amp Mode lt value gt amp Subject lt value gt amp 4 http lt camip gt api wbsetcammail cgi type ConditionByMotion amp Mode lt value gt amp Subject lt value gt amp 5 http lt camip gt api wbsetcammail cgi type AttachSize amp AttachSize lt value gt 6 http lt camip gt api wbsetcammail cgi type Recipient amp MustSendAdminMode lt value gt 7 http lt camip gt api wbsetcammail cgi type MailTo n amp RecipientAddr lt value gt amp AlarmIn lt value gt amp Motion lt value gt n 1 10 1 6 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default Authentication type Authentication Mode 1 No authetication 2 POP 1 SMTP server name SMTPServer any max 128 bytes POP3 Server name POP3Server any max 128 bytes User ID POP3ID any max 32 bytes Password POP3Password any max 32 bytes Administrator e mail address AdminMailAddr any max 64 bytes E mail sending by Alarm In type ConditionByAlarmln Mode 1 OFF 2 0N 1 Subject Subject any max
95. mberOfPrePicture va ue r n NumberOfPostPicture va ue r n Interval va ue r n AiFileName value r n MdFileName value r n 9 5 4 Example 1 http 10 1 0 1 api wbgetcamftprecord cgi 9 5 5 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes TOSHIBA Corp 81 Server Path value r n Server2Path value r n lt byExtControlln gt r n Interval value r n FileName value r n Server1 Path value r n Server2Path value r n lt Accumulation gt r n Mode va ue r n Interval value n n OverWriting value r n TOSHIBA Network Camera IK WB15A 9 6 Reference of E mail Settings wbgetcammail cgi 9 6 1 Syntax 1 http lt camip gt api wogetcammail cgi SDK Ver 1 00 SC 9 6 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 9 6 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetcammail cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Mn Camera Mail r n lt Authentication gt r n Mode value r n SMTPServer value r n POP3Server value r n POPSID value r POP3Password value r n AdminMailAddr va ue r n lt ConditionByAlarmIn gt r n Mode value r n Subjec
96. mp Reboot Yes 5 1 5 Notes 1 If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception 2 Multiple type lt value gt cannot be enumerated simultaneously This API must be started for each type 3 For only entered items setting is performed For the other items their existing values are held 4 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes 5 To validate a setting by this API the camera must be rebooted 6 When Reboot Yes is entered and setting can be performed according to other entered value the camera performs reboot processing as itis Accordingly the client may not receive 20 OK r n being a normal termination status 7 When Reboot No is entered reboot the camera by wbsetcamreboot cgi or turn on off the power supply of the camera after starting this API OTOSHIBA Corp 49 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 5 2 User Operation Restriction Control wbsetadminuserfunctions cgi 5 2 1 Syntax 1 http lt camip gt api wbsetadminuserfunctions cgi type Default 2 http lt camip gt api wbsetadminuserfunctions cgi type FunctionRestriction amp Mode lt value gt 3 http lt camip gt api wbsetadminuserfunctions cgi type Function amp Resolution lt value gt amp CompressionRatio lt value gt amp 5 2 2 Input It
97. n OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes TOSHIBA Corp 105 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC IX IK WB15A List Operation type API List Deletion of All Ext Control In List Deletion of Ext Control In List by Time and Date Item No Item Sub number menu API name Function type 15 Alarm In List 15 1 Reference of Alarm In List wblistalarm cgi 3 types Deletion of All Alarm In List Deletion of Alarm In List by Time and Date Normal List 15 2 Reference of Normal List wblistnormal cgi 3 types Deletion of All Normal List Deletion of Normal List by Time and Date Ext Control In List 15 3 Reference of Ext Control In List wblistextcontrol cgi 3 types OTOSHIBA Corp 106 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 15 List Operation wblistalarm cgi Reference Deletion of Alarm In List wblistnormal cgi Reference Deletion of Normal List wblistextcontrol cgi Reference Deletion of Ext Control In List wblist func cgi 1 2 3 1 Indicates a list operation API 2 Indicates a list operation type reference deletion API 3 4 3 Indicates the function matched to the WEB setting page 4 Every API is started and executed as cgi On and after the next page the camera reference API is shown TOSHIBA Corp 107 TOSHIBA Network Camera IK WB15A
98. n gt r n Zoom value r n Resolution value r n Audio value r n CompressionRatio va ue r n PictureSaving value r n AEControl value An PanTilt value r n Mounting va ue r n AutoPatrol value um AutoBW value r n Scan value r n WhiteBalance value r n Preset value r n WBManualGain value r n PlayAlarm va ue r n AWBOffset value r n PlayNormal value r n AWBRange value r n PlayControl value r n AutoGainControl va ue r n 13 2 4 Example 1 http 10 1 0 1 api wbgetadminuserfunctions cgi 13 2 5 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 99 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 13 3 Reference of Time and Date Settings wbgetadminTaD cgi 13 3 1 Syntax 1 http lt camip gt api wbgetadminTaD cgi 13 3 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 13 3 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetadminTaD cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Mode value r n Mn Server value r n Admin T amp D r n AdjustingCycle value r n lt TimeZone gt r n lt DaylightSaving gt Location value r n Mode value
99. n ms Set the execution timeout value in ms for the case where a non communication status is continued over a certain period with the client while lt image field gt is output 7 6 3 Output The format is the same as that for getting Live Pictures by streaming For details refer to Appendix A 7 6 4 Example 1 http 10 1 0 1 api getstream cgi 3087830878Z23VIC3Q 8 amp Z3VIc3Q 8580808089000 7 6 5 Notes 1 The client ID should be one that is distributing the stream If a non existent ID is specified abort processing is not performed 2 The 4 interfaces of Live Picture stream Playback Picture stream Live Audio stream and Abort stream are common APIs However the meaning of each parameter varies depending on the target to be executed 3 It is desirable that the stream should be stopped by abort5 or abort10 This will reduce the network load of the IK WB15A OTOSHIBA Corp TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 7 7 Abort stream abort10 getstream cgi 774 Syntax 1 http lt camip gt api getstream cgi lt clientID gt amp lt uniquelD gt amp lt ID gt amp lt PW gt amp lt stream Type gt amp lt interval gt amp lt mode gt amp lt value gt amp lt timeOut gt 7 7 2 Input Parameter Value Explanation lt clientID gt Enter a unique ID of up to 15 digits This lt clientID gt is used as an index to forcibly terminate abort10 the streaming
100. n to all types OpeLog No Yes default Yes omissible 13 1 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetadminuserinfo cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Mn User Info r n LoginRestriction va ue r n 13 1 4 Example 1 http 10 1 0 1 api wbgetadminuserinfo cgi 13 1 5 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 98 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 13 2 Reference of User Operation Restriction wbgetadminuserfunctions cgi 13 2 1 Syntax 1 http lt camip gt api wogetadminuserfunctions cgi 13 2 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 13 2 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetadminuserfunctions cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n SlowShutterMax value r n Mn BackLightCompensation va ue r n Admin UserFunctions r n Sharpness value r n lt FunctionRestriction gt r n Gain value r n Mode value r n NoiseReduction value r n lt Functio
101. nd the list output may be stopped halfway In this case a status to notify the error is output after the last list A case 1 B case 2 20 OK r n 20 OK r n Wn AAN alarmlist 1 r n AAN alarmlist 2 n n 60 FailAction r n Mn i 60 FailAction r n In both cases of success and failure the format is not the HTML format 2 When at type RemoveAll RemoveSpan Code Status Code Status 20 OK 60 FailAction 31 InvalidEntry 32 InvalidValue 15 1 4 Example 1 http 10 1 0 1 api wblistalarm cgi type Show 2 http 10 1 0 1 api wblistalarm cgi type RemoveAll 3 http 10 1 0 1 api wblistalarm cgi type RemoveSpan amp StartD T 200501 12000000 amp EndDT 200501 24235959 15 1 5 Notes 1 The relation between StartDT and EndDT at type RemoveSpan should be StartDT lt EndDT and both should be of the yyymmddHHMMSS format 2 Attype RemoveAll and type RemoveSpan the corresponding list is immediately deleted without confirmation 3 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes 4 This API does not check type lt value gt and any argument other than StartDT lt value gt and EndDT lt value gt at type RemoveSpan Accordingly if there are illegal arguments other than these they are ignored OTOSHIBA Corp 109 TOSHIBA Network Camera IK WB15A 15 2 Reference Deletion of Normal List wblistnormal cgi 15 2 1 Syntax SDK
102. nently r n 302 Redirection HTTP 1 0 302 Moved Temporarily r n 304 Client Error HTTP 1 0 304 Not Modified r n 400 Client Error HTTP 1 0 400 Bad Requesit r n 401 Client Error HTTP 1 0 401 Unauthorized r n 403 Client Error HTTP 1 0 403 Forbidden r n 404 Client Error HTTP 1 0 404 Not Found r n 500 Server Error HTTP 1 0 500 Server Error r n 501 Server Error HTTP 1 0 501 Not Implemented r n 502 Server Error HTTP 1 0 502 Bad Gateway r n 503 Server Error HTTP 1 0 503 Service Unavailable r n 505 Server Error HTTP 1 0 505 HTTP Version Not Supported r n OTOSHIBA Corp TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC ll Comparison between WEB Setting Page and API functions API types gt APIs are roughly classified into the following 6 types Information setting type API Information reference type API Image audio type API List operation type API External storage operation type API Pan Tilt Zoom PTZ operation type API API Functions gt As a rule all the items to be executed by the WEB setting page can also be set or referenced as the API The meanings of the codes in the table are O All operable for the function X All inoperable for the function Partially inoperable for the function The function is not applicable This is intended so that the function should be used depending on whether the using person is an administrator or user in an application
103. of the other APIs 3 Up to 30fps at 640x480 VGA 320x240 QVGA 160x120 QQVGA 7 5fps at 1280x960 SXVGA resolution For details refer to Appendix D TOSHIBA Corp 64 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 7 3 Get Playback Pictures by streaming getstream cgi 7 31 Syntax 1 http lt camip gt api getstream cgi lt clientID gt amp lt uniquelD gt amp lt ID gt amp lt PW gt amp lt stream Type gt amp lt interval gt amp lt mode gt amp lt value gt amp lt timeOut gt 73 2 Input Parameter Value Explanation lt clientID gt Enter a unique ID of up to 15 digits This lt clientID gt is used as an index to forcibly terminate abort the streaming execution task from the outside It cannot be omitted lt uniquelD gt Enter a unique ID of up to 15 digits Embed the current time data of the client on each occasion Originally this is used as a cache reading preventive means in using the browser by continuously changing the value If there is not any problem similar to the browser in an application this parameter can be left blank lt ID gt Enter the administrator ID that is base64 encoded Originally it is necessary to enter the administrator ID when obtaining the image data of a LIVE image _play jpg In the IK WB15A however it is can be left blank as a parameter lt PW gt Enter the administrator ID that is base64 encoded Originally it is necessar
104. ol cgi 10 3 1 Syntax 1 http lt camip gt api wbgetptautopatrol cgi 10 3 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 10 3 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetptautopatrol cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Mn PanTilt AutoPatrol r n lt StayTime gt r n StayTime va ue r n lt AutoPatrolStopNumbers gt r n PresetNumber 1 va ue r n PresetNumber 2 va ue r n PresetNumber 64 va ue r n 10 3 4 Example 1 http 10 1 0 1 api wbgetptautopatrol cgi 10 3 5 Notes 1 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 88 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 11 Reference of Network Setting wbgetnwkbasic cgi Reference of Network Basic Settings wbgetnwkbandwidth cgi Reference of Bandwidth Control Settings wbgetnwkddns cgi Reference of DDNS Settings wbgetnwkftpserver cgi Reference of FTP Server Settings wbgetnwkmac cgi Reference of MAC Address wbget nwk func cgi 1 2 3 4 D 1 2 3 4 Indicates a reference API Indicates a Pan Tilt type reference API Indicates the function matched to the WEB setting page
105. oomPosition 0 lt PresetNumber 30 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 31 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 32 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 33 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 34 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 35 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 36 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 37 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 38 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 39 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 40 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 41 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 42 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt Pre
106. ot receive 20 OK r n being a normal termination status When Reboot No is entered and the basic settings of the network are performed reboot the camera by wbsetcamreboot cgi or turn on off the power supply of the camera after starting this API If only Camera name is set by this API and the other items are not changed at all it is not necessary to reboot the camera as a camera reboot exception TOSHIBA Corp 41 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 3 2 Bandwidth Control Settings wbsetnwkbandwidth cgi 3 2 1 Syntax 1 http lt camip gt api wbsetnwkbandwidth cgi type Default 2 http lt camip gt api wbsetnwkbandwidth cgi type Set amp Mode lt value gt amp Numeric lt va ue gt amp BandWidth lt value gt 3 2 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default Function type Set Mode 1 0FF 2 0N 1 Band numeric Numeric any O lt n lt 102400 100 Band unit BandWidth 1 Kbit S 2 Mbit S 2 Log output control of cgi common to all types OpeLog No Yes default Yes omissible 3 2 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 3 2 4 Example 1 http 10 1 0 1 api wbsetnwkbandwidth cgi type Default 2 http 10 1 0 1 api wbsetnwkbandwidth cgi type SetgMode 28Numeric 2568Ban
107. page 4 Every API is started and executed as cgi On and after the next page the network setting API is shown TOSHIBA Corp 45 TOSHIBA Network Camera IK WB15A 4 1 Multi Screen Display Settings SDK Ver 1 00 SC wbsetmultiscreen cgi Syntax 1 http lt camip gt api wbsetmultiscreen cgi type Default 2 http lt camip gt api wbsetmultiscreen cgi type DisplayMode 8Mode lt value gt 3 http lt camip gt api wbsetmultiscreen cgi type Camera 1 amp Name lt value gt amp Addr lt value gt amp 4 http lt camip gt api wbsetmultiscreen cgi type Camera 30 8Name lt value gt SAddr lt value gt 8 4 1 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default Multi Screen display mode type DisplayMode Mode 1 OFF 2 0N 1 Set enable my camera on multi screen type MyCameralnfo Selection 1 OFF 2 Checked 2 Added camera Name Camera 1 Name any max 64 bytes 1 Access Addr any max 128 bytes HTTP port number HTTPPortNumber 80 1025 65535 80 Type Kind Should be ignored Enable on multi screen Selection 1 OFF 2 Checked 1 Added camera Name Camera 30 Name any max 64 bytes 30 Access Addr any max 128 bytes HTTP port number HTTPPortNumber 80 1025 65535 80 Type Kind Should be ignored Enable on multi screen Selection 1 OFF 2 Checked 1 Log output control of cgi common to all types
108. pe gt 2 connections is up to 10 clients simultaneously For details refer to Appendix D OTOSHIBA Corp 66 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 7 4 Get Live Audio by streaming getstream cgi 741 Syntax 1 http lt camip gt api getstream cgi lt clientID gt amp lt uniquelD gt amp lt ID gt amp lt PW gt amp lt stream Type gt amp lt interval gt amp lt mode gt amp lt value gt amp lt timeOut gt 7 4 2 Input Parameter Value Explanation lt clientID gt Enter a unique ID of up to 15 digits This lt clientID gt is used as an index to forcibly terminate abort the streaming execution task from the outside It cannot be omitted lt uniquelD gt Enter a unique ID of up to 15 digits Embed the current time data of the client on each occasion Originally this is used as a cache reading preventive means in using the browser by continuously changing the value If there is not any problem similar to the browser in an application this parameter can be left blank lt ID gt Enter the user ID that is base64 encoded or the Originally lt ID gt is omissible only when the user limitation setting is Invalid administrator ID OFF at obtaining the image data of a LIVE image _live wav In the IK WB15A it can be left blank as a parameter lt PW gt Enter the user ID that is base64 encoded or the Originally lt PW gt is omissible only when the user limitation se
109. position of record images lt direction gt Enter the direction of reproduction Normal direction 0 Reverse direction 1 lt step gt Enter the number of images to be skipped number of Usually specify 1 skipped images lt number gt Enter the total number of images to be reproduced When 0 is specified reproduction is performed to the last image When any value other than 0 is specified enter the number of images that the client requires 7 3 3 Output The format is the same as that for getting Live Pictures by streaming For details refer to Appendix A 7 3 4 Example http 10 1 0 1 api getstream cgi 3087 amp 3087 amp amp amp 2 amp 0 amp 0 amp 08 amp 9000 Notes The client ID is an ID of up to 15 digits that is generated on the client side to execute getstream If this ID is already in use the camera informs the client of an error to cancel the image distribution The 4 interfaces of Live Picture stream Playback Picture stream Live Audio stream and Abort stream are common APIs However the meaning of each parameter varies depending on the target to be executed It is desirable that the stream should be stopped by abort5 or abort10 This will reduce the network load of the IK WB15A Only regarding the interface of getstream type API to obtain reproduced images as a stream parameters are extended for other getstream types The number of getstream cgi lt streamTy
110. ppendix A 125 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC For JPEG data Content Type image jpeg r n Content Length lt image size gt r n Mn lt JPEG image data gt r n For Audio data Content Type audio wav r n Content Length lt image size gt r n r n lt WAV image data gt r n Each lt image fields gt and an output message from the streaming execution task are separated by a unique 32 byte synchronization ID based on each occasion which is called boundary Regarding the image data receiving status it can be judged by enclosing in the boundary whether the data indicated in Length has been received If Length does not match with the actual received image size the image data in this boundary is regarded as incomplete data so that an error is notified or the data is discarded proceeding to receiving processing for the next image data For termination due to an error If streaming cannot be started due to a parameter error the data is output in the following fixed format HTTP 1 0 200 OK r n Content Type multipart x mixed replace boundary lt 32byte sync gt r n r n lt 32byte sync gt r n Content Length 20 r n lt stream msg gt r n lt 32byte sync gt r n Content Length 20 r n EndOf getstream cgi TOSHIBA Corp Appendix A 126 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC As compared with the normal status this status is characterized by the following two point
111. precord cgi type Server 2 amp Name F TPs amp LoginID lt base64enc gt amp Password lt basee64enc gt http 10 1 0 1 apiAwbsetcamftprecord cgi type AttachedPicture amp Size 3 http 10 1 0 1 api wbsetcamftprecord cgi type HowToUse amp Detail 1 http 10 1 0 1 apiAvbsetcamftprecord cgi type bySchedule amp lnterval 5 http 10 1 0 1 apiAwbsetcamftprecord cgi type by Alarm amp interval 10 amp AiFileName ext amp MdFileName mtd http 10 1 0 1 apiAvbsetcamftprecord cgi type byExtControlln amp Interval 10 amp FileName extc amp Serverl Path cam jpge http 10 1 0 1 apiAwbsetcamftprecord cgi type Accumulation amp Mode 28 amp lInterval 10 Notes If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception Multiple type lt va ue gt cannot be enumerated simultaneously This API must be started for each type When LoginlD Password is specified at type Server 1 2 these must be base64 encoded When a blank character is included in lt value gt it must be URL encoded For only entered items setting is performed For the other items their existing values are held When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes Be very careful that the value of Detail entry of type HowToUse differs from the entry format of WEB setting page OTOSHIBA Corp 24 TOSHIBA Network Camera IK WB15A 1 6 Mai
112. put Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 9 5 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand wbgetcamftprecord cgi indicates the notification data format to the client when data has been obtained normally 20 OK r n Mn Camera FTPclient r n lt FTPCondition gt r n Mode va ue r n AlarminMode value r n MotionMode value r n lt Server 1 gt r n Name value r n LoginID value r n Password va ue r n FTPcPortNumber va ue r n FTPMode value r n ConnectMode value r n lt Server 2 gt r n Name value r n LoginID value r n Password value r n OTOSHIBA Corp FTPcPortNumber value r n FTPMode value r n ConnectMode value r n lt AttachedPicture gt Size value r n FileNameMode value r n lt HowToUse gt r n Detail value r n lt bySchedule gt r n Monday value r n Tuesday value r n Wednesday value r n Thursday value r n Friday value r n Saturday value r n Sunday value r n Pattern1Start va ue r n Pattern1End value r n 80 To the next page TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page Pattern2Start va ue r n Pattern2End value r n Interval va ue r n FileName value r n Server1Path va ue r n Server2Path value r n lt byAlarm gt r n Nu
113. put control of cgi common to all types OpeLog No Yes default Yes omissible 3 4 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 3 4 4 Example 1 http 10 1 0 1 api wbsetnwkftpserver cgi type Default 2 http 10 1 0 1 api wbsetnwkftpserver cgi type Set amp Mode 2 amp LoginlD lt base64enc gt amp Password lt base64enc gt amp MaxConnection 5 3 4 5 Notes QABON OTOSHIBA Corp 44 If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception Multiple type lt va ue gt cannot be enumerated simultaneously This API must be started for each type When LoginlD Password is specified at type Server 1 2 these must be base64 encoded When a blank character is included in lt value gt it must be URL encoded For only entered item setting is performed For the other items their existing values are held When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 4 Multi Screen Display Settings wbsetmultiscreen cgi Multi Screen Display Settings wbset multi func cgi 4 1 2 3 1 Indicates a setting API 2 Indicates a multi screen display type setting API 3 Indicates the function matched to the WEB setting
114. r 17 gt TOSHIBA Corp 129 To the next page Appendix B TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 18 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 19 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 20 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 21 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 22 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 23 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 24 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 25 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 26 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 27 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 28 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 29 gt PresetName PanPosition 32767 TiltPosition 32767 Z
115. rFunctions lt FunctionRestriction gt Mode 1 lt Function gt Resolution 1 CompressionRatio 1 AEControl 1 Mounting 1 AutoBW 1 WhiteBalance 1 WBManualGain 1 AWBOffset 1 AWBRange 1 AutoGainControl 1 SlowShutterMax 1 BackLightCompensation 1 Sharpness 1 lt Camera 28 gt Gain 1 Name NoiseReduction 1 Addr Zoom 1 HTTPPortNumber 80 Audio 1 Kind 1 PictureSaving 1 Selection 1 PanTilt 1 lt Camera 29 gt AutoPatrol 1 Name Scan 1 Adar Preset 1 PlayAlarm 1 PlayNormal 1 PlayControl 1 Admin T amp D lt TimeZone gt Location 8 lt NTP gt Mode 1 Server AdjustingCycle 1 lt DaylightSaving gt Mode 1 Log Condition Display 1 Filter 1 Which 1 NumberOf 16 Keyword Year 5 Month 1 Day 1 Hour 0 Minute 0 Second 0 BcAd 1 TOSHIBA Corp Appendix B TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC Appendix C PAN TILT direction and coordinate on Desktop Wall Mount Ceiling Mount 1 PAN TILT when using Desktop Wall Mount installation method 1 Direction of PAN TILT Tilt Up Top Limit 5 0 Pan Right Pan Left Right Limit 56 2640 Left Limit 56 0 Tilt Down Bottom Limit 49 1200 2 Formula to get the approximate Value of PAN
116. rection of PAN TILT Pan Left Left Limit 56 Tilt Up Tilt Down Top Limit 49 Bottom Limit 5 Pan Right Right Limit 56 2 Formula to get the approximate Value of PAN TILT position Action Formula Range of n Panning to n degree from the center n 56 x24 56 lt n lt 56 Tilting to n degree from the level n 5 x22 B lt n lt 49 Refer to Tables in 5 and 6 below 3 Formula to get approximate Value of Left Right Top Bottom Limit Setting Formula Range of n Left Limit n 56 x24 56 lt Nn lt 56 Right Limit n 56 x24 56 lt Nn lt 56 Top Limit n 5 x22 5 lt N lt 49 Bottom Limit n 5 x22 5 lt N lt 49 TOSHIBA Corp 137 Appendix C TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 4 Value for wbpantiltapi cgi when using Desktop Mount option Value Pan Left wbpantiltapi cgi cont_2 2 Pan Right wbpantiltapi cgi cont_2 1 Tilt Up wbpantiltapi cgi cont_2 8 Tilt Down wbpantiltapi cgi cont_2 4 5 Relation between PAN degree and value in API Degree Value Degree Value Degree Value Degree Value Degree Value Degree Value Pan Left 37 448 17 919 Pan Right 20 1791 40 2263 56 0 36 471 16 943 1 1344 21 1815 41 2286 55 24 35 495 15 966 2 1367 22 1839 42
117. rol cgi type Default 2 http lt camip gt api wbsetptautopatrol cgi type Stay Time amp Stay Time lt value gt 3 http lt camip gt api wbsetptautopatrol cgi type AutoPatrolStopNumber amp PresetNumber 1 lt value gt amp PresetNumber 2 lt value gt amp 2 3 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default Auto patrol stop time type StayTime StayTime 1 2 5 10 1 minute Preset number 1 type AutoPatrolStopNumber PresetNumber 1 1 0FF 2 Checked 1 Preset number 64 PresetNumber 64 1 OFF 2 Checked 1 Log output control of cgi common to all types OpeLog No Yes default Yes omissible 2 3 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntryData 2 3 4 Example 1 http 10 1 0 1 api wbsetptautopatrol cgi type Default 2 http 10 1 0 1 api wbsetptautopatrol cgi type Stay Time amp Stay Time 10 3 http 10 1 0 1 api wbsetptautopatrol cgi type AutoPatrolStoopNumber amp PresetNumber 1 2 amp PresetNumber 33 2 2 3 5 Note A TOSHIBA Corp 34 If only type lt value gt is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception Multiple type lt value gt cannot be enumerated simultaneously This API must be started for each type 3 For only entered items setting is performed For the other items their existing values ar
118. rp 30 To the next page TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page 2 1 4 Example ON al o E a S a S Sa N 2 1 5 Notes k MARN al OTOSHIBA Corp http 10 1 0 1 api wbsetptbasic cgi type Default http 10 1 0 1 api wbsetptbasic cgi type PT Condition amp ScanSpeed 2 amp PowerUp 4 amp FreezeActivity 2 http 10 1 0 1 api wbsetptbasic cgi type Association ToAlarm amp Mode 2 amp PTByMotion 2 amp PresetNumber 33 amp Resume 1 http 10 1 0 1 api wbsetptbasic cgi type LeftLimitSetting amp Mode 2 amp Degree 1 75 http 10 1 0 1 api wbsetptbasic cgi type RightLimitSetting amp Mode 1 http 10 1 0 1 api wbsetptbasic cgi type TopLimitSetting amp Mode 2 amp Degree 175 http 10 1 0 1 api wbsetptbasic cgi type BottomLimitSetting amp Mode 1 31 If only type Set is entered and then lt entry gt lt value gt is not entered no setting is performed type Default is an exception Multiple type lt value gt cannot be enumerated simultaneously This API must be started for each type For only entered items setting is performed For the other items their existing values are held When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes Setting values of Degree is defined in Appendix C Item Type Entry name Entry value Std val Unit Bottom
119. rt Stream getstream cgi OTOSHIBA Corp To the next page TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page Item Menu API name Reference All Information wbgetallinfo cgi Getting Camera Informations Basic wbgetcambasic cgi Frame Rate wbgetframerate cgi Alarm wbgetcamalarm cgi Recording wbgetcamrecord cgi FTP Recording wbgetcamftprecord cgi E mail wbgetcammail cgi Audio wbgetcamsound cgi Getting PAN TILT Informations Basic wbgetptbasic cgi Operations Range Preset wbgetptpreset cgi Auto Patrol wbgetptautopatrol cgi Easy Preset Management wbpreset cgi 9 Getting Network Informations Basic wbgetnwkbasic cgi Bandwidth Control wbgetnwkbandwidth cgi o DDNS wbgetnwkddns cgi F FTP Server wbgetnwkftpserver cgi a MAC Address wbgetnwkmac cgi Multi Screen Settings Infrastructure of Cameras wbgetmultiscreen cgi Getting Administrator User Login Restriction wbgetadminuserinfo cgi Settings User Operation Restriction wbgetadminuserfunctions cgi Date and Time NTP wbgetadminTaD cgi Current Time wbgetadmintime cgi FW Update Configuration Import Export Reset to Default gt Camera Rebooting Getting Log Settings Log Filters wbgetlogconditions cgi Browse wbgetloglist cgi OTOSHIBA Corp To the next page TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page
120. s There is no lt lt image fields gt gt The stream message lt stream msg gt is added together with the Length indicating line before the stream termination message of EndOf getstream cgi Contents of lt stream msg gt lt stream msg gt is a message to be used to notify the client of a streaming execution result and its length is fixed to 20 bytes in every message This is used not only to notify an error message but to notify a streaming forced termination status such as abort5 abort10 EndOf getstream cgi is a part of lt stream msg and a message that is always output when streaming ends Next the types of lt stream msg gt message and the output timing of these messages are described below Item No Message type contents of message Status Note 1 Normal 1 OUT EndOf getstream cgi both normal and error This message may always be output with the streaming exec task abort exec task exception of abort10 2 Normal 2 OUT Not Found normal The last data has been distributed at reproduced streaming exec task image stream distribution 3 Error 1 OUT Parameter Error error An error has found in an input parameter to the streaming exec task stream 4 Error 2 OUT unmatch auth info error The ID PW authentication information does not streaming exec task match In the IK WB15A This error is not notified 5 Emergency Normal 1 OUT Abort
121. setNumber 43 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 44 gt PresetName PanPosition 82767 TitPosition 32767 ZoomPosition 0 lt PresetNumber 45 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 46 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 47 gt PresetName PanPosition 82767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 48 gt PresetName TOSHIBA Corp 130 To the next page Appendix B TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 49 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 50 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 51 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 52 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 53 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 54 gt PresetName PanPosition 32767 TiltPosition 32767 ZoomPosition 0 lt PresetNumber 55 gt PresetName PanPosition 32767 TiltPosition 3
122. t va ue r n Body value r n URLMode value r n URLInfo va ue r n AttachMode value r n lt ConditionByMotion gt r n OTOSHIBA Corp Mode value r n Subject value An Body value r n URLMode value r n URLInfo value r n AttachMode value r n lt AttachSize gt r n AttachSize value r n lt Recipient gt r n MustSendAdminMode value r n lt MailTo 1 gt r n RecipientAddr value n Alarmin value n n Motion va ue r n lt MailTo 2 gt r n RecipientAddr va ue r n Alarmin va ue r n Motion value r n 82 To the next page TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page lt MailTo 3 gt r n lt MailTo 7 gt r n RecipientAdar value r n RecipientAddr value r n Alarmin value r n Alarmin value r n Motion va ue r n Motion value r n lt MailTo 4 gt r n lt MailTo 8 gt r n RecipientAdar va ue r n RecipientAddr value r n Alarmin value r n Alarmin value r n Motion va ue r n Motion value r n lt MailTo 5 gt r n lt MailTo 9 gt r n RecipientAdar value r n RecipientAddr value r n Alarmin value r n Alarmin value r n Motion va ue r n Motion va ue r n lt MailTo 6 gt r n lt MailTo 10 gt r n RecipientAddr va ue r n RecipientAddr value r n Alarmin value r n Alarmin value r n Motion va ue r n Motion value r n 9 6 4 Example 1 http 10 1 0 1 api wbgetc
123. t mode gt amp lt value gt amp lt timeOut gt 7 6 2 Input Parameter Value Explanation lt clientID gt Enter a unique ID of up to 15 digits This lt clientID gt is used as an index to forcibly terminate abort5 the streaming execution task from the outside It cannot be omitted lt uniquelD gt Enter a unique ID of up to 15 digits Embed the current time data of the client on each occasion Originally this is used as a cache reading preventive means in using the browser by continuously changing the value If there is not any problem similar to the browser in an application this parameter can be left blank lt ID gt Enter the user ID that is base64 encoded or the Originally the ID used for executing the streaming is required administrator ID In the IK WB15A it can be left blank lt PW gt Enter the user ID that is base64 encoded or the Originally the PW used for executing the streaming is required administrator ID In the IK WB15A it can be left blank lt streamType gt Specify 5 for the type of abort5 Termination of external abort 5 lt interval gt 0 When lt streamType gt is 5 this parameter may have any value However enter 0 lt mode gt 0 When lt streamType gt is 5 this parameter may have any value However enter 0 lt value gt 0 When lt streamType gt is 5 this parameter may have any value However enter 0 lt timeout gt Set the execution timeout value i
124. t supported by the API URL decode All parameters to API are URL decoded If numeric 5 inputted the API treats this character as 5 5 does not equal to 5 Client Cache When the client used is a WEB browser the camera information at that time may not be obtained correctly due to the browser cache For example the information reference type API Accordingly take extreme care about the client cache Information output The following settings output from this API are not in HTML format Status Setting information Obtain the information according to the output format described in this specification After the command API is executed by a browser its result may not be displayed in the output format described in this specification In this case open the output source of the browser by another editor Then the information can be read in a correct format For the status refer to API termination status that will be described later Security All of these APIs require authentication that is managed by administrator ID When executing each API be sure to clear the basic authentication beforehand Reply status from the API It may take some time to receive a reply status from the setting type API To operate multiple APIs continuously be sure to proceed to the next operation after receiving the previous API execution reply status OTOSHIBA Corp TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC
125. te Settings 9 3 Reference of Alarm Settings oviedo din a 9 4 Reference of Recording Settings 9 5 Reference of FTP Recording SOMOS ideas 80 9 6 Reference of E mail Se S T e a E a sa 82 9 7 RoOterence OA Settings 2 ccc AE A E E ETA AO E 84 10 Reference of PAN TIL Setting tooo a 85 110 1 Reference of Pan Tilt Basic SOMOS tn a aaa 86 10 27 Referente Preset Settings pci A A ad AE 87 10 37 Reference of Auto Patrol SCS cia a a A A aia 88 11 Reference of Network Setting coi da 89 11 1 Reference of Network Basie Ati oras 90 TOSHIBA Corp TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 11 2 Reference of Bandwidth Control Settings cece eee eee cece eaten etree eee ener renee eee eee eee eee eee ee eee eee anna aaa aaa ee ee ee e ee ee eeeee 91 11 3 gt Reference of DDNS Settings sas stats cas aa eaaa a ARE 92 11 4 Reference of FIP Server Settings imita a redada 93 1125 Get MAG ADOOS vec coca cag tei A A A ntc 94 12 Reference of Administrator Functions eee EEE ee t EEE een ee enn een eee ree een ee ee ke eeeeaeeeeeeeaaeeeeeaaeeeeseaaees 95 12 1 Reference of MulticScreenslnformathon ce sisisisvs s s sta sce den ees a a sagpecedcenacsaataggede iia ieaa 96 13 Reference of Administrator Functions erra rene 97 13 1 Reference of User infom a O io cion AAA ii EREE REESEN 98 13 2 Reference of User Operation Restriction
126. tered no setting is performed type Default is an exception 2 Multiple type lt value gt cannot be enumerated simultaneously This API must be started for each type TOSHIBA Network Camera IK WB15A 5 3 NTP Settings wbsetadminTaD cgi 5 3 1 Syntax SDK Ver 1 00 SC http lt camip gt api wosetadminTaD cgi type Default 1 2 http lt camip gt api wbsetadminTaD cgi type TimeZone amp Location lt value gt 3 http lt camip gt api wbsetadminTaD cgi type NT P amp Mode lt value gt amp Server lt value gt amp AdjustingCycle lt value gt 4 http lt camip gt api wbsetadminTaD cgi type DaylightSaving amp Mode lt value gt 5 3 2 Input Item Type Entry name Entry value Std val Unit Reset to Default type Default Time zone type TimeZone Location 12 12 7 hour Using NTP type NTP Mode 1 0FF 2 ON 1 NTP Server name Server any max 64 bytes Adjusting Cycle AdjustingCycle 1 On camera boot and 24 hour priod 1 2 On camera boot and 12 hour priod 3 On camera boot and 6 hour priod 4 On camera boot and 1 hour priod Daylight Saving type DaylightSaving Mode 1 O0FF 2 0N 1 Log output control of cgi common to all types OpeLog No Yes default Yes omissible 5 3 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 92 CriticalError 30 InvalidType 33 InvalidOperand 31 InvalidEntry 34 NoEntry
127. tion data format to the client when data has been obtained normally 20 OK r n r n Zoom value r n PAN value r n TILT value r n 17 3 4 Example 1 http 10 1 0 1 api wbgetptzposition cgi 17 3 5 Note N A OTOSHIBA Corp 124 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC Appendix A Output of getstream cgi The distribution format by streaming has the following fixed format lt HTTP Header gt lt Image Data Division gt lt Message Notification Division gt To distribute multiple image data mage Data Division is executed repeatedly lt Message Notification Division gt notifies the client of the streaming execution status and termination status as a message The following is an explanation of how to distribute image data For normal termination To distribute image data by streaming it is output in the following fixed format The italic portion means a portion that changes as data HTTP 1 0 200 OK r n Content Type multipart x mixed replace boundary lt 32byte sync gt n n r n lt 32byte sync gt r n lt lt image fields gt gt lt 32byte sync gt r n lt lt image fields gt gt lt 32byte sync gt r n lt lt image fields gt gt lt 32byte sync gt r n Content Length 20 r n EndOf getstream cgi The above is used as the basic format and the contents of lt lt image fields gt gt varies depending on whether it is voice data or image data as shown below TOSHIBA Corp A
128. tting is Invalid administrator ID OFF at obtaining a LIVE image In the IK WB15A it can be left blank as a parameter lt streamType gt Specify 1 for the type of the LIVE audio to be obtained livewav 1 lt interval gt 0 When lt streamType gt is 1 this parameter may have any value However enter 0 lt mode gt Specify a fixed number of files or a fixed period as the Fixed number of files 0 LIVE audio obtaining method Fixed period 1 lt value gt Set the numeric value for the mode specified in lt mode gt When lt mode gt is 0 set the number of files in lt value gt When lt mode gt is 1 set the time interval in lt value gt lt timeout gt Set the execution timeout value in ms Set the execution timeout value in ms for the case where a non communication status is continued over a certain period with the client while lt image field gt is output 7 4 3 Output The format is the same as that for getting Live Pictures by streaming For details refer to Appendix A 7 4 4 Example 1 http 10 1 0 1 api getstream cgi 3087 amp 3087 amp amp amp 1 amp 1000 amp 1 amp 0 amp 9000 OTOSHIBA Corp 67 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 7 4 5 Notes 1 The client ID is an ID of up to 15 digits that is generated on the client side to execute getstream If this ID is already in use the camera informs the client of an error to cancel the image distribution 2 The 4 interfaces of
129. ut For details refer to Appendix A 7 1 4 Example 1 http 10 1 0 1 api getstream cgi 3087 amp 3087 amp amp amp 0 amp 1000 amp 1 amp 0 amp 9000 OTOSHIBA Corp 62 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 7 1 5 Notes 1 The client ID is an ID of up to 15 digits that is generated on the client side to execute getstream If this ID is already in use the camera informs the client of an error to cancel the image distribution 2 The 4 interfaces of Live Picture stream Playback Picture stream Live Audio stream and Abort stream are common APIs However the meaning of each parameter varies depending on the target to be executed 3 Itis desirable that the stream should be stopped by abort5 or abort10 This will reduce the network load of the IK WB15A 4 The number of getstream cgi lt streamType gt 0 connections is up to 10 clients simultaneously JPEG and WAV are independent respectively For details refer to Appendix D TOSHIBA Corp 63 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 7 2 One shot Live Picture _ live jpg 7 2 1 Syntax 1 http lt camip gt admin __live jpg 7 2 2 Input N A 7 2 3 Output 1 Only asingle JPEG image is downloaded 7 24 Example 1 http 10 1 0 1 admin __live jpg 7 2 5 Notes 1 This API can obtain only a single image To obtain multiple images start this API in succession 2 Note that the directory of this API is different from those
130. way In this case a status to notify the error is output after the last list A case 1 B case 2 20 OK r n 20 OK r n r n Mn normallist 1 r n i r n normallist 2 r n 60 FailAction r n r n 60 FailAction r n In both cases of success and failure the format is not the HTML format 2 When at type RemoveAll RemoveSpan Code Status Code Status 20 OK 60 FailAction 31 InvalidEntry 32 InvalidValue 15 2 4 Example 1 http 10 1 0 1 api wblistnormal cgi type Show 2 http 10 1 0 1 api wblistnormal cgi type RemoveAll 3 http 10 1 0 1 api wblistnormal cgi type RemoveSpan amp StartDT 200501 12000000 amp EndDT 200501 24235959 15 2 5 Notes 1 The relation between StartDT and EndDT at type RemoveSpan should be StartDT lt EndDT and both should be of the yyymmddHHMMSS format 2 Attype RemoveAll and type RemoveSpan the corresponding list is immediately deleted without confirmation 3 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes 4 This API does not check type lt value gt and any argument other than StartDT lt value gt and EndDT lt value gt at type RemoveSpan Accordingly if there are illegal arguments other than these they are ignored OTOSHIBA Corp 111 TOSHIBA Network Camera IK WB15A 15 3 Reference Deletion of Ext Control In List wblistextcontrol cgi 15 3 1 Syntax 1 http lt camip gt
131. x 1 http lt camip gt api wbsetlogclear cgi type Set 6 2 2 Input Item Type Entry name Entry value Std val Unit Clear logs type Set Log output control of cgi common to all types OpeLog No Yes default Yes omissible 6 2 3 Output Code Status Code Status Code Status 20 OK 32 InvalidValue 40 FailToSave 30 InvalidType 33 InvalidOperand 92 CriticalError 31 InvalidEntry 34 NoEntryData 6 2 4 Example 1 http 10 1 0 1 api wbsetlogclear cgi type Set 6 2 5 Notes 1 After this API is started the log is deleted immediately without confirmation 2 Accordingly take extreme care to handle this API 3 When saving results in a failure the message FailToSave is output This status does not match with the purpose of the function Please disregard this message 4 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 59 SDK Ver 1 00 SC TOSHIBA Network Camera IK WB15A VII IK WB15A Picture Audio type API List Item No Item Menu API name Notes 7 Live Pictures Get Stream cere pane The getstream type APIs Get One shot __live jpg are common interface Playback Pictures Get Stream getstream cgi and functions are Live Audio Get Stream getstream cgi distinguished with E parameters Abort Abort Stream getstream cgi OTO
132. y be stopped halfway In this case a status to notify the error is output after the last list A case 1 B case 2 20 OK r n 20 OK r n r n i An extcontrollist 1 r n Mn extcontrollist 2 r n 60 FailAction r n r n 60 FailAction r n In both cases of success and failure the format is not the HTML format 2 When at type RemoveAll RemoveSpan Code Status Code Status 20 OK 60 FailAction 31 InvalidEntry 32 InvalidValue 15 3 4 Example 1 http 10 1 0 1 api wblistextcontrol cgi type Show 2 http 10 1 0 1 api wblistextcontrol cgi type RemoveAll 3 http 10 1 0 1 api wblistextcontrol cgi type RemoveSpan amp StartD T 20050112000000 amp EndDT 200501 24235959 15 3 5 Notes 1 The relation between StartDT and EndDT at type RemoveSpan should be StartDT lt EndDT and both should be of the yyymmddHHMMSS format 2 Attype RemoveAll and type RemoveSpan the corresponding list is immediately deleted without confirmation 3 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes 4 This API does not check type lt value gt and any argument other than StartDT lt value gt and EndDT lt value gt at type RemoveSpan Accordingly if there are illegal arguments other than these they are ignored OTOSHIBA Corp 113 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC X IK WB15A External Storage Operation Type API List
133. y to enter the administrator ID when obtaining the image data of a LIVE image _play jpg In the IK WB15A however it can be left blank as a parameter lt streamType gt Specify 2 for the type of the LIVE image to be obtained Always specify 2 lt interval gt o When lt streamType gt is 2 this parameter may have any value However enter 0 lt mode gt eg When lt streamType gt is 2 this parameter may have any value However enter 0 lt value gt eg When lt streamType gt is 2 this parameter may have any value However enter 0 lt timeout gt Set the execution timeout value in ms Set the execution timeout value in ms for the case where a non communication status is continued over a certain period with the client while lt image field gt is output lt type gt Enter the type of reproduced image to be obtained Alarm In record image 21 Motion record image a Normal record image 13 Ext Control In record image 14 lt listNumber gt Enter the list number to be reproduced List number To the next page OTOSHIBA Corp 65 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC From the last page Parameter Value Explanation lt position gt Enter the order of the first image to be reproduced from Numeric value to indicate the number of images the starting position beginning
134. y using the export function of the WEB setting screen can be obtained by the output of this API 2 When OpeLog No is entered a log related to API start end is not output When it is omitted it is regarded as OpeLog Yes OTOSHIBA Corp 74 TOSHIBA Network Camera IK WB15A SDK Ver 1 00 SC 9 Reference of Camera Setting wbgetcambasic cgi Reference of Camera Basic Settings wbgetcamframerate cgi Reference of Frame Rate Settings wbgetcamalarm cgi Reference of Alarm Settings wbgetcamrecord cgi Reference of Recording Settings wbgetcamfrprecord cgi Reference of FTP Recording Settings wbgetcammail cgi Reference of E mail Settings wbgetcamsound cgi Reference of Audio Settings wbget cam func cgi 1 2 3 4 1 Indicates a reference API 2 Indicates a camera type reference API 3 Indicates the function matched to the WEB setting page 4 Every API is started and executed as cgi On and after the next page the camera reference API is shown TOSHIBA Corp 75 TOSHIBA Network Camera IK WB15A 9 1 Reference of Camera Basic Settings wbgetcambasic cgi 9 1 1 Syntax 1 http lt camip gt api wbogetcambasic cgi SDK Ver 1 00 SC 9 1 2 Input Item Type Entry name Value Log output control of cgi common to all types OpeLog No Yes default Yes omissible 9 1 3 Output Code Status Code Status 20 OK 92 CriticalError 32 InvalidValue 33 InvalidOperand

Toshiba Toshiba Security Camera User Manual

Contents

Download Pdf Manuals

Related Search

Related Contents