Xamarin.Forms- Dependency Service (Text To Speech)

Here I am going to explain how we can use the Text to Speech feature in Xamarin.Forms without using any dependency service plugin. It is a beautiful feature and yet simple. If we are not using any plugin, then it will not affect our app size.

Prerequisites

Xamarin.Forms project with PCL approach. 

STEP 1 - Create an Interface class in PCL

Right-click on PCL project ->Add New-> EmptyInterface. Create this Interface class with the name of “ItextToSpeech”.

Create a method inside the class as I am showing in the image.

using System;
namespace DemoTest.Inerface
{
    public interface ItextToSpeeech
    {
        void Speak(string text);
    }
}

Now, the interface is created successfully.

STEP 2 - Implement interface method platform-wise

First, we will do it for Android.

Right-click on the .Droid project and add a new class with the name of “TtImplementation”.

Right-click -> Add New-> EmptyClass

Now, we need to do the implementation of that method which we have created in the Interface. For doing this, just follow my screenshot.

[assembly : Dependency(typeof (TtImplementation)]
namespace DemoTest.Droid
{
    public class TtImplementation: java.Lang.Object, ItextToSpeech, TextToSpeech.IOnInitListener
    {
        TextToSpeech speaker;
        string toSpeak;
        public void Speak(string text)
        {
            toSpeak = text;
            if(speaker==null)
            {
                speaker = new TextToSpeech(Forms.Context, this);
            }
            else
            {
                speaker.Speak(toSpeak, QueueMode.Flush, null, null);
            }
        }
        public void OnInit(OperationResult status)
        {
            if(status.Equals(OperationResult.Success))
            {
                speaker.Speak(toSpeak, QueueMode.flush, null, null);
            }
        }
    }
}

Here, implementation of “Speak ” method in .Droid is done.

STEP 3 - FOR iOS

Here also, we will do the same but for iOS. We will create a new class with the name of “TtImplementation” in the iOS project.

For creating this, just right-click on .iOS project -> Add New-> EmptyClass.

For implementing the Speak method which we have created in the interface, just follow the below screenshot.

[assembly : Dependency(typeof (TtImplementation)]
namespace DemoTest.iOS
{
    public class TtImplementation: ItextToSpeech
    {
        public TtImplementation()
        {

        }
        public void Speak(string text)
        {
            var speechSynthesizer = new AVSpeechSynthesizer();
            var speechUtterance = new AVSpeechUtterance(text)
            {
                Rate= AVSpeechUtterance.MaximumSpeechRate/2,
                Voice= AVSpeechSynthesisVoice.FromLanguage("en-Us"),
                Volume=0.5f,
                PitchMultiplier= 1.0f
            };

            speechSynthesizer.SpeakUtterance(speechUtterance);

        }
    }
}

All the implementation is done. We have successfully implemented the TextToSpeech feature in our Xamarin.Forms project without using any plugin.

Now, it’s time to check how it is working on both the platforms.

So for testing, I have created a simple application which I am going to show you. So just follow my instructions.

STEP 4 - Create UI for testing

I have created a very simple UI where I have taken 2 Entries,1 Button, and 1 label control.

Go to your Main.xaml file, open it, and write the code as I have written in the following screenshot.

 

 

<?xml version="1.0" encoding="utf-8" ?>

<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"

xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"

xmlns:local="clr-namespace:DemoTest"

x:Class="DemoTest.DemoTestPage">

<ContentPage.Padding>

<OnPlatform x:TypeArgument="Thickness">

<OnPlatform.Platforms>

<On Platform="iOS" Value="0,20,0,0"/>

<On Platform="Android" Value="0,0,0,0"/>

</OnPlatform.Platforms>

</OnPlatform>

</ContentPage.Padding>

<StackLayout Orientation="Vertical">

<Entry x:Name="valueAentry"

AutomationId="e1"

FontSize="40"/>

<Entry x:Name="valueBentry"

AutomationId="e2"

FontSize="40"/>

<Button Text="ADD"

BackgroundColor="Purple"

TextColor="White"

FontSize="40"

AutomationId="btnAdd"

Clicked="Add_Clicked" />

<Label x:Name="lblresult" FontSize="40" AutomationId="lblRES" />

</StackLayout>

</ContentPage>

You can see that I have created a simple UI.

As I mentioned previously, I have taken a button. So, for that button, I have also created a Click event.

 Open MainPage.xaml.cs file in your PCL project and write the following code.

namespace DemoTest
{
    public partial class DemoTestPage : ContentPage
    {
        public DemoTestPage()
        {
            InitializeComponent();
        }

        void Add_Clicked(Object sender, System.EventArgs e)
        {
            lblresult.Text = "Result" + (Convert.ToInt32(valueAentry.Text) + Convert.ToInt32(valueBentry.Text)).ToString();
            DependencyService.Get<ItextToSpeech>().Speak(lblresult.Text);
        }
    }
}

In this code, we are taking the values of entry1 and entry2 and for click event, we have written a program for SUM.

And the result is populated in level.

So, you we can test it. Just build the program and deploy on your simulator. After that, enter the values and click on the ADD button.

Now you will be able to listen to the value.

 

Conclusion

We have done a good practice for TextToSpeech implementation. We can implement it in our project based on the project requirement. This is very beneficial because we don’t have to use any plugin for this functionality.