PreviewTeamView Class

Definition

Allows the app to sign up for event handlers that notifies when the user invokes call control\screen sharing\etc UI in the shell that the app wouldn't otherwise be aware of.

public ref class PreviewTeamView sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.UI.Core.Preview.Communications.PreviewCommunicationsContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class PreviewTeamView final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.UI.Core.Preview.Communications.PreviewCommunicationsContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class PreviewTeamView
Public NotInheritable Class PreviewTeamView
Inheritance
Object IInspectable PreviewTeamView
Attributes

Windows requirements

Device family
Windows Team Extension SDK (introduced in 10.0.19041.0)
API contract
Windows.UI.Core.Preview.Communications.PreviewCommunicationsContract (introduced in v1.0)

Remarks

Though an instance of PreviewTeamView must be retrieved on the UI thread, it is generally a free-threaded object whose methods do not block. For instance, calling StartScreenSharing can return before the screen sharing border is actually drawn. For this reason, some properties have callbacks so the app may be notified when the action is actually complete.

Properties

IsFullScreen

Describes the state of the app's full screen view.

IsScreenSharing

Describes the state of the outbound screen sharing.

MeetingInfoDisplayType

Indicates to the VTC app how it should display meetings.

MeetingUri

Contains the meeting join Uri.

SharingScreenBounds

The bounds of the rectangle for the outgoing screen sharing behavior.

SystemState

The system state.

Methods

EnterFullScreen()

Requests the app to toggle full screen view.

GetForCurrentView()

Gets an instance of PreviewTeamView for the current window (app view).

JoinMeetingWithUri(Uri)

Requests to join the meeting with the given appointment.

LeaveFullScreen()

Requests the app to exit out of full screen view.

NotifyMeetingEnded(PreviewTeamEndMeetingKind)

Notifies the Shell that the user has ended the meeting.

RequestForeground()

Requests the app to set its view to foreground.

SetButtonLabel(String)

Sets customized text for the Start menu button. The default text is the app's display name.

SetTitle(String)

Setting a customized or localized sidebar title. The default title is the app's display name.

StartSharingScreen()

Starts outgoing screen sharing.

StopSharingScreen()

Stops outgoing screen sharing.

Events

CleanupRequested

The system is ending the current user's session and telling the VTC app that it should clean up any user state. If there is state on disk, or some other slow operation is required, the app can take the deferral in the argument.

CommandInvoked

The user has invoked some UI or a hotkey that is not part of the app but should control the call.

EndMeetingRequested

Indicates the app should end the call. It can take a deferral using the the argument provided to block the shell UI from being cleaned up until the call is fully cleaned up.

IsFullScreenChanged

Indicates that the app window is now full screen.

IsScreenSharingChanged

Indicates whether or not a system is displaying a screen sharing border.

JoinMeetingRequested

Either the user, the shell or the app itself has initiated a meeting join. This tells the app that it is time to actually join the call. The app can use the deferral in the argument provided to this event handler to perform work before the shell displays UI indicating the call has been joined.

SharingScreenBoundsChanged

The bounds of the rectangle for the outgoing screen sharing have changed.

SystemStateChanged

The session availability has changed.

Applies to