Phone Class |
Phone represents a Cisco Spark calling device.
The application can obtain a phone object from Spark object
and use *phone* to call other Cisco Spark users or PSTN when enabled.
The phone must be registered before it can make or receive calls.
Inheritance HierarchyNamespace: SparkSDK
Assembly: SparkSDK (in SparkSDK.dll) Version: 0.1.0.0 (0.1.0.0)
SyntaxC#
public sealed class Phone
The Phone type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AudioMaxBandwidth |
The max bandwidth for audio in unit bps for the call.
|
| ShareMaxBandwidth |
The max bandwidth for sharing in unit bps for the call.
|
| VideoCodecLicense |
Return the text of the H.264 codec license from Cisco Systems, Inc.
|
| VideoCodecLicenseURL |
Return the URL of the H.264 codec license from Cisco Systems, Inc.
|
| VideoMaxBandwidth |
The max bandwidth for video in unit bps for the call.
|
Methods| Name | Description | |
|---|---|---|
 | ActivateVideoCodecLicense |
Response to onRequestVideoCodecActivation event.
|
| Deregister |
Removes this phone from Cisco Spark cloud on behalf of the authenticated user.
It also disconnects the websocket from Cisco Spark cloud.
Subsequent invocations of this method behave as a no-op.
|
| Dial |
Makes a call to an intended recipient on behalf of the authenticated user.
|
| DisableVideoCodecActivation |
Prevents Cisco Spark SDK from poping up an Alert for the end user to approve the use of H.264 video codec license from Cisco Systems, Inc.
|
| GetAVIODevices |
Get audio/video IO devices
|
| Register |
Registers this phone to Cisco Spark cloud on behalf of the authenticated user.
It also creates the websocket and connects to Cisco Spark cloud.
|
| RequestVideoCodecActivation |
Notify the end user to activate the use of H.264 codec license from Cisco Systems, Inc.
Invoking this function is optional since the alert will appear automatically during the first video call.
|
| SelectAVIODevice |
Select an audio/video IO device
|
| StartPreview |
Render a preview of the local party before the call is answered.
|
| StopPreview |
Stop rendering the preview of the local party.
|
| UpdatePreview |
Update the preview when video window is resized.
|
Events| Name | Description | |
|---|---|---|
 | OnIncoming |
Callback when call is incoming.
|
| OnRequestVideoCodecActivation |
Callback when request video codec activation
|
RemarksSince: 0.1.0
See Also