AudioVideoMcuSession.BeginEnableMuteAllMode Method

Definition

Namespace:

Microsoft.Rtc.Collaboration.AudioVideo

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

BeginEnableMuteAllMode(EnableMuteAllModeOptions, AsyncCallback, Object)	Enables mute all mode on AudioVideoMcuSession based on given options.
BeginEnableMuteAllMode(AsyncCallback, Object)	Enables mute all mode on AudioVideoMcuSession.

BeginEnableMuteAllMode(EnableMuteAllModeOptions, AsyncCallback, Object)

Enables mute all mode on AudioVideoMcuSession based on given options.

public:
 IAsyncResult ^ BeginEnableMuteAllMode(Microsoft::Rtc::Collaboration::AudioVideo::EnableMuteAllModeOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginEnableMuteAllMode (Microsoft.Rtc.Collaboration.AudioVideo.EnableMuteAllModeOptions options, AsyncCallback userCallback, object state);

member this.BeginEnableMuteAllMode : Microsoft.Rtc.Collaboration.AudioVideo.EnableMuteAllModeOptions * AsyncCallback * obj -> IAsyncResult

Public Function BeginEnableMuteAllMode (options As EnableMuteAllModeOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

options

EnableMuteAllModeOptions

Optional parameters when enabling mute all mode. Can be null.

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

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

BeginEnableMuteAllMode(AsyncCallback, Object)

Enables mute all mode on AudioVideoMcuSession.

public:
 IAsyncResult ^ BeginEnableMuteAllMode(AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginEnableMuteAllMode (AsyncCallback userCallback, object state);

member this.BeginEnableMuteAllMode : AsyncCallback * obj -> IAsyncResult

Public Function BeginEnableMuteAllMode (userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

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 but only leaders can unmute themselves. LeadersOnly