/// <summary>
-/// Partial Interop Class
+/// Partial interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Partial Libraries Class
+ /// Partial libraries class.
/// </summary>
internal static partial class Libraries
{
using System.Runtime.InteropServices;
/// <summary>
-/// Partial Interop Class
+/// Partial interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Stt Interop Class
+ /// Stt interop class.
/// </summary>
internal static class Stt
{
namespace Tizen.Uix.Stt
{
/// <summary>
- /// This class holds information about the DefaultLanguageChanged Event
+ /// This class holds information about the DefaultLanguageChanged event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class DefaultLanguageChangedEventArgs
}
/// <summary>
- /// The previous language
+ /// The previous language.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string PreviousLanguage
}
/// <summary>
- /// The current language
+ /// The current language.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string CurrentLanguage
namespace Tizen.Uix.Stt
{
/// <summary>
- /// This class holds information related to Engine Changed Event
+ /// This class holds information related to the EngineChanged event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class EngineChangedEventArgs
}
/// <summary>
- /// Engine Id
+ /// The Engine ID.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string EngineId
}
/// <summary>
- /// Default Language
+ /// The default language.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string Language
}
/// <summary>
- /// The necessity of credential
+ /// The necessity of the credential.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public bool NeedCredential
}
/// <summary>
- /// Whether the silence detection is supported or not
+ /// Whether silence detection is supported or not.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public bool SupportSilence
namespace Tizen.Uix.Stt
{
/// <summary>
- /// This class holds information related to the STT ErrorOccurred Event
+ /// This class holds information related to the STT ErrorOccurred event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class ErrorOccurredEventArgs
}
/// <summary>
- /// The Error Value
+ /// The error value.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public Error ErrorValue
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
- /// string error message
+ /// String error message.
/// </returns>
public string ErrorMessage
{
}
/// <summary>
- /// The result event
+ /// The result event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public ResultEvent Result
}
/// <summary>
- /// Result texts.
+ /// The result text.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public IEnumerable<string> Data
}
/// <summary>
- /// Returns the Result text count.
+ /// Returns the result text count.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public int DataCount
}
/// <summary>
- /// Engine message
+ /// The engine message.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public ResultMessage Message
namespace Tizen.Uix.Stt
{
/// <summary>
- /// This Class represents the result of recognition result from the engine.
+ /// This class represents the result of recognition result from the engine.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class ResultTime
}
/// <summary>
- /// The result index
+ /// The result index.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public int Index
}
/// <summary>
- /// The token event
+ /// The token event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public TimeEvent TokenEvent
}
/// <summary>
- /// The result text
+ /// The result text.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string Text
}
/// <summary>
- /// The start time of result text
+ /// The start time of result text.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public long StartTime
}
/// <summary>
- /// The end time of result text
+ /// The end time of result text.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public long EndTime
namespace Tizen.Uix.Stt
{
/// <summary>
- /// This class holds information related to the STT StateChanged event
+ /// This class holds information related to the STT StateChanged event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class StateChangedEventArgs
}
/// <summary>
- /// A previous state
+ /// The previous state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public State Previous
internal set;
}
/// <summary>
- /// A current state
+ /// The current state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public State Current
namespace Tizen.Uix.Stt
{
/// <summary>
- /// The token event
+ /// The token event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum ResultEvent
{
/// <summary>
- /// Event when the recognition full or last result is ready
+ /// Event when the recognition for full or last result is ready.
/// </summary>
/// <since_tizen> 3 </since_tizen>
FinalResult = 0,
/// <summary>
- /// Event when the recognition partial result is ready
+ /// Event when the recognition for partial result is ready.
/// </summary>
/// <since_tizen> 3 </since_tizen>
PartialResult,
/// <summary>
- /// Event when the recognition has failed
+ /// Event when the recognition has failed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Error
};
/// <summary>
- /// Enumeration representing the result message
+ /// Enumeration for representing the result message.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum ResultMessage
{
/// <summary>
- /// No Error
+ /// No Error.
/// </summary>
/// <since_tizen> 3 </since_tizen>
None,
};
/// <summary>
- /// Enumeration for the Token type
+ /// Enumeration for the token types.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum TimeEvent
{
/// <summary>
- /// Event when the token is beginning type
+ /// Event when the token is beginning type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Beginning = 0,
/// <summary>
- /// Event when the token is middle type
+ /// Event when the token is middle type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Middle = 1,
/// <summary>
- /// Event when the token is end type
+ /// Event when the token is end type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
End = 2
};
/// <summary>
- /// Enum for Error values that can occur
+ /// Enumeration for the error values that can occur.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum Error
{
/// <summary>
- /// Successful, No error
+ /// Successful, No error.
/// </summary>
/// <since_tizen> 3 </since_tizen>
None,
/// <summary>
- /// Out of Memory
+ /// Out of Memory.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 3 </since_tizen>.
OutOfMemory,
/// <summary>
- /// I/O error
+ /// I/O error.
/// </summary>
- /// <since_tizen> 3 </since_tizen>
+ /// <since_tizen> 3 </since_tizen>.
IoError,
/// <summary>
- /// Invalid parameter
+ /// Invalid parameter.
/// </summary>
/// <since_tizen> 3 </since_tizen>
InvalidParameter,
/// <summary>
- /// No answer from the STT service
+ /// No answer from the STT service.
/// </summary>
/// <since_tizen> 3 </since_tizen>
TimedOut,
/// <summary>
- /// Device or resource busy
+ /// Device or resource busy.
/// </summary>
/// <since_tizen> 3 </since_tizen>
RecorderBusy,
/// <summary>
- /// Network is down
+ /// Network is down.
/// </summary>
/// <since_tizen> 3 </since_tizen>
OutOfNetwork,
/// <summary>
- /// Permission denied
+ /// Permission denied.
/// </summary>
/// <since_tizen> 3 </since_tizen>
PermissionDenied,
/// <summary>
- /// STT NOT supported
+ /// STT NOT supported.
/// </summary>
/// <since_tizen> 3 </since_tizen>
NotSupported,
/// <summary>
- /// Invalid state
+ /// Invalid state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
InvalidState,
/// <summary>
- /// Invalid language
+ /// Invalid language.
/// </summary>
/// <since_tizen> 3 </since_tizen>
InvalidLanguage,
/// <summary>
- /// No available engine
+ /// No available engine.
/// </summary>
/// <since_tizen> 3 </since_tizen>
EngineNotFound,
/// <summary>
- /// Operation failed
+ /// Operation failed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
OperationFailed,
/// <summary>
- /// Not supported feature of current engine
+ /// Not supported feature of current engine.
/// </summary>
/// <since_tizen> 3 </since_tizen>
NotSupportedFeature,
/// <summary>
- /// Recording timed out
+ /// Recording timed out.
/// </summary>
/// <since_tizen> 3 </since_tizen>
RecordingTimedOut,
/// <summary>
- /// No speech while recording
+ /// No speech while recording.
/// </summary>
/// <since_tizen> 3 </since_tizen>
NoSpeech,
/// <summary>
- /// Progress to ready is not finished
+ /// Progress to ready is not finished.
/// </summary>
/// <since_tizen> 3 </since_tizen>
InProgressToReady,
/// <summary>
- /// Progress to recording is not finished
+ /// Progress to recording is not finished.
/// </summary>
/// <since_tizen> 3 </since_tizen>
InProgressToRecording,
/// <summary>
- /// Progress to processing is not finished
+ /// Progress to processing is not finished.
/// </summary>
/// <since_tizen> 3 </since_tizen>
InProgressToProcessing,
/// <summary>
- /// Service reset
+ /// Service reset.
/// </summary>
/// <since_tizen> 3 </since_tizen>
ServiceReset
};
/// <summary>
- /// Enumeration for Recognition Types
+ /// Enumeration for the recognition types.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum RecognitionType
{
/// <summary>
- /// Free form dictation
+ /// Free form dictation.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Free,
/// <since_tizen> 3 </since_tizen>
Partial,
/// <summary>
- /// Search
+ /// Search.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Search,
/// <summary>
- /// Web Search
+ /// Web search.
/// </summary>
/// <since_tizen> 3 </since_tizen>
WebSearch,
/// <summary>
- /// Map
+ /// Map.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Map
};
/// <summary>
- /// Enumeration for the State types
+ /// Enumeration for the state types.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum State
{
/// <summary>
- /// Created state
+ /// Created state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Created = 0,
/// <summary>
- /// Ready state
+ /// Ready state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Ready = 1,
/// <summary>
- /// Recording state
+ /// Recording state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Recording = 2,
/// <summary>
- /// Processing state
+ /// Processing state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Processing = 3,
/// <summary>
- /// Unavailable
+ /// Unavailable.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Unavailable
};
/// <summary>
- /// Enumeration for the Silence Detection types
+ /// Enumeration for the silence detection types.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum SilenceDetection
{
/// <summary>
- /// Silence detection type - False
+ /// Silence detection type - False.
/// </summary>
/// <since_tizen> 3 </since_tizen>
False = 0,
/// <summary>
- /// Silence detection type - True
+ /// Silence detection type - True.
/// </summary>
/// <since_tizen> 3 </since_tizen>
True = 1,
/// <summary>
- /// Silence detection type - Auto
+ /// Silence detection type - Auto.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Auto = 2
/// <summary>
/// A main function of Speech-To-Text (below STT) API recognizes sound data recorded by users.
- /// After choosing a language, applications will start recording and recognizing.
+ /// After choosing a language, the applications will start recording and recognizing.
/// After recording, the applications will receive the recognized result.
/// The STT has a client-server for the service of multi-applications.
- /// 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.
+ /// The STT service always works in the background as a server. If the service is not working, client library will invoke it and the client will communicate with it.
+ /// The service has engines and a recorder, so that the 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
/// 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>
+ /// <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 STT state changes.
+ /// Event to be invoked when the STT state changes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<StateChangedEventArgs> StateChanged
}
/// <summary>
- /// Event to be invoked when default language change.
+ /// Event to be invoked when the default language changes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<DefaultLanguageChangedEventArgs> DefaultLanguageChanged
}
/// <summary>
- /// Event to be invoked to detect engine change.
+ /// Event to be invoked to detect the engine change.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public event EventHandler<EngineChangedEventArgs> EngineChanged
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <pre>
- /// The State must be Recording.
+ /// The state must be recording.
/// </pre>
public float RecordingVolume
{
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <returns>
- /// Current STT State value.
+ /// Current STT state value.
/// </returns>
public State CurrentState
{
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <exception cref="InvalidOperationException">
- /// This Exception can occur while setting due to the following reasons
+ /// This exceptioncan occur while setting due to the following reasons:
/// 1. Operation Failed
/// 2. Invalid State
/// </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>
- /// <exception cref="ArgumentException"> This can happen if Improper EngineId is provided while setting the value. </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>
+ /// <exception cref="ArgumentException">This can happen if improper EngineId is provided while setting the value.</exception>
/// <pre>
- /// The State must be Created.
+ /// The state must be created.
/// </pre>
public string Engine
{
}
/// <summary>
- /// Retrieves the time stamp of the current recognition result
+ /// Retrieves the time stamp of the current recognition result.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
- /// list of ResultTime
+ /// List of ResultTime.
/// </returns>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// http://tizen.org/feature/microphone
/// </feature>
/// <remarks>
- /// This function should only be called in RecognitionResult Event
+ /// This function should only be called in the RecognitionResult event.
/// </remarks>
- /// <exception cref="InvalidOperationException"> This Exception can be due to 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>
+ /// <exception cref="InvalidOperationException">This exception can be due to 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<ResultTime> GetDetailedResult()
{
List<ResultTime> list = new List<ResultTime>();
/// <summary>
- /// Gets the private data from stt engine.
+ /// Gets the private data from the STT engine.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="key">
- /// The key string
+ /// The key string.
/// </param>
/// <returns>
- /// The Data Corresponding to the Key provided
+ /// The data corresponding to the key is provided.
/// </returns>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// 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="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.
+ /// The state must be ready.
/// </pre>
public string GetPrivateData(string key)
{
}
/// <summary>
- /// Sets the private data to stt engine.
+ /// Sets the private data to the STT engine.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="key">
- /// The key string
+ /// The key string.
/// </param>
/// <param name="data">
- /// The data string
+ /// The data string.
/// </param>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// 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="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.
+ /// The state must be ready.
/// </pre>
public void SetPrivateData(string key, string data)
{
}
/// <summary>
- /// Gets the list of Supported Engine
+ /// Gets the list of supported engines.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
- /// IEnumerable<SupportedEngine> list of supported engines
+ /// IEnumerable<SupportedEngine> list of supported engines.
/// </returns>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// 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>
+ /// <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
+ /// Sets the application credential.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="credential">
- /// The credential string
+ /// The credential string.
/// </param>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// http://tizen.org/feature/microphone
/// </feature>
/// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reasons
+ /// This exceptioncan be due to the following reasons:
/// 1. Operation Failed
/// 2. Invalid State
/// </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>
+ /// <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.
+ /// The state must be created.
/// </pre>
public void SetCredential(string credential)
{
/// 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>
+ /// <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.
+ /// The state must be created.
/// </pre>
/// <post>
- /// If this function is successful, the STT state will be Ready
- /// If this function is unsuccessful, ErrorOccurred event will be invoked
+ /// If this function is successful, the STT state will be ready.
+ /// If this function is unsuccessful, ErrorOccurred event will be invoked.
/// </post>
public void Prepare()
{
/// 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>
+ /// <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.
+ /// The state must be ready.
/// </pre>
/// <post>
- /// If this function is successful, the STT state will be Created
+ /// If this function is successful, the STT state will be Created.
/// </post>
public void Unprepare()
{
}
/// <summary>
- /// Retrieves all supported languages of current engine.
+ /// Retrieves all the supported languages of the current engine.
/// 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>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <returns>
- /// list of strings of supported languages.
+ /// List of strings for 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
+ /// This exception can be due to the following reasons:
/// 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>
+ /// <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> GetSupportedLanguages()
{
List<string> languageList = new List<string>();
/// RecognitionType value.
/// </param>
/// <returns>
- /// bool value indicating whether the recognition type is supported.
+ /// 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
+ /// This exception can be due to the following reasons:
/// 1. Invalid State
- /// 2. Engine Not Found.
- /// 3. Operation Failed.
+ /// 2. Engine Not Found
+ /// 3. Operation Failed
/// </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="NotSupportedException">This exception can be due to STT not supported.</exception>
/// <pre>
- /// The state should be Ready.
+ /// The state should be ready.
/// </pre>
public bool IsRecognitionTypeSupported(RecognitionType type)
{
/// http://tizen.org/feature/microphone
/// </feature>
/// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reasons
+ /// This exception can be due to the following reasons:
/// 1. Invalid State
- /// 2. Not supported feature of current engine.
- /// 3. Operation Failed.
+ /// 2. Not supported feature of current engine
+ /// 3. Operation Failed
/// </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to STT Not Supported. </exception>
+ /// <exception cref="NotSupportedException">This exception can be due to STT not supported.</exception>
/// <pre>
- /// The state should be Ready.
+ /// The state should be ready.
/// </pre>
public void SetSilenceDetection(SilenceDetection type)
{
/// <summary>
/// Sets the sound to start recording.
- /// Sound file type should be wav type.
+ /// Sound file type should be .wav type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <param name="filePath">
- /// File Path for the sound.
+ /// 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. Invalid State.
- /// 2. Operation Failed.
+ /// This exception can be due to the following reasons:
+ /// 1. Invalid State
+ /// 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>
+ /// <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.
+ /// The state should be ready.
/// </pre>
public void SetStartSound(string filePath)
{
/// http://tizen.org/feature/microphone
/// </feature>
/// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reasons
- /// 1. Invalid State.
- /// 2. Operation Failed.
+ /// This exception can be due to the following reasons:
+ /// 1. Invalid State
+ /// 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>
+ /// <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.
+ /// The state should be ready.
/// </pre>
public void UnsetStartSound()
{
/// <summary>
/// Sets the sound to stop recording.
- /// Sound file type should be wav type.
+ /// Sound file type should be .wav type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/microphone
/// </feature>
/// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reasons
- /// 1. Invalid State.
- /// 2. Operation Failed.
+ /// This exception can be due to the following reasons:
+ /// 1. Invalid State
+ /// 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>
- /// <exception cref="ArgumentException"> If an Invalid Parameter is provided. </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 exception can be due to Invalid Parameter.</exception>
/// <pre>
- /// The state should be Ready.
+ /// The state should be ready.
/// </pre>
public void SetStopSound(string filePath)
{
/// http://tizen.org/feature/microphone
/// </feature>
/// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reasons
- /// 1. Invalid State.
- /// 2. Operation Failed.
+ /// This exception can be due to the following reasons:
+ /// 1. Invalid State
+ /// 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>
+ /// <exception cref="NotSupportedException">This exception can be due to STT not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException"> his exception can be due to permission denied.</exception>
/// <pre>
- /// The state should be Ready.
+ /// The state should be ready.
/// </pre>
public void UnsetStopSound()
{
}
/// <summary>
- /// Starts recording and recognition asynchronously.
- /// 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
+ /// Starts the recording and recognition asynchronously.
+ /// This function starts recording in the STT service and sends the recording data to the engine.
+ /// This work continues until stop, cancel, or silence is detected by engine.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <param name="language">
- /// The language selected
+ /// The language selected.
/// </param>
/// <param name="type">
- /// The type for recognition
+ /// 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. Invalid State.
- /// 2. Operation Failed.
- /// 3. Recorder Busy.
+ /// This exception can be due to the following reasons:
+ /// 1. Invalid State
+ /// 2. Operation Failed
+ /// 3. Recorder Busy
/// 4. Progress to recording is not finished
/// </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"> If an Invalid Language is provided. </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 exception can be due to an invalid language.</exception>
/// <pre>
- /// The state should be Ready.
+ /// The state should be ready.
/// </pre>
/// <post>
- /// It will invoke StateChanged Event if registered.
- /// If this function succeeds, the STT state will be Recording.
- /// If you call this function again before state changes, you will receive ErrorINProgressToRecording.
+ /// It will invoke the StateChanged event, if registered.
+ /// If this function succeeds, the STT state will be recording.
+ /// If you call this function again before the state changes, you will receive ErrorINProgressToRecording.
/// </post>
public void Start(string language, RecognitionType type)
{
}
/// <summary>
- /// Finishes the recording and starts recognition processing in engine asynchronously.
+ /// Finishes the recording and starts recognition processing in the engine asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/microphone
/// </feature>
/// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reasons
- /// 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.
+ /// This exception can be due to the following reasons:
+ /// 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>
- /// <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="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>
/// <post>
- /// It will invoke StateChanged Event if registered.
- /// 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
+ /// It will invoke the StateChanged Event, if registered.
+ /// If this function succeeds, the STT state will be processing.
+ /// If you call this function again before the state changes, you will receive ErrorINProgressToProcessing.
+ /// After processing of engine, the RecognitionResult event is invoked.
/// </post>
public void Stop()
{
}
/// <summary>
- /// Cancels processing recognition and recording asynchronously.
- /// This function cancels recording and engine cancels recognition processing.
- /// After successful cancel, StateChanged event is invoked otherwise if error is occurred, ErrorOccurred event is invoked.
+ /// Cancels processing the recognition and recording asynchronously.
+ /// This function cancels recording and the engine cancels recognition processing.
+ /// After successful cancellation, the StateChanged event is invoked, otherwise if an error is occurs, the ErrorOccurred event is invoked.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/microphone
/// </feature>
/// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reasons
- /// 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.
+ /// This exception can be due to the following reasons:
+ /// 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>
- /// <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="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>
/// <post>
- /// It will invoke StateChanged Event if registered.
- /// If this function succeeds, the STT state will be Ready.
- /// If you call this function again before state changes, you will receive ErrorINProgressToReady.
+ /// It will invoke the StateChanged event, if registered.
+ /// If this function succeeds, the STT state will be ready.
+ /// If you call this function again before the state changes, you will receive ErrorINProgressToReady.
/// </post>
public void Cancel()
{
}
/// <summary>
- /// Method to release resources
+ /// A method to release resources.
/// </summary>
public void Dispose()
{
namespace Tizen.Uix.Stt
{
/// <summary>
- /// This Class provideds the Information related to STT Engine.
+ /// This class provides the information related to STT engine.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class SupportedEngine
this._engineName = name;
}
/// <summary>
- /// The Engine Id
+ /// The engine ID.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
- /// The string Engine Id
+ /// The string engine ID.
/// </returns>
public string EngineId
{
}
/// <summary>
- /// The Engine Name
+ /// The engine name.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
- /// The string Engine Name
+ /// The string engine name.
/// </returns>
public string EngineName
{
*/
/// <summary>
-/// Partial Interop Class
+/// Partial interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Partial Libraries Class
+ /// Partial libraries class.
/// </summary>
internal static partial class Libraries
{
using static Interop.VoiceControlCommand;
/// <summary>
-/// Partial Interop Class
+/// Partial interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// VoiceControl Interop Class
+ /// VoiceControl interop class.
/// </summary>
internal static class VoiceControl
{
-/*
+/*
* Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
using Tizen.Uix.VoiceControl;
/// <summary>
-/// Partial Interop Class
+/// Partial interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// VoiceControlCommand Interop Class
+ /// VoiceControlCommand interop class.
/// </summary>
internal static class VoiceControlCommand
{
namespace Tizen.Uix.VoiceControl
{
/// <summary>
- /// This class holds information about the CurrentLanguageChanged Event
+ /// This class holds information about the CurrentLanguageChanged event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class CurrentLanguageChangedEventArgs
}
/// <summary>
- /// The previous language
+ /// The previous language.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string PreviousLanguage
}
/// <summary>
- /// The current language
+ /// The current language.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string CurrentLanguage
namespace Tizen.Uix.VoiceControl
{
/// <summary>
- /// This class holds information related to the VoiceControl ErrorOccured Event
+ /// This class holds information related to the VoiceControl ErrorOccured event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class ErrorOccuredEventArgs
}
/// <summary>
- /// The Error Value
+ /// The error value.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public Error ErrorValue
{
/// <summary>
/// The recognition result from the engine.
- /// 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.
+ /// If the duplicated commands are recognized, the event(e.g. Result.Rejected) of a command may be rejected
+ /// for selecting the command as a priority. If you set similar or same commands, or the recognized results are multi-results, the CommandList has multi commands.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class RecognitionResult
}
/// <summary>
- /// The result event
+ /// The result event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public ResultEvent Result
}
/// <summary>
- /// The spoken text
+ /// The spoken text.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string ResultMessage
/// <summary>
- /// The recognized command list
+ /// The recognized command list.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public VoiceCommandList CommandList
}
/// <summary>
- /// Gets the Recognition result
+ /// Gets the recognition result.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public RecognitionResult Result
namespace Tizen.Uix.VoiceControl
{
/// <summary>
- /// This class holds information related to the VoiceControl service ServiceStateChanged event
+ /// This class holds information related to the VoiceControl service ServiceStateChanged event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class ServiceStateChangedEventArgs
}
/// <summary>
- /// A previous state
+ /// The previous state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public ServiceState Previous
}
/// <summary>
- /// A current state
+ /// The current state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public ServiceState Current
namespace Tizen.Uix.VoiceControl
{
/// <summary>
- /// This class holds information related to the VoiceControl client StateChanged event
+ /// This class holds information related to the VoiceControl client StateChanged event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class StateChangedEventArgs
}
/// <summary>
- /// A previous state
+ /// The previous state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public State Previous
}
/// <summary>
- /// A current state
+ /// The current state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public State Current
namespace Tizen.Uix.VoiceControl
{
/// <summary>
- /// Enumeration for Command Format
+ /// Enumeration for the command format.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CommandFormat
{
/// <summary>
- /// fixed command format.
+ /// The fixed command format.
/// </summary>
Fixed = 0,
/// <summary>
- /// fixed and variable fixed command format.
+ /// The fixed and variable fixed command format.
/// </summary>
FixedAndVFixed = 1,
/// <summary>
- /// variable fixed and fixed command format.
+ /// The variable fixed and fixed command format.
/// </summary>
VFixedAndFixed = 2,
/// <summary>
- /// fixed and non-fixed command format.
+ /// The fixed and non-fixed command format.
/// </summary>
FixedAndNonFixed = 3,
/// <summary>
- /// non-fixed and fixed command format.
+ /// The non-fixed and fixed command format.
/// </summary>
NonFixedAndFixed = 4,
/// <summary>
- /// Undefined
+ /// Undefined.
/// </summary>
Undefined = 5
};
/// <summary>
- /// This class represents a Voice Command
+ /// This class represents a voice command.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class VoiceCommand
internal SafeCommandHandle _handle;
/// <summary>
- /// Public Constructor
+ /// The 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>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
+ /// <exception cref="InvalidOperationException">This exception can be due to an 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>
+ /// <exception cref="NotSupportedException">This exception can be due to not supported.</exception>
public VoiceCommand()
{
SafeCommandHandle handle;
/// <summary>
/// Gets the unfixed command.
/// This property should be used for commands which have non-fixed format.
- /// empty string will be returned in case of some internal error
+ /// An empty string will be returned in case of some internal error.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public string UnfixedCommand
}
/// <summary>
- /// Gets/Sets command type.
+ /// Gets or sets the 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>
+ /// <remarks>If you do not set the command type, the default value is undefined. You should set the type if the 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>
public CommandType Type
{
get
}
/// <summary>
- /// Gets/Sets the command format.
+ /// Gets or 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>
+ /// <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>
public CommandFormat Format
{
get
}
/// <summary>
- /// Gets/Sets command
- /// in case of get empty string will be returned in case of some internal error
+ /// Gets or sets the command.
+ /// A 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>
+ /// <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
{
get
namespace Tizen.Uix.VoiceControl
{
/// <summary>
- /// this class represents list of Voice Commands
+ /// This class represents a list of the voice commands.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class VoiceCommandList
internal SafeCommandListHandle _handle;
private List<VoiceCommand> _list;
private VcCmdListCb _callback;
+ private int _index;
/// <summary>
- /// Public Constructor
+ /// The public constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/speech.control
/// http://tizen.org/feature/microphone
/// </feature>
- /// <exception cref="OutOfMemoryException"> This Exception can be due to Out of memory. </exception>
- /// <exception cref="ArgumentException"> This Exception can be due to Invalid Parameter. </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
+ /// <exception cref="OutOfMemoryException">This exception can be due to out of memory.</exception>
+ /// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
+ /// <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 VoiceCommandList()
{
SafeCommandListHandle handle;
throw ExceptionFactory.CreateException(error);
}
_handle = handle;
+ _list = new List<VoiceCommand>();
+ _index = 0;
}
internal VoiceCommandList(SafeCommandListHandle handle)
{
_handle = handle;
+ _index = 0;
+
+ _list = new List<VoiceCommand>();
+ _callback = (IntPtr vcCommand, IntPtr userData) =>
+ {
+ SafeCommandHandle cmdHandle = new SafeCommandHandle(vcCommand);
+ cmdHandle._ownership = false;
+ _list.Add(new VoiceCommand(cmdHandle));
+ return true;
+ };
+ ErrorCode error = VcCmdListForeachCommands(_handle, _callback, IntPtr.Zero);
+ if (error != ErrorCode.None)
+ {
+ Log.Error(LogTag, "GetAllCommands Failed with error " + error);
+ throw ExceptionFactory.CreateException(error);
+ }
}
/// <summary>
- /// Gets command count of list.
- /// -1 is returned in case of internal failure.
+ /// Gets a command count of the list.
+ /// -1 is returned in case of an internal failure.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// Command counts of the list.
+ /// Command count of the list.
/// </value>
/// <privilege>
/// http://tizen.org/privilege/recorder
}
/// <summary>
- /// Get current command from command list by index.
- /// null will be returned in case of Empty List
+ /// Gets the current command from the command list by index.
+ /// Null will be returned in case of an empty list.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
{
SafeCommandHandle current;
ErrorCode error = VcCmdListGetCurrent(_handle, out current);
- if (error != ErrorCode.None)
+ if (ErrorCode.None != error)
{
Log.Error(LogTag, "Current Failed with error " + error);
return null;
}
- current._ownership = false;
- return new VoiceCommand(current);
+
+ return _list[_index];
}
}
/// <summary>
- /// Adds command to command list.
+ /// Adds a command to the command list.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/microphone
/// </feature>
/// <param name="command">The command</param>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
- /// <exception cref="NullReferenceException"> This will occur if the provide parameter is null. </exception>
+ /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+ /// <exception cref="NotSupportedException">This exception can be due to not supported.</exception>
+ /// <exception cref="NullReferenceException">This will occur if the provided parameter is null.</exception>
public void Add(VoiceCommand command)
{
ErrorCode error = VcCmdListAdd(_handle, command._handle);
Log.Error(LogTag, "Add Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
+
+ _list.Add(command);
}
/// <summary>
- /// Removes command from command list.
+ /// Removes a command from the command list.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/microphone
/// </feature>
/// <param name="command">The command</param>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
- /// <exception cref="NullReferenceException"> This will occur if the provide parameter is null. </exception>
+ /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
+ /// <exception cref="NotSupportedException">This exception can be due to not supported.</exception>
+ /// <exception cref="NullReferenceException">This will occur if the provided parameter is null.</exception>
public void Remove(VoiceCommand command)
{
ErrorCode error = VcCmdListRemove(_handle, command._handle);
Log.Error(LogTag, "Remove Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
+
+ _list.Remove(command);
}
/// <summary>
- /// Retrieves all commands of command list.
+ /// Retrieves all commands from the command list.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/speech.control
/// http://tizen.org/feature/microphone
/// </feature>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
+ /// <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 IEnumerable<VoiceCommand> GetAllCommands()
{
- _list = new List<VoiceCommand>();
+ List<VoiceCommand> commandList = new List<VoiceCommand>();
_callback = (IntPtr vcCommand, IntPtr userData) =>
{
SafeCommandHandle handle = new SafeCommandHandle(vcCommand);
handle._ownership = false;
- _list.Add(new VoiceCommand(handle));
+ commandList.Add(new VoiceCommand(handle));
return true;
};
ErrorCode error = VcCmdListForeachCommands(_handle, _callback, IntPtr.Zero);
}
/// <summary>
- /// Moves index to first command.
+ /// Moves an index to the first command.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/speech.control
/// http://tizen.org/feature/microphone
/// </feature>
- /// <exception cref="InvalidOperationException"> This Exception can be due to List Empty. </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
+ /// <exception cref="InvalidOperationException">This exception can be due to list empty.</exception>
+ /// <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 void First()
{
ErrorCode error = VcCmdListFirst(_handle);
- if (error != ErrorCode.None)
+ if (ErrorCode.None != error)
{
Log.Error(LogTag, "First Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
+ _index = 0;
}
/// <summary>
- /// Moves index to last command.
+ /// Moves an index to the last command.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/speech.control
/// http://tizen.org/feature/microphone
/// </feature>
- /// <exception cref="InvalidOperationException"> This Exception can be due to List Empty. </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
+ /// <exception cref="InvalidOperationException">This exception can be due to list empty.</exception>
+ /// <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 void Last()
{
ErrorCode error = VcCmdListLast(_handle);
- if (error != ErrorCode.None)
+ if (ErrorCode.None != error)
{
Log.Error(LogTag, "Last Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
+ _index = Count - 1;
}
/// <summary>
- /// Moves index to next command.
+ /// Moves an index to the next command.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/microphone
/// </feature>
/// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reaons
- /// 1. List Empty
+ /// This exception can be due to the following reasons:
+ /// 1. List empty
/// 2. List reached end
/// </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
+ /// <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 void Next()
{
ErrorCode error = VcCmdListNext(_handle);
- if (error != ErrorCode.None)
+ if (ErrorCode.None != error)
{
Log.Error(LogTag, "Next Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
+ _index++;
}
/// <summary>
- /// Moves index to previous command.
+ /// Moves an index to the previous command.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/microphone
/// </feature>
/// <exception cref="InvalidOperationException">
- /// This Exception can be due to the following reaons
- /// 1. List Empty
+ /// This exception can be due to the following reasons:
+ /// 1. List empty
/// 2. List reached end
/// </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
+ /// <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 void Previous()
{
ErrorCode error = VcCmdListPrev(_handle);
- if (error != ErrorCode.None)
+ if (ErrorCode.None != error)
{
Log.Error(LogTag, "Previous Failed with error " + error);
throw ExceptionFactory.CreateException(error);
}
+ _index--;
}
}
}
namespace Tizen.Uix.VoiceControl
{
/// <summary>
- /// Enum for Error values that can occur
+ /// Enumeration for the error values that can occur.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum Error
{
/// <summary>
- /// Successful, No error
+ /// Successful, no error.
/// </summary>
None,
/// <summary>
- /// Out of Memory
+ /// Out of memory.
/// </summary>
OutOfMemory,
/// <summary>
- /// I/O error
+ /// I/O error.
/// </summary>
IoError,
/// <summary>
- /// Invalid parameter
+ /// Invalid parameter.
/// </summary>
InvalidParameter,
/// <summary>
- /// No answer from the STT service
+ /// No answer from the STT service.
/// </summary>
TimedOut,
/// <summary>
- /// Device or resource busy
+ /// Device or resource busy.
/// </summary>
RecorderBusy,
/// <summary>
- /// Permission denied
+ /// Permission denied.
/// </summary>
PermissionDenied,
/// <summary>
- /// VC NOT supported
+ /// VC NOT supported.
/// </summary>
NotSupported,
/// <summary>
- /// Invalid state
+ /// Invalid state.
/// </summary>
InvalidState,
/// <summary>
- /// Invalid language
+ /// Invalid language.
/// </summary>
InvalidLanguage,
/// <summary>
- /// No available engine
+ /// No available engine.
/// </summary>
EngineNotFound,
/// <summary>
- /// Operation failed
+ /// Operation failed.
/// </summary>
OperationFailed,
/// <summary>
- /// Operation Rejected
+ /// Operation rejected.
/// </summary>
OperationRejected,
/// <summary>
- /// List reached end
+ /// List reached end.
/// </summary>
IterationEnd,
/// <summary>
- /// List Empty
+ /// List empty.
/// </summary>
Empty,
/// <summary>
- /// Service reset
+ /// Service reset.
/// </summary>
ServiceReset,
/// <summary>
- /// Progress to ready is not finished
+ /// Progress to ready is not finished.
/// </summary>
InProgressToReady,
/// <summary>
- /// Progress to recording is not finished
+ /// Progress to recording is not finished.
/// </summary>
InProgressToRecording,
/// <summary>
- /// Progress to processing is not finished
+ /// Progress to processing is not finished.
/// </summary>
InProgressToProcessing
};
public enum State
{
/// <summary>
- /// 'None' state
+ /// 'None' state.
/// </summary>
None = 0,
/// <summary>
- /// 'Initialized' state
+ /// 'Initialized' state.
/// </summary>
Initialized = 1,
/// <summary>
- /// 'Ready' state
+ /// 'Ready' state.
/// </summary>
Ready = 2,
/// <summary>
- /// state cannot be determined
+ /// The state cannot be determined.
/// </summary>
Unavailable
};
/// <summary>
- /// Enumerations of service state.
+ /// Enumeration for the service state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum ServiceState
{
/// <summary>
- /// 'None' state
+ /// 'None' state.
/// </summary>
None = 0,
/// <summary>
- /// 'Ready' state
+ /// 'Ready' state.
/// </summary>
Ready = 1,
/// <summary>
- /// 'Recording' state
+ /// 'Recording' state.
/// </summary>
Recording = 2,
/// <summary>
- /// 'Processing' state
+ /// 'Processing' state.
/// </summary>
Processing = 3,
/// <summary>
- /// state cannot be determined
+ /// The state cannot be determined.
/// </summary>
Unavailable
};
/// <summary>
- /// Enumerations of result event.
+ /// Enumeration for the result event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum ResultEvent
{
/// <summary>
- /// Normal result
+ /// Normal result.
/// </summary>
Success = 0,
/// <summary>
- /// Rejected result
+ /// Rejected result.
/// </summary>
Rejected = 1
};
/// <summary>
- /// Enumerations of command type.
+ /// Enumeration for the command type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CommandType
{
/// <summary>
- /// Foreground command by client
+ /// Foreground command by the client.
/// </summary>
Foreground = 1,
/// <summary>
- /// Background command by client
+ /// Background command by the client.
/// </summary>
Background = 2,
/// <summary>
- /// Undefined command
+ /// The undefined command.
/// </summary>
Undefined = -1
};
/// <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.
+ /// A main function of the voice control API registers the command and gets a notification for the recognition result.
+ /// Applications can add their own commands and provide results when their command is recognized by the 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.
- /// </remarks>
- /// <param name="evt">The ResultEvent</param>
- /// <param name="cmdList">Command List</param>
- /// <param name="result">Result</param>
-
private static event EventHandler<RecognitionResultEventArgs> _recognitionResult;
private static event EventHandler<StateChangedEventArgs> _stateChanged;
private static event EventHandler<ServiceStateChangedEventArgs> _serviceStateChanged;
private static RecognitionResult s_recognitionResult;
/// <summary>
- /// Gets current language.
+ /// Gets the current language.
/// A 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.
- /// Empty string is returned incase of some internal error
+ /// An empty string is returned in case of some internal error.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// Current language in voice control.
+ /// The current language in voice control.
/// </value>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <pre>
- /// The State must be Initialized or Ready.
+ /// The state must be initialized or ready.
/// </pre>
public static string CurrentLanguage
{
}
/// <summary>
- /// Gets current state of voice control client.
+ /// Gets the current state of the voice control client.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// Current state of voice control client.
+ /// The current state of the voice control client.
/// </value>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <pre>
- /// The State must be Initialized or Ready.
+ /// The state must be initialized or ready.
/// </pre>
public static State State
{
}
/// <summary>
- /// Gets current state of voice control service.
+ /// Gets the current state of the voice control service.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// Current state of voice control service.
+ /// The current state of the voice control service.
/// </value>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <pre>
- /// The State must be Ready.
+ /// The state must be ready.
/// </pre>
public static ServiceState ServiceState
{
/// http://tizen.org/feature/microphone
/// </feature>
/// <remarks>
- /// Invocation name is used to activate background commands. The invocation name can be the same as the application name or any other phrase.
+ /// The invocation name is used to activate background commands. The invocation name can be same as the application name or any other phrase.
/// For example, an application "Tizen Sample" has a background command, "Play music", and the invocation name of the application is set to "Tizen Sample".
/// In order to activate the background command, users can say "Tizen Sample, Play music". The invocation name is dependent on the current language.
/// For example, if the current language is "en_US"(English), the invocation name is also "en_US".
/// If the current language is "ja_JP"(Japanese) and the invocation name is "en_US", the invocation name will not be recognized.
- /// This function should be called before SetCommandList().
+ /// This function should be called before the SetCommandList().
/// </remarks>
- /// <param name="name">Invocation name that an application wants to be invoked by</param>
- /// <exception cref="InvalidOperationException"> This Exception can be due to Invalid State. </exception>
- /// <exception cref="ArgumentException"> This Exception can be due to Invalid Parameter. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <param name="name">Invocation name to be invoked by an application.</param>
+ /// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
+ /// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
+ /// <exception cref="NotSupportedException">This exception can be due to not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <pre>
- /// The State must be Ready.
+ /// The state must be ready.
/// </pre>
public static void SetInvocationName(string name)
{
}
/// <summary>
- /// Initializes voice control.
+ /// Initializes the voice control.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/speech.control
/// 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 Not Supported. </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to 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 not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <post>
- /// The State will be Initialized.
+ /// The state will be initialized.
/// </post>
public static void Initialize()
{
}
/// <summary>
- /// Deinitializes voice control.
+ /// Deinitializes the voice control.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/speech.control
/// http://tizen.org/feature/microphone
/// </feature>
- /// <exception cref="InvalidOperationException"> This Exception can be due to Invalid State. </exception>
- /// <exception cref="InvalidOperationException"> This Exception can be due to Operation Failed. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
+ /// <exception cref="InvalidOperationException">This exception can be due to operation failed.</exception>
+ /// <exception cref="NotSupportedException">This exception can be due to not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
public static void Deinitialize()
{
ErrorCode error = VcDeinitialize();
/// http://tizen.org/feature/speech.control
/// http://tizen.org/feature/microphone
/// </feature>
- /// <exception cref="InvalidOperationException"> This Exception can be due to Invalid State. </exception>
- /// <exception cref="InvalidOperationException"> This Exception can be due to Operation Failed. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
+ /// <exception cref="InvalidOperationException">This exception can be due to operation failed.</exception>
+ /// <exception cref="NotSupportedException">This exception can be due to not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <pre>
- /// The State should be Initialized
+ /// The state must be initialized.
/// </pre>
/// <post>
- /// The State will be Ready
+ /// The state must be ready.
/// </post>
public static void Prepare()
{
/// http://tizen.org/feature/speech.control
/// 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 Not Supported. </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
+ /// <exception cref="NotSupportedException">This exception can be due to not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <pre>
- /// The State should be Ready
+ /// The state must be ready.
/// </pre>
/// <post>
- /// The State should be Initialized
+ /// The state must be initialized.
/// </post>
public static void Unprepare()
{
}
/// <summary>
- /// Retrieves all supported languages.
+ /// Retrieves all the supported languages.
/// A 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.
/// http://tizen.org/feature/speech.control
/// http://tizen.org/feature/microphone
/// </feature>
- /// <exception cref="InvalidOperationException"> This Exception can be due to Invalid State. </exception>
- /// <exception cref="InvalidOperationException"> This Exception can be due to Operation Failed. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
+ /// <exception cref="InvalidOperationException">This exception can be due to operation failed.</exception>
+ /// <exception cref="NotSupportedException">This exception can be due to not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <pre>
- /// The State should be Ready or Initialized
+ /// The state must be ready or initialized.
/// </pre>
public static IEnumerable<string> GetSupportedLanguages()
{
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
- /// The Command List else null in case of no System Commands
+ /// The command list, else null in case of no system commands.
/// </returns>
/// <privilege>
/// http://tizen.org/privilege/recorder
/// </privilege>
/// <privlevel>
- /// public
+ /// public.
/// </privlevel>
/// <feature>
/// http://tizen.org/feature/speech.control
/// </feature>
/// <remarks>
/// In the system command list, there are system commands predefined by product manufacturers.
- /// Those commands have the highest priority. Therefore, the user can not set any commands same with the system commands.
+ /// Those commands have the highest priority. Therefore, the user cannot set any commands similar to system commands.
/// </remarks>
- /// <exception cref="InvalidOperationException"> This Exception can be due to Invalid State. </exception>
- /// <exception cref="InvalidOperationException"> This Exception can be due to Operation Failed. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
+ /// <exception cref="InvalidOperationException">This exception can be due to operation failed.</exception>
+ /// <exception cref="NotSupportedException">This exception can be due to not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <pre>
- /// The State should be Ready
+ /// The state must be ready.
/// </pre>
public static VoiceCommandList GetSystemCommandList()
{
/// <summary>
/// Requests to start the dialogue.
- /// Using this function, the developer can request starting the dialogue to the framework.
- /// When the developer requests the dialogue, two types of texts, dispText and uttText, can be sent by this function.dispText is a text for displaying, and uttText is that for uttering.
+ /// By using this function, the developer can start requesting the dialogue to the framework.
+ /// When the developer requests the dialogue, two types of texts, dispText and uttText can be sent by this function. dispText is a text for displaying and uttText is that for uttering.
/// For example, if dispText is "October 10th" and uttText is "Today is October 10th.", "October 10th" will be displayed on the screen and "Today is October 10th." will be spoken.
/// 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.
+ /// If the developer sets autoStart as True, the framework will start to record the next speech and continue the dialogue.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/microphone
/// </feature>
/// <remarks>
- /// If autoStart is true, the recognition will start again. In this case, it can be restarted up to 4 times.
+ /// If autoStart is True, the recognition will start again. In this case, it can be restarted up to 4 times.
/// </remarks>
- /// <param name="dispText"> Text to be displayed on the screen/// </param>
- /// <param name="uttText">Text to be spoken</param>
- /// <param name="autoStart">A variable for setting whether the dialog session will be restarted automatically or not</param>
- /// <exception cref="InvalidOperationException"> This Exception can be due to Invalid State. </exception>
- /// <exception cref="ArgumentException"> This Exception can be due to Invalid Parameter. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <param name="dispText">Text to be displayed on the screen.</param>
+ /// <param name="uttText">Text to be spoken.</param>
+ /// <param name="autoStart">A variable for setting whether the dialog session will be restarted automatically or not.</param>
+ /// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
+ /// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
+ /// <exception cref="NotSupportedException">This exception can be due to not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <pre>
- /// The State should be Ready
+ /// The state must be ready.
/// </pre>
public static void RequestDialog(string dispText, string uttText, bool autoStart)
{
}
/// <summary>
- /// Sets command list.
+ /// Sets the command list.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </feature>
/// <remarks>
/// The command type is valid for CommandType 'Foreground' or 'Background'.
- /// The matched commands of command list should be set and they should include type and command text at least.
+ /// The matched commands of the command list should be set and they should include type and command text at least.
/// </remarks>
/// <param name="list">Command list</param>
/// <param name="type">Command type</param>
- /// <exception cref="InvalidOperationException"> This Exception can be due to Invalid State. </exception>
- /// <exception cref="ArgumentException"> This Exception can be due to Invalid Parameter. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
+ /// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
+ /// <exception cref="NotSupportedException">This exception can be due to not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <pre>
- /// The State should be Ready
+ /// The state must be ready.
/// </pre>
public static void SetCommandList(VoiceCommandList list, CommandType type)
{
}
/// <summary>
- /// Unsets command list.
+ /// Unsets the command list.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// http://tizen.org/feature/microphone
/// </feature>
/// <param name="type">Command type</param>
- /// <exception cref="InvalidOperationException"> This Exception can be due to Invalid State. </exception>
- /// <exception cref="ArgumentException"> This Exception can be due to Invalid Parameter. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
- /// <exception cref="UnauthorizedAccessException"> This Exception can be due to Permission Denied. </exception>
+ /// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
+ /// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
+ /// <exception cref="NotSupportedException">This exception can be due to not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">This exception can be due to permission denied.</exception>
/// <pre>
- /// The State should be Ready
+ /// The state should be ready.
/// </pre>
public static void UnsetCommandList(CommandType type)
{
/// http://tizen.org/feature/speech.control
/// http://tizen.org/feature/microphone
/// </feature>
- /// <exception cref="InvalidOperationException"> This Exception can be due to Invalid State. </exception>
- /// <exception cref="ArgumentException"> This Exception can be due to Invalid Parameter. </exception>
- /// <exception cref="NotSupportedException"> This Exception can be due to Not Supported. </exception>
- /// <returns>The Recognition Result if possible else a null object</returns>
+ /// <exception cref="InvalidOperationException">This exception can be due to an invalid state.</exception>
+ /// <exception cref="ArgumentException">This exception can be due to an invalid parameter.</exception>
+ /// <exception cref="NotSupportedException">This exception can be due to not supported.</exception>
+ /// <returns>The recognition result if possible, else a null object.</returns>
/// <pre>
- /// The State should be Ready
+ /// The state must be ready.
/// </pre>
public static RecognitionResult GetResult()
{
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <pre>
- /// The State should be Initialized
+ /// The state must be initialized.
/// </pre>
public static event EventHandler<RecognitionResultEventArgs> RecognitionResult
{
}
/// <summary>
- /// Event to be invoked when VoiceControl service state changes.
+ /// Event to be invoked when the VoiceControl service state changes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <pre>
- /// The State should be Initialized
+ /// The state must be initialized.
/// </pre>
public static event EventHandler<ServiceStateChangedEventArgs> ServiceStateChanged
{
}
/// <summary>
- /// Event to be invoked when VoiceControl client state changes.
+ /// Event to be invoked when the VoiceControl client state changes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <pre>
- /// The State should be Initialized
+ /// The state must be initialized.
/// </pre>
public static event EventHandler<StateChangedEventArgs> StateChanged
{
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <pre>
- /// The State should be Initialized
+ /// The state must be initialized.
/// </pre>
public static event EventHandler<ErrorOccuredEventArgs> ErrorOccured
{
}
/// <summary>
- /// Event to be invoked when default laungage change.
+ /// Event to be invoked when the default language changes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <pre>
- /// The State should be Initialized
+ /// The state must be initialized.
/// </pre>
public static event EventHandler<CurrentLanguageChangedEventArgs> CurrentLanguageChanged
{
projects / platform / core / csapi / tizenfx.git / commitdiff