docs/controls.md

# Global JS controls

A few aspects of Element Call's interface can be controlled through a global API on the `window`.

## Picture-in-picture

- `controls.canEnterPip(): boolean` Determines whether it's possible to enter picture-in-picture mode.
- `controls.enablePip(): void` Puts the call interface into picture-in-picture mode. Throws if not in a call.
- `controls.disablePip(): void` Takes the call interface out of picture-in-picture mode, restoring it to its natural display mode. Throws if not in a call.

## Audio output devices

These functions must be used in conjunction with the `controlledOutput` URL parameter in order to have any effect.

- `controls.setOutputDevices(devices: { id: string, name: string, forEarpiece?: boolean }[]): void` Sets the list of available audio outputs. `forEarpiece` is used on ios only.
  It flags the device that should be used if the user selects earpice mode. This should be the main (stereo loudspeaker) of the device.
- `controls.onOutputDeviceSelect: ((id: string) => void) | undefined` Callback called whenever the user or application selects a new audio output.
- `controls.setOutputEnabled(enabled: boolean)` Enables/disables all audio output from the application. This can be useful for temporarily pausing audio while the controlling application is switching output devices. Output is enabled by default.
Add simple global controls to put the call in picture-in-picture mode (#2573 ) 2024-08-27 07:47:20 -04:00			`# Global JS controls`

WIP 2025-04-29 22:12:07 +02:00			A few aspects of Element Call's interface can be controlled through a global API on the `window`.

			`## Picture-in-picture`
Add simple global controls to put the call in picture-in-picture mode (#2573 ) 2024-08-27 07:47:20 -04:00
			- `controls.canEnterPip(): boolean` Determines whether it's possible to enter picture-in-picture mode.
			- `controls.enablePip(): void` Puts the call interface into picture-in-picture mode. Throws if not in a call.
			- `controls.disablePip(): void` Takes the call interface out of picture-in-picture mode, restoring it to its natural display mode. Throws if not in a call.
WIP 2025-04-29 22:12:07 +02:00
			`## Audio output devices`

			These functions must be used in conjunction with the `controlledOutput` URL parameter in order to have any effect.

add earpice mode 2025-05-14 19:55:08 +02:00			- `controls.setOutputDevices(devices: { id: string, name: string, forEarpiece?: boolean }[]): void` Sets the list of available audio outputs. `forEarpiece` is used on ios only.
			`It flags the device that should be used if the user selects earpice mode. This should be the main (stereo loudspeaker) of the device.`
WIP 2025-04-29 22:12:07 +02:00			- `controls.onOutputDeviceSelect: ((id: string) => void) \| undefined` Callback called whenever the user or application selects a new audio output.
			- `controls.setOutputEnabled(enabled: boolean)` Enables/disables all audio output from the application. This can be useful for temporarily pausing audio while the controlling application is switching output devices. Output is enabled by default.