Developer
WebSocket API
Commands
Web App Overlays

Web App Overlays

RequestOverlayIDs

ResponseUpdateOverlayIDs

Maps each web app overlay's page URL to its overlay handle. A web app can look up its own by its URL.

on('UpdateOverlayIDs', (handles) => console.log('My overlay handle:', handles[window.location.href]));
send('RequestOverlayIDs');

RequestUpdateOverlayCanvasSize

jsonData{ width, height }rawDataoverlay handle

Changes the resolution of a web app overlay.

send('RequestUpdateOverlayCanvasSize', {
  jsonData: { width: 1024, height: 768 },
  rawData: String(handle),
});