ConferenceSession Class

Reference

Definition

Namespace:: Microsoft.Rtc.Collaboration

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.

ConferenceSession enables an application to join a conference and perform other operations related to an activated conference.

public ref class ConferenceSession : Microsoft::Rtc::Signaling::IOfferAnswer, Microsoft::Rtc::Signaling::ISipSubscriptionProcessor

public class ConferenceSession : Microsoft.Rtc.Signaling.IOfferAnswer, Microsoft.Rtc.Signaling.ISipSubscriptionProcessor

type ConferenceSession = class
    interface IOfferAnswer
    interface ISipSubscriptionProcessor

Public Class ConferenceSession
Implements IOfferAnswer, ISipSubscriptionProcessor

Inheritance: Object
ConferenceSession

Derived: Microsoft.Rtc.Internal.Collaboration.Conferencing.InternalConferenceSession

Implements: IOfferAnswer ISipSubscriptionProcessor

Properties

AccessLevel	Gets the conference access level.
AudioVideoMcuSession	Gets the audio-video MCU session.
AutomaticLeaderAssignment	Gets the automatic leader assignment applied to attendees joining this conference.
ConferenceUri	Gets the conference URI.
Conversation	Gets the conversation that owns this conference session.
Disclaimer	Gets the disclaimer that should be presented to the user prior to joining.
DisclaimerTitle	Gets the disclaimer title used to schedule the conference.
HostingNetwork	Gets information about where the conference is being hosted.
InstantMessagingMcuSession	Gets the instant messaging MCU session.
IsTrustedJoin	Gets whether the conference was joined as a trusted application.
LobbyBypass	Gets the current lobby bypass policy applied to the conference.
LobbyManager	Gets an object that allows leaders to manage lobby participants.
Organizer	Gets the participant who organized the conference.
ParticipantData	Gets an XML blob set by the conference organizer to send to participants when they join.
RecordingPolicy	Gets the recording policy set by the administrator.
SchedulingTemplate	Gets the scheduling template used to schedule the conference.
State	Gets the state of the conference session.
Subject	Gets the conference subject.

Methods

BeginEject(ConversationParticipant, AsyncCallback, Object)	Ejects all endpoints of a participant from the conference.
BeginEject(ConversationParticipant, EjectOptions, AsyncCallback, Object)	Ejects all endpoints of a participant from the conference.
BeginGetExtendedProperties(AsyncCallback, Object)	Gets the extended properties of the conference.
BeginJoin(AsyncCallback, Object)	Obsolete. This method will be removed from future versions. Instead, use BeginJoin(ConferenceJoinOptions, AsyncCallback, Object) to join a conference. Creates and joins an ad-hoc conference.
BeginJoin(ConferenceJoinInformation, AsyncCallback, Object)	Obsolete. This method will be removed from future versions. Instead, use BeginJoin(String, ConferenceJoinOptions, AsyncCallback, Object) to join a conference. Joins a conference based on the provided join information.
BeginJoin(ConferenceJoinOptions, AsyncCallback, Object)	Joins a conference based on the provided join options.
BeginJoin(MeetNowOptions, AsyncCallback, Object)	Creates and joins an ad hoc conference conference with the widest possible audience.
BeginJoin(String, ConferenceJoinOptions, AsyncCallback, Object)	Joins a conference based on the provided conference URI and join options.
BeginLockConference(AsyncCallback, Object)	Locks the joined conference.
BeginLockConference(LockConferenceOptions, AsyncCallback, Object)	Locks the joined conference.
BeginModifyConferenceConfiguration(ConferenceAccessLevel, LobbyBypass, AutomaticLeaderAssignment, AsyncCallback, Object)	Modifies conference configuration.
BeginModifyConferenceConfiguration(ConferenceAccessLevel, LobbyBypass, AutomaticLeaderAssignment, ModifyConferenceConfigurationOptions, AsyncCallback, Object)	Modifies conference configuration.
BeginModifyRole(ConversationParticipant, ConferencingRole, AsyncCallback, Object)	Modifies the role of a participant in the conference.
BeginModifyRole(ConversationParticipant, ConferencingRole, ModifyRoleOptions, AsyncCallback, Object)	Modifies the role of a participant in the conference.
BeginTerminateConference(AsyncCallback, Object)	Terminates the conference and forces all participants to leave if performed by a conference leader. Otherwise it causes the participant to leave the conference.
BeginUnlockConference(AsyncCallback, Object)	Unlocks a conference.
BeginUnlockConference(UnlockConferenceOptions, AsyncCallback, Object)	Unlocks a conference.
EndEject(IAsyncResult)	Waits for the pending asynchronous eject operation to complete.
EndGetExtendedProperties(IAsyncResult)	Waits for the pending asynchronous operation to complete.
EndJoin(IAsyncResult)	Waits for the pending asynchronous join operation to complete.
EndLockConference(IAsyncResult)	Waits for the pending asynchronous operation to lock the conference to complete.
EndModifyConferenceConfiguration(IAsyncResult)	Waits for the pending asynchronous operation to complete.
EndModifyRole(IAsyncResult)	Waits for the pending asynchronous operation to modify the participant role to complete."
EndTerminateConference(IAsyncResult)	Waits for the pending asynchronous termination operation to complete.
EndUnlockConference(IAsyncResult)	Waits for the pending asynchronous operation to unlock the conference to complete.
GetAllowedAccessLevels()	Returns a snapshot of the allowed admission policies in the conference.
GetAllowedAutomaticLeaderAssignments()	Gets the allowed automatic leader assignments for the conference.
GetAllowedLobbyBypassValues()	Gets the allowed lobby bypass values for the conference.
GetLocalParticipantEndpoints()	Gets a snapshot collection of the endpoints used by the local participant to communicate with the focus.
GetMcuInformation(String)	Gets the MCU information (including MCU URI) for the provided MCU type.
GetRemoteParticipantEndpoints()	Gets a snapshot collection of the endpoints used by the remote participants to communicate with the focus.
GetTraceCorrelationID()	Gets the trace correlation id for this instance.
ToString()	Returns a System.String that represents this object.
TryGetMcuSession<T>(T)	Attempts to retrieve an McuSession of type `T`.
TryGetParticipantEndpointProperties(ParticipantEndpoint, ConferenceParticipantEndpointProperties)	Gets the properties for the given participant endpoint.

Operators

Implicit(ConferenceSession to RealTimeAddress)

Converts this conference session to the address of the joined conference for later rejoin.

Events

ParticipantEndpointAttendanceChanged	Raised when one or more participant endpoints join or leave the focus.
ParticipantEndpointPropertiesChanged	Raised when one or more properties of a participant endpoint change.
PropertiesChanged	Raised when one or more properties of the conference session change.
StateChanged	Raised when the conference session state changes.
TerminationCountdownStatusChanged	Raised when the automatic conference termination status changes.

Explicit Interface Implementations

IOfferAnswer.GetAnswer(Object, ContentDescription)	The method that is called when media description answer is required for an outgoing 200 OK response or an outgoing ACK when the initial INVITE request had no offer.
IOfferAnswer.GetOffer(Object)	The method that is called when media description offer is required for an outgoing INVITE request or an outgoing 200 OK response to an INVITE request with null offer.
IOfferAnswer.HandleOfferInInviteResponse(Object, OfferInInviteResponseEventArgs)	The method that is called when a media offer is received by the inviter in response to the original reinvite with a null offer.
IOfferAnswer.HandleOfferInReInvite(Object, OfferInReInviteEventArgs)	The method that is called when media renegotiation (ReInvite) is received. This happens when the remote sends another INVITE request inside an existing INVITE dialog to renegotiate media description.
IOfferAnswer.SetAnswer(Object, ContentDescription)	The method that is called when media description response is received in a 200 OK response or ACK message for an INVITE request.
ISipSubscriptionProcessor.GetExtensionHeaders(SipSubscription+RequestType, IEnumerable<SignalingHeader>)	Gets the headers to add to the SUBSCRIBE request.
ISipSubscriptionProcessor.GetMessageBody(SipSubscription+RequestType, ContentType, Byte[])	Generates a message body and content type for the SUBSCRIBE request to the focus.
ISipSubscriptionProcessor.ProcessErrorResponse(SipResponseData)	Called when the subscribe failed(?)
ISipSubscriptionProcessor.ProcessNotification(SipMessageData)	Process notifications from the subscription.
ISipSubscriptionProcessor.SubscriptionStateChanged(SubscriptionStateChangedEventArgs)	The subscription state changed

Extension Methods

BeginSetEndpointRecording(ConferenceSession, Boolean, ParticipantEndpoint, AsyncCallback, Object)
EndSetEndpointRecording(ConferenceSession, IAsyncResult)
GetCccpAdmissionPolicy(ConferenceSession)
GetConferenceAttendanceType(ConferenceSession)
GetDialogContext(ConferenceSession)
GetIsAnonymousDialOutAllowed(ConferenceSession)
GetJoinUrl(ConferenceSession)
GetLocalCaaUri(ConferenceSession)
GetServerMode(ConferenceSession)
GetTelemetryId(ConferenceSession)
SetAcpMcuSessionSupport(ConferenceSession, Boolean)

Applies to