Class TTSPlayer

View Source

Definition

Namespace:
Tizen.NUI
Assembly:
Tizen.NUI.dll
API Level:
3

The Text-to-speech (TTS) player.


                
C#

                

                    
Copy

                    

                

            
public class TTSPlayer : BaseHandle, IDynamicResourceHandler, IElement, INameScope, IElementController, System.IDisposable
Inheritance
Object
BindableObject
Element
BaseHandle
TTSPlayer
Implements
IDynamicResourceHandler
INameScope
System.IDisposable

Properties

View Source

Instance

Gets the singleton of the TTSPlayer object.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static TTSPlayer Instance { get; }
Property Value
Type Description
TTSPlayer
API Level: 5

Methods

View Source

Get()

Gets the singleton of the TTS player for the default mode.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static TTSPlayer Get()
Returns
Type Description
TTSPlayer

A handle of the TTS player for the default mode.
API Level: 3
View Source

Get(TTSPlayer.TTSMode)

Gets the singleton of the TTS player for the given mode.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static TTSPlayer Get(TTSPlayer.TTSMode mode)
Parameters
Type Name Description
TTSPlayer.TTSMode mode

The mode of TTS player.
Returns
Type Description
TTSPlayer

A handle of the TTS player for the given mode.
API Level: 3
View Source

GetState()

Gets the current state of the player.

Declaration

                
C#

                

                    
Copy

                    

                

            
public TTSPlayer.TTSState GetState()
Returns
Type Description
TTSPlayer.TTSState

The current TTS state.

Remarks

The TTS player needs to be initialized.

API Level: 3
View Source

Pause()

Pauses the currently playing utterance.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Pause()
Remarks

The TTS player needs to be initialized.

API Level: 3
View Source

Play(String)

Starts playing the audio data synthesized from the specified text.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Play(string text)
Parameters
Type Name Description
String text

The text to play.
Remarks

The TTS player needs to be initialized.

API Level: 3
View Source

Resume()

Resumes the previously paused utterance.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Resume()
Remarks

The TTS player needs to be initialized.

API Level: 3
View Source

Stop()

Stops playing the utterance.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Stop()
Remarks

The TTS player needs to be initialized.

API Level: 3

Events

View Source

StateChanged

State changed event.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<TTSPlayer.StateChangedEventArgs> StateChanged
Event Type
Type Description
EventHandler<TTSPlayer.StateChangedEventArgs>
API Level: 3

Implements

Extension Methods