vsdk 8.1.0
 
Loading...
Searching...
No Matches
Vsdk::Tts Namespace Reference

Namespaces

namespace  Events
 

Classes

class  Channel
 Can perform voice synthesis. More...
 
class  Engine
 Responsible for creation of Channel instances. More...
 

Typedefs

using ChannelPtr = std::shared_ptr< Channel >
 
using ChannelVoices = std::map< std::string, std::vector< std::string > >
 
using EnginePtr = std::shared_ptr< Engine >
 

Enumerations

enum class  ChannelEventCode {
  NativeEvent , GenerationStarted , GenerationEnded , ProcessFinished ,
  TextRewritten , Marker , WordMarkerStart , WordMarkerEnd
}
 
enum class  ChannelErrorCode { NativeError }
 

Functions

auto synthesizeFromText (ChannelPtr const &channel, std::string const &text) -> Vsdk::Audio::Buffer
 Synthesizes audio data from a SSML or raw text string.
 
auto synthesizeFromFile (ChannelPtr const &channel, std::string const &path) -> Vsdk::Audio::Buffer
 Synthesizes audio data from a SSML or raw text file.
 

Typedef Documentation

◆ ChannelPtr

using Vsdk::Tts::ChannelPtr = typedef std::shared_ptr<Channel>

◆ ChannelVoices

using Vsdk::Tts::ChannelVoices = typedef std::map<std::string, std::vector<std::string> >

◆ EnginePtr

using Vsdk::Tts::EnginePtr = typedef std::shared_ptr<Engine>

Enumeration Type Documentation

◆ ChannelEventCode

enum class Vsdk::Tts::ChannelEventCode
strong
Enumerator
NativeEvent 
GenerationStarted 
GenerationEnded 
ProcessFinished 
TextRewritten 
Marker 
WordMarkerStart 
WordMarkerEnd 

◆ ChannelErrorCode

enum class Vsdk::Tts::ChannelErrorCode
strong
Enumerator
NativeError 

This one is raised when an unmanaged native error is raised.

Function Documentation

◆ synthesizeFromText()

auto Vsdk::Tts::synthesizeFromText ( ChannelPtr const &  channel,
std::string const &  text 
) -> Vsdk::Audio::Buffer

Synthesizes audio data from a SSML or raw text string.

Warning
This is a synchronous call! The longer and/or more complex the text to synthesize, the longer it will take for the call to finish.

◆ synthesizeFromFile()

auto Vsdk::Tts::synthesizeFromFile ( ChannelPtr const &  channel,
std::string const &  path 
) -> Vsdk::Audio::Buffer

Synthesizes audio data from a SSML or raw text file.

Warning
This is a synchronous call! The longer and/or more complex the text to synthesize, the longer it will take for the call to finish.