Summary of the content on the page No. 1
TOSHIBA Network Camera
Ver 1.00.SC
(C) TOSHIBA Corp.
Jun, 2006
Summary of the content on the page No. 2
TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) History Version Page Topics Creator T&D Notes B.71.SC Release. VerB.71.SC T.Hamada Mon May 29 2006 B.72.SC All Typo; PTZF -> PTZ T.Hamada Thu Jun 08 2006 30,31 Modified; wbsetptbasic.cgi values 32 Modified; wbsetptpreset.cgi values 35-38 Added; OpeLog=Yes/No 54 Modified; Notes 6); Appendix.C -> Appendix.B 59 Modified; …logclear.cgi&type=Set -> .cgi?type=Set 63,66,68 Typo;
Summary of the content on the page No. 3
TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) Contents I. About API ............................................................................................................................................................................................................ 1 Firmware version corresponding to this specification > .................................................................................................................................... 1 API protocol > .
Summary of the content on the page No. 4
TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) 4. Multi-Screen Display Settings......................................................................................................................................................................... 45 4.1 Multi-Screen Display Settings .................................................................................................................................................................... 46 5. Administrator Functions .....
Summary of the content on the page No. 5
TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) 11.2 Reference of Bandwidth Control Settings................................................................................................................................................... 91 11.3 Reference of DDNS Settings ..................................................................................................................................................................... 92 11.4 Reference of FTP Server Settings .....
Summary of the content on the page No. 6
TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) I. About API Firmware version corresponding to this specification > The firmware version to which this specification is applicable is ‘Version 0.16.10.018.115 or later’. API protocol > 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 > The error code to be notified from the HTTP server of the IK-WB15A
Summary of the content on the page No. 7
TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) II. Comparison between WEB Setting Page and API functions API types > 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 > As a rule, all the items to be executed by the WEB setting page can also be set or reference
Summary of the content on the page No. 8
TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) From the last 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 X Auto Patrol O X O X O X O X Operation Range O X O X O X O X Network Settings Basic O X O X O X O X Bandwidth Control O X O X O X 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 C
Summary of the content on the page No. 9
TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) From the last page. WEB operation API operation Function list 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 Oper
Summary of the content on the page No. 10
TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) III. Restrictions on the API When using this API group, take the following items into consideration. 1) Method type Method type API type 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 : Su
Summary of the content on the page No. 11
Picture/ Data Setting Audio TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) 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 wbsetptprese
Summary of the content on the page No. 12
Getting Data 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 wbget
Summary of the content on the page No. 13
List Operation Others TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) From the last page. Item Menu API name Alarm In List Operation Get Alarm In List wblistalarm.cgi Delete Alarm In List(All) Delete Alarm In List(Date and Time) Normal List Operation Get Normal List wblistnormal.cgi Delete Normal List(All) Delete Normal List(Date and Time) Ext. Control In List Operation Get Ext. Control In List wblistextcontrol.cgi Delete Ext. Control In List(All) Delete Ext. Control In Lis
Summary of the content on the page No. 14
TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) V. API Termination Status Termination status classification > 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 m
Summary of the content on the page No. 15
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
Summary of the content on the page No. 16
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&type=Set&Resolution=3 For an API without the ‘type’ attribute like wbgetcambasic.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
Summary of the content on the page No. 17
TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) VI. IK-WB15A Setting Type API List Item No. Item Sub-number Menu API name Function type 1 Camera Settings 1-1Basic wbsetcambasic.cgi 2 types 1-2 Frame Rate wbsetcamframerate.cgi 2 types 1-3Alarm wbsetcamalarm.cgi 4 types 1-4Recording wbsetcamrecord.cgi 4 types 1-5 FTP Recording wbsetcamftprecord.cgi 10 types 1-6E-mail wbsetcammail.cgi 16 types 1-7Audio wbsetcamsound.cgi 3 types 2 PAN/TILT Settings 2-1 Basic/Operation Range wbsetptbas
Summary of the content on the page No. 18
TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) 1. Camera Settings - wbsetcambasic.cgi - Basic Settings - wbsetcamframerate.cgi - Frame Rate Settings - wbsetcamalarm.cgi - Alarm Settings - wbsetcamrecord.cgi - Recording Settings - wbsetcamftprecord.cgi - FTP Recording Settings - wbsetcammail.cgi - E-mail Settings - wbsetcamsound.cgi - Audio Settings wbset cam func .cgi (1) (2) (3) (4) (1) Indicates a setting API. (2) Indicates a camera type setting
Summary of the content on the page No. 19
TOSHIBA Network Camera - IK-WB15A - SDK (Ver 1.00.SC) 1.1 Basic Settings wbsetcambasic.cgi 1.1.1 Syntax 1) http:///api/wbsetcambasic.cgi?type=Default 2) http:///api/wbsetcambasic.cgi?type=Set[&Resolution=][&CompressionRatio=][&...] 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 - - - - 1:160x120 (QQV
Summary of the content on the page No. 20
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 - Auto gain control AutoGainControl 1:OFF 2:Standard 3:Max 2 - 1:OFF(x1) Slow shutter SlowShutterMax 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） 1:OFF Backlight compensation BackLightCompensation 7 - 2:Upper 2/3(Are
