Video Class

Video device class

Definition

Namespace: ASCOM.Com.DriverAccess
Assembly: ASCOM.Com (in ASCOM.Com.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public class Video : ASCOMDevice, IVideoV2, 
	IAscomDeviceV2, IAscomDevice, IVideo
Inheritance
Object    ASCOMDevice    Video
Implements
IAscomDevice, IAscomDeviceV2, IVideo, IVideoV2

Constructors

Video(String) Initialise Video device
Video(String, ILogger) Initialise Video device with a debug logger

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 ASCOMDevice)
Connecting Completion variable for asynchronous connect and disconnect operations
(Inherited from ASCOMDevice)
Description Returns a description of the driver, such as manufacturer and model number.
(Inherited from ASCOMDevice)
DeviceState Returns the device's operational state in a single call
(Inherited from ASCOMDevice)
DriverInfo Descriptive and version information about this ASCOM driver.
(Inherited from ASCOMDevice)
DriverVersion A string in the form "n.n" containing only the major and minor version of the driver.
(Inherited from ASCOMDevice)
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 ASCOMDevice)
LastVideoFrame Returns an IVideoFrame with its ImageArray property populated.
Name The short name of the driver, for display purposes
(Inherited from ASCOMDevice)
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 ASCOMDevice)
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.
Videos Return a list of all Video devices registered in the ASCOM Profile
VideoState VideoState device state
Width Returns the width of the video frame in pixels.

Methods

Action Invokes the specified device-specific action.
(Inherited from ASCOMDevice)
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 ASCOMDevice)
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 ASCOMDevice)
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 ASCOMDevice)
ConfigureDeviceProperties Displays a device properties configuration dialog that allows the configuration of specialized settings.
Connect Connect to device asynchronously
(Inherited from ASCOMDevice)
Disconnect Disconnect from device asynchronously
(Inherited from ASCOMDevice)
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 ASCOMDevice)
SetupDialog Show the device set-up dialog
(Inherited from ASCOMDevice)
StartRecordingVideoFile Starts recording a new video file.
StopRecordingVideoFile Stops the recording of a video file.

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