IVideoStartRecordingVideoFile Method

Starts recording a new video file.

Definition

Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
C#
string StartRecordingVideoFile(
	string PreferredFileName
)

Parameters

PreferredFileName  String
The file name requested by the client. Some systems may not allow the file name to be controlled directly and they should ignore this parameter.

Return Value

String
The actual file name of the file that is being recorded.

Exceptions

NotImplementedExceptionMust throw exception if not implemented.
InvalidOperationExceptionMust throw exception if the current camera state doesn't allow to begin recording a file.
NotConnectedExceptionWhen Connected is False.
DriverExceptionAn error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself.

Version Information

.NET Standard

Supported in: 2.0

See Also