Skip to main content

​
Sandbox

Python
class Sandbox(SandboxBase)

​
get_video_stream_url

Python
def get_video_stream_url()
Get the video stream URL.

​
take_screenshot

Python
@overload
def take_screenshot(format: Literal["stream"]) -> Iterator[bytes]
Take a screenshot and return it as a stream of bytes.

​
take_screenshot

Python
@overload
def take_screenshot(format: Literal["bytes"]) -> bytearray
Take a screenshot and return it as a bytearray.

​
take_screenshot

Python
def take_screenshot(format: Literal["bytes", "stream"] = "bytes")
Take a screenshot and return it in the specified format. Arguments:
  • format: The format of the screenshot. Can be ‘bytes’, ‘blob’, or ‘stream’.
Returns: The screenshot in the specified format.

​
left_click

Python
def left_click()
Left click on the current mouse position.

​
double_click

Python
def double_click()
Double left click on the current mouse position.

​
right_click

Python
def right_click()
Right click on the current mouse position.

​
middle_click

Python
def middle_click()
Middle click on the current mouse position.

​
scroll

Python
def scroll(amount: int)
Scroll the mouse wheel by the given amount. Arguments:
  • amount: The amount to scroll.

​
move_mouse

Python
def move_mouse(x: int, y: int)
Move the mouse to the given coordinates. Arguments:
  • x: The x coordinate.
  • y: The y coordinate.

​
get_cursor_position

Python
def get_cursor_position()
Get the current cursor position. Returns: A tuple with the x and y coordinates.

​
get_screen_size

Python
def get_screen_size()
Get the current screen size. Returns: A tuple with the width and height.

​
write

Python
def write(text: str)
Write the given text at the current cursor position. Arguments:
  • text: The text to write.

​
press

Python
def press(key: str)
Press a key. Arguments:
  • key: The key to press (e.g. “enter”, “space”, “backspace”, etc.).

​
hotkey

Python
def hotkey(*keys)
Press a hotkey. Arguments:
  • keys: The keys to press (e.g. hotkey("ctrl", "c") will press Ctrl+C).

​
open

Python
def open(file_or_url: str)
Open a file or a URL in the default application. Arguments:
  • file_or_url: The file or URL to open.
⌘I