appium_screen_recording
Start or stop mobile screen recording. Use start to begin capturing, stop to end and save the video as MP4.
Instructions
Start or stop screen recording. action=start begins recording; action=stop stops and saves to MP4.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | start begins recording; stop ends, retrieves, and saves it. | |
| bitRate | No | Android only. Video bit rate in bits per second. | |
| videoFps | No | iOS only. Frames per second. Default: 10. | |
| bugReport | No | Android only. Display timestamp overlay. Requires API level 27+. | |
| sessionId | No | Session ID to target. If omitted, uses the active session. | |
| timeLimit | No | Recorder limit in seconds; it does not retrieve/save automatically, so call stop. iOS default 180/max 4200; Android default 180/max 1800. | |
| videoSize | No | Android only. Frame size in WIDTHxHEIGHT format (e.g. 1280x720). | |
| videoType | No | iOS only. Video codec to use (e.g. libx264). | |
| videoScale | No | iOS only. Scaling value (e.g. 1280:720). | |
| pixelFormat | No | iOS only. Output pixel format (e.g. yuv420p). | |
| forceRestart | No | Restart and discard any active recording; default false. | |
| videoFilters | No | iOS only. FFMPEG video filters. Takes precedence over videoScale. | |
| videoQuality | No | iOS only. Video quality preset. Default: medium. | |
| hardwareAcceleration | No | iOS only. FFMPEG hardware acceleration backend. |