ToneController.Send Method (ToneId)
Sends the specified tone at 50% volume.
Namespace: Microsoft.Rtc.Collaboration.AudioVideo
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Sub Send ( _
tone As ToneId _
)
'Usage
Dim instance As ToneController
Dim tone As ToneId
instance.Send(tone)
public void Send(
ToneId tone
)
Parameters
- tone
Type: Microsoft.Rtc.Collaboration.AudioVideo.ToneId
The tone to be sent.
Exceptions
Exception | Condition |
---|---|
ArgumentOutOfRangeException | Thrown when tone argument is out of range (less than MinTone or greater than MaxTone), or when volume is negative or larger than 100. |
Remarks
Tones will be sent only when all three of the conditions are true. - An active AudioVideoFlow is attached. - AudioVideoFlow.ToneEnabled is equal to true. - AudioVideoFlow.HoldType equals to None.
Examples
The following example shows how to send a tone through ToneController.
C# Sending a tone through ToneController.
toneController.AttachFlow(audioVideoFlow);
toneController.Send(ToneId.Tone0);