Class

SpielSpeaker

Description [src]

final class Spiel.Speaker : GObject.Object {
  /* No available fields */
}

A virtual speaker for speech synthesis

The SpielSpeaker class represents a single “individual” speaker. Its primary method is spiel_speaker_speak() which queues utterances to be spoken.

This class also provides a list of available voices provided by DBus speech providers that are activatable on the session bus.

SpielSpeakers initialization may perform blocking IO if it the first instance in the process. The default constructor is asynchronous (spiel_speaker_new()), although there is a synchronous blocking alternative (spiel_speaker_new_sync()).

Ancestors

Constructors

spiel_speaker_new_finish

Finishes an operation started with spiel_speaker_new().

spiel_speaker_new_sync

Synchronously creates a SpielSpeaker.

Functions

spiel_speaker_new

Asynchronously creates a SpielSpeaker.

Instance methods

spiel_speaker_cancel

Stops the current utterance from being spoken and dumps the utterance queue.

spiel_speaker_get_providers

Fetches the speech providers that offer voices to this speaker.

spiel_speaker_get_voices

Fetches the voices available to this speaker.

spiel_speaker_pause

Pause the given speaker. If an utterance is being spoken, it will pause until spiel_speaker_resume() is called. If the speaker isn’t speaking, calling spiel_speaker_speak() will store new utterances in a queue until spiel_speaker_resume() is called.

spiel_speaker_resume

Resumes the given paused speaker. If the speaker isn’t pause this will do nothing.

spiel_speaker_speak

Speak the given utterance. If an utterance is already being spoken the provided utterances will be added to a queue and will be spoken in the order recieved.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GAsyncInitable (3)
g_async_initable_init_async

Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements GInitable you can optionally call g_initable_init() instead.

unstable since: 2.22

g_async_initable_init_finish

Finishes asynchronous initialization and returns the result. See g_async_initable_init_async().

unstable since: 2.22

g_async_initable_new_finish

Finishes the async construction for the various g_async_initable_new calls, returning the created object or NULL on error.

unstable since: 2.22

Methods inherited from GInitable (1)
g_initable_init

Initializes the object implementing the interface.

unstable since: 2.22

Properties

Spiel.Speaker:paused

The speaker is in a paused state.

Spiel.Speaker:providers

The list of available SpielProviders that offer voices.

Spiel.Speaker:sink

The gstreamer sink this speaker is connected to.

Spiel.Speaker:speaking

The speaker has an utterance queued or speaking.

Spiel.Speaker:voices

The list of available SpielVoices that can be used in an utterance.

Signals

Spiel.Speaker::mark-reached

Emitted when an SSML mark element is reached.

Spiel.Speaker::range-started

Emitted when a range will be spoken in a given utterance. Not all voices are capable of notifying when a range will be spoken.

Spiel.Speaker::sentence-started

Emitted when a sentence will be spoken in a given utterance. Not all voices are capable of notifying when a sentence will be spoken.

Spiel.Speaker::utterance-canceled

Emitted when a given utterance has been canceled after it has started speaking.

Spiel.Speaker::utterance-error

Emitted when a given utterance has failed to start or complete.

Spiel.Speaker::utterance-finished

Emitted when a given utterance has completed speaking.

Spiel.Speaker::utterance-started

Emitted when the given utterance is actively being spoken.

Spiel.Speaker::word-started

Emitted when a word will be spoken in a given utterance. Not all voices are capable of notifying when a word will be spoken.

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct SpielSpeakerClass {
  GObjectClass parent_class;
  
}
No description available.
Class members
parent_class: GObjectClass
No description available.