/// <summary>
/// This class holds information about the CurrentLanguageChanged Event
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class CurrentLanguageChangedEventArgs
{
internal CurrentLanguageChangedEventArgs(string previous, string current)
/// <summary>
/// The previous language
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string PreviousLanguage
{
get;
/// <summary>
/// The current language
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string CurrentLanguage
{
get;
internal set;
}
}
-}
\ No newline at end of file
+}
/// <summary>
/// This class holds information related to the VoiceControl ErrorOccured Event
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ErrorOccuredEventArgs
{
internal ErrorOccuredEventArgs(ErrorCode error)
/// <summary>
/// The Error Value
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public Error ErrorValue
{
get;
internal set;
}
}
-}
\ No newline at end of file
+}
/// If the duplicated commands are recognized, the event(e.g. Result.Rejected) of command may be rejected
/// for selecting command as priority.If you set similar or same commands or the recognized results are multi-results, CommandList has the multi commands.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class RecognitionResult
{
private ResultEvent _resultEvent;
/// <summary>
/// The result event
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ResultEvent Result
{
get
/// <summary>
/// The spoken text
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string ResultMessage
{
get
/// <summary>
/// The recognized command list
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public VoiceCommandList CommandList
{
get
/// <summary>
/// The recognition result from the engine.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class RecognitionResultEventArgs : EventArgs
{
private RecognitionResult _result;
/// <summary>
/// Gets the Recognition result
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public RecognitionResult Result
{
get
/// <summary>
/// This class holds information related to the VoiceControl service ServiceStateChanged event
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class ServiceStateChangedEventArgs
{
internal ServiceStateChangedEventArgs(ServiceState previous, ServiceState current)
/// <summary>
/// A previous state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ServiceState Previous
{
get;
/// <summary>
/// A current state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public ServiceState Current
{
get;
/// <summary>
/// This class holds information related to the VoiceControl client StateChanged event
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class StateChangedEventArgs
{
internal StateChangedEventArgs(State previous, State current)
/// <summary>
/// A previous state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public State Previous
{
get;
/// <summary>
/// A current state
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public State Current
{
get;
/// <summary>
/// Enumeration for Command Format
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum CommandFormat
{
/// <summary>
/// <summary>
/// This class represents a Voice Command
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class VoiceCommand
{
internal SafeCommandHandle _handle;
/// <summary>
/// Public Constructor
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="InvalidOperationException"> This Exception can be due to Invalid State. </exception>
/// <exception cref="OutOfMemoryException"> This Exception can be due to Out Of Memory. </exception>
/// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
/// This property should be used for commands which have non-fixed format.
/// empty string will be returned in case of some internal error
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public string UnfixedCommand
{
get
/// <summary>
/// Gets/Sets command type.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>If you do not set the command type, the default value is Undefined. You should set type if command is valid</remarks>
/// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
/// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
/// <summary>
/// Gets/Sets the command format.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>The default format is Fixed</remarks>
/// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
/// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
/// Gets/Sets command
/// in case of get empty string will be returned in case of some internal error
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
/// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
public string Command
/// <summary>
/// this class represents list of Voice Commands
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class VoiceCommandList
{
internal SafeCommandListHandle _handle;
/// <summary>
/// Public Constructor
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// Gets command count of list.
/// -1 is returned in case of internal failure.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// Command counts of the list.
/// </value>
/// Get current command from command list by index.
/// null will be returned in case of Empty List
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// Current command from the command list.
/// </value>
/// <summary>
/// Adds command to command list.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Removes command from command list.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Retrieves all commands of command list.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Moves index to first command.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Moves index to last command.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Moves index to next command.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Moves index to previous command.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Enum for Error values that can occur
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Error
{
/// <summary>
/// <summary>
/// Enumeration for the client state.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum State
{
/// <summary>
/// <summary>
/// Enumerations of service state.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ServiceState
{
/// <summary>
/// <summary>
/// Enumerations of result event.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum ResultEvent
{
/// <summary>
/// <summary>
/// Enumerations of command type.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum CommandType
{
/// <summary>
/// A main function of Voice Control API register command and gets notification for recognition result.
/// Applications can add their own commands and be provided result when their command is recognized by user voice input.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static class VoiceControlClient
{
/// <summary>
/// Called when client gets the recognition result.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>
/// If the duplicated commands are recognized, the event(e.g. Result.Rejected) of command may be rejected
/// for selecting command as priority.If you set similar or same commands or the recognized results are multi-results, cmdList has the multi commands.
/// For example, "ko_KR" for Korean, "en_US" for American English.
/// Empty string is returned incase of some internal error
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// Current language in voice control.
/// </value>
/// <summary>
/// Gets current state of voice control client.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// Current state of voice control client.
/// </value>
/// <summary>
/// Gets current state of voice control service.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// Current state of voice control service.
/// </value>
/// <summary>
/// Sets the invocation name.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Initializes voice control.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Deinitializes voice control.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Connects the voice control service.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Disconnects the voice control service.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// 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>
/// <summary>
/// Gets the system command list.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>
/// The Command List else null in case of no System Commands
/// </returns>
/// Also, the developer can set whether the dialogue starts automatically or not, using autoStart.
/// If the developer sets autoStart as true, the framework will start to record next speech and continue the dialogue.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Sets command list.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Unsets command list.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Gets the recognition result.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <summary>
/// Event to be invoked when the recognition is done.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <pre>
/// The State should be Initialized
/// </pre>
/// <summary>
/// Event to be invoked when VoiceControl service state changes.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <pre>
/// The State should be Initialized
/// </pre>
/// <summary>
/// Event to be invoked when VoiceControl client state changes.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <pre>
/// The State should be Initialized
/// </pre>
/// <summary>
/// Event to be invoked when an error occurs.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <pre>
/// The State should be Initialized
/// </pre>
/// <summary>
/// Event to be invoked when default laungage change.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <pre>
/// The State should be Initialized
/// </pre>
projects / platform / core / csapi / uix-voice-control.git / commitdiff