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.

TapAction actionTap = call.TapAsync(
    new CallTap
    {
        Audio = new CallTap.AudioParams
        {
            Direction = CallTap.AudioParams.AudioDirection.both,
        }
    },
    new CallTapDevice
    {
        Type = CallTapDevice.DeviceType.rtp,
        Parameters = new CallTapDevice.RTPParams
        {
            Address = "1.2.3.4",
            Port = 12345,
        }
    });

Thread.Sleep(3000);

if (!agent.IsAvailable)
{
    StopResult resultStop = actionTap.Stop();
}