voice
present_status
Check what is on the shared screen
Effects: read
Ask what the room is ACTUALLY seeing on the screen-share right now. Returns presenting plus the page_id, url and title read live from the shared tab. Use it before telling participants what is on screen, and whenever you are not certain the share still points at the tab you meant — pressing keys or scrolling does NOT change which tab is shared, only present_tab does.
Arguments
No arguments.
present_stop
Stop sharing the screen on the call
Effects: external_api
Take whatever is on the call's screen-share back down, so the room sees nobody presenting. Takes no arguments — it stops whatever THIS call is showing. Use it when you are done with a tab and the room should stop looking at it; present_tab with a different page_id switches the share instead, and browser.close on the shared tab also ends it. Stopping when nothing is being shared is a success, not an error — the room already sees nothing. Returns presenting=false once the share is down; present_status will then report nothing on screen. If it comes back ok=false the share may STILL BE UP — do not tell the room you stopped it; retry, or call present_status to see what the room can actually see.
Arguments
No arguments.
present_tab
Share a browser tab on the call
Effects: external_api
Put one of the agent's browser tabs on the live call's screen-share. Pass the page_id you got from browser.open. Only usable while the agent is in an active voice call. THIS IS THE ONLY WAY TO CHANGE WHAT THE ROOM SEES — scrolling or pressing keys changes the page, never which tab is shared. The shared tab stays the active share until you call present_tab with a different page_id, call present_stop to take it down, close the tab via browser.close, or the call ends. Returns the page_id, url and title actually on screen; check them before telling anyone what they are looking at, and use present_status to re-check later.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
page_id | string | yes | page_id returned by browser.open for the tab you want to share. Must be a tab still open in the agent's browser context. (max 128.0) |