diff --git a/appium/webdriver/extensions/screen_record.py b/appium/webdriver/extensions/screen_record.py index 07c9b2ba..d03393e2 100644 --- a/appium/webdriver/extensions/screen_record.py +++ b/appium/webdriver/extensions/screen_record.py @@ -151,6 +151,9 @@ def start_recording_screen(self, **options: Any) -> Union[bytes, str]: Possible values are 'ultrafast', 'superfast', 'veryfast'(default), 'faster', 'fast', 'medium', 'slow', 'slower', 'veryslow' + Usage: + driver.start_recording_screen() + Returns: bytes: Base-64 encoded content of the recorded media if `stop_recording_screen` isn't called after previous `start_recording_screen`. @@ -184,6 +187,12 @@ def stop_recording_screen(self, **options: Any) -> bytes: the same key as `fileFieldName` then it is going to be ignored. (Since Appium 1.18.0) headers (dict): [multipart/form-data requests] Headers mapping (Since Appium 1.18.0) + Usage: + payload = driver.stop_recording_screen() + with open('media.mp4', "wb") as fd: + import base64 + fd.write(base64.b64decode(payload)) + Returns: bytes: Base-64 encoded content of the recorded media file or an empty string if the file has been successfully uploaded to a remote location