AudioVideoMcuSession.BeginEnableAnnouncements Method
NOTE: This API is now obsolete.
This method will be removed from future versions. Use AudioVideoCall.AudioVideoMcuRouting methods. Enables participant endpoints communicating with the Audio-Video MCU to receive audio announcements in the conference.
Namespace: Microsoft.Rtc.Collaboration.AudioVideo
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
<ObsoleteAttribute("This method will be removed from future versions. Use AudioVideoCall.AudioVideoMcuRouting methods.")> _
Public Function BeginEnableAnnouncements ( _
subscribingParticipantEndpoints As IEnumerable(Of ParticipantEndpoint), _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As AudioVideoMcuSession
Dim subscribingParticipantEndpoints As IEnumerable(Of ParticipantEndpoint)
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginEnableAnnouncements(subscribingParticipantEndpoints, _
userCallback, state)
[ObsoleteAttribute("This method will be removed from future versions. Use AudioVideoCall.AudioVideoMcuRouting methods.")]
public IAsyncResult BeginEnableAnnouncements(
IEnumerable<ParticipantEndpoint> subscribingParticipantEndpoints,
AsyncCallback userCallback,
Object state
)
Parameters
- subscribingParticipantEndpoints
Type: System.Collections.Generic.IEnumerable<ParticipantEndpoint>
The list of participant endpoints to receive broadcast announcements.
- userCallback
Type: System.AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
Type: System.Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Return Value
Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | Thrown when the parent ConferenceSession is not in a valid state or the conference does not support the corresponding MCU type. Also thrown if none of the supplied participant endpoints are currently present in the MCU. |
| ArgumentNullException | Thrown when the supplied subscribingParticipantEndpoints is null. |
| ArgumentException | Thrown when one of collection members in subscribingParticipantEndpoints is null. |
| RealTimeInvalidOperationException | Thrown when the parent ConferenceSession is reconnecting (FailureReason will be set to InvalidOperationReason.RetryableOperation). |
Remarks
An endpoint supporting privileged operations is required for this operation.
Note that any of the supplied endpoints in subscribingParticipantEndpoints my leave the MCU while this method is being processed. The request will be sent for participant endpoints that are currently known to be in the MCU, while the other endpoints are ignored. However, if all supplied endpoints have left the MCU, an InvalidOperationException will be thrown.