StartVideoCallButton control

Core concepts

Learn about the properties of the Microsoft Lync 2013 StartVideoCallButton control.

Applies to: Lync 2013 | Lync Server 2013

In this article
Control overview
Members
Code example
Additional resources

Control overview

Use the StartVideoCallButton control in Microsoft Lync 2013 SDK applications to launch a video conversation between the user who activated the control and another user specified by the Source property.

StartVideoCallButton Control

Members

Notable StartVideoCallButton control public properties and events relating to unified communications appear in the following table. For a full list, see Lync 2013 class libraries reference.

Property or event

Description

DisplayName property

Gets the display name of the currently logged-in user.

Source property

Gets or sets the contact with whom a video call will be established when this button is pressed. Valid values for this property include String, Contact, and DistributionGroup objects.

  • If the value is a string that does not contain the sip: or tel: prefix, the control performs a search, using the string specified as a search criteria, and loads the first contact in the result set matching the specified string. This behavior is not deterministic and yields the slowest performance.

  • If the value is a SIP URI string qualified by the sip: or tel: prefix, the contact is loaded using an exact match of the specified URI. This behavior is deterministic and yields better performance.

  • If the value is a Contact or DistributionGroup object, it's used as-is. This behavior is deterministic and yields the best performance.

ContextualInformation property

Gets or sets a data structure that contains information used to customize the information that accompanies messages. For more information about using contextual information, see Contextual Lync conversations.

Model property

Reserved for internal use. This property may appear in XAML text when editing templates. To preserve control functionality, it should remain unchanged.

Code example

The following example can be used for Microsoft Silverlight and Microsoft Windows Presentation Foundation (WPF) application development.

<StackPanel>
  <controls:StartVideoCallButton Source="sip:mary@contoso.com"/>
</StackPanel>

See also