From Bright Pattern Documentation
Jump to: navigation, search
(Created new topic from branched topic Documentation:ServicePattern:desktop-javascript-api-specification:PauseScreenRecording:5.1)
 
 
Line 1: Line 1:
 
<translate>= Pause Screen Recording=
 
<translate>= Pause Screen Recording=
This function pauses screen recording of the user session.
+
Pauses screen recording of the user session.
  
 
For the period when screen recording is paused, the recording will contain a static snapshot of the desktop at the moment when pause was applied.
 
For the period when screen recording is paused, the recording will contain a static snapshot of the desktop at the moment when pause was applied.
  
== Syntax ==
+
== Request ==
''pauseScreenRecording(callback);''
+
=== Syntax ===
 +
pauseScreenRecording(callback);
 +
 
 +
=== Parameters ===
 +
{|border="1" style="border-collapse:collapse" cellpadding="5"
 +
| '''Parameter'''
 +
| '''Type'''
 +
| '''Optional/Required'''
 +
| '''Description'''
 +
|-
 +
| [[desktop-javascript-api-specification/Callback|callback]]
 +
| Function
 +
| Required
 +
| Function that will be called upon completion of the method
 +
|}
 +
 
  
== Parameters ==
 
[[desktop-javascript-api-specification/Callback|''callback'']] – Function that will be called upon completion of the method
 
  
  
  
  
<center>[[desktop-javascript-api-specification/StopScreenRecording|< Previous]]  |  [[desktop-javascript-api-specification/ResumeScreenRecording|Next >]]</center>
 
 
</translate>
 
</translate>

Latest revision as of 18:18, 10 September 2019

• 5.2 • 5.3 • 5.8

Pause Screen Recording

Pauses screen recording of the user session.

For the period when screen recording is paused, the recording will contain a static snapshot of the desktop at the moment when pause was applied.

Request

Syntax

pauseScreenRecording(callback);

Parameters

Parameter Type Optional/Required Description
callback Function Required Function that will be called upon completion of the method



< Previous | Next >