AudioVideoMcuSession Class

Reference

Definition

Namespace:: Microsoft.Rtc.Collaboration.AudioVideo

Assembly:: Microsoft.Rtc.Collaboration.dll

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.

Allows requests to be made to the Audio-Video MCU.

public ref class AudioVideoMcuSession : Microsoft::Rtc::Collaboration::McuSession

public class AudioVideoMcuSession : Microsoft.Rtc.Collaboration.McuSession

type AudioVideoMcuSession = class
    inherit McuSession

Public Class AudioVideoMcuSession
Inherits McuSession

Inheritance: Object

McuSession
AudioVideoMcuSession

Remarks

This class represents the Audio-Video specific implementation of the media-agnostic McuSession. The class encapsulates operations and events relevant to the Audio-Video MCU.

Properties

AttendanceAnnouncementsStatus	Gets the current status for attendance announcements.
AudioMuteAllMode	Gets the current audio mute all mode. MuteAllMode
AudioSelfUnmuteAssignment	Gets the current audio self unmute assignment that is assigned. SelfUnmuteAssignment
ConferenceSession	Gets the parent ConferenceSession object. (Inherited from McuSession)
IsAudioSupported	Gets whether audio is supported by the MCU for the joined conference.
IsMultiViewVideoSupported	Gets whether multi-view video is supported by the MCU for the joined conference.
IsVideoSupported	Gets whether video is supported by the MCU for the joined conference.
McuInformation	Gets information about the MCU including the MCU address or null if the MCU session is not bound to a conference (The parent ConferenceSession has not joined a conference yet, or the joined conference does not support the corresponding MCU type). (Inherited from McuSession)
MuteAllMode	Obsolete. Gets the current mute all mode. MuteAllMode
SelfUnmuteAssignment	Obsolete. Gets the current self unmute assignment that is assigned. SelfUnmuteAssignment
State	Gets the state of the MCU as communicated by the focus. (Inherited from McuSession)
SupportedMediaTypes	Gets the media types supported by the MCU.
VideoSource	Gets the current video source that is assigned. VideoSource

Methods

BeginAddToDefaultRouting(ParticipantEndpoint, AddToDefaultRoutingOptions, AsyncCallback, Object)	Adds an endpoint to the default MCU routing.
BeginAddToDefaultRouting(ParticipantEndpoint, AsyncCallback, Object)	Adds an endpoint to the default MCU routing.
BeginDialOut(String, AsyncCallback, Object)	Requests the Audio-Video MCU to initiate an Audio-Video call to the supplied destination URI.
BeginDialOut(String, AudioVideoMcuDialOutOptions, AsyncCallback, Object)	Requests the Audio-Video MCU to initiate an Audio-Video call to the supplied destination URI.
BeginDialOut(String, McuDialOutOptions, AsyncCallback, Object)	Requests the Audio-Video MCU to initiate an Audio-Video call to the supplied destination URI.
BeginDisableMuteAllMode(AsyncCallback, Object)	Disables mute all mode on AudioVideoMcuSession if it was already enabled.
BeginDisableMuteAllMode(DisableMuteAllModeOptions, AsyncCallback, Object)	Disables mute all on AudioVideoMcuSession if it was already enabled based on given options.
BeginEject(ConversationParticipant, AsyncCallback, Object)	Ejects a participant from the MCU. (Inherited from McuSession)
BeginEject(ConversationParticipant, EjectOptions, AsyncCallback, Object)	Ejects a participant from the MCU. (Inherited from McuSession)
BeginEject(String, AsyncCallback, Object)	Ejects a participant or an endpoint from the MCU based on the supplied URI. (Inherited from McuSession)
BeginEject(String, EjectOptions, AsyncCallback, Object)	Ejects a participant or an endpoint from the MCU based on the supplied URI. (Inherited from McuSession)
BeginEnableMuteAllMode(AsyncCallback, Object)	Enables mute all mode on AudioVideoMcuSession.
BeginEnableMuteAllMode(EnableMuteAllModeOptions, AsyncCallback, Object)	Enables mute all mode on AudioVideoMcuSession based on given options.
BeginModifyAttendanceAnnouncements(AttendanceAnnouncementsStatus, AsyncCallback, Object)	Enables or disables attendance announcements.
BeginModifyAttendanceAnnouncements(AttendanceAnnouncementsStatus, ModifyAttendanceAnnouncementOptions, AsyncCallback, Object)	Enables or disables attendance announcements.
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.
BeginRemoveFromDefaultRouting(ParticipantEndpoint, AsyncCallback, Object)	Removes an endpoint from the default MCU routing.
BeginRemoveFromDefaultRouting(ParticipantEndpoint, RemoveFromDefaultRoutingOptions, AsyncCallback, Object)	Removes an endpoint from the default MCU routing.
BeginSendCommand(ConferenceCommand, AsyncCallback, Object)	Send a request to the MCU via the focus. (Inherited from McuSession)
BeginSendCommand(ConferenceCommand, ConferenceCommandOptions, AsyncCallback, Object)	Send a request to the MCU via the focus. (Inherited from McuSession)
BeginTransfer(AudioVideoCall, McuTransferOptions, AsyncCallback, Object)	Transfers an established two party Audio-Video call to the MCU.
BeginTransfer(Call, McuTransferOptions, AsyncCallback, Object)	Transfers an established two party call to the MCU. (Inherited from McuSession)
BeginUnmute(ParticipantEndpoint, AsyncCallback, Object)	Enables the audio coming from the supplied participant endpoint to be sent to the conference.
BeginUnmute(ParticipantEndpoint, UnmuteOptions, AsyncCallback, Object)	Enables the audio coming from the supplied participant endpoint to be sent to the conference.
EndAddToDefaultRouting(IAsyncResult)	Waits for the pending operation to complete.
EndDialOut(IAsyncResult)	Waits for the pending operation to complete.
EndDisableMuteAllMode(IAsyncResult)	Waits for the pending operation to complete.
EndEject(IAsyncResult)	Waits for the pending eject operation to complete. (Inherited from McuSession)
EndEnableMuteAllMode(IAsyncResult)	Waits for the pending operation to complete.
EndModifyAttendanceAnnouncements(IAsyncResult)	Waits for the pending operation to complete.
EndMute(IAsyncResult)	Waits for the pending operation to complete.
EndRemoveFromDefaultRouting(IAsyncResult)	Waits for the pending operation to complete.
EndSendCommand(IAsyncResult)	Waits for the pending send command to complete. (Inherited from McuSession)
EndTransfer(IAsyncResult)	Waits for the pending operation to complete.
EndUnmute(IAsyncResult)	Waits for the pending operation to complete.
GetLocalParticipantEndpoints()	Gets a snapshot collection of the endpoints used by the local participant to communicate with the MCU. (Inherited from McuSession)
GetRemoteParticipantEndpoints()	Gets a snapshot collection of the endpoints used by remote participants to communicate with the MCU. (Inherited from McuSession)
HandleParticipantEndpointAttendanceChanged(Collection<KeyValuePair<ParticipantEndpoint, McuParticipantEndpointProperties>>, Collection<KeyValuePair<ParticipantEndpoint, McuParticipantEndpointProperties>>)	Processes added or removed participant endpoints to the MCU.
HandleParticipantEndpointPropertiesChanged(ParticipantEndpoint, PropertyMergeInformation<McuParticipantEndpointProperties>)	Process updated MCU participant endpoint properties.
HandlePropertiesChanged(PropertyMergeInformation<McuSessionProperties>)	Process updated session properties.
RaiseAttendanceChanged<TProperties>(Collection<KeyValuePair<ParticipantEndpoint, McuParticipantEndpointProperties>>, Collection<KeyValuePair<ParticipantEndpoint, McuParticipantEndpointProperties>>, EventHandler<ParticipantEndpointAttendanceChangedEventArgs<TProperties>>)	Raises a attendance changed event on behalf of the derived class. (Inherited from McuSession)
RaiseSessionParticipantPropertyChanged<TProperties>(ParticipantEndpoint, PropertyMergeInformation<McuParticipantEndpointProperties>, EventHandler<ParticipantEndpointPropertiesChangedEventArgs<TProperties>>)	Raises a property changed event for the McuSessionParticipant. (Inherited from McuSession)
RaiseSessionPropertyChanged<TProperties>(PropertyMergeInformation<McuSessionProperties>, EventHandler<PropertiesChangedEventArgs<TProperties>>)	Raises a property changed event on behalf of the derived class. (Inherited from McuSession)
ResetCore()	Recycles the AudioVideoMcuSession for reuse.
ToString()	Returns a String that represents the current McuSession. (Inherited from McuSession)
TryGetParticipantEndpointProperties(ParticipantEndpoint, AudioVideoMcuParticipantEndpointProperties)	Gets the properties of the supplied participant endpoint in this MCU.
TryGetParticipantEndpointProperties(ParticipantEndpoint, McuParticipantEndpointProperties)	Gets the basic properties for a participant endpoint in the MCU. (Inherited from McuSession)

Events

ParticipantEndpointAttendanceChanged	Raised when one or more participant endpoints join or leave the MCU.
ParticipantEndpointPropertiesChanged	Raised when one or more properties of a participant endpoint change.
PropertiesChanged	Raised when one or more session properties change.
StateChanged	Raised when the MCU state changes are reported back to the application. (Inherited from McuSession)

Extension Methods

BeginHold(AudioVideoMcuSession, ParticipantEndpoint, HoldOptions, AsyncCallback, Object)
BeginModifyVideoSource(AudioVideoMcuSession, VideoSource, ModifyVideoSourceOptions, AsyncCallback, Object)
BeginResume(AudioVideoMcuSession, ParticipantEndpoint, ResumeOptions, AsyncCallback, Object)
BeginTransfer(AudioVideoMcuSession, String, String, String, String, String, String, IEnumerable<String>, McuTransferOptions, AsyncCallback, Object)
CreateVideoSource(AudioVideoMcuSession, VideoSourceMode, ParticipantEndpoint)
EndHold(AudioVideoMcuSession, IAsyncResult)
EndModifyVideoSource(AudioVideoMcuSession, IAsyncResult)
EndResume(AudioVideoMcuSession, IAsyncResult)
BeginSendCommand(McuSession, ConferenceCommand, ConferenceCommandOptions, AsyncCallback, Object)
EndSendCommand(McuSession, IAsyncResult)

Applies to