Introduction ISpy FAQs ISpy Manual

ActiveX interface of ISpy

To enable other applications to trigger ISpy to perform a capture operation, or view and/or change any of it's settings, ISpy offers an ActiveX interface when running. This means other programs can open a connection to ISpy, and instruct it for instance to upload an image. This interface is only available on the Windows 95/98 platform, not on Windows NT.

The server can be accessed by the name "ISpy.WebCam".

Methods

The following methods are available. They will return when the operation is finished.

Method Return type Parameters Description
Abort (short) int - Abort any currently ongoing capture process
Capture (short) int - Start capture now, in the currently selected capture mode
CaptureContinuous (short) int - Start a continuous capture sequence now
CaptureSeries (short) int - Perform a 'series' (loop) capture now
CaptureSingle (short) int - Perform a single shot capture now
Pause (short) int - Put ISpy in 'Pause' mode
Resume (short) int - Resume from current 'Pause' mode

Return codes are 0 on success.

Properties

The following properties are available. The properties are read/write unless listed different.

Property Type Description
BorderColor (long) int Color of border around image (if enabled)
BorderEnable bool Dis/enable of border around image
BorderWidth (short) int Width (number of pixels) of border around image (if enabled)
CaptionBackgroundColor (long) int Color of background behind caption (if caption and caption background is enabled)
CaptionFont string Font used for caption text (if caption is enabled)
CaptionFontBold bool Controls regular/bold switch of caption text (if caption is enabled)
CaptionFontItalic bool Controls regular/italic switch of caption text (if caption is enabled)
CaptionFontSize (short) int Size of font used for caption text (if caption is enabled)
CaptionHPos (short) int Controls horizontal position of caption text (if caption is enabled); 0=left, 1=center, 2=right
CaptionText string Formatting string for caption (if caption is enabled)
CaptionTextColor (long) int Color of caption text (if caption is enabled)
CaptionUseBackground bool Controls turning off/on of background behind caption text (if caption is enabled)
CaptionVPos (short) int Controls vetical position of caption text (if caption is enabled); 0=top, 1=center, 2=bottom
DefaultAuthentication bool Switches between using the Windows-remembered username/password for dial-up connections, or explicitly specifying it.
DialupConnection string The name of the dial-up connection to use (if dial-up is enabled)
DialupPassword string The password to use for the dial-up connection (if dial-up is enabled)
DialupRetries (short) int Number of retries for the dial-up connection (if dial-up is enabled)
DialupUsername string The username to use for the dial-up connection (if dial-up is enabled)
FTPMode (short) int The mode to use when making a FTP connection (if FTP is enabled); 0=simple, 1=normal, 2=safe
FTPHost string The name of the host to connect to by FTP (if FTP is enabled)
HistoryEnabled bool Enables the keeping of a recent file archive
HistoryLength (short) int The number of files to keep in the file archive (if history is enabled)
ImageQuality (short) int The quality of jpeg compression, between 0 and 100; 0=very low quality; 100=perfect
LocalPath string The path to safe local images to; check Appendix B for special macros
NextUpload string The time of the next scheduled upload; read-only
OverlayEnable bool Controls turning on/off of image overlay
OverlayFilename string The filename of the overlay image (if overlay is enabled); make sure the file exists!
OverlayXPos (short) int The horizontal position, measured from the left edge, of the overlay image (if overlay is enabled)
PassiveFTP bool Toggles passive FTP mode (if FTP is enabled)
Password string Password to use for FTP connections (if FTP is enabled)
PauseMode bool Toggles pause mode (temporarily disables uploads)
ProgressiveJPEG bool Toggles making of progressive JPEG images
ProxyMode (short) int Controls the proxy mode for FTP connections (if FTP is enabled); 0=use default proxy server, 1=use no proxy server, 2=use the specified proxy server
ProxyServer string The name of the proxy server to use for FTP connections (if FTP is enabled)
RemotePath string The path to safe images to on the FTP server (if FTP is enabled); check Appendix B for special macros
SKeyInstalled bool Shows if the S/Key / OPIE extension is installed; read-only
SafeLocalFile bool Toggles safe mode for local files
ScriptAfterCapture string The name of the external program to execute after a capture
ScriptAfterFTP string The name of the external program to execute after a FTP transfer (if FTP is enabled)
ScriptBeforeCapture string The name of the external program to execute before a capture
ScriptBeforeFTP string The name of the external program to execute before a FTP transfer (if FTP is enabled)
ShowCaption bool Enables caption text on each captured image
Status string The last line shown on the status bar; read-only
TransparencyColor (long) int The color to draw transparently for the overlay image (if image overlay is enabled and the mode is set to 2)
TransparencyMode (short) int Controls if and how the overlay image is drawn transparently (if image overlay is enabled ); 0=not transparent, 1=use left top pixel for transparency, 2=specify explicitly
TransparencyTolerance (short) int Controls the tolerance used when matching transparency for overlay image (if image overlay is enabled ), between 0 and 255; 0=use exact color, 255=any color matches
Upload24 bool Toggles between capturing 24 hours a day and only between a specified interval
UploadBeep bool Toggles beeping when capturing
UploadCaptionAsFile bool Toggles uploading the caption text as file
UploadEveryDay bool Toggles between uploading the every day of the week or only on the specified days
UploadFriday bool Toggles uploading on friday (if not uploading on every day of the week)
UploadFrom string Time to start uploading, format HH:MM:SS (if not uploading 24 hours per day)
UploadInterval (long) int Time between two captures, in seconds
UploadModeContinuous bool Toggles to continuous upload mode
UploadModeSeries bool Toggles to series of images upload mode
UploadModeSingle bool Toggles to single image upload mode
UploadMonday bool Toggles uploading on monday (if not uploading on every day of the week)
UploadNumSeries (short) int Length of series to capture (if in series upload mode)
UploadSaturday bool Toggles uploading on saturday (if not uploading on every day of the week)
UploadSpeed double Maximum upload speed in frames per second (if not in single image mode)
UploadSunday bool Toggles uploading on sunday (if not uploading on every day of the week)
UploadThursday bool Toggles uploading on thursday (if not uploading on every day of the week)
UploadTo string Time to stop uploading, format HH:MM:SS (if not uploading 24 hours per day)
UploadTuesday bool Toggles uploading on tuesday (if not uploading on every day of the week)
UploadWednesday bool Toggles uploading on wednesday (if not uploading on every day of the week)
UseDialup bool Toggles using Dial-Up Networking
UseFTP bool Toggles using FTP to upload images
UseSKey bool Toggles using S/Key authentication (if installed)
UserName string Username to use for FTP connections (if FTP is enabled)

Samples

Here's some sample Visual Basic code to trigger a capture from ISpy:

Dim ISpy As Object
' This declares the variable
Set ISpy = CreateObject("ISpy.WebCam")
' This creates the connection to ISpy
ISpy.Capture
' This performs the actual capture
Set ISpy = Nothing
' This deletes the last reference to the object, thus freeing the connection

Here's some sample Active Server Pages code to set the caption to a string as entered in a HTML form:

<%
Dim ISpy
' This declares the variable
Set ISpy = Server.CreateObject("ISpy.WebCam")
' This creates the connection to ISpy
Response.Write "Old caption text was " & ISpy.Caption & "
					
The web-based administration of ISpy is built using the ActiveX interface and Active Server Pages. If you have chosen to install it, you'll find sample use of all properties in the ASP code. The files are installed in directory C:\WebShare\wwwroot\ISpyAdmin\.

					

						


						

					

					

					

						

							
							Introduction

								Installation

								Using ISpy

								Using live images on web pages

								Web-based administration of ISpy

								Frequently asked questions		
							Appendix A -Supported frame-grabbers

								Appendix B -Time formatting macros

								Appendix C -Files installed by ISpy

								Appendix D -ActiveX interface of ISpy

								
Contents

						

					

					

					

					

						
home