studio/element-call
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

review: improve comments

Browse Source
This commit is contained in:
Valere
2026-03-24 18:25:09 +01:00
parent 1bc2abb84f
commit fc61a36d4a
2 changed files with 11 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/controls.ts
View File

@@ -40,26 +40,28 @@ export interface OutputDevice {
id: string; id: string;
name: string; name: string;
/** /**
* Reverse engineered: * `forEarpiece` in an iOS only flag, that will be set on the default speaker device.
* - on iOS always true if output is routed to speaker. In other case iOS on declare a `dummy` id device. * The default speaker device will be used for the earpiece mode by
* In that case then ElementCalls manually append a earpiece device with id `EARPIECE_CONFIG_ID` anb `{ type: "earpiece" }` * using a stereo pan and reducing the volume significantly. (in combination this is similar to a dedicated earpiece mode)
* - on iOS this is true if output is routed to speaker.
* In that case then ElementCalls manually appends an earpiece device with id `EARPIECE_CONFIG_ID` and `{ type: "earpiece" }`
* - on Android this is unused. * - on Android this is unused.
*/ */
forEarpiece?: boolean; forEarpiece?: boolean;
/** /**
* Reverse engineered: * Is the device the OS earpiece audio configuration?
* - on iOS always undefined * - on iOS always undefined
* - on Android true for the `TYPE_BUILTIN_EARPIECE` * - on Android true for the `TYPE_BUILTIN_EARPIECE`
*/ */
isEarpiece?: boolean; isEarpiece?: boolean;
/** /**
* Reverse engineered: * Is the device the OS default speaker:
* - on iOS always true if output is routed to speaker. In other case iOS on declare a `dummy` id device. * - on iOS always true if output is routed to speaker. In other case iOS on declare a `dummy` id device.
* - on Android true for the `TYPE_BUILTIN_SPEAKER` * - on Android true for the `TYPE_BUILTIN_SPEAKER`
*/ */
isSpeaker?: boolean; isSpeaker?: boolean;
/** /**
* Reverse engineered: * Is the device the OS default external headset (bluetooth):
* - on iOS always undefined. * - on iOS always undefined.
* - on Android true for the `TYPE_BLUETOOTH_SCO` * - on Android true for the `TYPE_BLUETOOTH_SCO`
*/ */

4
src/state/AndroidControlledAudioOutput.ts
View File

@@ -70,7 +70,9 @@ export class AndroidControlledAudioOutput implements MediaDevice<
"[MediaDevices AndroidControlledAudioOutput]", "[MediaDevices AndroidControlledAudioOutput]",
); );
// STATE stream: the current state of the controller, including the list of available devices and the selected device. /**
* STATE stream: the current state of the controller, including the list of available devices and the selected device.
*/
private readonly controllerState$: Behavior<ControllerState>; private readonly controllerState$: Behavior<ControllerState>;
/** /**