.NET WPF Applications

Develop .NET WPF applications that manage speaker profiles using your favorite .NET WPF development tools. This includes development environments such as Microsoft Visual C# .NET and Microsoft Visual Basic .NET.

The following sections describe the steps for integrating ProfileKit with .NET WPF applications.

ProfileKit Assemblies

ProfileKit includes WPF compatible .NET assemblies for .NET Framework and .NET to support most applications' target framework. If you need a specific target framework, then contact Chant Product Support.

To access ProfileKit .NET classes within a WPF application, add project references to the following nuget package:

• 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.
• Select the Chant.ProfileKit.Windows package and press the Install button.

To access the ProfileKit .NET classes within your application, add references to the Chant shared and ProfileKit assemblies in your code.

using System;
...
using Chant.ProfileKit.Windows;
using Chant.Shared.Windows;

Imports Chant.ProfileKit.Windows
Imports Chant.Shared.Windows
Class MainWindow
...

Platform Target

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

Object Instantiation

Declare a global variable for the ProfileKit class, instantiate an instance, add the event handler, and set the credentials.

private NProfileKit _ProfileKit;
private NSAPI5Profile _Profile = null;
private NSAPI5Recognizer _Recognizer = null;
public MainWindow()
{
    InitializeComponent();
    // Instantiate ProfileKit
    _ProfileKit = new NProfileKit();
    if (_ProfileKit != null)
    {
        // Set credentials
        _ProfileKit.SetCredentials("Credentials");
        _Recognizer = _ProfileKit.CreateSAPI5Recognizer();
        if (_Recognizer != null)
        {
            _Recognizer.APIError += this.Recognizer_APIError;
        }
    }
}

Dim _ProfileKit As NProfileKit
Dim WithEvents _Recognizer As NSAPI5Recognizer
Dim _Profile As NSAPI5Profile

Private Sub Window_Loaded(ByVal sender As System.Object, ByVal e As System.Windows.RoutedEventArgs)
    Dim engine As NChantEngine
    ' Instantiate ProfileKit
    _ProfileKit = New NProfileKit()
    If (_ProfileKit IsNot Nothing) Then
        ' Set credentials
        _ProfileKit.SetCredentials("Credentials")
        _Recognizer = _ProfileKit.CreateSAPI5Recognizer()
    End If
End Sub

These applications require the applicable ProfileKit Speech API library in the same directory as the application .exe.

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 Recognizer_APIError(object sender, ChantAPIErrorEventArgs e)
{
    // Format transcript message
    string errorMsg = "";
    errorMsg = "(" + e.RC.ToString() + ") ";
    errorMsg += " " + e.Function.ToString() + " ";
    errorMsg += e.Message;
    ...
}

Private Sub Recognizer_APIError(ByVal sender As System.Object, ByVal e As ChantAPIErrorEventArgs) Handles _Synthesizer.APIError
    Dim errorMsg As String
    ' Format transcript message
    errorMsg = "(" + e.RC.ToString() + ") "
    errorMsg += " " + e.Function.ToString() + " "
    errorMsg += e.Message
    ...
End Sub

Development and Deployment Checklist

When developing and deploying .NET 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 developing and deploying applications targeting Microsoft SAPI5, Micosoft Speech Platform, and Nuance Dragon NaturallySpeaking speech technologies:

Sample Projects

.NET WPF sample projects that use nuget packages may be found in the following directory of the vssamples.zip download:

• Applications that target Microsoft SAPI5, Micosoft Speech Platform, and Nuance Dragon NaturallySpeaking speech tecnologies:
  • Chant\ProfileKit 10\NET\Windows\cs and
  • Chant\ProfileKit 10\NET\Windows\vb.