SignalWire.Relay.Calling.CallRingback

This object represents a call ringback that is being played.

Constructor

The only constructor is the default constructor, properties should all be assigned by initializer or after construction.

Parameters

None

Examples

Basic Example

1 CallRingback ringbackAudio = new CallRingback
2 {
3      Type = CallRingback.RingbackType.audio,
4      Parameters = new CallRingback.AudioParams
5      {
6           URL = "http://path/to/audio/file"
7      }
8 };
9 
10 CallRingback ringbackRingtone = new CallRingback
11 {
12      Type = CallRingback.RingbackType.ringtone,
13      Parameters = new CallRingback.RingtoneParams
14      {
15          Name = "us",
16          Duration = 30
17      }
18 };
19 
20 CallRingback ringbackSilence = new CallRingback
21 {
22      Type = CallRingback.RingbackType.silence,
23      Parameters = new CallRingback.SilenceParams
24      {
25          Duration = 30
26      }
27 };
28 
29 CallRingback ringbackTTS = new CallRingback
30 {
31      Type = CallRingback.RingbackType.tts,
32      Parameters = new CallRingback.TTSParams
33      {
34          Gender = "female",
35          Language = "en",
36          Text = "I'm a little teapot"
37      }
38 };

Properties

Property	Type	Description
`Type`	`SignalWire.Relay.Calling.CallRingback.RingbackType`	This is the type of the media.
`Parameters`	object	This is the object that represents the parameters specific to the type, see `SignalWire.Relay.Calling.CallRingback.RingbackType` for more information.

Methods

ParametersAs<T>()

This is a helper method to convert the Parameters to the real type.

Parameters

Parameter	Type	Required	Description
`T`	Type	required	This is the data type for the conversion, see `SignalWire.Relay.Calling.CallRingback.RingbackType` for more information.

Returns

T - This is an instance of the data type resulting from the conversion, see SignalWire.Relay.Calling.CallRingback.RingbackType for more information.

Examples

1 CallRingback.AudioParams audioParams = ringbackAudio.ParametersAs<CallRingback.AudioParams>();
2 CallRingback.RingtoneParams ringtoneParams = ringbackRingtone.ParametersAs<CallRingback.RingtoneParams>
3 CallRingback.SilenceParams silenceParams = ringbackSilence.ParametersAs<CallRingback.SilenceParams>();
4 CallRingback.TTSParams ttsParams = ringbackTTS.ParametersAs<CallRingback.TTSParams>();

Events

None