Asynchronously starts a new recording that will run for a predetermined amount of time.

Namespace: ININ.IceLib.QualityManagement
Assembly: ININ.IceLib.QualityManagement (in ININ.IceLib.QualityManagement.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public void StartTimedRecordingAsync(
	string userIdToRecord,
	TimeSpan recordingDuration,
	EventHandler<StartTimedRecordingCompletedEventArgs> completedCallback,
	Object userState
)
Visual Basic
Public Sub StartTimedRecordingAsync ( _
	userIdToRecord As String, _
	recordingDuration As TimeSpan, _
	completedCallback As EventHandler(Of StartTimedRecordingCompletedEventArgs), _
	userState As Object _
)

Parameters

userIdToRecord
Type: System..::..String
The user whose screen will be recorded.
recordingDuration
Type: System..::..TimeSpan
The length of time that the recording will run. Note that the recording duration will be rounded up to the nearest second.
completedCallback
Type: System..::..EventHandler<(Of <(<'StartTimedRecordingCompletedEventArgs>)>)>
The callback to invoke when the asynchronous operation completes.
userState
Type: System..::..Object
An optional object that contains state information for this request. This object is a way for the caller to store context information which will be provided to the AsyncCompleted event. If no context information is desired then nullNothingnullptra null reference (Nothing in Visual Basic) may be supplied.

Remarks

When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs-derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information. For more information on async method calls, see How Async Calls Work.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionuserIdToRecord is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionThe userIdToRecord length is zero.
System..::..ArgumentOutOfRangeExceptionThe value of recordingDuration is negative.

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.

See Also