Tizen 2.1 base
[framework/osp/speech.git] / src / inc / FUixSpeech_ITextToSpeech.h
1 //
2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
4 //
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 //     http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 //
17
18 /**
19  * @file    FUixSpeech_ITextToSpeech.h
20  * @brief   This is the header file of the _ITextToSpeech class.
21  */
22
23 #ifndef _FUIX_SPEECH_INTERNAL_ITEXT_TO_SPEECH_H_
24 #define _FUIX_SPEECH_INTERNAL_ITEXT_TO_SPEECH_H_
25
26 #include <FBaseDataType.h>
27 #include <FBaseObject.h>
28 #include <FOspConfig.h>
29 #include <FUixSpeechTextToSpeechTypes.h>
30 #include <FUixSpeechITextToSpeechEventListener.h>
31
32 namespace Tizen { namespace Base { namespace Collection {
33     class IList;
34 }}}
35 namespace Tizen { namespace Locales {
36     class Locale;
37 }}
38
39 namespace Tizen { namespace Uix { namespace Speech
40 {
41
42 class _ITextToSpeech
43 {
44 public:
45     virtual ~_ITextToSpeech(void){}
46
47     virtual result Construct(ITextToSpeechEventListener& listener) = 0;
48     virtual result Initialize(void) = 0;
49
50     virtual result Speak(const Tizen::Base::String& text, TextToSpeechRequestMode requestMode) = 0;
51     virtual result Stop(void) = 0;
52     virtual result Pause(void) = 0;
53     virtual result Resume(void) = 0;
54
55     virtual result SetLocale(const Tizen::Locales::Locale& locale) = 0;
56     virtual Tizen::Locales::Locale GetLocale(void) const = 0;
57     virtual const Tizen::Base::Collection::IList* GetSupportedLocales(void) const = 0;
58     virtual bool IsLocaleSupported(const Tizen::Locales::Locale& locale) const = 0;
59
60     virtual result SetSpeechRate(TextToSpeechSpeechRate speechRate) = 0;
61
62     virtual TextToSpeechStatus GetCurrentStatus(void) const = 0;
63
64 }; // _ITextToSpeech
65
66 } } } // Tizen::Uix::Speech
67 #endif