Relay.Calling.TapResult

This object returned from tap method that represents the final result of a tapping.

Methods-submenu

GetDestinationDevice

Returns the destination device receiving media.

Parameters

None

Returns

Object - The destination device.

Examples

Tap audio and then inspect the destination device.

1 var tapdevice signalwire.TapDevice
2 tapdevice.Type = signalwire.TapRTP.String()
3 tapdevice.Params.Addr = "82.47.225.162"
4 tapdevice.Params.Port = 1234
5 tapdevice.Params.Codec = "PCMU"
6 tapAction, err := resultDial.Call.TapAudioAsync(signalwire.TapDirectionListen, &tapdevice)
7 if err != nil {
8     signalwire.Log.Fatal("Error occurred while trying to tap audio: %v\n", err)
9 }
10 time.Sleep(10 * time.Second)
11 tapAction.Stop()
12 signalwire.Log.Info("Tap: %v Result: %v\n", tapAction.GetTap(), tapAction.GetResult())
13 signalwire.Log.Info("SourceDevice: %v\n", tapAction.GetSourceDevice())           // comes from the Signalwire platform
14 signalwire.Log.Info("DestinationDevice: %v\n", tapAction.GetDestinationDevice()) // the device passed above

GetEvent

Returns the last Relay Event arrived for this operation.

Parameters

None

Returns

Relay.Event - Last Relay Event.

GetSourceDevice

Returns the source device sending media.

Parameters

None

Returns

Object - The source device.

Examples

Inspect the source device.

1 signalwire.Log.Info("SourceDevice: %v\n", tapAction.GetSourceDevice())           // comes from the Signalwire platform

GetTap

Returns the params for this tap action.

Parameters

None

Returns

signalwire.Tap

Examples

Inspect the tap params.

1 signalwire.Log.Info("Tap: %v Result: %v\n", tapAction.GetTap(), tapAction.GetResult())

GetSuccessful

Return true if the tapping succeeded, false otherwise.

Parameters

None

Returns

Boolean - True/False accordingly to the state.