API Index

API index

Index to all CSAF API components, methods, signals, and properties.

QML ModuleQML TypeTypeDescription / Link
ComponentsAjaxdescriptionAJAX (Asynchronous JavaScript and XML ) APIs
ComponentsAjaxmethoddel(url, success, error)
ComponentsAjaxmethodget(url, success, error)
ComponentsAjaxmethodpost(url, data, success, error)
ComponentsAjaxmethodput(url, data, success, error)
ComponentsAjaxmethodrequest(options)
ComponentsClockdescriptionProvides date and time information and timers
ComponentsClockpropertycurrentDateTime : date
ComponentsClockpropertydateTimeFormat : string
ComponentsClockpropertylocalizedDateTimeString : string
ComponentsClocksignalcurrentDateTimeChanged ()
ComponentsClockmethodstring localizedDate (string format)
ComponentsClockmethodstring localizedDateTime (string format)
ComponentsClockmethodstartTaskTimer ()
ComponentsClockmethodint taskElapsedTime ()
ComponentsConferenceRequestdescriptionHelper component to create a SIP request that can be passed to Conference join method to start a SIP call
ComponentsConferenceRequestpropertyaccount : string
ComponentsConferenceRequestpropertycodec : string
ComponentsConferenceRequestpropertydomain : string
ComponentsConferenceRequestpropertyincludeStandardCodecs : bool
ComponentsConferenceRequestpropertypassword : string
ComponentsConferenceRequestpropertyregistrationRequired : bool
ComponentsConferenceRequestpropertysrtpPolicy : string
ComponentsConferenceRequestpropertytlsCaCertificate : string
ComponentsConferenceRequestpropertytlsServerNameValidation : bool
ComponentsConferenceRequestpropertyuserName : string
ComponentsConferenceRequestmethodvoid addTunnel (string type, string pemCertificate, list<string> serverUris)
ComponentsConferenceRequestmethodvoid addUri (string uri)
ComponentsConferenceRequestmethodConferenceRequest create ()
ComponentsConferenceRequestmethodstring rawHeader (string headerName)
ComponentsConferenceRequestmethodvoid setRawHeader (string headerName, string headerValue)
ComponentsKeypadControllerdescriptionPhysical keypad controller
ComponentsKeypadControllersignalkeyPressed (variant event)
ComponentsKeypadControllersignalkeyReleased (variant event)
ComponentsKeypadControllersignalmutePressed (variant event)
ComponentsKeypadControllersignalvolumeDownPressed (variant event)
ComponentsKeypadControllersignalvolumeUpPressed (variant event)
ComponentsScreendescriptionProvides metrics of the device display
ComponentsScreenpropertyheight : int
ComponentsScreenpropertynavigationBarHeight : int
ComponentsScreenpropertynavigationBarWidth : int
ComponentsScreenpropertytabHeight : int
ComponentsScreenpropertytabWidth : int
ComponentsScreenpropertywidth : int
ComponentsThemedescriptionProvides theming properties such as colors and metrics
ComponentsThemepropertyactiveTextColor : color
ComponentsThemepropertyalertTextColor : colo
ComponentsThemepropertybackgroundColor : color
ComponentsThemepropertybackgroundImage : url
ComponentsThemepropertycontrolsPrimaryColor : color
ComponentsThemepropertydefaultTextColor : color
ComponentsThemepropertydisabledTextColor : color
ComponentsThemepropertyfiftyPercentOpaqueColor : color
ComponentsThemepropertyfontFamily : string
ComponentsThemepropertyfontSizeCaption : int
ComponentsThemepropertyfontSizeLarge : int
ComponentsThemepropertyfontSizeMedium : int
ComponentsThemepropertyfontSizeMicro : int
ComponentsThemepropertyfontSizeSmall : int
ComponentsThemepropertyfontSizeXLarge : int
ComponentsThemepropertyfontSizeXXLarge : int
ComponentsThemepropertyfontSizeXXXLarge : int
ComponentsThemepropertyfontSizeXXXXLarge : int
ComponentsThemepropertykeyboardHeight : int
ComponentsThemepropertykeyboardKeyHeight : int
ComponentsThemepropertykeyboardKeyImage : url
ComponentsThemepropertykeyboardKeyPopupColor : color
ComponentsThemepropertykeyboardKeyWidth : int
ComponentsThemepropertykeyboardPopupDuration : int
ComponentsThemepropertykeyboardWidth : int
ComponentsThemepropertykeyboardXSpacing : int
ComponentsThemepropertykeyboardYSpacing : int
ComponentsThemepropertynavigationBarBackgroundImage : url
ComponentsThemepropertynavigationBarHomeIconName : string
ComponentsThemepropertyreversedTextColor : color
ComponentsThemepropertytenPercentOpaqueColor : color
ComponentsThemepropertytextFieldBackgroundColor : color
ComponentsThemepropertytitleTextColor : color
ComponentsThemepropertytwentyPercentOpaqueColor : color
ComponentsUIApplicationdescriptionMain component of the application
ComponentsUIApplicationpropertyautoLaunchAfterLoad : bool
ComponentsUIButtondescriptionPush button with an icon
ComponentsUIButtonpropertychecked : bool
ComponentsUIButtonpropertyhighlighted : bool
ComponentsUIButtonpropertyiconName : alias
ComponentsUIButtonpropertyiconSource : alias
ComponentsUIButtonpropertyiconState : alias
ComponentsUIButtonpropertypressed : alias
ComponentsUIButtonsignalclicked ()
ComponentsUIDialerTabdescriptionDial pad with call button and input field
ComponentsUIDialerTabpropertyactionKeyIconName : alias
ComponentsUIDialerTabpropertyactionKeyIconSource : alias
ComponentsUIDialerTabpropertyactionKeyText : string
ComponentsUIDialerTabpropertycursorPos : alias
ComponentsUIDialerTabpropertyhelpText : alias
ComponentsUIDialerTabpropertyinputText : alias
ComponentsUIDialerTabpropertykeyModel : alias
ComponentsUIDialerTabpropertymaximumLength : alias
ComponentsUIDialerTabpropertyminimumLength : int
ComponentsUIDialerTabpropertyplayKeyClickTone : bool
ComponentsUIDialerTabpropertyreadOnly : alias
ComponentsUIDialerTabpropertysendDtmf : bool
ComponentsUIDialerTabsignaldialClicked (string dialString)
ComponentsUIDialerTabmethodaddChar (c)
ComponentsUIDialerTabmethoddeleteChar ()
ComponentsUIDividerdescriptionDivider line
ComponentsUIDividerpropertylength : int
ComponentsUIDividerpropertyorientation : int
ComponentsUIDividerpropertythickness : int
ComponentsUIDtmfTabdescriptionDTMF dial pad
ComponentsUIDtmfTabsignalsendDtmf (string numText)
ComponentsUIDtmfTabmethodclearTextField ()
ComponentsUIFlickabledescriptionA flickable with overlay scrollbars
ComponentsUIFlickablepropertyhorizontalScrollBarPolicy : int
ComponentsUIFlickablepropertyscrollBarThickness : real
ComponentsUIFlickablepropertyverticalScrollBarPolicy : int
ComponentsUIImagedescriptionState and theme aware image class
ComponentsUIImagepropertyname : string
ComponentsUIImagepropertysearchPaths : variant
ComponentsUIImagepropertystate : string
ComponentsUIItemdescriptionSimple visual QML type with Dolby additions
ComponentsUIItempropertyenabled : bool
ComponentsUIKeyboardControllerdescriptionItem that enables control of the on-screen software input panel (keyboard)
ComponentsUIKeyboardControllerpropertyactionKeyLabel : string
ComponentsUIKeyboardControllerpropertyautoCapitalizationPolicy : string
ComponentsUIKeyboardControllerpropertyinitialKeyboardLayout : string
ComponentsUIKeyboardControllerpropertyinputText : string
ComponentsUIKeyboardControllerpropertyisPassword : bool
ComponentsUIKeyboardControllerpropertymaximumLength : int
ComponentsUIKeyboardControllersignalactionKeyPressed (string text)
ComponentsUIKeyboardControllersignalcancelKeyPressed ()
ComponentsUIKeyboardControllermethodhide()
ComponentsUIKeyboardControllermethodshow ()
ComponentsUILabelButtondescriptionA push button with an icon and label underneath
ComponentsUILabelButtonpropertyhighlighted : alias
ComponentsUILabelButtonpropertyiconHeight : alias
ComponentsUILabelButtonpropertyiconName : alias
ComponentsUILabelButtonpropertyiconSource : alias
ComponentsUILabelButtonpropertyiconWidth : alias
ComponentsUILabelButtonpropertylabelText : alias
ComponentsUILabelButtonpropertypressed : alias
ComponentsUILabelButtonpropertyspacing : alias
ComponentsUILabelButtonsignalclicked ()
ComponentsUIListViewdescriptionA list view whose delegate should be one of the form field components
ComponentsUIListViewpropertyscrollIndicatorVisible : alias
ComponentsUIMessageOverlaydescriptionA full screen overlay that displays a title, message, and action buttons
ComponentsUIMessageOverlaypropertyfirstButtonIconName : alias
ComponentsUIMessageOverlaypropertyfirstButtonIconSource : alias
ComponentsUIMessageOverlaypropertyfirstButtonOnly : bool
ComponentsUIMessageOverlaypropertyfirstButtonText : alias
ComponentsUIMessageOverlaypropertyheaderText : alias
ComponentsUIMessageOverlaypropertyheaderVisible : alias
ComponentsUIMessageOverlaypropertymessageText : alias
ComponentsUIMessageOverlaypropertymessageTextComponent : alias
ComponentsUIMessageOverlaypropertysecondButtonIconName : alias
ComponentsUIMessageOverlaypropertysecondButtonIconSource : alias
ComponentsUIMessageOverlaypropertysecondButtonText : alias
ComponentsUIMessageOverlaysignalfirstButtonClicked ()
ComponentsUIMessageOverlaysignalsecondButtonClicked ()
ComponentsUIOverlaydescriptionFull-screen overlay that can react when its content area is clicked
ComponentsUIOverlaysignalclicked()
ComponentsUIPagedescriptionA full screen UI page containing a navigation bar, tab view and overlay components
ComponentsUIPagepropertynavigationBarModel : alias
ComponentsUIPagepropertynavigationBarPosition : alias
ComponentsUIPagepropertynavigationBarVisible : alias
ComponentsUIPagepropertyoverlayLoader : alias
ComponentsUIPagepropertyoverlaySourceComponent : alias
ComponentsUIPagepropertyoverlayVisible : alias
ComponentsUIPagepropertytabLoader : alias
ComponentsUIPagepropertytabLoaderSource : url
ComponentsUIPagepropertytabLoaderSourceComponent : alias
ComponentsUIPagesignalnavigationBarSelectionChanged (string action, int position)
ComponentsUIPickerFormFielddescriptionA picker laid out horizontally
ComponentsUIPickerFormFieldpropertyinputField : alias
ComponentsUIPickerFormFieldpropertyinputFieldText : alias
ComponentsUIPickerFormFieldpropertyinputFieldWidth : alias
ComponentsUIPickerFormFieldpropertylabel : alias
ComponentsUIPickerFormFieldpropertylabelText : alias
ComponentsUIPickerFormFieldsignalclicked ()
ComponentsUIPickerOverlaydescriptionA full screen overlay that displays a title, picker, and cancel button
ComponentsUIPickerOverlaypropertybuttonText : alias
ComponentsUIPickerOverlaypropertycancelButtonIconName : alias
ComponentsUIPickerOverlaypropertycancelButtonIconSource : alias
ComponentsUIPickerOverlaypropertycancelButtonVisible : bool
ComponentsUIPickerOverlaypropertycurrentIndex : alias
ComponentsUIPickerOverlaypropertydelegate : alias
ComponentsUIPickerOverlaypropertyheaderText : alias
ComponentsUIPickerOverlaypropertyheaderVisible : alias
ComponentsUIPickerOverlaypropertymodel : alias
ComponentsUIPickerOverlaysignalcancelButtonClicked ()
ComponentsUIPickerOverlaysignalselected (int index, string value)
ComponentsUIProgressIndicatordescriptionAn indeterminate progress bar and indicator
ComponentsUIProgressIndicatorpropertyanimationDuration : alias
ComponentsUIProgressIndicatorpropertycurrentIndex : int
ComponentsUIProgressIndicatorpropertydots : int
ComponentsUIProgressIndicatorpropertyrunning : alias
ComponentsUIResourceLoaderdescriptionProvides the ability to load binary Qt Resource Files (RCC)
ComponentsUIResourceLoaderpropertyactualMapRoot : string
ComponentsUIResourceLoaderpropertyerrorString : string
ComponentsUIResourceLoaderpropertymapRoot : string
ComponentsUIResourceLoaderpropertysource : url
ComponentsUIResourceLoaderpropertystatus : Status
ComponentsUIResourceLoadersignalerror ()
ComponentsUIResourceLoadersignalloaded ()
ComponentsUIResourceLoadersignalstatusChanged (Status status)
ComponentsUISliderdescriptionHorizontal or vertical slider control
ComponentsUISliderpropertyanimateHandle : bool
ComponentsUISliderpropertyinverted : alias
ComponentsUISliderpropertymaximumValue : alias
ComponentsUISliderpropertyminimumValue : alias
ComponentsUISliderpropertyorientation : int
ComponentsUISliderpropertypressed : alias
ComponentsUISliderpropertystepSize : alias
ComponentsUISliderpropertystyling : SliderStylingProperties
ComponentsUISliderpropertyupdateValueWhileDragging : bool
ComponentsUISliderpropertyuseDecimals : bool
ComponentsUISliderpropertyvalue : alias
ComponentsUISliderpropertyvalueIndicatorMargin : int
ComponentsUISliderpropertyvalueIndicatorPosition : string
ComponentsUISwitchdescriptionA toggle switch indicating a boolean value
ComponentsUISwitchpropertychecked : bool
ComponentsUISwitchpropertypressed : bool
ComponentsUISwitchsignalclicked ()
ComponentsUISwitchFormFielddescriptionA UISwitch laid out in a row with a label
ComponentsUISwitchFormFieldpropertychecked : alias
ComponentsUISwitchFormFieldpropertylabelText : alias
ComponentsUISwitchFormFieldsignalclicked ()
ComponentsUITextdescriptionStatic text GUI component
ComponentsUITextButtondescriptionPush button with Text
ComponentsUITextButtonpropertyenabled : alias
ComponentsUITextButtonpropertyfont : alias
ComponentsUITextButtonpropertyhorizontalMargins : int
ComponentsUITextButtonpropertymaxHeight : int
ComponentsUITextButtonpropertymaxWidth : int
ComponentsUITextButtonpropertyminHeight : int
ComponentsUITextButtonpropertyminWidth : int
ComponentsUITextButtonpropertypressed : alias
ComponentsUITextButtonpropertytext : alias
ComponentsUITextButtonpropertytextColor : color
ComponentsUITextButtonpropertyverticalMargins : int
ComponentsUITextButtonsignalclicked ()
ComponentsUITextFielddescriptionAn editable text field component
ComponentsUITextFieldpropertyactionKeyLabel : string
ComponentsUITextFieldpropertyautoCapitalizationPolicy : string
ComponentsUITextFieldpropertyinitialKeyboardLayout : string
ComponentsUITextFieldpropertyinputText : string
ComponentsUITextFieldpropertyisPassword : bool
ComponentsUITextFieldpropertymaximumLength : int
ComponentsUITextFieldpropertyplaceholderText : string
ComponentsUITextFieldpropertytextComponent : alias
ComponentsUITextFormFielddescriptionA UITextField laid out in a row with a text label
ComponentsUITextFormFieldpropertyactionKeyLabel : alias
ComponentsUITextFormFieldpropertyautoCapitalizationPolicy : alias
ComponentsUITextFormFieldpropertyinitialKeyboardLayout : alias
ComponentsUITextFormFieldpropertyinputField : alias
ComponentsUITextFormFieldpropertyinputFieldEnabled : alias
ComponentsUITextFormFieldpropertyinputFieldHelpText : alias
ComponentsUITextFormFieldpropertyinputFieldMaximumLength : alias
ComponentsUITextFormFieldpropertyinputFieldText : alias
ComponentsUITextFormFieldpropertyinputFieldWidth : alias
ComponentsUITextFormFieldpropertylabel : alias
ComponentsUITextFormFieldpropertylabelText : alias
ComponentsUITextInputdescriptionA line of text that can be edited
ComponentsUITranslationLoaderdescriptionProvides the ability to load binary Qt Translation Files (QM)
ComponentsUITranslationLoaderpropertyerrorString : string
ComponentsUITranslationLoaderpropertysource : url
ComponentsUITranslationLoaderpropertystatus : Status
ComponentsUITranslationLoadersignalerror ()
ComponentsUITranslationLoadersignalloaded ()
ComponentsUITranslationLoadersignalstatusChanged (Status status)
EngineAppdescriptionProvides application control and navigation APIs
EngineApppropertycheckForUpdatesInterval : int
EngineApppropertylaunchIconLabel : string
EngineApppropertylaunchIconName : string
EngineApppropertyloadCustomHomePage : bool
EngineApppropertyloadHomePageOnIdleTimeout : bool
EngineAppsignalapplicationWillHide ()
EngineAppsignalapplicationWillShow ()
EngineAppsignalclearAppSettings ()
EngineAppsignalclearLocalContacts ()
EngineAppsignalclearRecentCalls ()
EngineAppsignalclearUserPreferences ()
EngineAppsignaldisplayWillDim ()
EngineAppsignaldisplayWillWakeUp ()
EngineAppsignallaunchApplication ()
EngineAppsignalloadHomePageEvent ()
EngineAppmethodcheckForUpdates ()
EngineAppmethodclearCallView ()
EngineAppmethodexitOobApp (status)
EngineAppmethodhideConferenceApp ()
EngineAppmethodloadCallViewFromComponent (component)
EngineAppmethodloadCallViewFromSource (url)
EngineAppmethodloadMainViewFromComponent (component)
EngineAppmethodloadMainViewFromSource (url)
EngineAppmethodprocessEvents ()
EngineAppmethodrestartConferenceApp ()
EngineAppmethodshowConferenceApp ()
EngineAppmethodshowHomePage ()
EngineAppmethodshowSettingsPage ()
EngineAppmethodbool showTelephonyDialerPage ()
EngineAppmethodbool showTelephonyInCallPage ()
EngineConferencedescriptionCall control component. This component allows application to initiate, manage and terminate a conference call with Dolby Voice backend infrastructure
EngineConferencepropertycanSendDtmf : bool
EngineConferencepropertycodec : string
EngineConferencepropertyconfId : int
EngineConferencepropertydurationSeconds : int
EngineConferencepropertyelapsedTime : string
EngineConferencepropertyfirstName : string
EngineConferencepropertyjbLatency : int
EngineConferencepropertylastName : string
EngineConferencepropertylocalContact : string
EngineConferencepropertylocalHold : bool
EngineConferencepropertylocalInfo : string
EngineConferencepropertymediaConnection : string
EngineConferencepropertymuted : bool
EngineConferencepropertynumber: string
EngineConferencepropertyremoteContact : string
EngineConferencepropertyremoteHold : bool
EngineConferencepropertyremoteInfo : string
EngineConferencepropertysipServer : string
EngineConferencepropertystate: string
EngineConferencepropertystatus: int
EngineConferencepropertystatusText : string
EngineConferencepropertytransport : string
EngineConferencepropertytunnelIP : string
EngineConferencepropertytunnelType : string
EngineConferencepropertyuuid : string
EngineConferencesignalcallStatisticsUpdate (variant statistics)
EngineConferencesignalmediaConnectionChanged (string state)
EngineConferencesignalstateChanged (string state)
EngineConferencemethodvoid join (ConferenceRequest conferenceRequest)
EngineConferencemethodvoid leave ()
EngineConferencemethodvoid sendDtmf (string keys, bool playback)
EngineConfigurationdescriptionAPIs to get and set the Dolby Conference Phone configuration parameters
EngineConfigurationpropertycustomParameter1 : ConfigurationParameter
EngineConfigurationpropertycustomParameter2 : ConfigurationParameter
EngineConfigurationpropertycustomParameter3 : ConfigurationParameter
EngineConfigurationpropertycustomParameter4 : ConfigurationParameter
EngineConfigurationpropertycustomSecureParameter1 : ConfigurationParameter
EngineConfigurationpropertycustomSecureParameter2 : ConfigurationParameter
EngineConfigurationpropertycustomSecureParameter3 : ConfigurationParameter
EngineConfigurationpropertycustomSecureParameter4 : ConfigurationParameter
EngineConfigurationpropertydateFormat : ConfigurationParameter
EngineConfigurationpropertydeviceName : ConfigurationParameter
EngineConfigurationpropertydoNotDisturb : ConfigurationParameter
EngineConfigurationpropertyerrorString : string
EngineConfigurationpropertyhighfiveDiscoveredList : variant
EngineConfigurationpropertylanguage : ConfigurationParameter
EngineConfigurationpropertyoperationMode : ConfigurationParameter
EngineConfigurationpropertypeerDeviceBleAddress : ConfigurationParameter
EngineConfigurationpropertypeerDeviceCustomData : string
EngineConfigurationpropertypeerDeviceIpAddress : ConfigurationParameter
EngineConfigurationpropertypersonalModeEnabled : bool
EngineConfigurationpropertyringerVolume : ConfigurationParameter
EngineConfigurationpropertysoftwareUpdateStatus : string
EngineConfigurationpropertyspatialCaptureOrigin : ConfigurationParameter
EngineConfigurationpropertyspeechVolume: ConfigurationParameter
EngineConfigurationpropertytimeFormat : ConfigurationParameter
EngineConfigurationpropertytimeZone : ConfigurationParameter
EngineConfigurationsignalerror (string errorStr)
EngineConfigurationsignalhighfiveDataRequestCompleted (int index, QString url, QString customData)
EngineConfigurationsignalhighfiveDiscoveryCompleted (bool highfiveDevicesFound)
EngineConfigurationsignalhighfivePairingDeviceCompleted (bool status)
EngineConfigurationsignalpeerDeviceCustomDataChanged (string data)
EngineConfigurationmethodvoid factoryResetDevice ()
EngineConfigurationmethodstring getDeviceCertificate ()
EngineConfigurationmethodConfigurationParameter getParameter (string name)
EngineConfigurationmethodvoid provision ()
EngineConfigurationmethodvoid rebootDevice ()
EngineConfigurationmethodbool resetParameters (variant paramList)
EngineConfigurationmethodbool selectHighfivePairingDevice (int)
EngineConfigurationmethodvoid setCustomParameter1 (string value)
EngineConfigurationmethodvoid setCustomParameter2 (string value)
EngineConfigurationmethodvoid setCustomParameter3 (string value)
EngineConfigurationmethodvoid setCustomParameter4 (string value)
EngineConfigurationmethodvoid setCustomSecureParameter1 (string value)
EngineConfigurationmethodvoid setCustomSecureParameter2 (string value)
EngineConfigurationmethodvoid setCustomSecureParameter3 (string value)
EngineConfigurationmethodvoid setCustomSecureParameter4 (string value)
EngineConfigurationmethodvoid setDateFormat (string value)
EngineConfigurationmethodvoid setDeviceName (string name)
EngineConfigurationmethodvoid setDoNotDisturb (bool value)
EngineConfigurationmethodvoid setLanguage (string value)
EngineConfigurationmethodvoid setOperationMode (string mode)
EngineConfigurationmethodbool setParameters (variant paramList)
EngineConfigurationmethodvoid setPeerDeviceBleAddress (string bleAddress)
EngineConfigurationmethodvoid setPeerDeviceIpAddress (string ipAddress)
EngineConfigurationmethodvoid setRingerVolume (int level)
EngineConfigurationmethodvoid setSpatialCaptureOrigin (string value)
EngineConfigurationmethodvoid setSpeechVolume (int level)
EngineConfigurationmethodvoid setTimeFormat (string value)
EngineConfigurationmethodvoid setTimeZone (string value)
EngineConfigurationmethodbool startHighfiveDataRequest (int)
EngineConfigurationmethodvoid startHighfiveDiscovery ()
EngineConfigurationParameterdescriptionQML type for configuration parameter
EngineConfigurationParameterpropertychangeable : bool
EngineConfigurationParameterpropertyname : string
EngineConfigurationParameterpropertyprovisioned : bool
EngineConfigurationParameterpropertyrebootOnChange : bool
EngineConfigurationParameterpropertyvalue : variant
EngineDevicedescriptionControl APIs for halo LED, tone and volume
EngineDevicepropertybleAdvertisingState : BleState
EngineDevicepropertylastLogsUploadStatus : string
EngineDevicesignalbleAdvertisingStateChanged (BleState state)
EngineDevicesignalbleError (BleError error)
EngineDevicesignallastLogsUploadStatusChanged (string status)
EngineDevicemethodvoid playTone (ToneName toneName, int repeats, int repeatInterval)
EngineDevicemethodvoid setLedOff ()
EngineDevicemethodvoid setLedOn (LedColor color, int onInterval, int offInterval)
EngineDevicemethodBleError startBleAdvertisement (string bleUuid, variant bleData, int bleAdvInterval)
EngineDevicemethodvoid stopBleAdvertisement ()
EngineDevicemethodvoid stopTone ()
EngineDevicemethodbool uploadLogs (url location, bool eventLogsOnly)
EngineDevicemethodvoid volumeDown ()
EngineDevicemethodvoid volumeUp ()
EngineKeypadManagerdescriptionPhysical keypad manager
EngineKeypadManagerpropertyenableDefaultHandlers : bool
EngineKeypadManagerpropertyvolumeKeysAutoRepeatEnable : bool
EngineKeypadManagermethodreset()
EngineLoggerdescriptionLogging APIs
EngineLoggermethodvoid syslog (LogLevel level, string message)
EnginePeripheralModeAudiodescriptionAllows application to monitor peripheral mode audio connection with paired video endpoint
EnginePeripheralModeAudiopropertyactive : bool
EnginePeripheralModeAudiopropertycanSendDtmf : bool
EnginePeripheralModeAudiopropertycodec : string
EnginePeripheralModeAudiopropertyjbLatency : int
EnginePeripheralModeAudiopropertymediaConnection : string
EnginePeripheralModeAudiopropertymuted : bool
EnginePeripheralModeAudiopropertystate : string
EnginePeripheralModeAudiopropertytransport : string
EnginePeripheralModeAudiopropertyuuid : string
EnginePeripheralModeAudiosignalaudioStatisticsUpdate (variant statistics)
EnginePeripheralModeAudiosignalmediaConnectionChanged (string state)
EnginePeripheralModeAudiosignalstateChanged (string state)
EnginePeripheralModeAudiomethodvoid disconnect ()
EnginePeripheralModeAudiomethodvoid sendDtmf (string keys, bool playback)
EngineTelephonydescriptionIPPBX telephony APIs
EngineTelephonypropertycallInProgress : bool
EngineTelephonysignalincomingCallStateChanged (TelephonyEnums state)
WebSockets

Configuration parameters

Native Dolby Conference Phone ConfigurationParameters.

TypeDescription
FeaturesThese configuration parameters define the features on the Dolby Conference Phone.
PreferencesThese parameters define the user preferences on the Dolby Conference Phone.
NetworkThese parameters specify the network connections for the Dolby Conference Phone.
Network2These parameters specify the secondary VLAN for the Dolby Conference Phone.
ProvisioningThese parameters specify the connection to the provisioning server.
SipThese parameters specify the connection to the call server (or SIP server).
DvmsThese parameters specify the connection to the BT MeetMe with Dolby Voice conferencing service.
DirectoryThese parameters define the directories that are stored on the phone. This includes the LDAP definitions.
LoggingThese parameters specify what information is logged and where it is logged.
DeviceThese parameter specify Dolby Conference Phone attributes and status.
AuthenticationThese parameters define the authentication parameters for the Dolby Conference Phone.

System images

Refer to the Components Image Provider page for the complete list of system built-in images available for Dolby Conference Phone app development.