mirror of
https://github.com/vector-im/element-call.git
synced 2026-01-30 03:15:55 +00:00
22 lines
1.8 KiB
Markdown
22 lines
1.8 KiB
Markdown
# 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 `controlledMediaDevices` URL parameter in order to have any effect.
|
|
|
|
- `controls.setAvailableOutputDevices(devices: { id: string, name: string, forEarpiece?: boolean, isEarpiece?: boolean isSpeaker?: boolean, isExternalHeadset?, 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 earpiece 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.setOutputDevice(id: string): void` Sets the selected audio device in Element Call's menu. This should be used if the OS decides to automatically switch to Bluetooth, for example.
|
|
- `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.
|
|
- `showNativeOutputDevicePicker: (() => void) | undefined`. Callback called whenever the user presses the output button in the settings menu.
|
|
This button is only shown on iOS. (`userAgent.includes("iPhone")`)
|