Interface IVideoRecordingProvider

Namespace

Ranorex.Core.Reporting

Assembly

Ranorex.Core.dll

Represents a video recording provider for recording tests

public interface IVideoRecordingProvider

Properties

CurrentVideoFileName

The current video file name, if recording is active.

string CurrentVideoFileName { get; }

Property Value

string

CurrentVideoLengthSeconds

The current length, in seconds, of the currently recording video. Zero if no video is recording.

int CurrentVideoLengthSeconds { get; }

Property Value

int

FileExtension

The file extension required by this provider for the video file name.

string FileExtension { get; }

Property Value

string

Methods

BeginFileRecording(string, VideoRecordingOptions)

Begin file recording to the specified file name with the specified options.

void BeginFileRecording(string fileName, VideoRecordingOptions options)

Parameters

fileName string

The target video file to record to. Uses the extension specified by the provider.

options VideoRecordingOptions

The options which should be used for recording, if supported.

EndFileRecording(bool)

Ends recording for the current video file.

void EndFileRecording(bool keepVideo)

Parameters

keepVideo bool

Specifies whether to keep the video file or not.

Initialize()

Called once for lazy initial setup.

void Initialize()

Remarks

Not called if video recording is disabled.