CallTap
Represents a current or past tapping of a call.
Obtain instances of this class by starting a Tap with one of the following methods:
Example
As soon as the other party answers the phone, start transmitting the audio of the call to an external service.
Properties
The unique ID for this tap session.
The current state of the tap session.
Whether the tap has ended. Returns true if the state is "finished".
Methods
ended
- ended():
Promise<CallTap>
Returns a promise that is resolved only after this tap finishes (or is stopped).
Returns
Promise<CallTap>
A promise that resolves to CallTap object when the tap session has been
ended.
Example
stop
- stop():
Promise<CallTap>
Stops the tapping.
Returns
Promise<CallTap>
A promise that resolves to CallTap object when the tap session has been stopped.
Example
Events
onStarted
- CallTap.listen(
{ onStarted: Callback }})
Emitted when the tapping starts. Your event handler will receive an instance of CallTap.
Parameters
The tap that started. See CallTap.
onEnded
- CallTap.listen(
{ onEnded: Callback }})
Emitted when the tapping ends. Your event handler will receive an instance of CallTap.
Parameters
The tap that ended. See CallTap.