fix screen recording docs
* Update start-recording-screen.yml
It can be confusing to pass the parameters without adding the given parameters under "options" - this is not stated anywhere in the document.
* Update start-recording-screen.yml
* Update start-recording-screen.yml
* Fixing the documentation
MODIFY
commands-yml/commands/device/recording-screen/start-recording-screen.yml
commands-yml/commands/device/recording-screen/start-recording-screen.yml
@@ -81,7 +81,10 @@ endpoint:
- name: session_id
description: ID of the session to route the command to
json_parameters:
- - name: remotePath
+ - name: options
+ type: object
+ description: The following parameters of the action
+ - name: options.remotePath
type: string
description: The path to the remote location, where the resulting video should be uploaded.
The following protocols are supported http/https, ftp.
@@ -91,48 +94,48 @@ endpoint:
fit into the available process memory.
This option only has an effect if there is screen recording process in progress
and `forceRestart` parameter is not set to `true`.
- - name: username
+ - name: options.username
type: string
description: The name of the user for the remote authentication.
- - name: password
+ - name: options.password
type: string
description: The password for the remote authentication.
- - name: method
+ - name: options.method
type: string
description: The http multipart upload method name. The 'PUT' one is used by default.
- - name: forceRestart
+ - name: options.forceRestart
type: boolean
description: Whether to try to catch and upload/return the currently running screen recording
(`false`, the default setting on server) or ignore the result of it
and start a new recording immediately (`true`).
- - name: timeLimit
+ - name: options.timeLimit
type: string
description: Recording time. 180 seconds is by default.
- - name: videoType
+ - name: options.videoType
type: string
description: (iOS Only) The format of the screen capture to be recorded.
Available formats "h264", "mp4" or "fmp4". Default is "mp4".
Only works for Simulator.
- - name: videoQuality
+ - name: options.videoQuality
type: string
description: (iOS Only) The video encoding quality (low, medium, high, photo - defaults to medium).
- - name: videoFps
+ - name: options.videoFps
type: string
description: (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.
- - name: bitRate
+ - name: options.bitRate
type: string
description: (iOS 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.
- - name: videoSize
+ - name: options.videoSize
type: string
description: (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"
- - name: bugReport
+ - name: options.bugReport
type: string
description: (Android Only) Set it to `true` in order to display additional information on the video overlay,
such as a timestamp, that is helpful in videos captured to illustrate bugs.

fix screen recording docs

* Update start-recording-screen.yml

It can be confusing to pass the parameters without adding the given parameters under "options" - this is not stated anywhere in the document.

* Update start-recording-screen.yml

* Update start-recording-screen.yml

* Fixing the documentation