8/3/2017

Dragon SDK Client Edition 14 SDK R1 Release notes

Click here for the PDF version of the R1 release notes.

Installation notes

Installing the Dragon SDK Client Edition from the DVD may take significant time. To speed up the process, we strongly recommend that you copy the contents of the DVD to your local drive and run setup.exe from there.

System requirements

RAM

Minimum:

2 GB for 32-bit Windows 7, 8.1, and 10.
4 GB for 64-bit Windows 7, 8.1,10, Windows Server 2008 R2, and Windows Server 2012.

CPU

Minimum: 2.2 GHz Intel® dual core or equivalent AMD processor. Faster processors yield faster performance.

Free hard disk space

8GB if you install from the DVD, 16GB if you copy the DVD to your hard drive and then install.

Supported operating systems

Windows 7, 8.1, and 10 32-bit and 64-bit
Windows Server 2008 R2
Windows Server 2012

Other requirements

Internet Explorer 9 or higher or the current version of Chrome or Firefox
A DVD drive for installation
An audio input device capable of 16-bit recording
For a list of recommended devices, see http://support.nuance.com/compatibility/.

Coexistence with other Dragon products

You can install Dragon SDK Client Edition on the same computer where Dragon Professional (Individual, Group) is installed.

You cannot run both the Dragon SDK Client Edition and Dragon Professional (Individual, Group) at the same time; either Dragon edition cannot be running when switching between the Dragon SDK Client and Dragon.

Voctool

The Dragon Vocabulary Tool (Voctool.exe) is no longer included with the DNS 14 SDK.

The Dragon Vocabulary Tool (Voctool.exe) is only available for download through your Partner Portal:

Log in to: https://network.nuance.com with the username and password supplied to you Nuance
Go to Product Downloads-->Desktop Application Solutions-->Dragon NaturallySpeaking-->Version 14-->VocTool folder
When you click on the link, you will be taken through a click-thru EULA and then the download.

To use the Dragon Vocabulary Tool, copy Voctool.exe to the 'Program Files\Nuance\Dragon SDK Client Edition 14\Program' directory.

What’s new in the Dragon SDK Client (v14)

We have not updated the Developer Guide or API Reference help files for the DNS 14 SDK. This is a list of what's new in the R1 release of the SDK client.

All new and changed functionally is described here in the release notes.

DGNEngineControl

Methods:

Method
DictationSourceMicrophoneNameGet	Returns the name of audio device (microphone) corresponding to dictation source as a string. HRESULT DictationSourceMicrophoneNameGet( [in] BSTR SpeakerName, [in] DgnDictationSourceConstants DictationSource, [out,retval] BSTR* Name );
DictationSourcesByPriority	Returns list of audio devices ordered by preference HRESULT DictationSourcesByPriority( [out,retval] SAFEARRAY(BSTR)* ppsaAudioDeviceNames );
ExportMyCommands	Exports commands from the user profile to a file. HRESULT ExportMyCommands( [in] BSTR FileName );
SetDataLocationDirectory	Changes paths in datalocation.ini HRESULT SetDataLocationDirectory( [in] VARIANT iUser,[in] BSTR DataPath ); iUser - 0 - Current User, 1 - All Users
SpeakerForceClose	Closes the current user profile without displaying speaker save prompt dialog box. The ‘SaveProfile’ argument can be set to FALSE to force close the profile without saving (default is TRUE). HRESULT SpeakerForceClose( [in, optional] VARIANT SaveProfile );
UnpackDictationSourceConstant	Breaks dictation source value into actual dictation source constant and an index HRESULT UnpackDictationSourceConstant( [in] DgnDictationSourceConstants PackedDictationSource, [out] DgnDictationSourceConstants * DictationSource, [out] long * DictationSourceIndexNumber );
SpeakerCreateWithDictationSourceName	Create a new speaker based on the specified microphone. HRESULT SpeakerCreateWithDictationSourceName( [in] BSTR SpeakerName, [in] BSTR DeviceName, [in] BSTR BaseSpeakerModel );
DictationSourceCreateWithDeviceName	Create a new dictation source based on the specified microphone. HRESULT DictationSourceCreateWithDeviceName( [in] BSTR DeviceName, [in] BSTR bstrBaseSpeakerModel, [optional][in] VARIANT varSpeaker );

Properties:

Property
AcousticContainerSizeInMB	Return the size in MB of the DictationSource folder corresponding to the dictation source passed as input. HRESULT AcousticContainerSizeInMB( [in] DgnDictationSourceConstants DictationSource, [in, defaultvalue("")] BSTR Speaker, [out, retval] unsigned long* pContainerSize );
TopicDomain	Returns the “domain” of the topic currently loaded. HRESULT TopicDomain( [in, defaultvalue("")] BSTR Speaker, [in, defaultvalue("")] BSTR Topic, [out, retval] DgnTopicDomainConstants* TopicDomain ); TopicDomain Includes the DgnTopicDomainConstants for the domains available in Dragon.
DateFormatList	Retrieves the DateFormat values list. The zero-based index of the returned list can be used to set the date format using the dgnengoptionDateFormat option of DgnEngineOptionConstants. HRESULT DateFormatList( [out, retval] IDgnStrings ** Formats );

Constants:

[]
DgnDragonBarModeConstantsConstant – new constants These constants describe the values which can be returned by the dgnengoptionDragonBarMode Option property of the DgnEngineOptionConstants object/interface The DgnEngineControl.CompatibilityModule() method sets or returns the status (enabled/disabled) of a compatibility module in the application associated with the specified window. For each compatibility module, there are two flags: 0 for local — Current application. Determines whether the compatibility module is enabled in a particular application -1 for global — Any application. Determines if the module is enabled in all applications. By default, the global flag is TRUE (enabled in all applications), and it should be changed only if it is critical.
dgnbarmodeInteractiveTutorial = 5	Enables/Disables the Interactive Tutorial
dgnbarmodeModernFloating = 6	Enables/Disables the modern floating Dragonbar
dgnbarmodeClassicDragonBar = 7	Enables/Disables the classic DragonBar

DgnDragonBarModeConstantsConstant – new constants

These constants describe the values which can be returned by the dgnengoptionDragonBarMode Option property of the DgnEngineOptionConstants object/interface

The DgnEngineControl.CompatibilityModule() method sets or returns the status (enabled/disabled) of a compatibility module in the application associated with the specified window. For each compatibility module, there are two flags:

0 for local — Current application. Determines whether the compatibility module is enabled in a particular application
-1 for global — Any application. Determines if the module is enabled in all applications. By default, the global flag is TRUE (enabled in all applications), and it should be changed only if it is critical.

dgnbarmodeInteractiveTutorial = 5

Enables/Disables the Interactive Tutorial

dgnbarmodeModernFloating = 6

Enables/Disables the modern floating Dragonbar

dgnbarmodeClassicDragonBar = 7

Enables/Disables the classic DragonBar

enum DgnDragonBarModeConstants {

dgnbarmodeDockedToTop = 0,

dgnbarmodeDockedToBottom = 1,

dgnbarmodeFloating = 2,

dgnbarmodeCling = 3,

dgnbarmodeTrayIconOnly = 4,

dgnbarmodeInteractiveTutorial = 5,

dgnbarmodeModernFloating = 6,

dgnbarmodeClassicDragonBar = 7

};

DgnEngineOptionConstants – new constants

The DgnEngineOptionConstants are used with the Option property of the EngineControl object

dgnengoptionSmartPhoneServerPort = 0xd1

An integer value specifying the port number of the Dragon Smart Phone Server.

dgnengoptionLiveMicMinStopFrames = 0xd6

Controls how many additional frames will be recorded after a mic-of request

dgnengoptionNewDragonBarLastLocation = 0xd7

A string value specifying X,Y coordinates of New Dragon bar when DNS exits

dgnengoptionModernDragonBarLastCollapseMode = 0xd8

A string value specifying last expand/collapse mode of New Dragon bar when DNS exits

dgnengoptionModernDragonBarAutoCollapse = 0xd9

A string value specifying last auto-collapse mode of New Dragon bar when DNS exits

dgnengoptionNoBackupSpeaker = 0xda

A Boolean value specifying needs save backup

dgnengoptionLogNBestChoices = 0xdb

A Boolean value specifying whether to enable NBest-Choices logging

enum DgnEngineOptionConstants {

dgnengoptionUseConfidence = 0x1,

dgnengoptionSaveCorrectionToArchive = 0x2,

dgnengoptionCollectDictationData = 0x3,

dgnengoptionReturnPauseFillers = 0x4,

dgnengoptionWaveDataAlwaysPreserved = 0x6,

dgnengoptionComputeSpeed = 0x7,

dgnengoptionEnableRecognitionModeCommands = 0x8,

dgnengoptionSelectBringsUpCorrectionMenu = 0x9,

dgnengoptionSelectSearchesBackwards = 0x0a,

dgnengoptionCorrectBringsUpSpellDialog = 0x0b,

dgnengoptionSpellBringsUpSpellDialog = 0x0c,

dgnengoptionAutomaticallyAddWordsToVocabulary = 0x0d,

dgnengoptionAutomaticPlaybackOnCorrection = 0x0e,

dgnengoptionShowOnlyChoicesOnCorrection = 0x0f,

dgnengoptionAnchorCorrectionMenu = 0x10,

dgnengoptionDoubleClickForCorrection = 0x11,

dgnengoptionMaxCorrectionMenuChoices = 0x12,

dgnengoptionPauseRequiredBeforeCommandsMs = 0x13,

dgnengoptionEnableNaturalLanguageCommands = 0x14,

dgnengoptionEnableCommandsInHtmlWindows = 0x15,

dgnengoptionRequireClickToSelectControls = 0x16,

dgnengoptionEnableMouseMotionCommands = 0x17,

dgnengoptionMouseMovementSpeed = 0x18,

dgnengoptionDragonBarMode = 0x19,

dgnengoptionDragonBarShowsMessages = 0x1a,

dgnengoptionDragonBarShowsExtras = 0x1b,

dgnengoptionBeepAfterRecognition = 0x1c,

dgnengoptionAnchorResultsBox = 0x1d,

dgnengoptionResultsBoxAutoHideDelaySec = 0x1e,

dgnengoptionUseClassicResultsBox = 0x50,

dgnengoptionStoreCorrectionsInArchive = 0x1f,

dgnengoptionCorrectionsArchiveSizeMs = 0x20,

dgnengoptionConserveDiskSpaceForUserFiles = 0x21,

dgnengoptionIncrementalAdaptationInGeneralTraining = 0x22,

dgnengoptionDiskSpaceReservedForPlaybackKb = 0x23,

dgnengoptionSaveRecordedDictationWithDocument = 0x24,

dgnengoptionSavesCountToBackupUser = 0x25,

dgnengoptionCollectDataForResearch = 0x26,

dgnengoptionCreateUsabilityLog = 0x27,

dgnengoptionMicrophoneOnAtStartup = 0x28,

dgnengoptionLaunchDragonPadAtStartup = 0x29,

dgnengoptionAutomaticallySaveUserAtShutdown = 0x2a,

dgnengoptionUseScreenReaderCompatibleMenus = 0x2b,

dgnengoptionUseActiveAccessibility = 0x2c,

dgnengoptionDateFormat = 0x2d,

dgnengoptionPowerMicHotkeyMicOnOff = 0x2e,

dgnengoptionPowerMicHotkeyCorrection = 0x2f,

dgnengoptionPowerMicHotkeyForceCommand = 0x30,

dgnengoptionPowerMicHotkeyForceDictation = 0x31,

dgnengoptionPowerMicHotkeyDragonBarMenu = 0x32,

dgnengoptionPowerMicHotkeyMicSleepOn = 0x33,

dgnengoptionPowerMicHotkeyPressToTalk = 0x34,

dgnengoptionPowerMicHotkeyDictationBox = 0x35,

dgnengoptionPowerMicHotkeyPlayback = 0x36,

dgnengoptionPowerMicHotkeyFastPlayback = 0x37,

dgnengoptionPowerMicHotkeyDragonConnect = 0x38,

dgnengoptionPowerMicHotkeyTab = 0x39,

dgnengoptionPowerMicHotkeyReturn = 0x40,

dgnengoptionRequireClickToSelectLinksInIE = 0x41,

dgnengoptionPowerMicHotkeyTrainWord = 0x42,

dgnengoptionPowerMicHotkeySpellMode = 0x43,

dgnengoptionPowerMicHotkeyNormalMode = 0x44,

dgnengoptionPowerMicHotkeyNumbersMode = 0x45,

dgnengoptionPowerMicHotkeyTranscribe = 0x46,

dgnengoptionPowerMicHotkeyPressCancel = 0x47,

dgnengoptionPowerMicHotkeySkipForward = 0x48,

dgnengoptionPowerMicHotkeySkipBackward = 0x49,

dgnengoptionMyCmdsHasMacroRecorder = 0xa1,

dgnengoptionMyCmdsAllowStepByStepScripting = 0xa2,

dgnengoptionMyCmdsAllowVBAScripting = 0xa3,

dgnengoptionProcessAffinityMask = 0xa4,

dgnengoptionSkipInitialTrainingForCurrentUser = 0xa5,

dgnengoptionValidateUsersWhileEnumerating = 0xb0,

dgnengoptionTimeBeforeMicSleepWithNoSound = 0xb1,

dgnengoptionAudioSourceDataAvailableTimeout = 0xb2,

dgnengoptionMaxReutterReplacement = 0xb3,

dgnengoptionMicHotkeyMicOnOff = 0xb4,

dgnengoptionCorrectionHotKey = 0xb5,

dgnengoptionDictationHotKey = 0xb6,

dgnengoptionDictationOnlyHotKey = 0xb7,

dgnengoptionDragonBarHotKey = 0xb8,

dgnengoptionSleepHotKey = 0xb9,

dgnengoptionPressToTalkHotKey = 0xba,

dgnengoptionDictationBoxHotKey = 0xbb,

dgnengoptionPlaybackHotKey = 0xbc,

dgnengoptionFastplaybackHotKey = 0xbd,

dgnengoptionSelectNextVariableHotKey = 0xbe,

dgnengoptionDecryptionPassword = 0xbf,

dgnengoptionUtteranceDetectionForFileRecognition = 0xc0,

dgnengoptionKeepChannelOpenForFileRecognition = 0xc1,

dgnengoptionDontUpdateChannelForFileRecognition = 0xc2,

dgnengoptionSynchronizeDocumentOnPhraseFinish = 0xc3,

dgnengoptionSpeechThreshold = 0xc4,

dgnengoptionSmartPhoneServerPort = 0xd1,

dgnengoptionAllowAddKnownSenseWordsToVocabulary = 0xd2,

dgnengoptionAllowSearchWordsIgnoringKnownSense = 0xd3,

dgnengoptionRequireClickToSelectMenus = 0xd4,

dgnengoptionNBestParamTopChoiceOnly = 0xd5,

dgnengoptionLiveMicMinStopFrames = 0xd6,

dgnengoptionNewDragonBarLastLocation = 0xd7,

dgnengoptionModernDragonBarLastCollapseMode = 0xd8,

dgnengoptionModernDragonBarAutoCollapse = 0xd9,

dgnengoptionNoBackupSpeaker = 0xda,

dgnengoptionLogNBestChoices = 0xdb

};

DgnRoamingUserOptionConstants – new and deprecated constants

The DgnRoamingUserOptionConstants represent the various options for the DgnEngineControl object's RoamingUserOption property.

dgnruoptionRoamingUserSupported = 0xe

New constant: Roaming User Supported

dgnruoptionCopyAcousticAlways = 0xa

Deprecated: Always copy acoustic information to network: This constant caused the local acoustic data files to be copied to the master roaming user profile when the program synchronizes the two user profiles.
This was removed in V14. Applications built with previous versions of the SDK that used this constant will continue to work

enum DgnRoamingUserOptionConstants {

dgnruoptionRoamingUserOn = 0x0,

dgnruoptionMasterUserDirectory = 0x1,

dgnruoptionLocalCacheDirectory = 0x2,

dgnruoptionCopyLogToMaster = 0x3,

dgnruoptionLimitedNetworkTraffic = 0x4,

dgnruoptionRestrictLocalUserAccess = 0x5,

dgnruoptionDoNotCopyDraFiles = 0x6,

dgnruoptionAudioSettingsOverride = 0x7,

dgnruoptionAlwaysBreakLock = 0x8,

hidden,

dgnruoptionDisableCaching = 0x9,

dgnruoptionMaxContainerSizeMb = 0xb,

dgnruoptionIncorporateVocDelta = 0xc,

dgnruoptionInspectVocDelta = 0xd,

dgnruoptionRoamingUserSupported = 0xe

};

DgnAdminSettingsConstants – new constants

Constants for AdministrativeSetting (Gets and sets the Miscellaneous options of the Administrative Settings dialog box) property

dgnasoptionMinimalCharsOfNewData4LMO = 0x11

The minimal Chars Of New Data needed for Language Model Optimization

dgnasoptionUseBackupDictionary4LMO = 0x12

Use Backup Dictionary for Language Model Optimization

enum DgnAdminSettingsConstants {

dgnasoptionRestrictedUserCannotModifyCommands = 0x1,

dgnasoptionDisableStepByStepCommands = 0x2,

dgnasoptionDisableAdvancedScriptingCommands = 0x3,

dgnasoptionRestrictedUserCannotModifyVocabulary = 0x4,

dgnasoptionRecordWaveDataBetweenUtterances = 0x5,

dgnasoptionCorrectionOnlyMode = 0x6,

dgnasoptionDisableAutoACOModelSelection = 0x7,

dgnasoptionEncryptPatientInfo = 0x8,

dgnasoptionAnchorDictationBox = 0x9,

dgnasoptionMinimalMinutesOfNewData4ACO = 0x10,

dgnasoptionMinimalCharsOfNewData4LMO = 0x11,

dgnasoptionUseBackupDictionary4LMO = 0x12

};

DgnTopicDomainConstants – new constants

Constants for TopicDomain (Returns the “domain” of the topic currently loaded.). DgnTopicDomainConstants contains the domains available in Dragon

dgnTopicDomainMedical = 0x0

If the topic is of medical domain

enum DgnTopicDomainConstants {

dgnTopicDomainMedical = 0x0,

dgnTopicDomainLegal = 0x1,

dgnTopicDomainGeneral = 0x2,

dgnTopicDomainPS360 = 0x3,

dgnTopicDomainCommandsOnly = 0x4,

dgnTopicDomainEmptyDictation = 0x5

};

DgnDialogConstants – new and deprecated constants The DgnDialogConstants indicate the Dragon dialog box that you want to display or check status for. Use the constants with the DgnEngineControl object's DlgShow and DlgStatusget methods.
dgndlgACODlg = 57	Displays the Acoustic Optimizer dialog
dgndlgLearnFromSentEmails = 58	Displays the Learn from Sent Emails dialog
dgndlgManageDictationSources = 59	Displays the Manage Dictation Source dialog
dgndlgNewCommandWizardAutoText = 60	Displays the Auto-text dialog
dgndlgManageCustomCommands = 61	Display the Manage Custom Commands dialog
Deprecated: dgndlgGeneralTraining has been deprecated and renamed dgndlgGeneralTraining_Obsolete. It is no lonnger supported in the V14 SDK.	Deprecated: Runs General Training to perform additional training of the user profile

enum DgnDialogConstants {

dgndlgAudioSetupWizard = 1,

dgndlgGeneralTraining_Obsolete = 2,

dgndlgVocabularyBuilder = 3,

hidden,

dgndlgVocBuilder = 3,

dgndlgSpeakerNew = 6,

dgndlgSpeakerOpen = 7,

dgndlgSpeakerSave = 8,

dgndlgNewCommandWizard = 10,

dgndlgEditCommandWizard = 11,

dgndlgVocabularyNew = 12,

dgndlgVocabularyOpen = 13,

dgndlgVocabularyEditor = 14,

dgndlgTrainWords = 16,

dgndlgMobileTraining = 17,

dgndlgOptions = 18,

dgndlgHelpTopics = 19,

dgndlgAbout = 20,

dgndlgImportDVC = 21,

dgndlgRemoveDVC = 22,

dgndlgUserBackup = 23,

dgndlgUserRestore = 24,

dgndlgAddWord = 25,

dgndlgUpgradeWizard = 26,

dgndlgAddWordsFromDocs = 27,

dgndlgRecognitionHistory = 28,

dgndlgTranscribe = 29,

dgndlgDictationShortcuts = 30,

dgndlgAccuracyCenter = 32,

dgndlgAccuracyAssistant = 33,

dgndlgCommandBrowser = 34,

dgndlgAddWordsFromList = 35,

dgndlgPerformanceAssistant = 36,

dgndlgManageUsers = 37,

dgndlgRoamingUsersOptions = 54,

dgndlgFormattingOptions = 55,

dgndlgRemoteMicrophoneConnection = 56,

dgndlgACODlg = 57,

dgndlgLearnFromSentEmails = 58,

dgndlgManageDictationSources = 59,

dgndlgNewCommandWizardAutoText = 60,

dgndlgManageCustomCommands = 61

};

DgnDialogFlagConstants – new constant

Flags for DlgShow method

dgnDialogFlagShowAcoustics = 0x1

Show acoustics in Speaker Open Dialog

enum DgnDialogFlagConstants {

dgnDialogFlagShowAcoustics = 0x1

};

Events:

_DDgnEngineControlEvents – new event

Client applications use the _DDgnEngineControlEvents interface to sink EngineControl events to track the progress of pending operations or to be notified about certain error conditions.

dispinterface _DDgnEngineControlEvents;

SignalQuality

Notifies the application about the SNR value of last utterance.

[void SignalQuality([in] DWORD dwSignalToNoiseRatio);

DISPID_DGN_ENGINECONTROLEVENTS_SIGNALQUALITY = 20;

IDgnDictCustomDictation

Methods:

Method
SkipNumberOfKeyStrokes	Ignore number of keystrokes for Smart Format Rules HRESULT SkipNumberOfKeyStrokes( [in] int bSkipCount); bSkipCount – the number of ketstrokes to skip
SessionSaveForOptimization	Forces the saving of a DRA session for optimization HRESULT SessionSaveForOptimization();
SnapshotSaveAligned	Saves a concordance file (.IDX) and a .WAV file aligned with the reference text file. This function is used in TranscribeFileToFileAndAlign. But it also can be used independently. HRESULT SnapshotSaveAligned( [in] BSTR ReferenceTextFileName, [in] BSTR IndexedFileName, [in, optional] VARIANT WaveFileName); ReferenceTextFileName - Name of the references text file IndexedFileName - The name of the .IDX concordance file where you want to save the current dictation session. WaveFileName - The name of the .WAV file where you want to save the current dictation session.
ParagraphTerminator	Returns or sets the string used to specify a new paragraph. When the user dictates "new paragraph," this string is inserted into the dictation buffer. The default is a carriage-return/line-feed pair. You must set this property before activating the custom dictation object for the first time (that is, before setting the Active property to TRUE). HRESULT ParagraphTerminator([in] BSTR String); HRESULT ParagraphTerminator([out, retval] BSTR * String);

Properties:

Property

SpellDialogIsDisplayed

The property returns TRUE if the spell correction dialog, invoked through DgnDictCustom.CorrectionDialog(), is displayed, otherwise it returns FALSE.”

HRESULT SpellDialogIsDisplayed(

[out, retval]VARIANT_BOOL * Displayed);

DNSTools

Constants:

DgnProductFeatureConstants – new constant

DgnProductFeatureConstants is called by ProductFeatureSupported (see description below):

HRESULT ProductFeatureSupported(

[in]DgnProductFeatureConstants dgnProdFeature,

[out,retval] BOOL* bIsSupported);

ProductFeatureSupported returns the following:

enum DgnProductFeatureConstants {

[helpstring("Allow Citrix Client Edit controls support.")] dgnProdFeatureCitrixEdits = 1,

[helpstring("Allow the use of data collection.")] dgnProdFeatureDataCollection = 2,

[helpstring("Allow Encrypt Patient Health Information.")] dgnProdFeatureDraEncryption = 3,

[helpstring("Allow Support for MS Excel.")] dgnProdFeatureExcelSupport = 4,

[helpstring("Product includes Vocabulary Editor.")] dgnProdFeatureVocabularyEditor = 5,

[helpstring("Allow Facebook Commands.")] dgnProdFeatureFacebookCmdsSupport = 6,

[helpstring("Allow Intuitive Web Commands.")] dgnProdFeatureIwcSupport = 7,

[helpstring("Allow import and export of custom commands.")] dgnProdFeatureMycmdsImportExport = 8,

[helpstring("Allow the Nuance Administrative Server.")] dgnProdFeatureNas = 9,

[helpstring("Allow the use of NLP commands.")] dgnProdFeatureNlpCommands = 10,

[helpstring("Allow Language Model Optimizer support.")] dgnProdFeatureLmoSupport = 11,

[helpstring("Allow MS Outlook support.")] dgnProdFeatureOutlookSupport = 12,

[helpstring("Allow special buttons in NUW for Dictaphone PowerMic II.")] dgnProdFeaturePowermicUI = 13,

[helpstring("Allow MS PowerPoint support.")] dgnProdFeaturePowerpointSupport = 14,

[helpstring("Allow upgrades of user profiles from previous product versions.")] dgnProdFeatureProfileUpgrades = 15,

[helpstring("Allow display of recognition history.")] dgnProdFeatureRecognitionHistory = 16,

[helpstring("Allow use of Roaming User loading/saving.")] dgnProdFeatureRoamingUser = 17,

[helpstring("Allow Smartphone-as-recorder feature.")] dgnProdFeatureSmartphoneRecorder = 18,

[helpstring("Allow creation of custom commands using the step by step scripting.")] dgnProdFeatureStepbystepScripting = 19,

[helpstring("Allow support for Transcription Agent.")] dgnProdFeatureTagentSupport = 20,

[helpstring("Allow tracking outside of the NatSpeak application.")] dgnProdFeatureTrackAllApps = 21,

[helpstring("Allow training of words.")] dgnProdFeatureTrainWords = 22,

[helpstring("Allow Text To Speech.")] dgnProdFeatureTts = 23,

[helpstring("Allow Twitter Commands.")] dgnProdFeatureTwitterCmdsSupport = 24,

[helpstring("Allow support for MS Word.")] dgnProdFeatureWordSupport = 25,

[helpstring("Allow support for Word Perfect.")] dgnProdFeatureWpSupport = 26,

[helpstring("Allow the use of VBA scripting to create a custom command..")] dgnProdFeatureVbaScripting = 27,

[helpstring("Allow VocTool to be present.")] dgnProdFeatureVoctool = 28,

[helpstring("Allow DragonBar to display.")] dgnProdFeatureDragonbarUI = 29,

[helpstring("Allow specific behavior used in Radiology SDK.")] dgnProdFeatureRadSdkBehavior = 30,

[helpstring("VoiceIt and transcription dialogs are available.")] dgnProdFeatureMobileFeatures = 31,

} DgnProductFeatureConstants;

DgnDictationOptionConstant – new and deprecated constants

Constants for dictation objects options DgnDictedit Option and DgnDictcustom Option.

dgndictoptionNbestCount= 0x1

Deprecated: Not supported in V14. This option set the prefered NBEST count associated with the grammar at activation time.

dgndictoptionTranscriptionCommandSet = 0x8

This option allows you to specify the transcription commands set.

You can set/restrict the type of commands that your application can accept from a transcriptionist.

dgndictoptionKeepTranscriptionMemory = 0x18

A boolean value specifying whether memory for DRA file should be kept while transcribing

dgndictoptionFormatPhraseHypothesis = 0x19

A boolean value specifying whether PhraseHypothesis callback should be formatted.

dgndictoptionResetDeletesAudio = 0x20

A Boolean value specifying whether reset deletes audio.

gndictoptionAccumulateRecognitionResults = 0x21

A Boolean value specifying whether accumulation of recognition results is enabled

enum DgnDictationOptionConstants {

dgndictoptionAutoAddWordsToVoc = 0x2,

dgndictoptionCaptureAllDictation = 0x3,

dgndictoptionCompModuleId = 0x4,

dgndictoptionEncrypt = 0x5,

dgndictoptionDelimitingCharacters = 0x6,

dgndictoptionEnableRejectedResults = 0x7,

dgndictoptionTranscriptionCommandSet = 0x8,

dgndictoptionUseGreedyReplacement = 0x9,

dgndictoptionUseSerialInsertion = 0xa,

dgndictoptionPlaybackSpeed = 0xb,

dgndictoptionFastForwardSpeed = 0xc,

dgndictoptionRewindSpeed = 0xd,

dgndictoptionPlaybackVolume = 0xe,

dgndictoptionFastForwardVolume = 0xf,

dgndictoptionRewindVolume = 0x10,

dgndictoptionPlayRewindFastForwardSound = 0x12,

dgndictoptionUsePressToTranscribe = 0x11,

dgndictoptionAudioCompressionEnabled = 0x13,

hidden,

dgndictoptionUseTextSynchronization = 0x14,

dgndictoptionInsertRejectionsIntoDocument = 0x15,

dgndictoptionOverdictationAdjustsSelection = 0x16,

dgndictoptionDecryptionPassword = 0x17,

dgndictoptionKeepTranscriptionMemory = 0x18,

dgndictoptionFormatPhraseHypothesis = 0x19,

dgndictoptionResetDeletesAudio = 0x20,

dgndictoptionAccumulateRecognitionResults = 0x21

};

DgnTranscriptionCommandSetConstants – new constants

Constants for dgndictoptionTranscriptionCommandSet in DgnTranscriptionCommandSetConstants.

dgntranscriptionCmdAllCommands = 0

Dictation Only

Note: The value is “0”. It was documented as “2” in previous versions of the SDK.

dgntranscriptionCmdDictationOnly = 2

All Commands

Note: The value is “2”. It was documented as “0” in previous versions of the SDK.

enum DgnTranscriptionCommandSetConstants {

dgntranscriptionCmdAllCommands = 0,

dgntranscriptionCmdRestrictedCommands = 1,

dgntranscriptionCmdDictationOnly = 2

};

DgnRegisterConstants – new constants

These constants are values for the Flags arguments of the Register methods.

dgnregMonitorSNR = 8

Monitor the SNR value for utterances.

enum DgnRegisterConstants {

dgnregNone = 0,

dgnregGlobalCM = 1,

dgnregNoTrayMic = 4,

dgnregMonitorSNR = 8

};

Enumerations

DgnUserTranscriptionSourceFlags – enumerations Transcription support bit flags enum DgnUserTranscriptionSourceFlags { dgnUserTranscriptionSource_NotSupported = 0, dgnUserTranscriptionSource_Creatable = 1, dgnUserTranscriptionSource_Untrained = 2, dgnUserTranscriptionSource_Trained = 4 };
dgnUserTranscriptionSource_NotSupported = 0	no profile or no transcription support
dgnUserTranscriptionSource_Creatable = 1	set if we can create and train a transcription source
dgnUserTranscriptionSource_Untrained = 2	set if profile has an untrained source
dgnUserTranscriptionSource_Trained = 4	set if profile has a trained

SpeechEngine

Methods:

Method

ProductFeatureSupported

Check if the product feature is supported.

See DgnProductFeatureConstants above.

HRESULT ProductFeatureSupported(
[in]DgnProductFeatureConstants dgnProdFeature,
[out,retval] BOOL* bIsSupported);

DgnAcousticOptimizer

Methods:

Method

Abort

Cancels the acoustics optimization process

HRESULT Abort();

IDgnDictCustomDictation

Constants:

DgnProductFeatureConstants – new constant

Constants for the IDgnUpgrade options.

enum DgnUpgradeOptionConstants {

dgnupgradeMaxSecsAcoDataDuringUpgrade = 0x1

};

dgnupgradeMaxSecsAcoDataDuringUpgrade = 0x1

Max Seconds of Aco Data During Upgrade.

IDgnSimplifiedLMBuilder

Methods:

Method

BuildFromDocuments

Builds LM from the specified list oif documents

HRESULT BuildFromDocuments(

[in] DgnLmSlotConstants Slot,

[in] IDgnStrings* FileList);

Common

Constants:

Constant

DgnLanguageConstants

Occurs when a command associated with this voice-command object is recognized.

dgnlangCanadianEnglish = 0xf809

enum DgnLanguageConstants {

dgnlangEnglish = 0x0009,

dgnlangUSEnglish = 0x0409,

dgnlangUKEnglish = 0x0809,

dgnlangAustralianEnglish = 0x0c09,

dgnlangIndianEnglish = 0xf009,

dgnlangSingaporeanEnglish = 0xf409,

dgnlangCanadianEnglish = 0xf809,

dgnlangFrench = 0x040c,

dgnlangItalian = 0x0410,

dgnlangGerman = 0x0407,

dgnlangSpanish = 0x040a,

dgnlangCastilianSpanish = 0xf00a,

dgnlangLatinAmericanSpanish = 0xf40a,

dgnlangDutch = 0x0413,

dgnlangJapanese = 0x0411,

dgnlangPortuguese = 0x0416

};

DgnVoiceMenu

Methods:

Method

Add

Adds a new command to a voice menu created by the DgnVoiceCmd.MenuCreate method.

New note: Voice commands should be added in your SpeakerChanged() or LanguageChanged() event handler.

HRESULT Add([in] long CmdNum, [in] BSTR Command,

[in] BSTR Category, [in] BSTR Description,

[in, optional] VARIANT Action, [in, optional] VARIANT Flags );

Remove

Removes a command from a voice menu created by the MenuCreate method. All commands added with the same ID are removed.

New note: Voice commands should be removed when the associated window closes or before closing/switching the speaker. Refer to the topic ‘Closing your Dragon SDK client application’ in the developer’s guide.

helpcontext(IDH_HTML_IVMenuAuto__Remove__in__long)]

HRESULT Remove( [in] long ID );

Properties:

Property

Active

Returns or sets a Boolean value that determines whether a voice menu created by the MenuCreate method is activated or deactivated for as long as speech recognition is awake for the site. The default is FALSE; you must set this property to TRUE to activate the voice menu.

Note: The property can be set when you add voice commands in your your SpeakerChanged() or LanguageChanged() event handler. Thereafter, it should only be modified in your RecognitionStarting event handler.

HRESULT Active( [in] VARIANT_BOOL Active );

Known issues

Custom words created by samples not shared

Custom words created using the samples provided with the Dragon SDK Client Edition (for example, the Custom Dictation Sample - dictcust.exe) are not shared with the Network Management Server (NMS) or other installations of Dragon.

If you want to create and share custom words, you can do this with NMS or with Dragon itself:

Words are shared to NMS, if you create new words in Dragon (not DSC samples)
Words are shared to Dragon, if you create new words on NMS