Dragon Medical SpeechKit Browser edition

https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/
Admin
Dragon Medical SpeechKit Browser edition enables developers to add secure and easy-to-integrate...
Tokens:36,273
Snippets:314
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### Custom Control Interface Example

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/custom-controls

Example demonstrating how to register a custom control type and assign the required properties and methods.

```APIDOC
## Custom Control Interface Example

### Description
This example shows the basic structure for implementing a custom control, including registering the control type and assigning the necessary properties and methods.

### Code Example
```javascript
var customControlType = NUSA_registerCustomControlType("MyCustomControl");
customControlType.newlineFormat = "\n";
customControlType.paragraphFormat = "\v"; // Example using vertical tab for paragraph

customControlType.replaceText = myCustomControl_replaceText;
customControlType.getText = myCustomControl_getText;
customControlType.getSelectionText = myCustomControl_getSelectionText;
customControlType.getSelection = myCustomControl_getSelection;
customControlType.setSelection = myCustomControl_setSelection;

function myCustomControl_replaceText(element, text, fromPos, length) {
  // Implementation for replacing text
  console.log("Replacing text in element:", element, "with:", text, "from position:", fromPos, "for length:", length);
}

function myCustomControl_getText(element) {
  // Implementation for getting text
  console.log("Getting text from element:", element);
  return element.textContent; // Example implementation
}

function myCustomControl_getSelectionText(element) {
  // Implementation for getting selected text
  console.log("Getting selection text from element:", element);
  return ""; // Placeholder
}

function myCustomControl_getSelection(element) {
  // Implementation for getting selection range
  console.log("Getting selection from element:", element);
  var selInfo = new NUSA_selectionInfo();
  selInfo.start = 0;
  selInfo.length = 0;
  return selInfo;
}

function myCustomControl_setSelection(element, start, length) {
  // Implementation for setting selection
  console.log("Setting selection in element:", element, "start:", start, "length:", length);
}

// Example of how to apply the custom control type to an HTML element:
// <div data-nusa-custom-control-type="MyCustomControl">Your content here</div>
```
```

--------------------------------

### Custom Control Interface Example

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/custom-controls

Provides an example of how to register a custom control type and implement its required members, including format properties and methods for text manipulation and selection.

```javascript
var customControlType = NUSA_registerCustomControlType("MyCustomControl");
customControlType.newlineFormat = "\n";
customControlType.paragraphFormat = "\v";
customControlType.replaceText = myCustomControl_replaceText;
customControlType.getText = myCustomControl_getText;
customControlType.getSelectionText = myCustomControl_getSelectionText;
customControlType.getSelection = myCustomControl_getSelection;
customControlType.setSelection = myCustomControl_setSelection;
function myCustomControl_replaceText(...) { ... }
```

--------------------------------

### SpeechKit Custom Container Interface Example

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/custom-controls

Provides a JavaScript example demonstrating how to register a custom container type and assign the required focus handling methods. This illustrates the integration of custom logic with SpeechKit's focus management.

```javascript
var customContainerType = NUSA_registerCustomContainerType("MyCustomContainer");
customContainerType.getFocussedElement = myCustomContainer_getFocussedElement;
customContainerType.setFocussedElement = myCustomContainer_setFocussedElement;

function myCustomContainer_getFocussedElement(...) { ... }
function myCustomContainer_setFocussedElement(...) { ... }
```

--------------------------------

### Recording Control API

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/start-stop-recording_source=recommendations

Functions to programmatically start, stop, and toggle the recording state for Dragon Medical SpeechKit.

```APIDOC
## Start Recording

### Description
Starts audio recording if it is currently inactive. If recording is already active, this function does nothing.

### Method
JavaScript Function Call

### Endpoint
N/A (Browser API)

### Parameters
None

### Request Example
```javascript
NUSA_startRecording();
```

### Response
No explicit response. Recording state is updated internally.

---

## Stop Recording

### Description
Stops audio recording if it is currently active. If recording is already stopped, this function does nothing.

### Method
JavaScript Function Call

### Endpoint
N/A (Browser API)

### Parameters
None

### Request Example
```javascript
NUSA_stopRecording();
```

### Response
No explicit response. Recording state is updated internally.

---

## Toggle Recording

### Description
Starts recording if it is stopped, or stops recording if it is active. This function does not track the recording state.

### Method
JavaScript Function Call

### Endpoint
N/A (Browser API)

### Parameters
None

### Request Example
```javascript
NUSA_toggleRecording();
```

### Response
No explicit response. Recording state is updated internally.
```

--------------------------------

### Create Application Command in JavaScript

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/application-commands

Creates an application command within a specified command set. This function takes the command set ID, a unique command ID, the spoken phrase, a display string, and a description. The command ID must not contain spaces or start with a number. The command is enabled by default.

```javascript
NUSA_createCommand(cmdSetId, "myTestCommandId", "this is a test", "THIS IS A TEST", "My test command description.");
```

--------------------------------

### Initialize Deferred Correction with NUSA_initialize()

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/use-case-deferred-correction-browser

This JavaScript example illustrates deferred initialization of Dragon Medical SpeechKit when `NUSA_configure()` is not implemented. It sets the `NUSA_documentMode` and then calls `NUSA_initialize()` with document ID and token.

```javascript
function initialize() {
    ...
    NUSA_documentMode = this.user.type === correctionist ? NUSA_mode.correctionist : NUSA_mode.author;
    NUSA_initialize(null, {
        id: "<document ID>",
        token: "<document token>"
    });
 ...
}
```

--------------------------------

### Handle VuiController Processing Events (JavaScript)

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/events

Callbacks to manage events related to individual VuiForms, indicating when speech processing starts and finishes. These are useful for updating the GUI or controlling navigation during speech recognition.

```javascript
function NUSA_onProcessingStarted() { }
function NUSA_onProcessingFinished() { }
```

--------------------------------

### Handle Text Control Processing Start and Finish Events (JavaScript)

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/events

These JavaScript functions are callbacks that notify your application when speech recognition processing begins and ends for a specific text control within a VuiForm. They are always fired in pairs for each element.

```javascript
function NUSA_onProcessingStartedForElement(element) {
  // Handle processing start event for the element
}

function NUSA_onProcessingFinishedForElement(element) {
  // Handle processing finish event for the element
}
```

--------------------------------

### Initialize SpeechKit for an Array of Elements (JavaScript)

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/specific-controls

This example demonstrates how to speech-enable an array of edit controls by passing them to the `NUSA_initialize()` function. The SpeechKit will then only parse the elements provided in the array, offering flexibility in defining speech-enabled areas.

```javascript
var childElements = [];
childElements.push.apply(childElements, document.getElementById("speechFormsContainer1").getElementsByTagName("*"));
childElements.push.apply(childElements, document.getElementById("speechFormsContainer2").getElementsByTagName("*"));
return NUSA_initialize(childElements);
// Dragon Medical SpeechKit will only parse the elements passed to the function.
```

--------------------------------

### Control Recording State with JavaScript Functions

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/start-stop-recording

These JavaScript functions allow you to programmatically control the recording state within Dragon Medical SpeechKit. NUSA_startRecording() initiates recording, NUSA_stopRecording() halts it, and NUSA_toggleRecording() switches between the two states without tracking the current state. These functions are essential for integrating speech recognition control into web applications.

```javascript
NUSA_startRecording();
NUSA_stopRecording();
NUSA_toggleRecording();
```

--------------------------------

### Show Personalization & Help Window with SpeechKit SDK (JavaScript)

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/hosted-view

This snippet demonstrates how to display the personalization and help window using the `NUSA_showForm` function in JavaScript. The `contentType` parameter determines which tab of the window is opened. Ensure your app is speech-enabled before calling this function.

```javascript
NUSA_showForm(NUSA_contentType.default);
// Or other content types like:
// NUSA_showForm(NUSA_contentType.voiceCommands);
// NUSA_showForm(NUSA_contentType.endUserHelp);
// NUSA_showForm(NUSA_contentType.addWord);
// NUSA_showForm(NUSA_contentType.autoTexts);
```

--------------------------------

### Custom Stop-Recording Delay

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/start-stop-recording_source=recommendations

Allows developers to specify a custom delay after the user stops recording to ensure all audio is captured.

```APIDOC
## Specify a stop-recording delay

### Description
Overrides the default stop-recording delay of Dragon Medical SpeechKit with a custom value. This ensures that all intended audio is processed, accounting for environmental factors or system performance.

### Method
JavaScript Function Call

### Endpoint
N/A (Browser API)

### Parameters
#### Query Parameters
- **customDelayValue** (integer) - Required - Your custom stop-recording delay in milliseconds. Must be an integer from 0 to 500.

### Request Example
```javascript
NUSA_setCustomAudioStopDelay(250); // Sets a custom delay of 250 milliseconds
```

### Response
No explicit response. The custom delay is set internally. This function should be called only once when the page is speech-enabled.
```

--------------------------------

### Implement Custom Container Focus Handling Methods

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/custom-controls_source=recommendations

Defines the mandatory methods for a custom container instance to handle focus management. These methods map between proxy HTML elements and the actual edit controls.

```javascript
function getFocussedElement(containerElement) {
  // Returns the focused edit control in the specified containerElement.
  // containerElement – the HTML element tagged with data-nusa-custom-container-type.
  // Return value: the HTML element tagged with data-nusa-custom-control-type.
}

function setFocussedElement(element) {
  // Sets the focus to the specified edit control.
  // element – the HTML element tagged with data-nusa-custom-control-type.
}
```

--------------------------------

### Custom Control Interface Implementation

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/custom-controls

Implement the following properties and methods on the CustomControl instance returned by `NUSA_registerCustomControlType` to enable speech interaction with your custom controls.

```APIDOC
## Custom Control Members

### Description
All properties and methods listed below are mandatory and must be implemented on the CustomControl instance.

### Properties
- **newlineFormat** (string) - Required - A string that represents a line break in the control's text. This must match the characters your edit control uses for a line break.
- **paragraphFormat** (string) - Required - A string that represents a paragraph break in the control's text. This must match the characters your edit control uses for a paragraph break. If your edit control doesn't support paragraphs, use two line breaks (e.g., `"\n\n"`). If your edit control supports single-line text fields only, omit these strings.

### Methods
- **replaceText(element, text, fromPos, length)**
  - **Description**: Replaces part of the text in the specified custom control.
  - **Parameters**:
    - `element` (HTMLElement) - The HTML element representing the custom control.
    - `text` (string) - The new text to insert.
    - `fromPos` (integer) - The starting position (0-based index) for the replacement.
    - `length` (integer) - The number of characters to replace.
  - **Behavior**: After replacement, the insertion point must be maintained relative to the modified text. If characters are inserted or removed to the left of the insertion point, the insertion point must move accordingly. If text to the right is modified, the insertion point should not change. If characters at the insertion point are modified, the insertion point should be set to the end of the modified region. This method should handle asynchronous updates gracefully to avoid interfering with user input.

- **getText(element)**
  - **Description**: Retrieves the current text of the specified custom control.
  - **Parameters**:
    - `element` (HTMLElement) - The HTML element representing the custom control.
  - **Return Value**: (string) The current text content of the control.

- **getSelectionText(element)**
  - **Description**: Retrieves the currently selected text of the specified custom control.
  - **Parameters**:
    - `element` (HTMLElement) - The HTML element representing the custom control.
  - **Return Value**: (string) The selected text.

- **getSelection(element)**
  - **Description**: Retrieves the current selection range of the specified custom control.
  - **Parameters**:
    - `element` (HTMLElement) - The HTML element representing the custom control.
  - **Return Value**: (`NUSA_selectionInfo` object) An object with `start` (integer) and `length` (integer) properties specifying the selected text range.

- **setSelection(element, start, length)**
  - **Description**: Sets the selection range in the specified custom control.
  - **Parameters**:
    - `element` (HTMLElement) - The HTML element representing the custom control.
    - `start` (integer) - The starting position of the selection.
    - `length` (integer) - The length of the selection.
```

--------------------------------

### SpeechKit Custom Control Selection Setting

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/custom-controls_source=recommendations

Implements the `setSelection` method for a custom control. This function sets the text selection within the specified HTML element to a given start position and length.

```javascript
function myCustomControl_setSelection(element, start, length) {
  // ... implementation to set selection in the element ...
}
```

--------------------------------

### SpeechKit Custom Control Selection Range Retrieval

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/custom-controls_source=recommendations

Implements the `getSelection` method for a custom control. This function retrieves the start position and length of the current text selection within the specified HTML element, returning an NUSA_selectionInfo object.

```javascript
function myCustomControl_getSelection(element) {
  var selInfo = new NUSA_selectionInfo();
  // ... implementation to get selection range ...
  selInfo.start = 0;
  selInfo.length = 5;
  return selInfo;
}
```

--------------------------------

### Implement Custom Container Focus Handling

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/custom-controls

Defines the mandatory methods for a custom container instance to manage focus. These methods map between proxy HTML elements and the actual edit controls, enabling SpeechKit to interact with custom focusable elements.

```javascript
function getFocussedElement(containerElement) {
  // Returns the focused edit control in the specified containerElement.
  // containerElement – the HTML element tagged with the data-nusa-custom-container-type attribute.
  // Return value: the HTML element tagged with the data-nusa-custom-control-type attribute.
}

function setFocussedElement(element) {
  // Sets the focus to the specified edit control.
  // element – the HTML element tagged with the data-nusa-custom-control-type attribute.
}
```

--------------------------------

### Define App-Defined Command Placeholder in JavaScript

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/application-commands

This snippet demonstrates how to create an application command with a placeholder. The placeholder is defined within angled brackets in the command phrase and is later registered with a human-readable description. This allows for dynamic input within voice commands.

```javascript
NUSA_createCommand(cmdSetId ,"myShowPatientCommand", "show me <patientId>", "show me <patientId>", "Shows data for the corresponding patient.");
NUSA_createCommandPlaceholder("patientId", "Name of the patient");
var values = new Array();
var spokenForms = new Array();
values.push("PTN.48389488");
spokenForms.push("Mr. Pink");
values.push("PTN.48389488");
spokenForms.push("Mr. Orange");
NUSA_setCommandPlaceholderValues("patientId", values, spokenForms);
```

--------------------------------

### Implement Command Recognition Callback in JavaScript

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/application-commands

This snippet shows how to implement the `NUSA_onCommandRecognized` function to handle recognized application commands. It includes checking the command ID and processing placeholder values associated with the recognized command. This is crucial for responding to user voice input.

```javascript
function NUSA_onCommandRecognized(cmdId, spokenText, content, placeholderIds, placeholderValues) {
    if (cmdId == "myShowPatientCommand") {
        if (placeholderIds[0] == "patientId") { // the unique identifier of the placeholder
            var patientName = placeholderValues[0];
        }
    }
}

// Example for multiple placeholders or values:
// for (var i = 0; i < placeholderIds.length; ++i) {
//     if (placeholderIds[i] == "patientId") { // the unique identifier of the placeholder
//         var patientName = placeholderValues[i];
//     }
//     else if (placeholderIds[i] == "anotherId") {
//         var data = placeholderValues[i];
//     }
// }
```

--------------------------------

### Create Command Set in JavaScript

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/application-commands

Creates a new command set for application commands. The command set has a human-readable title and description, which are displayed in the personalization and help window. The command set is enabled by default.

```javascript
var cmdSetId = NUSA_createCommandSet("My Test CommandSet ", " Description of my test command set ");
```

--------------------------------

### Custom Container Focus Handling Methods

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/custom-controls_source=recommendations

Implement these methods on the CustomContainer instance returned by `NUSA_registerCustomContainerType` to enable SpeechKit to retrieve and set focus within your custom containers.

```APIDOC
## PUT /websites/learn_microsoft_en-us_industry_healthcare_speechkit_browser/focus

### Description
Defines the methods for retrieving and setting the currently focused element within a custom container.

### Method
PUT

### Endpoint
/websites/learn_microsoft_en-us_industry_healthcare_speechkit_browser/focus

### Parameters
#### Path Parameters
- **containerElement** (HTMLElement) - Required - The HTML element tagged with the `data-nusa-custom-container-type` attribute.
- **element** (HTMLElement) - Required - The HTML element tagged with the `data-nusa-custom-control-type` attribute that acts as a proxy for the edit control to be focused.

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
// Assigning the methods to the custom container type
customContainerType.getFocussedElement = function(containerElement) {
  // Implementation to return the focused element
  return containerElement.querySelector('[data-nusa-custom-control-type].focused');
};

customContainerType.setFocussedElement = function(element) {
  // Implementation to set focus to the specified element
  element.focus();
};
```

### Response
#### Success Response (200)
- **getFocussedElement**: Returns the focused HTML element within the container.
- **setFocussedElement**: Sets the focus to the specified HTML element.

#### Response Example
```
// No direct response body for method assignment, but successful execution implies focus is managed.
```
```

--------------------------------

### Set Custom Stop-Recording Delay in JavaScript

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/start-stop-recording

This JavaScript function allows you to specify a custom delay in milliseconds after recording is stopped. This ensures all user audio is processed, accounting for environmental factors. The customDelayValue must be an integer between 0 and 500. This function should only be called once when speech-enabling the page.

```javascript
NUSA_setCustomAudioStopDelay(customDelayValue);
// customDelayValue: integer from 0 to 500
```

--------------------------------

### Dynamically Load SpeechKit JavaScript

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/deferred-initialization_source=recommendations

Demonstrates how to dynamically load the Dragon Medical SpeechKit JavaScript file by creating a script element and appending it to the document's head. This method is useful for loading the SpeechKit when it's needed rather than on page load.

```javascript
function loadScriptDynamically()
    {
    var script = document.createElement("script");
    script.type = "text/javascript";
    script.src = "https://speechanywhere.nuancehdp.com/<channel>/scripts/Nuance.SpeechAnywhere.js";
    document.getElementsByTagName("head")[0].appendChild(script);
    }
```

--------------------------------

### Open Next Document with NUSA_initializeVuiForm()

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/use-case-deferred-correction-browser

This JavaScript code demonstrates how to open a new document for editing in a single-page application after closing the previous one. It uses `NUSA_initializeVuiForm()` and requires the document ID and token.

```javascript
function open() {
    ...
    NUSA_initializeVuiForm({
        id: "<document ID>", 
        token: "<document token>",
    });
    ...
}
```

--------------------------------

### Configure Speech Recognition Language and Topic (JavaScript)

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/language-topic_source=recommendations

This snippet demonstrates how to set the `NUSA_language` and `NUSA_topic` variables within the `NUSA_configure()` function for Dragon Medical SpeechKit. The language uses IETF tags (e.g., 'en-US'), and topics correspond to medical specialties or 'Clinical Administration'. These settings must be configured before the first recording starts.

```javascript
function NUSA_configure() {
    NUSA_userId = "pat_smith";
    NUSA_applicationName = "Sample_Basic";
    NUSA_language = "en-US";
    NUSA_topic = NUSA_topicSurgery;
}
```

--------------------------------

### Initialization with NUSA_configure()

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/use-case-deferred-correction-browser_source=recommendations

Details on configuring Dragon Medical SpeechKit for deferred correction using the `NUSA_configure()` function, including setting document mode and credentials.

```APIDOC
## Initialization with NUSA_configure()

### Description
If your application implements `NUSA_configure()`, configure your application for deferred correction by setting the `NUSA_documentMode` and `NUSA_documentCredentials` variables.

### Procedure
1. Add Dragon Medical SpeechKit to your web page header. Use the deferred-correction URL that corresponds to the Nuance-hosted system you're connecting to and the release channel you're using.
2. Set the following variables in your implementation of `NUSA_configure()`:
   - `NUSA_documentMode` - use the `NUSA_mode` enum; default value: `NUSA_mode.author`.
   - `NUSA_documentCredentials` - an object containing the document ID and document token.

### JavaScript Example
```javascript
function NUSA_configure() {
    ...
    NUSA_documentMode = this.user.type === correctionist ? NUSA_mode.correctionist : NUSA_mode.author;
    NUSA_documentCredentials = {
        id: "<document ID>",
        token: "<document token>"
    };
    ...
}
```

### Note
`NUSA_documentMode` can only be set during initialization; changing its value later will have no effect.
```

--------------------------------

### Add Standard Placeholder to Command in JavaScript

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/application-commands

Adds a standard placeholder to an application command's phrase and display string. This allows for dynamic input within the spoken command, such as a numerical range. The placeholder must be consistent in both the phrase and the display string.

```javascript
NUSA_createCommand("myScrollCommand", "scroll down <standard:cardinal0-100> pages", "scroll down <standard:cardinal0-100> pages","Scrolls down the specified number of pages.");
```

--------------------------------

### Custom Control Text Manipulation and Selection Methods

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/custom-controls

Defines the mandatory methods that must be implemented for a custom control to interact with the SpeechKit recognition system. These include replacing text, retrieving text, and managing selection ranges.

```javascript
function replaceText(element, text, fromPos, length )
// Replaces part of the text in the specified custom control.
// element – the HTML element representing the custom control.
// text – the new text as string.
// fromPos – position of the first character to be replaced (the first character of text has fromPos '0').
// length – number of characters to be replaced.
```

```javascript
function getText(element)
// Retrieves the current text of the specified custom control.
// element – the HTML element representing the custom control.
// Return value: the current text as string.
```

```javascript
function getSelectionText(element)
// Retrieves the currently selected text of the specified custom control.
// element – the HTML element representing the custom control.
// Return value: the selected text as string.
```

```javascript
function getSelection(element)
// Retrieves the current selection range of the specified custom control.
// element – the HTML element representing the custom control.
// Return value: NUSA_selectionInfo object whose start and length properties specify the selected text range.
```

```javascript
function setSelection(element, start, length)
// Sets the selection in the specified custom control.
// element – HTML element representing the custom control.
// start – position of the first character to select.
// length – length of the selection.
```

--------------------------------

### Handle Recognized Application Commands (JavaScript)

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/events

Callback triggered when an application command is recognized. It provides details about the command, including its ID, the spoken phrase, and any associated placeholder data.

```javascript
function NUSA_onCommandRecognized(cmdId, spokenPhrase, content, placeholderIds, placeholderValues) { }
```

--------------------------------

### Implement Custom Control Interface for SpeechKit

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/custom-controls_source=recommendations

Defines the mandatory properties and methods for a CustomControl instance to interact with the SpeechKit recognition system. This includes setting newline and paragraph formats, and implementing functions for replacing text, retrieving text, and managing selections.

```javascript
var customControlType = NUSA_registerCustomControlType("MyCustomControl");
customControlType.newlineFormat = "\n";
customControlType.paragraphFormat = "\v";
customControlType.replaceText = myCustomControl_replaceText;
customControlType.getText = myCustomControl_getText;
customControlType.getSelectionText = myCustomControl_getSelectionText;
customControlType.getSelection = myCustomControl_getSelection;
customControlType.setSelection = myCustomControl_setSelection;

function myCustomControl_replaceText(element, text, fromPos, length) { /* ... */ }
function myCustomControl_getText(element) { /* ... */ }
function myCustomControl_getSelectionText(element) { /* ... */ }
function myCustomControl_getSelection(element) { /* ... */ }
function myCustomControl_setSelection(element, start, length) { /* ... */ }
```

--------------------------------

### Register Custom Container and Control Types (JavaScript)

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/custom-controls

This snippet demonstrates how to register custom control and container types within the NUSA_configure function. It sets up the necessary types for custom edit controls and their containers, preparing them for SpeechKit integration. The custom control type is registered as 'MyCustomControl' and the custom container type as 'MyCustomContainer'.

```javascript
NUSA_configure({
  customControls: {
    MyCustomControl: {
      // ... custom control interface implementation ...
    }
  },
  customContainers: {
    MyCustomContainer: {
      // ... custom container interface implementation ...
    }
  }
});
```

--------------------------------

### Add Proxy Elements for Custom Controls and Containers (HTML)

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/custom-controls

This HTML snippet shows how to add proxy elements to an HTML page for custom edit controls and their containers. The `data-nusa-custom-container-type` attribute on the container proxy links it to the registered container type. For each custom control, a proxy element with `data-nusa-custom-container-id` and `data-nusa-custom-control-type` attributes is added, referencing its container and registered control type.

```html
<div id="MyCustomContainerInstance" data-nusa-custom-container-type="MyCustomContainer"></div>

<div id="MyCustomControlInstance_1" data-nusa-custom-container-id="MyCustomContainerInstance" data-nusa-custom-control-type="MyCustomControl"></div>
...
```

--------------------------------

### Deferred Initialization with NUSA_initialize()

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/use-case-deferred-correction-browser_source=recommendations

Instructions for initializing Dragon Medical SpeechKit for deferred correction when `NUSA_configure()` is not implemented, using `NUSA_initialize()`.

```APIDOC
## Deferred Initialization with NUSA_initialize()

### Description
If your application doesn't implement `NUSA_configure()`, initialize Dragon Medical SpeechKit for deferred correction using `NUSA_initialize()`. This involves adding the SpeechKit to the header, setting deferred correction variables, and calling `NUSA_initialize()` with document credentials.

### Procedure
1. Add Dragon Medical SpeechKit to your web page header. Use the deferred-correction URL that corresponds to the Nuance-hosted system you're connecting to and the release channel you're using.
2. Among the usual set of configuration variables, set the deferred correction variables:
   - `NUSA_documentMode` - use the `NUSA_mode` enum; default value: `NUSA_mode.author`.
3. Call `NUSA_initialize()` and provide the document ID and document token as an object parameter.

### JavaScript Example
```javascript
function initialize() {
    ...
    NUSA_documentMode = this.user.type === correctionist ? NUSA_mode.correctionist : NUSA_mode.author;
    NUSA_initialize(null, {
        id: "<document ID>",
        token: "<document token>"
    });
 ...
}
```
```

--------------------------------

### Add Proxy Element for Custom Container - HTML

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/custom-controls_source=recommendations

This HTML snippet shows how to add a proxy element for a custom container. This `div` element serves as a placeholder that SpeechKit uses to identify and interact with the custom container. The `data-nusa-custom-container-type` attribute must match the name registered in `NUSA_configure`.

```html
<div id="MyCustomContainerInstance" data-nusa-custom-container-type="MyCustomContainer"></div>
```

--------------------------------

### Opening a Document After Closing

Source: https://learn.microsoft.com/en-us/industry/healthcare/speechkit/browser/implement/use-case-deferred-correction-browser_source=recommendations

Steps for opening a new document in a single-page application after a previous document has been closed, using `NUSA_initializeVuiForm()`.

```APIDOC
## Opening After Closing

### Description
If your app enables users to edit multiple documents without reloading or navigating to another page (single-page application), you can open the next document by ensuring the previous one is closed and then calling `NUSA_initializeVuiForm()` with the new document's credentials.

### Procedure
1. Make sure the previous document has been closed.
2. Load the new document to your page.
3. Call `NUSA_initializeVuiForm()` and provide the document ID and document token as an object parameter.

### JavaScript Example
```javascript
function open() {
    ...
    NUSA_initializeVuiForm({
        id: "<document ID>", 
        token: "<document token>",
    });
    ...
}
```
```
Tokens:
Raw