SignalWire.Relay.Calling.TapAction

This object returned from TapAsync method that represents a tap operation that is currently active on a call.

Properties

Property	Type	Description
`ControlID`	string	The identifier used to control the operation.
`Result`	`SignalWire.Relay.Calling.TapResult`	Final result of tapping.
`State`	`SignalWire.Relay.Calling.CallTapState`	Current state of the tap operation.
`Completed`	bool	Whether the tap operation has completed.
`Payload`	`SignalWire.Relay.Calling.CallTap`	Payload sent to Relay to start the tap operation.
`SourceDevice`	`SignalWire.Relay.Calling.CallTapDevice`	The source device of the tap operation.

Methods

Stop

Stop the action immediately.

Parameters

None

Returns

SignalWire.Relay.Calling.StopResult - The result object to interact with.

Examples

Start tapping and stop it if agent is not available in 3 seconds.

1 TapAction actionTap = call.TapAsync(
2     new CallTap
3     {
4         Audio = new CallTap.AudioParams
5         {
6             Direction = CallTap.AudioParams.AudioDirection.both,
7         }
8     },
9     new CallTapDevice
10     {
11         Type = CallTapDevice.DeviceType.rtp,
12         Parameters = new CallTapDevice.RTPParams
13         {
14             Address = "1.2.3.4",
15             Port = 12345,
16         }
17     });
18 
19 Thread.Sleep(3000);
20 
21 if (!agent.IsAvailable)
22 {
23     StopResult resultStop = actionTap.Stop();
24 }