/// <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
/// 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>
+ /// <value>
+ /// Default language in STT.
+ /// </value>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Gets the microphone volume during recording.
/// </summary>
+ /// <value>
+ /// Recording volume in STT.
+ /// </value>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
- /// <precondition>
+ /// <pre>
/// The State must be Recording.
- /// </precondition>
+ /// </pre>
public float GetRecordingVolume
{
get
/// <summary>
/// Gets the current STT state.
/// </summary>
+ /// <value>
+ /// Current state of STT.
+ /// </value>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// This property can be used to get and set the current engine id.
/// </summary>
+ /// <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
/// <exception cref="ArgumentException">
/// This can happen if Improper EngineId is provided while setting the value.
/// </exception>
- /// <precondition>
+ /// <pre>
/// The State must be Created.
- /// </precondition>
+ /// </pre>
public string Engine
{
get
/// <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>
/// <returns>
/// The Data Corresponding to the Key provided
/// </returns>
+ /// <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. No Answer from STT Service
/// 2. STT Not Supported
/// 3. Invalid State
/// </exception>
- /// <precondition>
+ /// <pre>
/// The State must be Ready.
- /// </precondition>
+ /// </pre>
public string GetPrivateData(string key)
{
string data;
/// <param name="data">
/// The data 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. No Answer from STT Service
/// <exception cref="ArgumentException">
/// This can happen if Improper value is provided while setting the value.
/// </exception>
- /// <precondition>
+ /// <pre>
/// The State must be Ready.
- /// </precondition>
+ /// </pre>
public void SetPrivateData(string key, string data)
{
lock (thisLock)
/// <returns>
/// IEnumerable<SupportedEngine> list of supported engines
/// </returns>
+ /// <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
/// <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
/// <exception cref="ArgumentException">
/// This can happen if Improper value is provided while setting the value.
/// </exception>
- /// <precondition>
+ /// <pre>
/// The State must be Created.
- /// </precondition>
+ /// </pre>
public void SetCredential(string credential)
{
lock (thisLock)
/// <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 reasons
/// 1. STT Not Supported
/// 2. Permission Denied
/// 3. Invalid State
/// </exception>
- /// <precondition>
+ /// <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)
/// <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 reasons
/// 1. STT Not Supported
/// 2. Permission Denied
/// 3. Invalid State
/// </exception>
- /// <precondition>
+ /// <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)
/// <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
/// <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
/// 3. Engine Not Found.
/// 4. Operation Failed.
/// </exception>
- /// <precondition>
+ /// <pre>
/// The state should be Ready.
- /// </precondition>
+ /// </pre>
public bool IsRecognitionTypeSupported(RecognitionType type)
{
bool supported;
/// <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
/// 3. Not supported feature of current engine.
/// 4. Operation Failed.
/// </exception>
- /// <precondition>
+ /// <pre>
/// The state should be Ready.
- /// </precondition>
+ /// </pre>
public void SetSilenceDetection(SilenceDetection type)
{
lock (thisLock)
/// <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.
/// <exception cref="ArgumentException">
/// If an Invalid Parameter is provided.
/// </exception>
- /// <precondition>
+ /// <pre>
/// The state should be Ready.
- /// </precondition>
+ /// </pre>
public void SetStartSound(string filePath)
{
lock (thisLock)
/// <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 reasons
/// 1. STT Not Supported.
/// 3. Invalid State.
/// 4. Operation Failed.
/// </exception>
- /// <precondition>
+ /// <pre>
/// The state should be Ready.
- /// </precondition>
+ /// </pre>
public void UnsetStartSound()
{
lock (thisLock)
/// <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.
/// <exception cref="ArgumentException">
/// If an Invalid Parameter is provided.
/// </exception>
- /// <precondition>
+ /// <pre>
/// The state should be Ready.
- /// </precondition>
+ /// </pre>
public void SetStopSound(string filePath)
{
lock (thisLock)
/// <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 reasons
/// 1. STT Not Supported.
/// 3. Invalid State.
/// 4. Operation Failed.
/// </exception>
- /// <precondition>
+ /// <pre>
/// The state should be Ready.
- /// </precondition>
+ /// </pre>
public void UnsetStopSound()
{
lock (thisLock)
/// <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.
/// <exception cref="ArgumentException">
/// If an Invalid Language is provided
/// </exception>
- /// <precondition>
+ /// <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)
/// <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 reasons
/// 1. STT Not Supported.
/// 6. Progress to recording is not finished.
/// 7. Progress to processing is not finished.
/// </exception>
- /// <precondition>
+ /// <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)
/// <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 reasons
/// 1. STT Not Supported.
/// 6. Progress to recording is not finished.
/// 7. Progress to processing is not finished.
/// </exception>
- /// <precondition>
+ /// <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)