AudioVideoMcuSession.BeginMute Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| BeginMute(ParticipantEndpoint, AsyncCallback, Object) |
Stops audio coming from the supplied participant endpoint from being sent to the conference. |
| BeginMute(ParticipantEndpoint, MuteOptions, AsyncCallback, Object) |
Stops audio coming from the supplied participant endpoint from being sent to the conference. |
BeginMute(ParticipantEndpoint, AsyncCallback, Object)
Stops audio coming from the supplied participant endpoint from being sent to the conference.
public:
IAsyncResult ^ BeginMute(Microsoft::Rtc::Collaboration::ParticipantEndpoint ^ endpoint, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginMute (Microsoft.Rtc.Collaboration.ParticipantEndpoint endpoint, AsyncCallback userCallback, object state);member this.BeginMute : Microsoft.Rtc.Collaboration.ParticipantEndpoint * AsyncCallback * obj -> IAsyncResultPublic Function BeginMute (endpoint As ParticipantEndpoint, userCallback As AsyncCallback, state As Object) As IAsyncResultParameters
- endpoint
- ParticipantEndpoint
The endpoint for which audio should be muted.
- 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
An IAsyncResult that references the asynchronous operation.
Exceptions
Thrown when the parent ConferenceSession is not in a valid state or the conference does not support the corresponding MCU type. Also thrown if the supplied endpoint is not in the MCU or has no audio to mute.
Thrown when the supplied endpoint is null.
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.
Applies to
BeginMute(ParticipantEndpoint, MuteOptions, AsyncCallback, Object)
Stops audio coming from the supplied participant endpoint from being sent to the conference.
public:
IAsyncResult ^ BeginMute(Microsoft::Rtc::Collaboration::ParticipantEndpoint ^ endpoint, Microsoft::Rtc::Collaboration::AudioVideo::MuteOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginMute (Microsoft.Rtc.Collaboration.ParticipantEndpoint endpoint, Microsoft.Rtc.Collaboration.AudioVideo.MuteOptions options, AsyncCallback userCallback, object state);member this.BeginMute : Microsoft.Rtc.Collaboration.ParticipantEndpoint * Microsoft.Rtc.Collaboration.AudioVideo.MuteOptions * AsyncCallback * obj -> IAsyncResultPublic Function BeginMute (endpoint As ParticipantEndpoint, options As MuteOptions, userCallback As AsyncCallback, state As Object) As IAsyncResultParameters
- endpoint
- ParticipantEndpoint
The endpoint for which audio should be muted.
- options
- MuteOptions
Options to customize the mute operation. Could be set to 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
An IAsyncResult that references the asynchronous operation.
Exceptions
Thrown when the parent ConferenceSession is not in a valid state or the conference does not support the corresponding MCU type. Also thrown if the supplied endpoint is not in the MCU or has no audio to mute.
Thrown when the supplied endpoint is null.
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.
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for