Edit

Share via


ToneController.ToneReceived Event

Definition

Raised when a ToneController receives a tone.

public:
 event EventHandler<Microsoft::Rtc::Collaboration::AudioVideo::ToneControllerEventArgs ^> ^ ToneReceived;
public event EventHandler<Microsoft.Rtc.Collaboration.AudioVideo.ToneControllerEventArgs> ToneReceived;
member this.ToneReceived : EventHandler<Microsoft.Rtc.Collaboration.AudioVideo.ToneControllerEventArgs> 
Public Custom Event ToneReceived As EventHandler(Of ToneControllerEventArgs) 

Event Type

Examples

The following example shows how to subscribe to the ToneReceived event.

C# Subscribing to ToneReceived event.


toneController.ToneReceived += delegate(object sender, ToneControllerEventArgs args)
{
    ToneId tone = (ToneId)args.Tone;
    float volume = args.Volume;

    // Do whatever it needs.
};



Remarks

Tones will be received only when all three of the following conditions are true:

  • An active AudioVideoFlow is attached.
  • AudioVideoFlow.ToneEnabled is equal to true.
  • AudioVideoFlow.HoldType is None or RemoteEndpointAllowTones.

Applies to