CallMedia

View as Markdown

SignalWire.Relay.Calling.CallMedia

This object represents a call media 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

1CallMedia media = new CallMedia
2{
3 Type = CallMedia.MediaType.tts,
4 Parameters = new CallMedia.TTSParams
5 {
6 Text = "I'm a little teapot"
7 }
8};

Properties

PropertyTypeDescription
TypeSignalWire.Relay.Calling.CallMedia.MediaTypeThis is the type of the media.
ParametersobjectThis is the object that represents the parameters specific to the type, see SignalWire.Relay.Calling.CallMedia.MediaType for more information.

Methods

ParametersAs<T>()

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

Parameters

ParameterTypeRequiredDescription
TTyperequiredThis is the data type for the conversion, see SignalWire.Relay.Calling.CallMedia.MediaType for more information.

Returns

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

Examples

1CallMedia.AudioParams audioParams = media.ParametersAs<CallMedia.AudioParams>();
2CallMedia.TTSParams ttsParams = media.ParametersAs<CallMedia.TTSParams>();
3CallMedia.SilenceParams silenceParams = media.ParametersAs<CallMedia.SilenceParams>();
4CallMedia.RingtoneParams ringtoneParams = media.ParametersAs<CallMedia.RingtoneParams>();

Events

None