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

Visual Basic (Declaration) 
Public 
Function 
BeginEnableAnnouncements ( _
	
subscribingParticipantEndpoints 
As 
IEnumerable(
Of 

ParticipantEndpoint), _
	
userCallback 
As 
AsyncCallback, _
	
state 
As 
Object _
) 
As 
IAsyncResult
C# 
public 
IAsyncResult 
BeginEnableAnnouncements(
	
IEnumerable<

ParticipantEndpoint> 
subscribingParticipantEndpoints,
	
AsyncCallback 
userCallback,
	
Object 
state
)
Visual C++ 
public:
IAsyncResult^ 
BeginEnableAnnouncements(
	
IEnumerable<

ParticipantEndpoint^>^ 
subscribingParticipantEndpoints, 
	
AsyncCallback^ 
userCallback, 
	
Object^ 
state
)
JavaScript 
function 
beginEnableAnnouncements(
subscribingParticipantEndpoints, 
userCallback, 
state);

Parameters

subscribingParticipantEndpoints
Type: IEnumerable < (Of < ( ParticipantEndpoint > ) > )
The list of participant endpoints to receive broadcast announcements.
userCallback
Type: AsyncCallback
The method to be called when the asynchronous operation is completed.
state
Type: Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Return Value

An IAsyncResult that references the asynchronous operation.

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.

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.
Microsoft.Rtc.Signaling . . :: . RealTimeInvalidOperationException Thrown when the parent ConferenceSession is reconnecting (FailureReason will be set to InvalidOperationReason.RetryableOperation).

See Also