/// <summary>
/// The token event
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ResultEvent
{
/// <summary>
/// Event when the recognition full or last result is ready
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
FinalResult = 0,
/// <summary>
/// Event when the recognition partial result is ready
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
PartialResult,
/// <summary>
/// Event when the recognition has failed
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Error
};
/// <summary>
/// Enumeration representing the result message
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ResultMessage
{
/// <summary>
/// No Error
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
None,
/// <summary>
/// Recognition failed because the speech started too soon.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
TooSoon,
/// <summary>
/// Recognition failed because the speech is too short.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
TooShort,
/// <summary>
/// Recognition failed because the speech is too long.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
TooLong,
/// <summary>
/// Recognition failed because the speech is too quiet to listen.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
TooQuiet,
/// <summary>
/// Recognition failed because the speech is too loud to listen.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
TooLoud,
/// <summary>
/// Recognition failed because the speech is too fast to listen.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
TooFast
};
/// <summary>
/// Enumeration for the Token type
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum TimeEvent
{
/// <summary>
/// Event when the token is beginning type
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Beginning = 0,
/// <summary>
/// Event when the token is middle type
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Middle = 1,
/// <summary>
/// Event when the token is end type
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
End = 2
};
/// <summary>
/// Enum for Error values that can occur
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Error
{
/// <summary>
/// Successful, No error
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
None,
/// <summary>
/// Out of Memory
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
OutOfMemory,
/// <summary>
/// I/O error
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
IoError,
/// <summary>
/// Invalid parameter
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
InvalidParameter,
/// <summary>
/// No answer from the STT service
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
TimedOut,
/// <summary>
/// Device or resource busy
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
RecorderBusy,
/// <summary>
/// Network is down
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
OutOfNetwork,
/// <summary>
/// Permission denied
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
PermissionDenied,
/// <summary>
/// STT NOT supported
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
NotSupported,
/// <summary>
/// Invalid state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
InvalidState,
/// <summary>
/// Invalid language
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
InvalidLanguage,
/// <summary>
/// No available engine
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
EngineNotFound,
/// <summary>
/// Operation failed
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
OperationFailed,
/// <summary>
/// Not supported feature of current engine
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
NotSupportedFeature,
/// <summary>
/// Recording timed out
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
RecordingTimedOut,
/// <summary>
/// No speech while recording
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
NoSpeech,
/// <summary>
/// Progress to ready is not finished
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
InProgressToReady,
/// <summary>
/// Progress to recording is not finished
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
InProgressToRecording,
/// <summary>
/// Progress to processing is not finished
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
InProgressToProcessing,
/// <summary>
/// Service reset
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
ServiceReset
};
/// <summary>
/// Enumeration for Recognition Types
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum RecognitionType
{
/// <summary>
/// Free form dictation
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Free,
/// <summary>
/// Continuous free dictation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Partial,
/// <summary>
/// Search
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Search,
/// <summary>
/// Web Search
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
WebSearch,
/// <summary>
/// Map
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Map
};
/// <summary>
/// Enumeration for the State types
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum State
{
/// <summary>
/// Created state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Created = 0,
/// <summary>
/// Ready state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Ready = 1,
/// <summary>
/// Recording state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Recording = 2,
/// <summary>
/// Processing state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Processing = 3,
/// <summary>
/// Unavailable
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Unavailable
};
/// <summary>
/// Enumeration for the Silence Detection types
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum SilenceDetection
{
/// <summary>
/// Silence detection type - False
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
False = 0,
/// <summary>
/// Silence detection type - True
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
True = 1,
/// <summary>
/// Silence detection type - Auto
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Auto = 2
};
/// The STT service always works in the background as a server. If the service is not working, client library will invoke it and client will communicate with it.
/// The service has engines and the recorder so client does not have the recorder itself. Only the client request commands to the STT service for using STT.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class SttClient : IDisposable
{
private IntPtr _handle;
/// <summary>
/// Constructor to create a STT instance.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
- /// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reaons
- /// 1. Out Of Memory
- /// 2. Operation Failed
- /// 3. STT Not Supported
- /// 4. Permission Denied
- /// </exception>
+ /// </privilege>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
+ /// <exception cref="InvalidOperationException"> This Exception can be due to Operation Failed. </exception>
+ /// <exception cref="OutOfMemoryException"> This Exception can be due to Out of Memory. </exception>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
public SttClient()
{
IntPtr handle;
/// <summary>
/// Event to be invoked when the recognition is done.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<RecognitionResultEventArgs> RecognitionResult
{
add
/// <summary>
/// Event to be invoked when STT state changes.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<StateChangedEventArgs> StateChanged
{
add
/// <summary>
/// Event to be invoked when an error occurs.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<ErrorOccuredEventArgs> ErrorOccured
{
add
/// <summary>
/// Event to be invoked when default laungage change.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<DefaultLanguageChangedEventArgs> DefaultLanguageChanged
{
add
/// <summary>
/// Event to be invoked to detect engine change.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<EngineChangedEventArgs> EngineChanged
{
add
/// The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code.
/// For example, "ko_KR" for Korean, "en_US" for American English.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <value>
+ /// Default language in STT.
+ /// </value>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
+ /// </privilege>
/// <returns>
/// Default Lanaguage string value.
/// </returns>
- public string GetDefaultLanguage
+ public string DefaultLanguage
{
get
{
/// <summary>
/// Gets the microphone volume during recording.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <value>
+ /// Recording volume in STT.
+ /// </value>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
- /// <precondition>
+ /// </privilege>
+ /// <pre>
/// The State must be Recording.
- /// </precondition>
- public float GetRecordingVolume
+ /// </pre>
+ public float RecordingVolume
{
get
{
/// <summary>
/// Gets the current STT state.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <value>
+ /// Current state of STT.
+ /// </value>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
+ /// </privilege>
/// <returns>
/// Current STT State value.
/// </returns>
- public State GetState
+ public State CurrentState
{
get
{
/// <summary>
/// This property can be used to get and set the current engine id.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
+ /// <value>
+ /// Current STT engine id.
+ /// </value>
+ /// <privilege>
+ /// http://tizen.org/privilege/recorder
+ /// </privilege>
/// <exception cref="InvalidOperationException">
/// This Exception can occur while setting due to the following reaons
- /// 1. Out Of Memory
- /// 2. Operation Failed
- /// 3. STT Not Supported
- /// 4. Permission Denied
- /// 5. Invalid State
- /// </exception>
- /// <exception cref="ArgumentException">
- /// This can happen if Improper EngineId is provided while setting the value.
+ /// 1. Operation Failed
+ /// 2. Invalid State
/// </exception>
- /// <precondition>
+ /// <exception cref="OutOfMemoryException"> This Exception can be due to Out of Memory. </exception>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <exception cref="ArgumentException"> This can happen if Improper EngineId is provided while setting the value. </exception>
+ /// <pre>
/// The State must be Created.
- /// </precondition>
+ /// </pre>
public string Engine
{
get
/// <summary>
/// Retrieves the time stamp of the current recognition result
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>
/// list of ResultTime
/// </returns>
+ /// <privilege>
+ /// http://tizen.org/privilege/recorder
+ /// </privilege>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
/// <remarks>
/// This function should only be called in RecognitionResult Event
/// </remarks>
- /// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reaons
- /// 1. Opearation Failed.
- /// 2. STT Not Supported
- /// 3. Permission Denied.
- /// </exception>
+ /// <exception cref="InvalidOperationException"> This Exception can be due to Opearation Failed. </exception>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
public IEnumerable<ResultTime> GetDetailedResult()
{
List<ResultTime> list = new List<ResultTime>();
/// <summary>
/// Gets the private data from stt engine.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="key">
/// The key string
/// </param>
/// <returns>
/// The Data Corresponding to the Key provided
/// </returns>
- /// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reaons
- /// 1. No Answer from STT Service
- /// 2. STT Not Supported
- /// 3. Invalid State
- /// </exception>
- /// <precondition>
+ /// <privilege>
+ /// http://tizen.org/privilege/recorder
+ /// </privilege>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
+ /// <exception cref="InvalidOperationException"> This Exception can be due to Invalid State. </exception>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="TimeoutException"> This Exception can be due to No Answer from STT Service. </exception>
+ /// <pre>
/// The State must be Ready.
- /// </precondition>
+ /// </pre>
public string GetPrivateData(string key)
{
string data;
/// <summary>
/// Sets the private data to stt engine.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="key">
/// The key string
/// </param>
/// <param name="data">
/// The data string
/// </param>
- /// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reaons
- /// 1. No Answer from STT Service
- /// 2. STT Not Supported
- /// 3. Invalid State
- /// </exception>
- /// <exception cref="ArgumentException">
- /// This can happen if Improper value is provided while setting the value.
- /// </exception>
- /// <precondition>
+ /// <privilege>
+ /// http://tizen.org/privilege/recorder
+ /// </privilege>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
+ /// <exception cref="InvalidOperationException"> This Exception can be due to Invalid State. </exception>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="TimeoutException"> This Exception can be due to No Answer from STT Service. </exception>
+ /// <exception cref="ArgumentException"> This can happen if Improper value is provided while setting the value. </exception>
+ /// <pre>
/// The State must be Ready.
- /// </precondition>
+ /// </pre>
public void SetPrivateData(string key, string data)
{
lock (thisLock)
/// <summary>
/// Gets the list of Supported Engine
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>
/// IEnumerable<SupportedEngine> list of supported engines
/// </returns>
- /// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reaons
- /// 1. Out Of Memory
- /// 2. Operation Failed
- /// 3. STT Not Supported
- /// 4. Permission Denied
- /// </exception>
+ /// <privilege>
+ /// http://tizen.org/privilege/recorder
+ /// </privilege>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
+ /// <exception cref="InvalidOperationException"> This Exception can be due to Operation Failed. </exception>
+ /// <exception cref="OutOfMemoryException"> This Exception can be due to Out of Memory. </exception>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
public IEnumerable<SupportedEngine> GetSupportedEngines()
{
List<SupportedEngine> engineList = new List<SupportedEngine>();
/// <summary>
/// Sets the app credential
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="credential">
/// The credential string
/// </param>
+ /// <privilege>
+ /// http://tizen.org/privilege/recorder
+ /// </privilege>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reaons
- /// 1. Out Of Memory
- /// 2. Operation Failed
- /// 3. STT Not Supported
- /// 4. Permission Denied
- /// 5. Invalid State
- /// </exception>
- /// <exception cref="ArgumentException">
- /// This can happen if Improper value is provided while setting the value.
+ /// 1. Operation Failed
+ /// 2. Invalid State
/// </exception>
- /// <precondition>
+ /// <exception cref="OutOfMemoryException"> This Exception can be due to Out of Memory. </exception>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <exception cref="ArgumentException"> This can happen if Improper value is provided while setting the value. </exception>
+ /// <pre>
/// The State must be Created.
- /// </precondition>
+ /// </pre>
public void SetCredential(string credential)
{
lock (thisLock)
/// <summary>
/// Connects to the STT service asynchronously.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
- /// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reasons
- /// 1. STT Not Supported
- /// 2. Permission Denied
- /// 3. Invalid State
- /// </exception>
- /// <precondition>
+ /// </privilege>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
+ /// <exception cref="InvalidOperationException"> This Exception can be due to Invalid State. </exception>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <pre>
/// The State must be Created.
- /// </precondition>
- /// <postcondition>
+ /// </pre>
+ /// <post>
/// If this function is successful, the STT state will be Ready
/// If this function is unsuccessful, ErrorOccured event will be invoked
- /// </postcondition>
+ /// </post>
public void Prepare()
{
lock (thisLock)
/// <summary>
/// Disconnects from the STT service.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
- /// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reasons
- /// 1. STT Not Supported
- /// 2. Permission Denied
- /// 3. Invalid State
- /// </exception>
- /// <precondition>
+ /// </privilege>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
+ /// <exception cref="InvalidOperationException"> This Exception can be due to Invalid State. </exception>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <pre>
/// The State must be Ready.
- /// </precondition>
- /// <postcondition>
+ /// </pre>
+ /// <post>
/// If this function is successful, the STT state will be Created
- /// </postcondition>
+ /// </post>
public void Unprepare()
{
lock (thisLock)
/// The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code.
/// For example, "ko_KR" for Korean, "en_US" for American English.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
+ /// </privilege>
/// <returns>
/// list of strings of supported languages.
/// </returns>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
- /// 1. STT Not Supported
- /// 2. Permission Denied
- /// 3. Engine Not Found.
- /// 4. Operation Failed.
+ /// 1. Engine Not Found.
+ /// 2. Operation Failed.
/// </exception>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
public IEnumerable<string> GetSupportedLangauages()
{
List<string> languageList = new List<string>();
/// <summary>
/// Checks whether the recognition type is supported.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
+ /// </privilege>
/// <param name="type">
/// RecognitionType value.
/// </param>
/// <returns>
/// bool value indicating whether the recognition type is supported.
/// </returns>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
- /// 1. STT Not Supported
- /// 2. Invalid State
- /// 3. Engine Not Found.
- /// 4. Operation Failed.
+ /// 1. Invalid State
+ /// 2. Engine Not Found.
+ /// 3. Operation Failed.
/// </exception>
- /// <precondition>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <pre>
/// The state should be Ready.
- /// </precondition>
+ /// </pre>
public bool IsRecognitionTypeSupported(RecognitionType type)
{
bool supported;
/// <summary>
/// Sets the silence detection.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
+ /// </privilege>
/// <param name="type">
/// SilenceDetection value.
/// </param>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
- /// 1. STT Not Supported
- /// 2. Invalid State
- /// 3. Not supported feature of current engine.
- /// 4. Operation Failed.
+ /// 1. Invalid State
+ /// 2. Not supported feature of current engine.
+ /// 3. Operation Failed.
/// </exception>
- /// <precondition>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <pre>
/// The state should be Ready.
- /// </precondition>
+ /// </pre>
public void SetSilenceDetection(SilenceDetection type)
{
lock (thisLock)
/// Sets the sound to start recording.
/// Sound file type should be wav type.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
+ /// </privilege>
/// <param name="filePath">
/// File Path for the sound.
/// </param>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
- /// 1. STT Not Supported.
- /// 2. Permission Denied.
- /// 3. Invalid State.
- /// 4. Operation Failed.
- /// </exception>
- /// <exception cref="ArgumentException">
- /// If an Invalid Parameter is provided.
+ /// 1. Invalid State.
+ /// 2. Operation Failed.
/// </exception>
- /// <precondition>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <exception cref="ArgumentException"> If an Invalid Parameter is provided. </exception>
+ /// <pre>
/// The state should be Ready.
- /// </precondition>
+ /// </pre>
public void SetStartSound(string filePath)
{
lock (thisLock)
/// <summary>
/// Unsets the sound to start recording.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
+ /// </privilege>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
- /// 1. STT Not Supported.
- /// 2. Permission Denied.
- /// 3. Invalid State.
- /// 4. Operation Failed.
+ /// 1. Invalid State.
+ /// 2. Operation Failed.
/// </exception>
- /// <precondition>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <pre>
/// The state should be Ready.
- /// </precondition>
+ /// </pre>
public void UnsetStartSound()
{
lock (thisLock)
/// Sets the sound to stop recording.
/// Sound file type should be wav type.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
+ /// </privilege>
/// <param name="filePath">
/// File Path for the sound.
/// </param>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
- /// 1. STT Not Supported.
- /// 2. Permission Denied.
- /// 3. Invalid State.
- /// 4. Operation Failed.
+ /// 1. Invalid State.
+ /// 2. Operation Failed.
/// </exception>
- /// <exception cref="ArgumentException">
- /// If an Invalid Parameter is provided.
- /// </exception>
- /// <precondition>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <exception cref="ArgumentException"> If an Invalid Parameter is provided. </exception>
+ /// <pre>
/// The state should be Ready.
- /// </precondition>
+ /// </pre>
public void SetStopSound(string filePath)
{
lock (thisLock)
/// <summary>
/// Unsets the sound to stop recording.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
+ /// </privilege>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
- /// 1. STT Not Supported.
- /// 2. Permission Denied.
- /// 3. Invalid State.
- /// 4. Operation Failed.
+ /// 1. Invalid State.
+ /// 2. Operation Failed.
/// </exception>
- /// <precondition>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <pre>
/// The state should be Ready.
- /// </precondition>
+ /// </pre>
public void UnsetStopSound()
{
lock (thisLock)
/// This function starts recording in the STT service and sending recording data to engine.
/// This work continues until Stop, Cancel or silence detected by engine
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
+ /// </privilege>
/// <param name="language">
/// The language selected
/// </param>
/// <param name="type">
/// The type for recognition
/// </param>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
- /// 1. STT Not Supported.
- /// 2. Permission Denied.
- /// 3. Invalid State.
- /// 4. Operation Failed.
- /// 5. Recorder Busy.
- /// 6. Progress to recording is not finished
- /// </exception>
- /// <exception cref="ArgumentException">
- /// If an Invalid Language is provided
+ /// 1. Invalid State.
+ /// 2. Operation Failed.
+ /// 3. Recorder Busy.
+ /// 4. Progress to recording is not finished
/// </exception>
- /// <precondition>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <exception cref="ArgumentException"> If an Invalid Language is provided. </exception>
+ /// <pre>
/// The state should be Ready.
- /// </precondition>
- /// <postcondition>
+ /// </pre>
+ /// <post>
/// It will invoke StateChanged Event if registerd.
/// If this function succeeds, the STT state will be Recording.
/// If you call this function again before state changes, you will receive ErrorINProgressToRecording.
- /// </postcondition>
+ /// </post>
public void Start(string language, RecognitionType type)
{
lock (thisLock)
/// <summary>
/// Finishes the recording and starts recognition processing in engine asynchronously.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
+ /// </privilege>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
- /// 1. STT Not Supported.
- /// 2. Permission Denied.
- /// 3. Invalid State.
- /// 4. Operation Failed.
- /// 5. Progress to ready is not finished.
- /// 6. Progress to recording is not finished.
- /// 7. Progress to processing is not finished.
+ /// 1. Invalid State.
+ /// 2. Operation Failed.
+ /// 3. Progress to ready is not finished.
+ /// 4. Progress to recording is not finished.
+ /// 5. Progress to processing is not finished.
/// </exception>
- /// <precondition>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <pre>
/// The state should be Recording.
- /// </precondition>
- /// <postcondition>
+ /// </pre>
+ /// <post>
/// It will invoke StateChanged Event if registerd.
/// If this function succeeds, the STT state will be Processing.
/// If you call this function again before state changes, you will receive ErrorINProgressToProcessing.
/// After processing of engine, RecognitionResult event is invoked
- /// </postcondition>
+ /// </post>
public void Stop()
{
lock (thisLock)
/// This function cancels recording and engine cancels recognition processing.
/// After successful cancel, StateChanged event is invoked otherwise if error is occurred, ErrorOccured event is invoked.
/// </summary>
- /// <priviledge>
+ /// <since_tizen> 3 </since_tizen>
+ /// <privilege>
/// http://tizen.org/privilege/recorder
- /// </priviledge>
+ /// </privilege>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
- /// 1. STT Not Supported.
- /// 2. Permission Denied.
- /// 3. Invalid State.
- /// 4. Operation Failed.
- /// 5. Progress to ready is not finished.
- /// 6. Progress to recording is not finished.
- /// 7. Progress to processing is not finished.
+ /// 1. Invalid State.
+ /// 2. Operation Failed.
+ /// 3. Progress to ready is not finished.
+ /// 4. Progress to recording is not finished.
+ /// 5. Progress to processing is not finished.
/// </exception>
- /// <precondition>
+ /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <pre>
/// The state should be Recording or Processing.
- /// </precondition>
- /// <postcondition>
+ /// </pre>
+ /// <post>
/// It will invoke StateChanged Event if registerd.
/// If this function succeeds, the STT state will be Ready.
/// If you call this function again before state changes, you will receive ErrorINProgressToReady.
- /// </postcondition>
+ /// </post>
public void Cancel()
{
lock (thisLock)
projects / platform / core / csapi / uix-stt.git / blobdiff