Skip to content

Commit

Permalink
chore: Update the documentation for the `macos: stopNativeScreenRecor…
Browse files Browse the repository at this point in the history
…ding` API (#331)
  • Loading branch information
mykola-mokhnach authored Feb 8, 2025
1 parent accce25 commit 612b0a0
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -657,6 +657,15 @@ successfully consumed.
If no screen recording has been started before then this API throws an exception.
Xcode must be at version 15+.

> [!IMPORTANT]
> In order to retrieve the recorded video from the local file system the Appium Server process itself
> or its parent process (e.g. Terminal) must have the "Full Disk Access" permission granted
> in 'System Preferences'→'Privacy & Security' tab.
> [!NOTE]
> Be careful while recording lengthy videos. They could be pretty large, and may easily exceed
> the free space on the home partition.
#### Arguments

Name | Type | Required | Description | Example
Expand Down
7 changes: 6 additions & 1 deletion lib/commands/native-record-screen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,12 @@ export async function macosStopNativeScreenRecording(
);
if (!matchedVideoPath) {
throw new Error(
`The screen recording identified by ${uuid} has not been found. Is it accessible?`
`The screen recording identified by ${uuid} cannot be retrieved. ` +
`Make sure the Appium Server process or its parent process (e.g. Terminal) ` +
`has Full Disk Access permission enabled in 'System Preferences' -> 'Privacy & Security' tab. ` +
`You may verify the presence of the recorded video manually by running the ` +
`'find "$HOME/Library/Daemon Containers/" -type f -name "${uuid}"' command from Terminal ` +
`if the latter has been granted the above access permission.`
);
}
const options = {
Expand Down

0 comments on commit 612b0a0

Please sign in to comment.