Interface: CallsApi

Recording the call on screen (ADR 0015), with calls:record. YapYap records, never the extension: the extension asks, YapYap asks the user in a window of its own, and only the user's click starts a recording. The extension never receives the sound, the file or its path.

Properties

record

readonly record: () => Promise<"recording" | "declined" | "no-call" | "unsupported">

Asks YapYap to offer recording the call on screen. Resolves with recording once the user chose Record, declined if they did not, no-call when no call is running, and unsupported where YapYap cannot record calls (see CallState.supported).

Returns

Promise<"recording" | "declined" | "no-call" | "unsupported">

---

recordings

readonly recordings: () => Promise<readonly CallRecording[]>

The recordings YapYap made, newest first.

Returns

Promise<readonly CallRecording[]>

---

reveal

readonly reveal: (id) => Promise<void>

Shows a recording in the system's file manager.

Parameters

id

string

Returns

Promise<void>

---

state

readonly state: () => Promise<CallState>

Returns

Promise<CallState>

---

stop

readonly stop: () => Promise<void>

Stops the recording running now, if any.

Returns

Promise<void>