IVideoV2 Interface

Video interface version 2, which incorporates the new members in IAscomDeviceV2 and the members present in IVideov1

Definition

Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
C#
public interface IVideoV2 : IAscomDeviceV2, 
	IAscomDevice, IVideo
Implements
IAscomDevice, IAscomDeviceV2, IVideo

Properties

BitDepth Reports the bit depth the camera can produce.
(Inherited from IVideo)
CameraState Returns the current camera operational state.
(Inherited from IVideo)
CanConfigureDeviceProperties Returns True if the driver supports custom device properties configuration via the ConfigureDeviceProperties method.
(Inherited from IVideo)
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)
Connecting Completion variable for asynchronous connect and disconnect operations
(Inherited from IAscomDeviceV2)
Description Returns a description of the driver, such as manufacturer and model number.
(Inherited from IAscomDevice)
DeviceState Returns the device's operational state in a single call
(Inherited from IAscomDeviceV2)
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.
(Inherited from IVideo)
ExposureMin The minimum supported exposure (integration time) in seconds.
(Inherited from IVideo)
FrameRate The frame rate at which the camera is running.
(Inherited from IVideo)
Gain Index into the Gains array for the selected camera gain.
(Inherited from IVideo)
GainMax Maximum value of Gain.
(Inherited from IVideo)
GainMin Minimum value of Gain.
(Inherited from IVideo)
Gains Gains supported by the camera.
(Inherited from IVideo)
Gamma Index into the Gammas array for the selected camera gamma.
(Inherited from IVideo)
GammaMax Maximum value of Gamma.
(Inherited from IVideo)
GammaMin Minimum value of Gamma.
(Inherited from IVideo)
Gammas Gammas supported by the camera.
(Inherited from IVideo)
Height Returns the height of the video frame in pixels.
(Inherited from IVideo)
IntegrationRate Index into the SupportedIntegrationRates array for the selected camera integration rate.
(Inherited from IVideo)
InterfaceVersion The interface version number that this device implements.
(Inherited from IAscomDevice)
LastVideoFrame Returns an IVideoFrame with its ImageArray property populated.
(Inherited from IVideo)
Name The short name of the driver, for display purposes
(Inherited from IAscomDevice)
PixelSizeX Returns the width of the CCD chip pixels in microns.
(Inherited from IVideo)
PixelSizeY Returns the height of the CCD chip pixels in microns.
(Inherited from IVideo)
SensorName Sensor name.
(Inherited from IVideo)
SensorType Type of colour information returned by the camera sensor.
(Inherited from IVideo)
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.
(Inherited from IVideo)
VideoCaptureDeviceName The name of the video capture device when such a device is used.
(Inherited from IVideo)
VideoCodec Returns the video codec used to record the video file.
(Inherited from IVideo)
VideoFileFormat Returns the file format of the recorded video file, e.g. AVI, MPEG, ADV etc.
(Inherited from IVideo)
VideoFramesBufferSize The size of the video frame buffer.
(Inherited from IVideo)
Width Returns the width of the video frame in pixels.
(Inherited from IVideo)

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.
(Inherited from IVideo)
Connect Connect to device asynchronously
(Inherited from IAscomDeviceV2)
Disconnect Disconnect from device asynchronously
(Inherited from IAscomDeviceV2)
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.
(Inherited from IVideo)
StopRecordingVideoFile Stops the recording of a video file.
(Inherited from IVideo)

Extension Methods

ConnectAsync Returns an awaitable, running, Task that connects to the device. (Polls IAscomDeviceV2.Connecting)
(Defined by ClientExtensions)
DisconnectAsync Returns an awaitable, running, Task that disconnects from the device. (Polls IAscomDeviceV2.Connecting)
(Defined by ClientExtensions)

Version Information

.NET Standard

Supported in: 2.0

See Also