Friday, July 2, 2010

Silverlight 4: Text to Speech application using COM API


imageHave you ever heard of Text to Speech engine? “Yes” I think. Yes, it is not a new thing in the Computer World. It was available since Windows 98 (as much as I can recall) but it is completely new in Silverlight. You can now use the Silverlight application to give an API call to the SAPI Engine which will convert the text to voice. Sounds Good? This is achievable using the COM APIs only.

 

Here I will describe you how to use COM API to give a TTS call to the SAPI Engine. After reading this topic here, you will be able to write your own code to develop your own application having the Text to Speech functionality in Silverlight 4.

Prerequisite

To develop this application, you need the following tools:

  1. Microsoft Visual Studio 2010
  2. Silverlight Tools for Visual Studio 2010

Once you set up your development environment, create a Silverlight project. If you are new to Silverlight application development and want to know about Silverlight and want to learn how to create a new Silverlight application, read the Silverlight Tutorial.

 

Setting up the Project for OOB

Before doing anything, you need to set up some configuration. Yes, because the COM API only works in Silverlight Out-of-Browser application, you need to change the project settings for that.

  • Right click on the Silverlight project and open the Properties.
  • Click the CheckBox “Enable running application out of the browser” as shown below and then click on the “Out-of-Browser Settings” button.

image

 

  • Once the Settings page has been open, set the desired options from the screen. Be sure that, you checked “Show install menu” and “Require elevated trust when running outside the browser”.

image
Once you done with this settings, you will be able to install this web version as an Out-of-Browser application.

 

Setting up the Project for dynamic Keyword

Now you have to add a DLL assembly reference to your project. As we will use dynamic keyword in our example and hence we need to add the “Microsoft.CSharp” assembly reference.

  • To do this, right click on the Silverlight project and chose “Add Reference” from the menu.
image
  • Now from the “Add Reference” dialog find the “Microsoft.CSharp”, select it and click Ok. This will add the assembly reference to the project.

image

 

Designing the UI

Once all the settings are done it is time to design our UI. Add a TextBox and a Button inside the MainPage.xaml file and set name to those. In our example, I am using “txtMessage” as the name of the TextBox and “btnSpeak” as the name of the Button.

 

Here is my XAML code for you:

<UserControl x:Class="Silverlight_4_Text_To_Speech_Demo.MainPage"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006">
    <StackPanel x:Name="LayoutRoot" Orientation="Vertical" Width="320">
        <TextBlock FontWeight="Bold" FontSize="14" Text="Silverlight 4 Text-To-Speech Demo" 
                    Margin="10" TextAlignment="Center" />
        <TextBlock Text="Enter some text and click on the 'Speak' button to read out 
the entered text."
Margin="10" TextWrapping="Wrap" /> <StackPanel Orientation="Horizontal"> <TextBox x:Name="txtMessage" Width="200" Height="100" Margin="5" AcceptsReturn="True" TextWrapping="Wrap" /> <Button x:Name="btnSpeak" Content="Speak" Width="100" Height="100" Margin="5" Click="btnSpeak_Click" /> </StackPanel> </StackPanel> </UserControl>

If you run this, it will look like below snapshot:

image

Here, we will use the TextBox to enter some texts inside it and once we click on the “Speak” button, it will start reading out the entered text. To do this, register the button click event and go for implementing the Text-to-Read functionality in our code behind file.

Playing with the Code

Lets start playing with the code now. Open the MainPage.xaml.cs and inside the button click event, first create an object of Sapi.SpVoice from the AutomationFactory and assign it to a dynamic variable.

dynamic textToSpeech = AutomationFactory.CreateObject("Sapi.SpVoice");

Set the Volume for the readout text by setting the Volume property of the Sapi object instance to 100. This will produce a full volume. Then call the Speak() method by passing the inserted text as a parameter to it.

Here is the full code snippet:

private void btnSpeak_Click(object sender, RoutedEventArgs e)
{
    if (App.Current.IsRunningOutOfBrowser && App.Current.HasElevatedPermissions)
    {
        dynamic textToSpeech = AutomationFactory.CreateObject("Sapi.SpVoice");
        textToSpeech.Volume = 100;
        textToSpeech.Speak(txtMessage.Text);
    }
    else
    {
        MessageBox.Show("Please install it as Trusted Out-of-Browser application.");
    }
}

Party smile Hoho, our application is ready to run now. Build your solution for any errors. If succeeded, run the application by pressing CTRL + F5. Install the application as Silverlight Out-of-Browser application first. To do this, right click on the Silverlight UI and click “Install” from the context menu. Now follow the steps mentioned in the setup UI.

Once successfully installed as Out of Browser, it will open the installed one from your local drive. Enter some text inside the TextBox and click on the “Speak” button. You will hear the text readout by someone. Yes, that’s it. Your application now supports text to speech.

image

If you like this feature, download the sample application and run in your local to see the live demo. Source Code for this article is also available.

Don’t forget to Vote this Article Up and leave your feedbacks. Enjoy working with the new features of Silverlight 4.

del.icio.us Tags: ,


Free Email Newsletter:
Get article updates by Email (We will not share) | Subscribe to RSS Feed
* Click confirmation link sent in email * If you didn't see the email in Inbox, check spam folder.

Submit Feedback or Queries

Encourage the Author by providing feedback about the post. If you have any queries on the same topic, don't hesitate to ask your questions here. I will try to answer you at the earliest.





Post your feedback or queries

Reply

Ivan said...

Thank you for sharing this code. I have never thought that Silverlight can do such things.

Awesome one. I really liked it. Thankyou again for sharing this code.


Reply

Win7Guru said...

Do you think that you could post an Expression Blend 4 version of this tutorial?


Reply

Kunal Chowdhury said...

It is a simple UI and from the images and the XAML code you can easily understand that you need only some TextBlocks, TextBox and button. If you need more help, let me know.


Reply

RajeshKumar.S said...

Excellent Article to understand the Text To Speech Library, but also get to know OOB Application, really useful to me


Reply

Kunal Chowdhury said...

Thanks Rajesh for the feedback.


Reply

Anonymous said...

Hi Kunal,

Dim textToSpeech As Dynamic = AutomationFactory.CreateObject("Sapi.SpVoice")
textToSpeech.Volume = 100
textToSpeech.Speak(txtMessage.Text)

I've an error in my Dim as dynamic.
Error is "Type Expected".

please help.

thanks so much.

Enan


Reply

Kunal Chowdhury said...

I think you are using VB.Net. VB.Net doesn't support "dynamic" keyword. It is a new feature in C# 4.0.

Regards,
Kunal


Reply

Anonymous said...

Oh I see...

Thanks for the information..

Nice Work.

I've been following all your post...
Hope you can update me with your upcoming Silverlight Tutorials.

Regards.

Enan


 
Copyright © Kunal's Blog by Kunal Chowdhury. All Rights Reserved.