interface MAGES::Experimental::EmbodimentJARIA::ITextToSpeechHandler¶

Overview¶

Interface for handling text to speech. More…

interface ITextToSpeechHandler
{
    // properties

    Agent TheAgent;
    Queue Subtitles;
    Queue AudioClips;
    bool IsSynthesizing;
    bool IsCanceled;

    // methods

    Task HandleTextAsync(string text);
    void Startup();
    void StopVoice();
    void ClearQueue();
    void SyncMessage(string message);
};

// direct descendants

class AzureTextHandler;

Detailed Documentation¶

Interface for handling text to speech.

Properties¶

Agent TheAgent

Gets or sets the Agent script.

Queue Subtitles

Gets or sets the subtitles queue for the subtitles of the audio clips.

Queue AudioClips

Gets or sets the audio clips queue.

bool IsSynthesizing

Gets or sets a value indicating whether the Text Handler is synthesizing.

bool IsCanceled

Gets or sets a value indicating whether the Text Handler is canceled.

Methods¶

Task HandleTextAsync(string text)

Handles the text to be spoken.

Parameters:

Returns:

Task.

void Startup()

Starts up the text handler.

void StopVoice()

Called to stop the voice.

void ClearQueue()

Called to clear text handlers queue.

void SyncMessage(string message)

Called to pass the message that is to be synced.

///

Parameters: