IVideo Interface |
Defines the IVideo Interface.
Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 6.0.0.0 (6.6.9999.9999)
SyntaxThe IVideo type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | BitDepth | Reports the bit depth the camera can produce. |
| CameraState | Returns the current camera operational state. |
| CanConfigureDeviceProperties | Returns True if the driver supports custom device properties configuration via the ConfigureDeviceProperties method. |
| Connected | Set True to connect to the device hardware. Set False to disconnect from the device hardware. You can also read the property to check whether it is connected. This reports the current hardware state. |
| Description | Returns a description of the device, such as manufacturer and model number. Any ASCII characters may be used. |
| DriverInfo | Descriptive and version information about this ASCOM driver. |
| DriverVersion | A string containing only the major and minor version of the driver. |
| ExposureMax | The maximum supported exposure (integration time) in seconds. |
| ExposureMin | The minimum supported exposure (integration time) in seconds. |
| FrameRate | The frame rate at which the camera is running. |
| Gain | Index into the Gains array for the selected camera gain. |
| GainMax | Maximum value of Gain. |
| GainMin | Minimum value of Gain. |
| Gains | Gains supported by the camera. |
| Gamma | Index into the Gammas array for the selected camera gamma. |
| GammaMax | Maximum value of Gamma. |
| GammaMin | Minimum value of Gamma. |
| Gammas | Gammas supported by the camera. |
| Height | Returns the height of the video frame in pixels. |
| IntegrationRate | Index into the SupportedIntegrationRates array for the selected camera integration rate. |
| InterfaceVersion | The interface version number that this device supports. Should return 1 for this interface version. |
| LastVideoFrame | Returns an IVideoFrame with its ImageArray property populated. |
| Name | The short name of the driver, for display purposes. |
| PixelSizeX | Returns the width of the CCD chip pixels in microns. |
| PixelSizeY | Returns the height of the CCD chip pixels in microns. |
| SensorName | Sensor name. |
| SensorType | Type of colour information returned by the the camera sensor. |
| SupportedActions | Returns the list of custom action names supported by this driver. |
| SupportedIntegrationRates | Returns the list of integration rates supported by the video camera. |
| VideoCaptureDeviceName | The name of the video capture device when such a device is used. |
| VideoCodec | Returns the video codec used to record the video file. |
| VideoFileFormat | Returns the file format of the recorded video file, e.g. AVI, MPEG, ADV etc. |
| VideoFramesBufferSize | The size of the video frame buffer. |
| Width | Returns the width of the video frame in pixels. |
Methods| Name | Description | |
|---|---|---|
 | Action | Invokes the specified device-specific custom action. |
| ConfigureDeviceProperties | Displays a device properties configuration dialog that allows the configuration of specialized settings. |
| Dispose | This method is a "clean-up" method that is primarily of use to drivers that are written in languages such as C# and VB.NET where resource clean-up is initially managed by the language's runtime garbage collection mechanic. Driver authors should take care to ensure that a client or runtime calling Dispose() does not adversely affect other connected clients. Applications should not call this method. |
| SetupDialog | Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually. |
| StartRecordingVideoFile | Starts recording a new video file. |
| StopRecordingVideoFile | Stops the recording of a video file. |
See Also