Export (0) Print
Expand All

StartVideoCallButton Control

[This is preliminary documentation and is subject to change.]

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

Notable StartVideoCallButton control public properties and events relating to unified communications appear in the following table. For a full list, see topics in the Communicator 2010 API Class Library documentation.

Property or Event


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 which does not contain the sip: or tel: prefix, the control will perform a search, using the string specified as a search criteria, and will load 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 will be 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 will be used as-is. This behavior is deterministic, and yields the best performance.

ContextualInformation property

Gets or sets a data structure which contains information used to customize the information that accompanies messages. For more information on the use of contextual information, see the topics listed at Contextual 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.

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

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

Community Additions

© 2014 Microsoft