Relay::Calling::TapAction

This object is returned by the asynchronous tap_media! method that represents a running media tap on the call.

Signalwire will send RTP or Websocket Audio (WS or WSS).

Properties

Property	Type	Description
result	Relay::Calling::TapResult	Final tap result.
completed	Boolean	Whether the action has finished.
payload	Hash	Payload sent to Relay to start tapping.
control_Id	String	UUID to identify the action.
source_device	Hash	Source device sending media.

Methods

stop

Stop the action immediately.

Parameters

None

Returns

Relay::Calling::StopResult - A StopResult object with a successful property.

Examples

Tapping audio from the call and then stop it using the TapAction object.

action = call.tap_media!(audio_direction: "listen", target_addr: "127.0.0.1", target_port: 1234)
sleep 5
action.stop