- Main Page
- Modules
- Namespaces
- Classes
- Files
- Related Pages
- Examples

- Alphabetical List
- Class List
- Class Hierarchy
- Class Members

# speech_sink Class Reference

`#include <fastformat/sinks/speech.hpp>`

List of all members.

## Detailed Description

Sink for translating a statement into speech.

Note:
  This component currently is only available on Windows, because it uses the Microsoft Speech API (SAPI). If anyone cares to contribute implementations for Linux or Mac OS-X, that would be very welcome.

## Public Types
typedef speech_sink | class_type
| This type.
typedef stlsoft::ref_ptr < ISpVoice > | voice_type
| The underlying voice type.
## Public Member Functions
| speech_sink (int flags=0)
| Constructs an instance.
voice_type | get () const
class_type & | write (int, size_t cchTotal, size_t numResults, ff_string_slice_t const *results)
| Outputs the results.

## Member Typedef Documentation

typedef speech_sink class_type

This type.

typedef stlsoft::ref_ptr<ISpVoice> voice_type

The underlying voice type.

## Constructor & Destructor Documentation

speech_sink | ( | int | flags = `0` | ) | `[inline, explicit]`

Constructs an instance.

## Member Function Documentation

class_type& write | ( | int | ,
|  | size_t | cchTotal,
|  | size_t | numResults,
|  | ff_string_slice_t const * | results |
| ) |  |  | `[inline]`

Outputs the results.

The documentation for this class was generated from the following file:

- fastformat/sinks/speech.hpp

FastFormat Library documentation © Matthew Wilson, 2006-2009 |