AudioVideoMcuSession.BeginEnableMuteAllMode Method (EnableMuteAllModeOptions, AsyncCallback, Object)
Enables mute all mode on AudioVideoMcuSession based on given options.
Namespace: Microsoft.Rtc.Collaboration.AudioVideo
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginEnableMuteAllMode ( _
options As EnableMuteAllModeOptions, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As AudioVideoMcuSession
Dim options As EnableMuteAllModeOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginEnableMuteAllMode(options, _
userCallback, state)
public IAsyncResult BeginEnableMuteAllMode(
EnableMuteAllModeOptions options,
AsyncCallback userCallback,
Object state
)
Parameters
- options
Type: Microsoft.Rtc.Collaboration.AudioVideo.EnableMuteAllModeOptions
Optional parameters when enabling mute all mode. Can be null.
- 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. |
| RealTimeInvalidOperationException | Thrown when the parent ConferenceSession is reconnecting (FailureReason will be set to InvalidOperationReason.RetryableOperation). |
Remarks
This operation is allowed by the server for conference leaders only.
Mute all mode will be enabled based on given enable mute all options options. If the options parameter is not specified mute all mode will be enabled but only leaders can unmute themselves. LeadersOnly