Change-Id: Ic0d7f7d752525fd7673738a569cd59ef006043d3
Signed-off-by: sooyeon.kim <sooyeon.kim@samsung.com>
/// <summary>
/// This class holds information about the DefaultLanguageChanged Event
/// </summary>
/// <summary>
/// This class holds information about the DefaultLanguageChanged Event
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class DefaultLanguageChangedEventArgs
{
internal DefaultLanguageChangedEventArgs(string previous, string current)
public class DefaultLanguageChangedEventArgs
{
internal DefaultLanguageChangedEventArgs(string previous, string current)
/// <summary>
/// The previous language
/// </summary>
/// <summary>
/// The previous language
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string PreviousLanguage
{
get;
public string PreviousLanguage
{
get;
/// <summary>
/// The current language
/// </summary>
/// <summary>
/// The current language
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string CurrentLanguage
{
get;
internal set;
}
}
public string CurrentLanguage
{
get;
internal set;
}
}
-}
\ No newline at end of file
/// <summary>
/// This class holds information related to Engine Changed Event
/// </summary>
/// <summary>
/// This class holds information related to Engine Changed Event
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class EngineChangedEventArgs
{
internal EngineChangedEventArgs(string engineId, string language, bool supportSilence, bool needCredential)
public class EngineChangedEventArgs
{
internal EngineChangedEventArgs(string engineId, string language, bool supportSilence, bool needCredential)
/// <summary>
/// Engine Id
/// </summary>
/// <summary>
/// Engine Id
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string EngineId
{
get;
public string EngineId
{
get;
/// <summary>
/// Default Lanaguage
/// </summary>
/// <summary>
/// Default Lanaguage
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Language
{
get;
public string Language
{
get;
/// <summary>
/// The necessity of credential
/// </summary>
/// <summary>
/// The necessity of credential
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool NeedCredential
{
get;
public bool NeedCredential
{
get;
/// <summary>
/// Whether the silence detection is supported or not
/// </summary>
/// <summary>
/// Whether the silence detection is supported or not
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public bool SupportSilence
{
get;
internal set;
}
}
public bool SupportSilence
{
get;
internal set;
}
}
-}
\ No newline at end of file
/// <summary>
/// This class holds information related to the STT ErrorOccured Event
/// </summary>
/// <summary>
/// This class holds information related to the STT ErrorOccured Event
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ErrorOccuredEventArgs
{
private IntPtr _handle;
public class ErrorOccuredEventArgs
{
private IntPtr _handle;
/// <summary>
/// The Error Value
/// </summary>
/// <summary>
/// The Error Value
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Error ErrorValue
{
get;
public Error ErrorValue
{
get;
/// <summary>
/// Gets the current error message.
/// </summary>
/// <summary>
/// Gets the current error message.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>
/// string error message
/// </returns>
/// <returns>
/// string error message
/// </returns>
- public string GetErrorMessage
+ public string ErrorMessage
-}
\ No newline at end of file
{
case SttError.OutOfMemory:
{
{
case SttError.OutOfMemory:
{
- exp = new InvalidOperationException("Out Of Memory");
+ exp = new OutOfMemoryException("Out Of Memory");
case SttError.TimedOut:
{
case SttError.TimedOut:
{
- exp = new InvalidOperationException("No answer from the STT service");
+ exp = new TimeoutException("No answer from the STT service");
case SttError.PermissionDenied:
{
case SttError.PermissionDenied:
{
- exp = new InvalidOperationException("Permission Denied");
+ exp = new UnauthorizedAccessException("Permission Denied");
break;
}
case SttError.NotSupported:
{
break;
}
case SttError.NotSupported:
{
- exp = new InvalidOperationException("STT NOT supported");
+ exp = new NotSupportedException("STT NOT supported");
/// <summary>
/// The recognition result from the engine.
/// </summary>
/// <summary>
/// The recognition result from the engine.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class RecognitionResultEventArgs
{
private ResultEvent _result;
public class RecognitionResultEventArgs
{
private ResultEvent _result;
/// <summary>
/// The result event
/// </summary>
/// <summary>
/// The result event
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ResultEvent Result
{
get
public ResultEvent Result
{
get
/// <summary>
/// Result texts.
/// </summary>
/// <summary>
/// Result texts.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<string> Data
{
get
public IEnumerable<string> Data
{
get
/// <summary>
/// Returns the Result text count.
/// </summary>
/// <summary>
/// Returns the Result text count.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public int DataCount
{
get
public int DataCount
{
get
/// <summary>
/// Engine message
/// </summary>
/// <summary>
/// Engine message
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ResultMessage Message
{
get
public ResultMessage Message
{
get
/// <summary>
/// This Class represents the result of recognition result from the engine.
/// </summary>
/// <summary>
/// This Class represents the result of recognition result from the engine.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ResultTime
{
internal ResultTime(int index, TimeEvent e, string text, long startTime, long endTime)
public class ResultTime
{
internal ResultTime(int index, TimeEvent e, string text, long startTime, long endTime)
/// <summary>
/// The result index
/// </summary>
/// <summary>
/// The result index
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <summary>
/// The token event
/// </summary>
/// <summary>
/// The token event
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public TimeEvent TokenEvent
{
get;
public TimeEvent TokenEvent
{
get;
/// <summary>
/// The result text
/// </summary>
/// <summary>
/// The result text
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string Text
{
get;
public string Text
{
get;
/// <summary>
/// The start time of result text
/// </summary>
/// <summary>
/// The start time of result text
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public long StartTime
{
get;
public long StartTime
{
get;
/// <summary>
/// The end time of result text
/// </summary>
/// <summary>
/// The end time of result text
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public long EndTime
{
get;
public long EndTime
{
get;
/// <summary>
/// This class holds information related to the STT StateChanged event
/// </summary>
/// <summary>
/// This class holds information related to the STT StateChanged event
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class StateChangedEventArgs
{
internal StateChangedEventArgs(State previous, State current)
public class StateChangedEventArgs
{
internal StateChangedEventArgs(State previous, State current)
/// <summary>
/// A previous state
/// </summary>
/// <summary>
/// A previous state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public State Previous
{
get;
public State Previous
{
get;
/// <summary>
/// A current state
/// </summary>
/// <summary>
/// A current state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public State Current
{
get;
public State Current
{
get;
/// <summary>
/// The token event
/// </summary>
/// <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>
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>
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>
PartialResult,
/// <summary>
/// Event when the recognition has failed
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Error
};
/// <summary>
/// Enumeration representing the result message
/// </summary>
Error
};
/// <summary>
/// Enumeration representing the result message
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ResultMessage
{
/// <summary>
/// No Error
/// </summary>
public enum ResultMessage
{
/// <summary>
/// No Error
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
None,
/// <summary>
/// Recognition failed because the speech started too soon.
/// </summary>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
End = 2
};
/// <summary>
/// Enum for Error values that can occur
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Error
{
/// <summary>
/// Successful, No error
/// </summary>
public enum Error
{
/// <summary>
/// Successful, No error
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
None,
/// <summary>
/// Out of Memory
/// </summary>
None,
/// <summary>
/// Out of Memory
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
OutOfMemory,
/// <summary>
/// I/O error
/// </summary>
OutOfMemory,
/// <summary>
/// I/O error
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
IoError,
/// <summary>
/// Invalid parameter
/// </summary>
IoError,
/// <summary>
/// Invalid parameter
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
InvalidParameter,
/// <summary>
/// No answer from the STT service
/// </summary>
InvalidParameter,
/// <summary>
/// No answer from the STT service
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
TimedOut,
/// <summary>
/// Device or resource busy
/// </summary>
TimedOut,
/// <summary>
/// Device or resource busy
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
RecorderBusy,
/// <summary>
/// Network is down
/// </summary>
RecorderBusy,
/// <summary>
/// Network is down
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
OutOfNetwork,
/// <summary>
/// Permission denied
/// </summary>
OutOfNetwork,
/// <summary>
/// Permission denied
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
PermissionDenied,
/// <summary>
/// STT NOT supported
/// </summary>
PermissionDenied,
/// <summary>
/// STT NOT supported
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
NotSupported,
/// <summary>
/// Invalid state
/// </summary>
NotSupported,
/// <summary>
/// Invalid state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
InvalidState,
/// <summary>
/// Invalid language
/// </summary>
InvalidState,
/// <summary>
/// Invalid language
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
InvalidLanguage,
/// <summary>
/// No available engine
/// </summary>
InvalidLanguage,
/// <summary>
/// No available engine
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
EngineNotFound,
/// <summary>
/// Operation failed
/// </summary>
EngineNotFound,
/// <summary>
/// Operation failed
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
OperationFailed,
/// <summary>
/// Not supported feature of current engine
/// </summary>
OperationFailed,
/// <summary>
/// Not supported feature of current engine
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
NotSupportedFeature,
/// <summary>
/// Recording timed out
/// </summary>
NotSupportedFeature,
/// <summary>
/// Recording timed out
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
RecordingTimedOut,
/// <summary>
/// No speech while recording
/// </summary>
RecordingTimedOut,
/// <summary>
/// No speech while recording
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
NoSpeech,
/// <summary>
/// Progress to ready is not finished
/// </summary>
NoSpeech,
/// <summary>
/// Progress to ready is not finished
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
InProgressToReady,
/// <summary>
/// Progress to recording is not finished
/// </summary>
InProgressToReady,
/// <summary>
/// Progress to recording is not finished
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
InProgressToRecording,
/// <summary>
/// Progress to processing is not finished
/// </summary>
InProgressToRecording,
/// <summary>
/// Progress to processing is not finished
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
InProgressToProcessing,
/// <summary>
/// Service reset
/// </summary>
InProgressToProcessing,
/// <summary>
/// Service reset
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
ServiceReset
};
/// <summary>
/// Enumeration for Recognition Types
/// </summary>
ServiceReset
};
/// <summary>
/// Enumeration for Recognition Types
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum RecognitionType
{
/// <summary>
/// Free form dictation
/// </summary>
public enum RecognitionType
{
/// <summary>
/// Free form dictation
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Free,
/// <summary>
/// Continuous free dictation.
/// </summary>
Free,
/// <summary>
/// Continuous free dictation.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Partial,
/// <summary>
/// Search
/// </summary>
Partial,
/// <summary>
/// Search
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Search,
/// <summary>
/// Web Search
/// </summary>
Search,
/// <summary>
/// Web Search
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
WebSearch,
/// <summary>
/// Map
/// </summary>
WebSearch,
/// <summary>
/// Map
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Map
};
/// <summary>
/// Enumeration for the State types
/// </summary>
Map
};
/// <summary>
/// Enumeration for the State types
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum State
{
/// <summary>
/// Created state
/// </summary>
public enum State
{
/// <summary>
/// Created state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Created = 0,
/// <summary>
/// Ready state
/// </summary>
Created = 0,
/// <summary>
/// Ready state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Ready = 1,
/// <summary>
/// Recording state
/// </summary>
Ready = 1,
/// <summary>
/// Recording state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Recording = 2,
/// <summary>
/// Processing state
/// </summary>
Recording = 2,
/// <summary>
/// Processing state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Processing = 3,
/// <summary>
/// Unavailable
/// </summary>
Processing = 3,
/// <summary>
/// Unavailable
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
Unavailable
};
/// <summary>
/// Enumeration for the Silence Detection types
/// </summary>
Unavailable
};
/// <summary>
/// Enumeration for the Silence Detection types
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum SilenceDetection
{
/// <summary>
/// Silence detection type - False
/// </summary>
public enum SilenceDetection
{
/// <summary>
/// Silence detection type - False
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
False = 0,
/// <summary>
/// Silence detection type - True
/// </summary>
False = 0,
/// <summary>
/// Silence detection type - True
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
True = 1,
/// <summary>
/// Silence detection type - Auto
/// </summary>
True = 1,
/// <summary>
/// Silence detection type - Auto
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// 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>
/// 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;
public class SttClient : IDisposable
{
private IntPtr _handle;
/// <summary>
/// Constructor to create a STT instance.
/// </summary>
/// <summary>
/// Constructor to create a STT instance.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// http://tizen.org/feature/speech.recognition
/// http://tizen.org/feature/microphone
/// </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
- /// </exception>
+ /// <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;
public SttClient()
{
IntPtr handle;
/// <summary>
/// Event to be invoked when the recognition is done.
/// </summary>
/// <summary>
/// Event to be invoked when the recognition is done.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<RecognitionResultEventArgs> RecognitionResult
{
add
public event EventHandler<RecognitionResultEventArgs> RecognitionResult
{
add
/// <summary>
/// Event to be invoked when STT state changes.
/// </summary>
/// <summary>
/// Event to be invoked when STT state changes.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<StateChangedEventArgs> StateChanged
{
add
public event EventHandler<StateChangedEventArgs> StateChanged
{
add
/// <summary>
/// Event to be invoked when an error occurs.
/// </summary>
/// <summary>
/// Event to be invoked when an error occurs.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<ErrorOccuredEventArgs> ErrorOccured
{
add
public event EventHandler<ErrorOccuredEventArgs> ErrorOccured
{
add
/// <summary>
/// Event to be invoked when default laungage change.
/// </summary>
/// <summary>
/// Event to be invoked when default laungage change.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<DefaultLanguageChangedEventArgs> DefaultLanguageChanged
{
add
public event EventHandler<DefaultLanguageChangedEventArgs> DefaultLanguageChanged
{
add
/// <summary>
/// Event to be invoked to detect engine change.
/// </summary>
/// <summary>
/// Event to be invoked to detect engine change.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler<EngineChangedEventArgs> EngineChanged
{
add
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>
/// 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>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// Default language in STT.
/// </value>
/// <value>
/// Default language in STT.
/// </value>
/// <returns>
/// Default Lanaguage string value.
/// </returns>
/// <returns>
/// Default Lanaguage string value.
/// </returns>
- public string GetDefaultLanguage
+ public string DefaultLanguage
/// <summary>
/// Gets the microphone volume during recording.
/// </summary>
/// <summary>
/// Gets the microphone volume during recording.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// Recording volume in STT.
/// </value>
/// <value>
/// Recording volume in STT.
/// </value>
/// <pre>
/// The State must be Recording.
/// </pre>
/// <pre>
/// The State must be Recording.
/// </pre>
- public float GetRecordingVolume
+ public float RecordingVolume
/// <summary>
/// Gets the current STT state.
/// </summary>
/// <summary>
/// Gets the current STT state.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// Current state of STT.
/// </value>
/// <value>
/// Current state of STT.
/// </value>
/// <returns>
/// Current STT State value.
/// </returns>
/// <returns>
/// Current STT State value.
/// </returns>
+ public State CurrentState
/// <summary>
/// This property can be used to get and set the current engine id.
/// </summary>
/// <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>
/// <value>
/// Current STT engine id.
/// </value>
/// </privilege>
/// <exception cref="InvalidOperationException">
/// This Exception can occur while setting due to the following reaons
/// </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 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.
/// </pre>
/// <pre>
/// The State must be Created.
/// </pre>
/// <summary>
/// Retrieves the time stamp of the current recognition result
/// </summary>
/// <summary>
/// Retrieves the time stamp of the current recognition result
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>
/// list of ResultTime
/// </returns>
/// <returns>
/// list of ResultTime
/// </returns>
/// <remarks>
/// This function should only be called in RecognitionResult Event
/// </remarks>
/// <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>();
public IEnumerable<ResultTime> GetDetailedResult()
{
List<ResultTime> list = new List<ResultTime>();
/// <summary>
/// Gets the private data from stt engine.
/// </summary>
/// <summary>
/// Gets the private data from stt engine.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="key">
/// The key string
/// </param>
/// <param name="key">
/// The key string
/// </param>
/// http://tizen.org/feature/speech.recognition
/// http://tizen.org/feature/microphone
/// </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>
+ /// <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.
/// </pre>
/// <pre>
/// The State must be Ready.
/// </pre>
/// <summary>
/// Sets the private data to stt engine.
/// </summary>
/// <summary>
/// Sets the private data to stt engine.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="key">
/// The key string
/// </param>
/// <param name="key">
/// The key string
/// </param>
/// http://tizen.org/feature/speech.recognition
/// http://tizen.org/feature/microphone
/// </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>
- /// <exception cref="ArgumentException">
- /// This can happen if Improper value is provided while setting the value.
- /// </exception>
+ /// <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.
/// </pre>
/// <pre>
/// The State must be Ready.
/// </pre>
/// <summary>
/// Gets the list of Supported Engine
/// </summary>
/// <summary>
/// Gets the list of Supported Engine
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>
/// IEnumerable<SupportedEngine> list of supported engines
/// </returns>
/// <returns>
/// IEnumerable<SupportedEngine> list of supported engines
/// </returns>
/// http://tizen.org/feature/speech.recognition
/// http://tizen.org/feature/microphone
/// </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
- /// </exception>
+ /// <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>();
public IEnumerable<SupportedEngine> GetSupportedEngines()
{
List<SupportedEngine> engineList = new List<SupportedEngine>();
/// <summary>
/// Sets the app credential
/// </summary>
/// <summary>
/// Sets the app credential
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="credential">
/// The credential string
/// </param>
/// <param name="credential">
/// The credential string
/// </param>
/// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reaons
/// </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 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.
/// </pre>
/// <pre>
/// The State must be Created.
/// </pre>
/// <summary>
/// Connects to the STT service asynchronously.
/// </summary>
/// <summary>
/// Connects to the STT service asynchronously.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// http://tizen.org/feature/speech.recognition
/// http://tizen.org/feature/microphone
/// </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>
+ /// <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.
/// </pre>
/// <pre>
/// The State must be Created.
/// </pre>
/// <summary>
/// Disconnects from the STT service.
/// </summary>
/// <summary>
/// Disconnects from the STT service.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// http://tizen.org/feature/speech.recognition
/// http://tizen.org/feature/microphone
/// </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>
+ /// <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.
/// </pre>
/// <pre>
/// The State must be Ready.
/// </pre>
/// 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>
/// 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>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
/// </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 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>();
public IEnumerable<string> GetSupportedLangauages()
{
List<string> languageList = new List<string>();
/// <summary>
/// Checks whether the recognition type is supported.
/// </summary>
/// <summary>
/// Checks whether the recognition type is supported.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
/// </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 cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
/// <pre>
/// The state should be Ready.
/// </pre>
/// <pre>
/// The state should be Ready.
/// </pre>
/// <summary>
/// Sets the silence detection.
/// </summary>
/// <summary>
/// Sets the silence detection.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
/// </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 cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
/// <pre>
/// The state should be Ready.
/// </pre>
/// <pre>
/// The state should be Ready.
/// </pre>
/// Sets the sound to start recording.
/// Sound file type should be wav type.
/// </summary>
/// Sets the sound to start recording.
/// Sound file type should be wav type.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
/// </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 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.
/// </pre>
/// <pre>
/// The state should be Ready.
/// </pre>
/// <summary>
/// Unsets the sound to start recording.
/// </summary>
/// <summary>
/// Unsets the sound to start recording.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
/// </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 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.
/// </pre>
/// <pre>
/// The state should be Ready.
/// </pre>
/// Sets the sound to stop recording.
/// Sound file type should be wav type.
/// </summary>
/// Sets the sound to stop recording.
/// Sound file type should be wav type.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
/// </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 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.
/// </pre>
/// <pre>
/// The state should be Ready.
/// </pre>
/// <summary>
/// Unsets the sound to stop recording.
/// </summary>
/// <summary>
/// Unsets the sound to stop recording.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
/// </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 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.
/// </pre>
/// <pre>
/// The state should be Ready.
/// </pre>
/// 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>
/// 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>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
/// </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 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.
/// </pre>
/// <pre>
/// The state should be Ready.
/// </pre>
/// <summary>
/// Finishes the recording and starts recognition processing in engine asynchronously.
/// </summary>
/// <summary>
/// Finishes the recording and starts recognition processing in engine asynchronously.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
/// </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 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.
/// </pre>
/// <pre>
/// The state should be Recording.
/// </pre>
/// 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>
/// 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>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// </feature>
/// <exception cref="InvalidOperationException">
/// This Exception can be due to the following reasons
/// </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 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.
/// </pre>
/// <pre>
/// The state should be Recording or Processing.
/// </pre>
/// <summary>
/// This Class provideds the Information related to STT Engine.
/// </summary>
/// <summary>
/// This Class provideds the Information related to STT Engine.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class SupportedEngine
{
private string _engineId;
public class SupportedEngine
{
private string _engineId;
/// <summary>
/// The Engine Id
/// </summary>
/// <summary>
/// The Engine Id
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>
/// The string Engine Id
/// </returns>
/// <returns>
/// The string Engine Id
/// </returns>
/// <summary>
/// The Engine Name
/// </summary>
/// <summary>
/// The Engine Name
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>
/// The string Engine Name
/// </returns>
/// <returns>
/// The string Engine Name
/// </returns>
Name: csapi-uix-stt
Summary: Tizen STT Uix API for C#
Name: csapi-uix-stt
Summary: Tizen STT Uix API for C#
Release: 1
Group: Development/Libraries
License: Apache-2.0
Release: 1
Group: Development/Libraries
License: Apache-2.0