ASCOM Library
IVideo Interface
Defines the IVideo Interface
Note: this applies to COM only
Definition
Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
C#
public interface IVideo : IAscomDeviceVB
Public Interface IVideo
Inherits IAscomDevice- Implements
- IAscomDevice
Properties
| 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 enable the link. Set False to disable the link.
You can also read the property to check whether it is connected.
(Inherited from IAscomDevice) |
| Description |
Returns a description of the driver, such as manufacturer and model number.
(Inherited from IAscomDevice) |
| DriverInfo |
Descriptive and version information about this ASCOM driver.
(Inherited from IAscomDevice) |
| DriverVersion |
A string in the form "n.n" containing only the major and minor version of the driver.
(Inherited from IAscomDevice) |
| 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 implements.
(Inherited from IAscomDevice) |
| LastVideoFrame | Returns an IVideoFrame with its ImageArray property populated. |
| Name |
The short name of the driver, for display purposes
(Inherited from IAscomDevice) |
| 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 camera sensor. |
| SupportedActions |
Returns the list of action names supported by this driver.
(Inherited from IAscomDevice) |
| 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
| Action |
Invokes the specified device-specific action.
(Inherited from IAscomDevice) |
| CommandBlind |
Transmits an arbitrary string to the device and does not wait for a response.
Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from IAscomDevice) |
| CommandBool |
Transmits an arbitrary string to the device and waits for a boolean response.
Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from IAscomDevice) |
| CommandString |
Transmits an arbitrary string to the device and waits for a string response.
Optionally, protocol framing characters may be added to the string before transmission.
(Inherited from IAscomDevice) |
| 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.
(Inherited from IAscomDevice) |
| StartRecordingVideoFile | Starts recording a new video file. |
| StopRecordingVideoFile | Stops the recording of a video file. |