Appium-Start Recording Screen(开始录制屏幕)

╰半橙微兮° 2022-11-18 05:51 340阅读 0赞

### Start Recording Screen ###

*   *   *   *   *  Example Usage
                 *  Support
                 *   *  Appium Server
                     *  Appium Clients
                 *  HTTP API Specifications
                 *   *  Endpoint
                     *  URL Parameters
                     *  JSON Parameters
                     *  Response

Start recording screen

##### Example Usage #####

<table> 
 <thead> 
  <tr> 
   <th></th> 
   <th align="left"></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Java</td> 
   <td align="left">driver.startRecordingScreen();<br>driver.startRecordingScreen(new BaseStartScreenRecordingOptions(…));</td> 
  </tr> 
  <tr> 
   <td>Python</td> 
   <td align="left">self.driver.start_recording_screen()</td> 
  </tr> 
  <tr> 
   <td>Javascript</td> 
   <td align="left">// webdriver.io example<br>driver.startRecordingScreen();<br>// wd example<br>await driver.startRecordingScreen();</td> 
  </tr> 
  <tr> 
   <td>Ruby</td> 
   <td align="left"># ruby_lib example<br>start_recording_screen<br>start_recording_screen video_size: <code>'1280x720'</code>, time_limit: <code>'180'</code>, bit_rate: <code>'5000000'</code> # Android<br>start_recording_screen video_type:<code>'h264'</code>, time_limit: <code>'260'</code> # iOS<br># ruby_lib_core example<br>@driver.get_performance_data_types</td> 
  </tr> 
  <tr> 
   <td>C#</td> 
   <td align="left">driver.StartRecordingScreen(<br>AndroidStartScreenRecordingOptions.GetAndroidStartScreenRecordingOptions()<br>.WithTimeLimit(TimeSpan.FromSeconds(10))<br>.WithBitRate(500000)<br>.WithVideoSize(<code>"720x1280"</code>));</td> 
  </tr> 
  <tr> 
   <td>PHP</td> 
   <td align="left">// TODO PHP sample</td> 
  </tr> 
 </tbody> 
</table>

##### Support #####

###### Appium Server ######

<table> 
 <thead> 
  <tr> 
   <th>Platform</th> 
   <th>Driver</th> 
   <th>Platform Versions</th> 
   <th>Appium Version</th> 
   <th>Driver Version</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>iOS</td> 
   <td>XCUITest</td> 
   <td>9.3+</td> 
   <td>1.6.0+</td> 
   <td>All</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>UIAutomation</td> 
   <td>None</td> 
   <td>None</td> 
   <td>None</td> 
  </tr> 
  <tr> 
   <td>Android</td> 
   <td>Espresso</td> 
   <td>?+</td> 
   <td>1.9.0+</td> 
   <td>All</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>UiAutomator2</td> 
   <td>?+</td> 
   <td>1.6.0+</td> 
   <td>All</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td>UiAutomator</td> 
   <td>4.3+</td> 
   <td>All</td> 
   <td>All</td> 
  </tr> 
  <tr> 
   <td>Mac</td> 
   <td>Mac</td> 
   <td>None</td> 
   <td>None</td> 
   <td>None</td> 
  </tr> 
  <tr> 
   <td>Windows</td> 
   <td>Windows</td> 
   <td>None</td> 
   <td>None</td> 
   <td>None</td> 
  </tr> 
 </tbody> 
</table>

###### Appium Clients ######

<table> 
 <thead> 
  <tr> 
   <th>Language</th> 
   <th>Support</th> 
   <th>Documentation</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Java</td> 
   <td>All</td> 
   <td>appium.github.io</td> 
  </tr> 
  <tr> 
   <td>Python</td> 
   <td>None</td> 
   <td>appium.github.io</td> 
  </tr> 
  <tr> 
   <td>Javascript (WebdriverIO)</td> 
   <td>All</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>Javascript (WD)</td> 
   <td>All</td> 
   <td>github.com</td> 
  </tr> 
  <tr> 
   <td>Ruby</td> 
   <td>All</td> 
   <td>www.rubydoc.info</td> 
  </tr> 
  <tr> 
   <td>PHP</td> 
   <td>None</td> 
   <td>github.com</td> 
  </tr> 
  <tr> 
   <td>C#</td> 
   <td>None</td> 
   <td>github.com</td> 
  </tr> 
 </tbody> 
</table>

##### HTTP API Specifications #####

###### Endpoint ######

`POST /session/:session_id/appium/start_recording_screen`

###### URL Parameters ######

<table> 
 <thead> 
  <tr> 
   <th>name</th> 
   <th>description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>session_id</td> 
   <td>ID of the session to route the command to</td> 
  </tr> 
 </tbody> 
</table>

###### JSON Parameters ######

<table> 
 <thead> 
  <tr> 
   <th>name</th> 
   <th>type</th> 
   <th>description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>options</td> 
   <td><code>object</code></td> 
   <td>The following parameters of the action</td> 
  </tr> 
  <tr> 
   <td>options.remotePath</td> 
   <td><code>string</code></td> 
   <td>The path to the remote location, where the resulting video should be uploaded. The following protocols are supported http/https, ftp. Null or empty string value (the default setting) means the content of resulting file should be encoded as Base64 and passed as the endpoint response value. An exception will be thrown if the generated media file is too big to fit into the available process memory. This option only has an effect if there is screen recording process in progress and <code>forceRestart</code> parameter is not set to <code>true</code>.</td> 
  </tr> 
  <tr> 
   <td>options.username</td> 
   <td><code>string</code></td> 
   <td>The name of the user for the remote authentication.</td> 
  </tr> 
  <tr> 
   <td>options.password</td> 
   <td><code>string</code></td> 
   <td>The password for the remote authentication.</td> 
  </tr> 
  <tr> 
   <td>options.method</td> 
   <td><code>string</code></td> 
   <td>The http multipart upload method name. The ‘PUT’ one is used by default.</td> 
  </tr> 
  <tr> 
   <td>options.forceRestart</td> 
   <td><code>boolean</code></td> 
   <td>Whether to try to catch and upload/return the currently running screen recording (<code>false</code>, the default setting on server) or ignore the result of it and start a new recording immediately (<code>true</code>).</td> 
  </tr> 
  <tr> 
   <td>options.timeLimit</td> 
   <td><code>string</code></td> 
   <td>Recording time. 180 seconds is by default.</td> 
  </tr> 
  <tr> 
   <td>options.videoType</td> 
   <td><code>string</code></td> 
   <td>(iOS Only) The format of the screen capture to be recorded. Available formats are the output of <code>ffmpeg -codecs</code> such as <code>libx264</code> and <code>mpeg4</code>. Defaults to <code>mjpeg</code>.</td> 
  </tr> 
  <tr> 
   <td>options.videoQuality</td> 
   <td><code>string</code></td> 
   <td>(iOS Only) The video encoding quality (low, medium, high, photo - defaults to medium).</td> 
  </tr> 
  <tr> 
   <td>options.videoFps</td> 
   <td><code>string</code></td> 
   <td>(iOS Only) The Frames Per Second rate of the recorded video. Change this value if the resulting video is too slow or too fast. Defaults to 10. This can decrease the resulting file size.</td> 
  </tr> 
  <tr> 
   <td>options.videoScale</td> 
   <td><code>string</code></td> 
   <td>(iOS Only) The scaling value to apply. Read https://trac.ffmpeg.org/wiki/Scaling for possible values. Example value of 720p scaling is ‘1280:720’. This can decrease/increase the resulting file size. No scale is applied by default.</td> 
  </tr> 
  <tr> 
   <td>options.bitRate</td> 
   <td><code>string</code></td> 
   <td>(Android Only) The video bit rate for the video, in megabits per second. 4 Mbp/s(4000000) is by default for Android API level below 27. 20 Mb/s(20000000) for API level 27 and above.</td> 
  </tr> 
  <tr> 
   <td>options.videoSize</td> 
   <td><code>string</code></td> 
   <td>(Android Only) The format is widthxheight. The default value is the device’s native display resolution (if supported), 1280x720 if not. For best results, use a size supported by your device’s Advanced Video Coding (AVC) encoder. For example, “1280x720”</td> 
  </tr> 
  <tr> 
   <td>options.bugReport</td> 
   <td><code>string</code></td> 
   <td>(Android Only) Set it to <code>true</code> in order to display additional information on the video overlay, such as a timestamp, that is helpful in videos captured to illustrate bugs. This option is only supported since API level 27 (Android O).</td> 
  </tr> 
 </tbody> 
</table>

###### Response ######

null