ToneController.Send Method (ToneId, Single)
Sends the specified tone at the specified volume.
Namespace: Microsoft.Rtc.Collaboration.AudioVideo
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Sub Send ( _
tone As ToneId, _
volume As Single _
)
'Usage
Dim instance As ToneController
Dim tone As ToneId
Dim volume As Single
instance.Send(tone, volume)
public void Send(
ToneId tone,
float volume
)
Parameters
- tone
Type: Microsoft.Rtc.Collaboration.AudioVideo.ToneId
The tone to be sent.
- volume
Type: System.Single
The volume, as a percent, of the tone to be sent. This value must be between 0 and 100, inclusive.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | Thrown when the tone 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.