TextToSpeech Class

TextToSpeech Class

Can convert text input to audio data.

Inheritance Hierarchy

SystemObject
  Ozeki.CommonDisposableClass
    Ozeki.MediaAbstractMediaSenderAudioData, AudioFormat
      Ozeki.MediaAudioSender
        Ozeki.MediaMediaStreamSender
          Ozeki.MediaTimerBasedMediaStreamHandler
            Ozeki.MediaAudioStreamPlayback
              Ozeki.MediaWaveStreamPlayback
                Ozeki.MediaTextToSpeech

Namespace: Ozeki.Media
Assembly: OzekiSDK (in OzekiSDK.dll) Version: 1.8.12.0 (1.8.12)

Syntax

C++

Copy

public class TextToSpeech : WaveStreamPlayback

Public Class TextToSpeech
	Inherits WaveStreamPlayback

public ref class TextToSpeech : public WaveStreamPlayback

type TextToSpeech =  
    class
        inherit WaveStreamPlayback
    end

The TextToSpeech type exposes the following members.

Constructors

	Name	Description
	TextToSpeech	Initializes a new instance of the TextToSpeech class
	TextToSpeech(AudioFormat)	Initializes a new instance of the TextToSpeech class

Top

Methods

	Name	Description
	AddAndStartText	Adds a text to the waiting queue and begins the playing with the first text in the queue.
	AddText	Adds text to the waiting queue.
	AddTTSEngine
	ChangeLanguage(String)	Changes the language of the TTS engine.
	ChangeLanguage(String, String)	Changes the language of the TTS engine.
	ChangeVoice	Changes the voice of the TTS engine.
	Clear	Clears the input queue.
	Dispose	Disposes the object. (Inherited from DisposableClass.)
	Dispose(Boolean)	Releases the unmanaged resources used by the TextToSpeech and optionally releases the managed resources (Overrides TimerBasedMediaStreamHandlerDispose(Boolean).)
	Finalize	(Inherited from DisposableClass.)
	GetAudioData	(Inherited from AudioStreamPlayback.)
	GetAudioFormat	(Inherited from MediaStreamSender.)
	GetAvailableVoices	Returns the collection of available Text-To-Speech voice.
	GetCurrentEngine	Get the current tts engine
	LoadReader	Initializes the file reader which will read the content of the stream. (This method will be invoked in the LoadStream(Stream) method.) (Inherited from WaveStreamPlayback.)
	LoadStream	(Inherited from AudioStreamPlayback.)
	NextText	Skips the actual text and begins playing the next text.
	Pause	Pauses the streaming. (If the streaming is already paused then does nothing.) (Inherited from MediaStreamSender.)
	ReceiverConnected	This will be called when this object has been connected to an audio receiver. (Inherited from AudioSender.)
	ReceiverDisconnected	This will be called when this object has been disconnected from an audio receiver. (Inherited from AudioSender.)
	SendMediaData	(Inherited from AbstractMediaSenderTData, TFormat.)
	SetPlaybackWaveStream	Changes the playback stream to the given stream. (Inherited from AudioStreamPlayback.)
	SetPreferredSendFormats	(Inherited from AbstractMediaSenderTData, TFormat.)
	Start	Starts playing the queue. (Overrides TimerBasedMediaStreamHandlerStart.)
	Stop	Stops the streaming. (Inherited from TimerBasedMediaStreamHandler.)
	TimerTick	This will be called when the built-in timer ticks. (Inherited from AudioStreamPlayback.)

Top

Fields

	Name	Description
	buffer	(Inherited from AudioStreamPlayback.)
	OutputFormat	(Inherited from MediaStreamSender.)
	Sync	(Inherited from MediaStreamSender.)

Top

Properties

	Name	Description
	Cached	Gets a boolean value indicating whether the playback stream is cached in the memory. (Inherited from AudioStreamPlayback.)
	ID	(Inherited from DisposableClass.)
	Interval	Gets the time between the send events (in milliseconds). (Inherited from TimerBasedMediaStreamHandler.)
	IsStreaming	Gets or sets a value that is true if the wave is streaming, otherwise false. (Inherited from MediaStreamSender.)
	Loop
	MediaFormat	(Inherited from AudioStreamPlayback.)
	Position	Gets or sets the current position in the audio stream (Inherited from MediaStreamSender.)
	Rate	Gets or sets the playback rate of the speech. (Range: -10 - 10)
	Stream	Gets the stream (Inherited from MediaStreamSender.)
	Texts
	Voice

Top

Events

	Name	Description
	MediaDataSent	(Inherited from AbstractMediaSenderTData, TFormat.)
	Stopped	Occurs when the audio recording or playing has been stopped (Inherited from MediaStreamSender.)

Top

Remarks

The text inputs will be placed in a queue. Only one text is being played at a time and when it is finished the next text will be played. Custom text-to-speech implementation can be added to the engine.

Reference

Ozeki.Media Namespace