Windows Desktop (WinUI) Applications

Develop Windows Desktop (WinUI) applications that manage grammars using your favorite Windows App SDK development tools. This includes development environments such as Microsoft Visual Studio.

The following sections describe the steps for integrating GrammarKit with Windows Desktop (WinUI) applications.

GrammarKit Assemblies

GrammarKit includes Windows App SDK compatible .NET assemblies to support most applications' target framework. If you need a specific target framework, then contact Chant Product Support.

To access GrammarKit .NET classes within a Windows Desktop (WinUI) application, add project references with the applicable nuget package depending on the application type and desired speech APIs:

• Select the application project in the Solution Explorer
• Right-click the mouse and select the Manage Nuget Packages… menu item.
• Enter Chant in the search bar.
• For System.Speech and Microsoft.Speech speech technologies:
  • Select the Chant.GrammarKit package and press the Install button.

• For Microsoft SAPI, Microsoft Speech Platform, and Microsoft WindowsMedia (via WinRT C++) speech technologies:
  • Select the Chant.GrammarKit.Windows package and press the Install button.

• For Microsoft WindowsMedia (via WinRT .NET) speech technologies:
  • Select the Chant.GrammarKit.WinRT.WindowsMedia package and press the Install button.

To access the GrammarKit .NET classes within applications that target Microsoft System.Speech and Microsoft.Speech speech technologies, add references to the Chant shared and GrammarKit assemblies in your code.

using System;
...
using Chant.GrammarKit;
using Chant.Shared;

These applications do not require a GrammarKit Speech API library.

To access the GrammarKit .NET classes within applications that target Microsoft SAPI5, Micosoft Speech Platform, and Microsoft WindowsMedia (via WinRT C++) speech technologies, add references to the Chant shared and GrammarKit assemblies in your code.

using System;
...
using Chant.GrammarKit.Windows;
using Chant.Shared.Windows;

These applications require the applicable GrammarKit Speech API library in the same directory (Appx) as the application .exe.

To access the GrammarKit .NET classes within applications that target Microsoft WindowsMedia (via WinRT .NET) speech technologies, add references to the Chant shared and GrammarKit assemblies in your code.

using System;
...
using Chant.GrammarKit.WinRT.WindowsMedia;
using Chant.Shared.WinRT.WindowsMedia;

These applications do not require a GrammarKit Speech API library.

Object Instantiation

Declare variables for the GrammarKit classes, instantiate instance, add the event handlers, and set the credentials.

private NGrammarKit _GrammarKit = null;
private NSAPI5Recognizer _Recognizer = null;
public MainWindow()
{
    InitializeComponent();
    // Instantiate GrammarKit
    _GrammarKit = new NGrammarKit();
    if (_GrammarKit != null)
    {
        // Set credentials
        _GrammarKit.SetCredentials("Credentials");
        _Recognizer = _GrammarKit.CreateSAPI5Recognizer();
        if (_Recognizer != null)
        {
            _Recognizer.CompileDone += this.Compile_CompileDone;
            _Recognizer.CompileError += this.Compile_CompileError;
        }
    }
}

Event Callbacks

Event callbacks are the mechanism in which the class object sends information back to the application such as compilation is complete or there was an error.

private void Compile_CompileDone(object sender, CompileEventArgs e)
{
    ...
}

private void Compile_CompileError(object sender, CompileEventArgs e)
{
    // Format transcript message
    string errorMsg = "";
    errorMsg = "(" + e.Error.ToString() + ") ";
    errorMsg += "error " + e.LineNumber.ToString() + " ";
    errorMsg += e.Description;
    ...
}

Platform Target

For applications that require the applicable GrammarKit Speech API library, set the project Platform target to either x86 for 32-bit application or x64 for 64-bit application as follows:

Development and Deployment Checklist

When developing and deploying Windows Desktop (WinUI) applications, ensure you have a valid license, bundle the correct Chant class libraries, and configure your installation properly on the target system.

Review the following checklist before deploying Windows Desktop (WinUI) applications targeting System.Speech or Microsoft.Speech speech technologies:

• Develop and deploy Windows Desktop (WinUI) applications to any system with a valid license from Chant. See the section License for more information about licensing Chant software.
• Copy Chant.GrammarKit.dll and Chant.Shared.dll assemblies to the target system or merge them with your application using an obfuscator like .NET Reactor by Eziriz.

Review the following checklist before deploying Windows Desktop (WinUI) applications targeting Microsoft SAPI, Microsoft Speech Platform, or Microsoft WindowsMedia (via WinRT C++) speech technologies:

Review the following checklist before deploying Windows Desktop (WinUI) applications targeting WindowsMedia (via WinRT .NET) speech technologies:

• Develop and deploy Windows Desktop (WinUI) applications to any system with a valid license from Chant. See the section License for more information about licensing Chant software.
• Copy Chant.GrammarKit.WinRT.WindowsMedia.dll and Chant.Shared.WinRT.WindowsMedia.dll assemblies to the target system or merge them with your application using an obfuscator like .NET Reactor by Eziriz.

Sample Projects

Windows Desktop (WinUI) sample projects are installed at the following location:

• Documents\Chant\GrammarKit 11\WinUI\Windows\cs.