Start Screen Recording · Appium 官方文檔

# 開始屏幕錄制開始屏幕錄制 ## 用法示例 ```java // Java driver.startRecordingScreen(); driver.startRecordingScreen(new BaseStartScreenRecordingOptions(....)); ``` ```python # Python self.driver.start_recording_screen() ``` ```javascript // Javascript // webdriver.io example driver.startRecordingScreen(); // wd example await driver.startRecordingScreen(); ``` ```ruby # Ruby # ruby_lib example start_recording_screen start_recording_screen video_size: '1280x720', time_limit: '180', bit_rate: '5000000' # Android start_recording_screen video_type: 'h264', time_limit: '260' # iOS # ruby_lib_core example @driver.start_recording_screen @driver.start_recording_screen video_size: '1280x720', time_limit: '180', bit_rate: '5000000' # Android @driver.start_recording_screen video_type: 'h264', time_limit: '260' # iOS ``` ```php # PHP // TODO PHP sample ``` ```csharp // C# driver.StartRecordingScreen( AndroidStartScreenRecordingOptions.GetAndroidStartScreenRecordingOptions() .WithTimeLimit(TimeSpan.FromSeconds(10)) .WithBitRate(500000) .WithVideoSize("720x1280")); ``` ## 支持 ### Appium Server |平臺|Driver|平臺版本|Appium 版本|Driver 版本| |--------|----------------|------|--------------|--------------| | iOS | [XCUITest](../drivers/ios-xcuitest.md) | 9.3+ | 1.6.0+ | All | | | [UIAutomation](../drivers/ios-uiautomation.md) | None | None | None | | Android | [Espresso](../drivers/android-espresso.md) | ?+ | 1.9.0+ | All | | | [UiAutomator2](../drivers/android-uiautomator2.md) | ?+ | 1.6.0+ | All | | | [UiAutomator](../drivers/android-uiautomator.md) | 4.3+ | All | All | | Mac | [Mac](../drivers/mac.md) | None | None | None | | Windows | [Windows](../drivers/windows.md) | None | None | None | ### Appium Clients |語言|支持|文檔| |--------|-------|-------------| |[Java](https://github.com/appium/java-client/releases/latest)| All | [static.javadoc.io](https://static.javadoc.io/io.appium/java-client/6.1.0/io/appium/java_client/screenrecording/CanRecordScreen.html#startRecordingScreen-T-) | |[Python](https://github.com/appium/python-client/releases/latest)| All | [appium.github.io](https://appium.github.io/python-client-sphinx/webdriver.extensions.html#webdriver.extensions.screen_record.ScreenRecord.start_recording_screen) | |[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All | | |[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All | [github.com](https://github.com/admc/wd/blob/master/lib/commands.js#L3412) | |[Ruby](https://github.com/appium/ruby_lib/releases/latest)| All | [Android](https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Android/Device#start_recording_screen-instance_method) [iOS](https://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Ios/Xcuitest/Device#start_recording_screen-instance_method) | |[PHP](https://github.com/appium/php-client/releases/latest)| None | [github.com](https://github.com/appium/php-client/) | |[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| None | [github.com](https://github.com/appium/appium-dotnet-driver/) | ## HTTP API 規范 ### 終端 `POST /session/:session_id/appium/start_recording_screen` ### URL 參數 |名稱|描述| |----|-----------| |session_id|將指令發往的會話（session）ID| ### JSON 參數 |名稱|類型|描述| |----|----|-----------| | options | `object` | The following parameters of the action | | options.remotePath | `string` | 遠程位置的路徑, 生成的視頻應該被上傳到這里。支持 http/https，ftp 協議。Null或空字符串值（默認）表示結果文件的內容使用 Base64 編碼并作為響應值傳遞給終端。如果生成的媒體文件太大而無法放入進程可用內存中，將引發異常。這個選項僅在屏幕錄制進行中 `forceRestart` 不為 `true` 時有效。 | | options.username | `string` | 用于遠程身份驗證的用戶的名稱 | | options.password | `string` | 用于遠程身份驗證的用戶的密碼 | | options.method | `string` | http multipart upload 方法名。默認使用 `PUT` 方法。 | | options.forceRestart | `boolean` | 是嘗試捕獲并上載/返回當前正在運行的屏幕錄制（服務器上默認為 `false`），還是忽略它的結果并立即開始新的錄制（`true`）。 | | options.timeLimit | `string` | 錄制時間。默認錄制180秒。 | | options.videoType | `string` | (iOS Only)要屏幕錄制的視頻格式。可用的格式是 `ffmpeg -codecs` 的輸出，例如 `libx264` 和 `mpeg4`。默認使用 `mpeg4` 格式。 | | options.videoQuality | `string` | (iOS Only) 視頻錄制的畫質 (低, 中, 高, 原畫 - 默認使用中畫質). | | options.videoFps | `string` | (iOS Only) 每秒錄制視頻的幀數。如果生成的視頻太慢或太快，請更改此值。默認為10。這可以減小生成的文件大小。| | options.videoScale | `string` | (iOS Only) 縮放比例。查看 https://trac.ffmpeg.org/wiki/Scaling 獲得可用比例。例如 720p 的默認比例為“1280:720”。這可以減小或增加生成的文件大小。默認情況下不應用縮放。 | | options.bitRate | `string` | (Android Only) 視頻的比特率，單位為Mbps。Android API 低于 27 的，默認為 4mbp/s（4000000）。API 27 及以上的為 20 Mb/s（20000000）。| | options.videoSize | `string` | (Android Only) 格式為widthxheight。默認為設備的本機顯示分辨率（如果支持），如果不支持，則為 1280x720。為了獲得最佳效果，請使用設備的高級視頻編碼（AVC）編碼器支持的大小。例如，“1280x720” | | options.bugReport | `string` | (Android Only) 將其設置為 `true`，以便在視頻覆蓋上顯示其他信息，例如時間戳，這對捕獲視頻以說明錯誤很有幫助。此選項僅在 API 27（Android O）之后才受支持. | ### 響應 null ## 參考 * [JSONWP 規范](https://github.com/appium/appium-base-driver/blob/master/lib/protocol/routes.js#L370)