-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>Tizen.Uix.SttEngine</name>
- </assembly>
- <members>
- <member name="T:Interop">
- <summary>
- Partial Interop Class
- </summary>
- <summary>
- Partial Interop Class
- </summary>
- </member>
- <member name="T:Interop.Libraries">
- <summary>
- Partial Libraries Class
- </summary>
- </member>
- <member name="T:Interop.SttEngine">
- <summary>
- SttEngine Interop Class
- </summary>
- </member>
- <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.OutOfMemory" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.IoError" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.InvalidParameter" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.NetworkDown" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.InvalidState" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.InvalidLanguage" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.OperationFailed" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.NotSupportedFeature" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.NotSupported" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.PermissionDenied" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.RecordingTimedOut" -->
- <member name="T:Tizen.Uix.SttEngine.AudioType">
- <summary>
- Enumeration for audio type.
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.AudioType.PcmS16Le">
- <summary>
- Signed 16bit audio type, Little endian
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.AudioType.PcmU8">
- <summary>
- Unsigned 8bit audio type
- </summary>
- </member>
- <member name="T:Tizen.Uix.SttEngine.ResultEvent">
- <summary>
- Enumeration for result.
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.ResultEvent.FinalResult">
- <summary>
- Event when either the full matched or the final result is delivered
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.ResultEvent.PartialResult">
- <summary>
- Event when the partial matched result is delivered
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.ResultEvent.Error">
- <summary>
- Event when the recognition has failed
- </summary>
- </member>
- <member name="T:Tizen.Uix.SttEngine.TimeEvent">
- <summary>
- Enumeration for result time.
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.TimeEvent.Beginning">
- <summary>
- Event when the token is beginning type
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.TimeEvent.Middle">
- <summary>
- Event when the token is middle type
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.TimeEvent.End">
- <summary>
- Event when the token is end type
- </summary>
- </member>
- <member name="T:Tizen.Uix.SttEngine.SpeechStatus">
- <summary>
- Enumeration for speech status.
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.SpeechStatus.BeginningPointDetected">
- <summary>
- Beginning point of speech is detected
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.SpeechStatus.EndPointDetected">
- <summary>
- End point of speech is detected
- </summary>
- </member>
- <member name="T:Tizen.Uix.SttEngine.ResultMessage">
- <summary>
- Enumeration representing the result message
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.ResultMessage.None">
- <summary>
- No Error
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooSoon">
- <summary>
- Recognition failed because the speech started too soon.
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooShort">
- <summary>
- Recognition failed because the speech is too short.
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooLong">
- <summary>
- Recognition failed because the speech is too long.
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooQuiet">
- <summary>
- Recognition failed because the speech is too quiet to listen.
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooLoud">
- <summary>
- Recognition failed because the speech is too loud to listen.
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooFast">
- <summary>
- Recognition failed because the speech is too fast to listen.
- </summary>
- </member>
- <member name="T:Tizen.Uix.SttEngine.Error">
- <summary>
- Enum for Error values that can occur
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.Error.None">
- <summary>
- Successful, No error
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.Error.OutOfMemory">
- <summary>
- Out of Memory
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.Error.IoError">
- <summary>
- I/O error
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.Error.InvalidParameter">
- <summary>
- Invalid parameter
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.Error.NetworkDown">
- <summary>
- Network down(Out of network)
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.Error.InvalidState">
- <summary>
- Invalid state
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.Error.InvalidLanguage">
- <summary>
- Invalid language
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.Error.OperationFailed">
- <summary>
- Operation failed
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.Error.NotSupportedFeature">
- <summary>
- Not supported feature of current engine
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.Error.NotSupported">
- <summary>
- NOT supported
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.Error.PermissionDenied">
- <summary>
- Permission denied
- </summary>
- </member>
- <member name="F:Tizen.Uix.SttEngine.Error.RecordingTimedOut">
- <summary>
- Recording timed out
- </summary>
- </member>
- <member name="T:Tizen.Uix.SttEngine.Engine">
- <summary>
- This Class represents the Stt Engine which has to be inherited to make the engine.
- </summary>
- </member>
- <member name="T:Tizen.Uix.SttEngine.Engine.Action`1">
- <summary>
- An Action with 2 Input Parameter returning a Error
- </summary>
- <typeparam name="T">Generic Type for Parameter 1</typeparam>
- <param name="a">The Input Parameter 1</param>
- <param name="b">The Input Parameter 2</param>
- <returns>Error Value</returns>
- </member>
- <member name="T:Tizen.Uix.SttEngine.Engine.OutAction`1">
- <summary>
- An Action with 2 Out Parameter returning a Error
- </summary>
- <typeparam name="T">Generic Type for Parameter 1</typeparam>
- <param name="a">The Input Parameter 1</param>
- <param name="b">The Input Parameter 2</param>
- <returns>Error Value</returns>
- </member>
- <member name="T:Tizen.Uix.SttEngine.Engine.ResultTime">
- <summary>
- Called when Stt engine provides the time stamp of result to the engine service user.
- This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.
- </summary>
- <param name="index">The result index</param>
- <param name="resultEvent">The token event</param>
- <param name="text">The result text</param>
- <param name="startTime">The time started speaking the result text</param>
- <param name="endTime">The time finished speaking the result text</param>
- <param name="userData">The User data</param>
- <returns>true to continue with the next iteration of the loop, false to break out of the loop</returns>
- <precondition>SendResult() should be called.</precondition>
- </member>
- <member name="T:Tizen.Uix.SttEngine.Engine.SupportedLanguages">
- <summary>
- Called when Stt engine informs the engine service user about whole supported language list.
- This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.
- </summary>
- <param name="language">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</param>
- <param name="userData">The User data</param>
- <returns>true to continue with the next iteration of the loop, false to break out of the loop</returns>
- <precondition>ForEachSupportedLanguages() should be called</precondition>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.GetInformation(System.String@,System.String@,System.String@,System.Boolean@)">
- <summary>
- Called when the engine service user requests the basic information of Stt engine.
- </summary>
- <remarks>
- In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary. Therefore, engineSetting must be transferred to the engine service user.
- </remarks>
- <param name="engineUuid">UUID of engine</param>
- <param name="engineName">Name of engine</param>
- <param name="engineSetting">The engine setting application(ui app)'s app ID</param>
- <param name="useNetwork">A variable for checking whether the network is used or not</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. OperationFailed
- 3. InvalidParameter
- </returns>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.Initialize">
- <summary>
- Called when the engine service user initializes Stt engine.
- This callback function is called by the engine service user to request for Stt engine to be started.
- </summary>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidParameter
- 3. InvalidState
- 4. OperationFailed
- </returns>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.Deinitialize">
- <summary>
- Called when the engine service user deinitializes Stt engine.
- This callback function is called by the engine service user to request for Stt engine to be deinitialized.
- </summary>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- </returns>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.ForEachSupportedLanguages(Tizen.Uix.SttEngine.Engine.SupportedLanguages,System.IntPtr)">
- <summary>
- Called when the engine service user gets the whole supported language list.
- </summary>
- <remarks>
- In this function, the engine service user's callback function 'SupportedLanguages' is invoked repeatedly for getting all supported languages
- and user_data must be transferred to 'SupportedLanguages'. If 'SupportedLanguages' returns false, it should be stopped to call 'SupportedLanguages'.
- </remarks>
- <param name="callback">The callback function</param>
- <param name="userData">The user data which must be passed to the callback delegate 'SupportedLanguages'</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- 3. InvalidParameter
- </returns>
- <postcondition>
- This callback function invokes SupportedLanguages repeatedly for getting supported languages.
- </postcondition>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.IsValidLanguage(System.String,System.Boolean@)">
- <summary>
- Called when the engine service user checks whether the corresponding language is valid or not in Stt engine.
- </summary>
- <param name="language">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</param>
- <param name="isValid">A variable for checking whether the corresponding language is valid or not. true to be valid, false to be invalid</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidParameter
- </returns>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.SupportSilenceDetection">
- <summary>
- Called when the engine service user checks whether Stt engine supports silence detection.
- </summary>
- <returns>true to support silence detection, false not to support silence detection</returns>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.SupportRecognitionType(System.String,System.Boolean@)">
- <summary>
- Called when the engine service user checks whether Stt engine supports the corresponding recognition type.
- </summary>
- <param name="type">The type for recognition, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>
- <param name="isSupported">A variable for checking whether Stt engine supports the corresponding recognition type.
- true to support recognition type, false not to support recognition type</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidParameter
- </returns>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.GetRecordingFormat(Tizen.Uix.SttEngine.AudioType@,System.Int32@,System.Int32@)">
- <summary>
- Called when the engine service user gets the proper recording format of Stt engine.
- The recording format is used for creating the recorder.
- </summary>
- <param name="types">The format used by the recorder</param>
- <param name="rate">The sample rate used by the recorder</param>
- <param name="channels">The number of channels used by the recorder</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- </returns>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.SetSilenceDetection(System.Boolean)">
- <summary>
- Called when the engine service user sets the silence detection.
- If the engine service user sets this option as 'TRUE', Stt engine will detect the silence (EPD) and send the callback event about it.
- </summary>
- <param name="isSet">A variable for setting the silence detection. true to detect the silence, false not to detect the silence</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- 3. NotSupportedFeature
- </returns>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.CheckAppAgreed(System.String,System.Boolean@)">
- <summary>
- Called when the engine service user requests for Stt engine to check whether the application agreed the usage of Stt engine.
- This callback function is called when the engine service user requests for Stt engine to check the application's agreement about using the engine.
- According to the need, the engine developer can provide some user interfaces to check the agreement.
- </summary>
- <param name="appid">The Application ID</param>
- <param name="isAgreed">A variable for checking whether the application agreed to use Stt engine or not. true to agree, false to disagree</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- 3. NotSupportedFeature
- </returns>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.NeedAppCredential">
- <summary>
- Called when the engine service user checks whether Stt engine needs the application's credential.
- </summary>
- <returns>true if Stt engine needs the application's credential, otherwise false </returns>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.ForEachResultTime(System.IntPtr,Tizen.Uix.SttEngine.Engine.ResultTime,System.IntPtr)">
- <summary>
- Called when the engine service user gets the result time information(stamp).
- </summary>
- <remarks>
- In this function, the engine service user's callback delegate 'ResultTime' is invoked repeatedly for sending the time information to the engine service user
- and user_data must be transferred to 'ResultTime'. If 'ResultTime' returns false, it should be stopped to call 'ResultTime'.
- timeInfo is transferred from SendResult. The type of timeInfo is up to the Stt engine developer.
- </remarks>
- <param name="timeInfo">The time information</param>
- <param name="callback">The callback function</param>
- <param name="userData">The user data which must be passed to the callback function ResultTime</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- 3. InvalidParameter
- </returns>
- <precondition>
- SendResult will invoke this function
- </precondition>
- <postcondition>
- This function invokes ResultTime repeatedly for getting result time information.
- </postcondition>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.Start(System.String,System.String,System.String,System.String,System.IntPtr)">
- <summary>
- Called when the engine service user starts to recognize the recording data.
- In this callback function, Stt engine must transfer the recognition result and userData to the engine service user using SendResult().
- Also, if Stt engine needs the application's credential, it sets the credential granted to the application.
- </summary>
- <param name="language">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</param>
- <param name="type">The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>
- <param name="appid">The Application ID</param>
- <param name="credential">The credential granted to the application</param>
- <param name="userData">The user data to be passed to the callback function</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- 3. InvalidParameter
- 4. InvalidLanguage
- 5. OperationFailed
- 6. NetworkDown
- </returns>
- <precondition>
- The engine is not in recognition processing.
- </precondition>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.SetRecordingData(System.String,System.UInt32)">
- <summary>
- Called when the engine service user sets and sends the recording data for speech recognition.
- This callback function is called by the engine service user to send the recording data to Stt engine.The engine receives the recording data and uses for speech recognition.
- this function should be returned immediately after recording data copy.
- </summary>
- <param name="data">The recording data</param>
- <param name="length">The length of recording data</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- 3. InvalidParameter
- 4. OperationFailed
- </returns>
- <precondition>
- Start should succeed</precondition>
- <postcondition>
- If the engine supports partial result, SendResult() should be invoked.</postcondition>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.Stop">
- <summary>
- Called when the engine service user stops to recognize the recording data.
- This callback function is called by the engine service user to stop recording and to get the recognition result.
- </summary>
- <returns>Following Error Codes can be returned
- 1. None
- 2. InvalidState
- 3. OperationFailed
- 4. NetworkDown
- </returns>
- <precondition>
- Start should succeed</precondition>
- <postcondition>
- After processing of the engine, , SendResult() should be invoked.</postcondition>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.Cancel">
- <summary>
- Called when the engine service user cancels to recognize the recording data.
- This callback function is called by the engine service user to cancel to recognize the recording data.Also, when starting the recorder is failed, this function is called.
- </summary>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- </returns>
- <precondition>Stt engine is in recognition processing or recording.</precondition>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.#ctor">
- <summary>
- Public Constructor
- </summary>
- <feature>
- http://tizen.org/feature/speech.recognition
- http://tizen.org/feature/microphone
- </feature>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.EngineMain(System.Int32,System.String[])">
- <summary>
- Main function for Speech-To-Text (STT) engine.
- This function is the main function for operating Stt engine.
- </summary>
- <privilege>
- http://tizen.org/privilege/recorder
- </privilege>
- <feature>
- http://tizen.org/feature/speech.recognition
- http://tizen.org/feature/microphone
- </feature>
- <remarks>
- ServiceAppMain should be used for working the engine after this function.
- </remarks>
- <param name="argc">The Number of Arguments</param>
- <param name="argv">The Arguments Array</param>
- <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>
- <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>
- <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.SendResult(Tizen.Uix.SttEngine.ResultEvent,System.String,System.String[],System.Int32,Tizen.Uix.SttEngine.ResultMessage,System.IntPtr)">
- <summary>
- Sends the recognition result to the engine service user.
- </summary>
- <feature>
- http://tizen.org/feature/speech.recognition
- http://tizen.org/feature/microphone
- </feature>
- <remarks>
- This API is used in SetRecordingData() and Stop(), when Stt engine sends the recognition result to the engine service user.
- This function is called in the following situations; 1) after Stop() is called, 2) the end point of speech is detected from recording, or 3) partial result is occurred.
- The recognition result must be transferred to the engine service user through this function. Also, timeInfo must be transferred to ForEachResultTime().
- The type of timeInfo is up to the Stt engine developer.
- </remarks>
- <param name="resultEvent">The result event</param>
- <param name="type">The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>
- <param name="result">Result texts</param>
- <param name="resultCount">Result text count</param>
- <param name="msg">Engine message</param>
- <param name="timeInfo">The time information</param>
- <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>
- <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>
- <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>
- <precondition>
- EngineMain function should be invoked before this function is called. Stop will invoke this function.
- </precondition>
- <postcondition>
- This function invokes ForEachResultTime
- </postcondition>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.SendError(Tizen.Uix.SttEngine.Error,System.String)">
- <summary>
- Sends the error to the engine service user.
- </summary>
- <feature>
- http://tizen.org/feature/speech.recognition
- http://tizen.org/feature/microphone
- </feature>
- <param name="error">The Error Reason</param>
- <param name="msg">The error message</param>
- <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>
- <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>
- <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>
- <precondition>
- Main function should be invoked before this function is called.
- </precondition>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.SendSpeechStatus(Tizen.Uix.SttEngine.SpeechStatus)">
- <summary>
- Sends the speech status to the engine service user when Stt engine notifies the change of the speech status.
- </summary>
- <feature>
- http://tizen.org/feature/speech.recognition
- http://tizen.org/feature/microphone
- </feature>
- <remarks>
- This API is invoked when Stt engine wants to notify the change of the speech status anytime. NOTE that this API can be invoked for recognizing the speech.
- </remarks>
- <param name="status">SpeechStatus</param>
- <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>
- <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>
- <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>
- <precondition>
- Main function should be invoked before this function is called. Start() and SetRecordingData() will invoke this function.
- </precondition>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.SetPrivateDataSetDelegate(Tizen.Uix.SttEngine.Engine.Action{System.String})">
- <summary>
- Sets a callback function for setting the private data.
- </summary>
- <privilege>
- http://tizen.org/privilege/recorder
- </privilege>
- <feature>
- http://tizen.org/feature/speech.recognition
- http://tizen.org/feature/microphone
- </feature>
- <param name="callback">
- Called when Stt engine receives the private data from the engine service user.
- This callback function is called when the engine service user sends the private data to Stt engine.
- In Parameters:
- a = Key -- The key field of private data
- b = data -- The data field of private data
- Following Error Codes can be returned
- 1. None
- 2. InvalidParameter
- 3. OperationFailed
- </param>
- <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>
- <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>
- <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>
- <precondition>
- Main function should be invoked before this function is called.
- </precondition>
- </member>
- <member name="M:Tizen.Uix.SttEngine.Engine.SetPrivateDataRequestedDelegate(Tizen.Uix.SttEngine.Engine.OutAction{System.String})">
- <summary>
- Sets a callback delegate for requesting the private data.
- </summary>
- <privilege>
- http://tizen.org/privilege/recorder
- </privilege>
- <feature>
- http://tizen.org/feature/speech.recognition
- http://tizen.org/feature/microphone
- </feature>
- <param name="callback">callback function
- Called when Stt engine provides the engine service user with the private data.
- This callback function is called when the engine service user gets the private data from Stt engine.
- Out Parameters:
- a = Key -- The key field of private data
- b = data -- The data field of private data
- Following Error Codes can be returned
- 1. None
- 2. InvalidParameter
- 3. OperationFailed
- </param>
- <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>
- <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>
- <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>
- <precondition>
- Main function should be invoked before this function is called.
- </precondition>
- </member>
- </members>
-</doc>
+<?xml version="1.0"?>\r
+<doc>\r
+ <assembly>\r
+ <name>Tizen.Uix.SttEngine</name>\r
+ </assembly>\r
+ <members>\r
+ <member name="T:Interop">\r
+ <summary>\r
+ Partial Interop Class\r
+ </summary>\r
+ <summary>\r
+ Partial Interop Class\r
+ </summary>\r
+ </member>\r
+ <member name="T:Interop.Libraries">\r
+ <summary>\r
+ Partial Libraries Class\r
+ </summary>\r
+ </member>\r
+ <member name="T:Interop.SttEngine">\r
+ <summary>\r
+ SttEngine Interop Class\r
+ </summary>\r
+ </member>\r
+ <!-- "F:Interop.SttEngine.ErrorCode.OutOfMemory" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.SttEngine.ErrorCode.IoError" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.SttEngine.ErrorCode.InvalidParameter" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.SttEngine.ErrorCode.NetworkDown" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.SttEngine.ErrorCode.InvalidState" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.SttEngine.ErrorCode.InvalidLanguage" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.SttEngine.ErrorCode.OperationFailed" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.SttEngine.ErrorCode.NotSupportedFeature" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.SttEngine.ErrorCode.NotSupported" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.SttEngine.ErrorCode.PermissionDenied" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.SttEngine.ErrorCode.RecordingTimedOut" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <member name="T:Tizen.Uix.SttEngine.AudioType">\r
+ <summary>\r
+ Enumeration for audio type.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.AudioType.PcmS16Le">\r
+ <summary>\r
+ Signed 16bit audio type, Little endian\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.AudioType.PcmU8">\r
+ <summary>\r
+ Unsigned 8bit audio type\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Uix.SttEngine.ResultEvent">\r
+ <summary>\r
+ Enumeration for result.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.ResultEvent.FinalResult">\r
+ <summary>\r
+ Event when either the full matched or the final result is delivered\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.ResultEvent.PartialResult">\r
+ <summary>\r
+ Event when the partial matched result is delivered\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.ResultEvent.Error">\r
+ <summary>\r
+ Event when the recognition has failed\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Uix.SttEngine.TimeEvent">\r
+ <summary>\r
+ Enumeration for result time.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.TimeEvent.Beginning">\r
+ <summary>\r
+ Event when the token is beginning type\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.TimeEvent.Middle">\r
+ <summary>\r
+ Event when the token is middle type\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.TimeEvent.End">\r
+ <summary>\r
+ Event when the token is end type\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Uix.SttEngine.SpeechStatus">\r
+ <summary>\r
+ Enumeration for speech status.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.SpeechStatus.BeginningPointDetected">\r
+ <summary>\r
+ Beginning point of speech is detected\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.SpeechStatus.EndPointDetected">\r
+ <summary>\r
+ End point of speech is detected\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Uix.SttEngine.ResultMessage">\r
+ <summary>\r
+ Enumeration representing the result message\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.ResultMessage.None">\r
+ <summary>\r
+ No Error\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooSoon">\r
+ <summary>\r
+ Recognition failed because the speech started too soon.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooShort">\r
+ <summary>\r
+ Recognition failed because the speech is too short.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooLong">\r
+ <summary>\r
+ Recognition failed because the speech is too long.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooQuiet">\r
+ <summary>\r
+ Recognition failed because the speech is too quiet to listen.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooLoud">\r
+ <summary>\r
+ Recognition failed because the speech is too loud to listen.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooFast">\r
+ <summary>\r
+ Recognition failed because the speech is too fast to listen.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Uix.SttEngine.Error">\r
+ <summary>\r
+ Enum for Error values that can occur\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.Error.None">\r
+ <summary>\r
+ Successful, No error\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.Error.OutOfMemory">\r
+ <summary>\r
+ Out of Memory\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.Error.IoError">\r
+ <summary>\r
+ I/O error\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.Error.InvalidParameter">\r
+ <summary>\r
+ Invalid parameter\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.Error.NetworkDown">\r
+ <summary>\r
+ Network down(Out of network)\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.Error.InvalidState">\r
+ <summary>\r
+ Invalid state\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.Error.InvalidLanguage">\r
+ <summary>\r
+ Invalid language\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.Error.OperationFailed">\r
+ <summary>\r
+ Operation failed\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.Error.NotSupportedFeature">\r
+ <summary>\r
+ Not supported feature of current engine\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.Error.NotSupported">\r
+ <summary>\r
+ NOT supported\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.Error.PermissionDenied">\r
+ <summary>\r
+ Permission denied\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.SttEngine.Error.RecordingTimedOut">\r
+ <summary>\r
+ Recording timed out\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Uix.SttEngine.Engine">\r
+ <summary>\r
+ This Class represents the Stt Engine which has to be inherited to make the engine.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Uix.SttEngine.Engine.Action`1">\r
+ <summary>\r
+ An Action with 2 Input Parameter returning a Error\r
+ </summary>\r
+ <typeparam name="T">Generic Type for Parameter 1</typeparam>\r
+ <param name="a">The Input Parameter 1</param>\r
+ <param name="b">The Input Parameter 2</param>\r
+ <returns>Error Value</returns>\r
+ </member>\r
+ <member name="T:Tizen.Uix.SttEngine.Engine.OutAction`1">\r
+ <summary>\r
+ An Action with 2 Out Parameter returning a Error\r
+ </summary>\r
+ <typeparam name="T">Generic Type for Parameter 1</typeparam>\r
+ <param name="a">The Input Parameter 1</param>\r
+ <param name="b">The Input Parameter 2</param>\r
+ <returns>Error Value</returns>\r
+ </member>\r
+ <member name="T:Tizen.Uix.SttEngine.Engine.ResultTime">\r
+ <summary>\r
+ Called when Stt engine provides the time stamp of result to the engine service user.\r
+ This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.\r
+ </summary>\r
+ <param name="index">The result index</param>\r
+ <param name="resultEvent">The token event</param>\r
+ <param name="text">The result text</param>\r
+ <param name="startTime">The time started speaking the result text</param>\r
+ <param name="endTime">The time finished speaking the result text</param>\r
+ <param name="userData">The User data</param>\r
+ <returns>true to continue with the next iteration of the loop, false to break out of the loop</returns>\r
+ <precondition>SendResult() should be called.</precondition>\r
+ </member>\r
+ <member name="T:Tizen.Uix.SttEngine.Engine.SupportedLanguages">\r
+ <summary>\r
+ Called when Stt engine informs the engine service user about whole supported language list.\r
+ This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.\r
+ </summary>\r
+ <param name="language">The language is specified as an ISO 3166 alpha-2 two letter country-code\r
+ followed by ISO 639-1 for the two-letter language code\r
+ for example, "ko_KR" for Korean, "en_US" for American English</param>\r
+ <param name="userData">The User data</param>\r
+ <returns>true to continue with the next iteration of the loop, false to break out of the loop</returns>\r
+ <precondition>ForEachSupportedLanguages() should be called</precondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.GetInformation(System.String@,System.String@,System.String@,System.Boolean@)">\r
+ <summary>\r
+ Called when the engine service user requests the basic information of Stt engine.\r
+ </summary>\r
+ <remarks>\r
+ In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary. Therefore, engineSetting must be transferred to the engine service user.\r
+ </remarks>\r
+ <param name="engineUuid">UUID of engine</param>\r
+ <param name="engineName">Name of engine</param>\r
+ <param name="engineSetting">The engine setting application(ui app)'s app ID</param>\r
+ <param name="useNetwork">A variable for checking whether the network is used or not</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. OperationFailed\r
+ 3. InvalidParameter\r
+ </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.Initialize">\r
+ <summary>\r
+ Called when the engine service user initializes Stt engine.\r
+ This callback function is called by the engine service user to request for Stt engine to be started.\r
+ </summary>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidParameter\r
+ 3. InvalidState\r
+ 4. OperationFailed\r
+ </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.Deinitialize">\r
+ <summary>\r
+ Called when the engine service user deinitializes Stt engine.\r
+ This callback function is called by the engine service user to request for Stt engine to be deinitialized.\r
+ </summary>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.ForEachSupportedLanguages(Tizen.Uix.SttEngine.Engine.SupportedLanguages,System.IntPtr)">\r
+ <summary>\r
+ Called when the engine service user gets the whole supported language list.\r
+ </summary>\r
+ <remarks>\r
+ In this function, the engine service user's callback function 'SupportedLanguages' is invoked repeatedly for getting all supported languages\r
+ and user_data must be transferred to 'SupportedLanguages'. If 'SupportedLanguages' returns false, it should be stopped to call 'SupportedLanguages'.\r
+ </remarks>\r
+ <param name="callback">The callback function</param>\r
+ <param name="userData">The user data which must be passed to the callback delegate 'SupportedLanguages'</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ 3. InvalidParameter\r
+ </returns>\r
+ <postcondition>\r
+ This callback function invokes SupportedLanguages repeatedly for getting supported languages.\r
+ </postcondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.IsValidLanguage(System.String,System.Boolean@)">\r
+ <summary>\r
+ Called when the engine service user checks whether the corresponding language is valid or not in Stt engine.\r
+ </summary>\r
+ <param name="language">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\r
+ For example, "ko_KR" for Korean, "en_US" for American English</param>\r
+ <param name="isValid">A variable for checking whether the corresponding language is valid or not. true to be valid, false to be invalid</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidParameter\r
+ </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.SupportSilenceDetection">\r
+ <summary>\r
+ Called when the engine service user checks whether Stt engine supports silence detection.\r
+ </summary>\r
+ <returns>true to support silence detection, false not to support silence detection</returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.SupportRecognitionType(System.String,System.Boolean@)">\r
+ <summary>\r
+ Called when the engine service user checks whether Stt engine supports the corresponding recognition type.\r
+ </summary>\r
+ <param name="type">The type for recognition, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>\r
+ <param name="isSupported">A variable for checking whether Stt engine supports the corresponding recognition type.\r
+ true to support recognition type, false not to support recognition type</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidParameter\r
+ </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.GetRecordingFormat(Tizen.Uix.SttEngine.AudioType@,System.Int32@,System.Int32@)">\r
+ <summary>\r
+ Called when the engine service user gets the proper recording format of Stt engine.\r
+ The recording format is used for creating the recorder.\r
+ </summary>\r
+ <param name="types">The format used by the recorder</param>\r
+ <param name="rate">The sample rate used by the recorder</param>\r
+ <param name="channels">The number of channels used by the recorder</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.SetSilenceDetection(System.Boolean)">\r
+ <summary>\r
+ Called when the engine service user sets the silence detection.\r
+ If the engine service user sets this option as 'TRUE', Stt engine will detect the silence (EPD) and send the callback event about it.\r
+ </summary>\r
+ <param name="isSet">A variable for setting the silence detection. true to detect the silence, false not to detect the silence</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ 3. NotSupportedFeature\r
+ </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.CheckAppAgreed(System.String,System.Boolean@)">\r
+ <summary>\r
+ Called when the engine service user requests for Stt engine to check whether the application agreed the usage of Stt engine.\r
+ This callback function is called when the engine service user requests for Stt engine to check the application's agreement about using the engine.\r
+ According to the need, the engine developer can provide some user interfaces to check the agreement.\r
+ </summary>\r
+ <param name="appid">The Application ID</param>\r
+ <param name="isAgreed">A variable for checking whether the application agreed to use Stt engine or not. true to agree, false to disagree</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ 3. NotSupportedFeature\r
+ </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.NeedAppCredential">\r
+ <summary>\r
+ Called when the engine service user checks whether Stt engine needs the application's credential.\r
+ </summary>\r
+ <returns>true if Stt engine needs the application's credential, otherwise false </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.ForEachResultTime(System.IntPtr,Tizen.Uix.SttEngine.Engine.ResultTime,System.IntPtr)">\r
+ <summary>\r
+ Called when the engine service user gets the result time information(stamp).\r
+ </summary>\r
+ <remarks>\r
+ In this function, the engine service user's callback delegate 'ResultTime' is invoked repeatedly for sending the time information to the engine service user\r
+ and user_data must be transferred to 'ResultTime'. If 'ResultTime' returns false, it should be stopped to call 'ResultTime'.\r
+ timeInfo is transferred from SendResult. The type of timeInfo is up to the Stt engine developer.\r
+ </remarks>\r
+ <param name="timeInfo">The time information</param>\r
+ <param name="callback">The callback function</param>\r
+ <param name="userData">The user data which must be passed to the callback function ResultTime</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ 3. InvalidParameter\r
+ </returns>\r
+ <precondition>\r
+ SendResult will invoke this function\r
+ </precondition>\r
+ <postcondition>\r
+ This function invokes ResultTime repeatedly for getting result time information.\r
+ </postcondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.Start(System.String,System.String,System.String,System.String,System.IntPtr)">\r
+ <summary>\r
+ Called when the engine service user starts to recognize the recording data.\r
+ In this callback function, Stt engine must transfer the recognition result and userData to the engine service user using SendResult().\r
+ Also, if Stt engine needs the application's credential, it sets the credential granted to the application.\r
+ </summary>\r
+ <param name="language">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\r
+ For example, "ko_KR" for Korean, "en_US" for American English</param>\r
+ <param name="type">The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>\r
+ <param name="appid">The Application ID</param>\r
+ <param name="credential">The credential granted to the application</param>\r
+ <param name="userData">The user data to be passed to the callback function</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ 3. InvalidParameter\r
+ 4. InvalidLanguage\r
+ 5. OperationFailed\r
+ 6. NetworkDown\r
+ </returns>\r
+ <precondition>\r
+ The engine is not in recognition processing.\r
+ </precondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.SetRecordingData(System.String,System.UInt32)">\r
+ <summary>\r
+ Called when the engine service user sets and sends the recording data for speech recognition.\r
+ This callback function is called by the engine service user to send the recording data to Stt engine.The engine receives the recording data and uses for speech recognition. \r
+ this function should be returned immediately after recording data copy.\r
+ </summary>\r
+ <param name="data">The recording data</param>\r
+ <param name="length">The length of recording data</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ 3. InvalidParameter\r
+ 4. OperationFailed\r
+ </returns>\r
+ <precondition>\r
+ Start should succeed</precondition>\r
+ <postcondition>\r
+ If the engine supports partial result, SendResult() should be invoked.</postcondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.Stop">\r
+ <summary>\r
+ Called when the engine service user stops to recognize the recording data.\r
+ This callback function is called by the engine service user to stop recording and to get the recognition result.\r
+ </summary>\r
+ <returns>Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ 3. OperationFailed\r
+ 4. NetworkDown\r
+ </returns>\r
+ <precondition>\r
+ Start should succeed</precondition>\r
+ <postcondition>\r
+ After processing of the engine, , SendResult() should be invoked.</postcondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.Cancel">\r
+ <summary>\r
+ Called when the engine service user cancels to recognize the recording data.\r
+ This callback function is called by the engine service user to cancel to recognize the recording data.Also, when starting the recorder is failed, this function is called.\r
+ </summary>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ </returns>\r
+ <precondition>Stt engine is in recognition processing or recording.</precondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.#ctor">\r
+ <summary>\r
+ Public Constructor\r
+ </summary>\r
+ <feature>\r
+ http://tizen.org/feature/speech.recognition\r
+ http://tizen.org/feature/microphone\r
+ </feature>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.EngineMain(System.Int32,System.String[])">\r
+ <summary>\r
+ Main function for Speech-To-Text (STT) engine.\r
+ This function is the main function for operating Stt engine.\r
+ </summary>\r
+ <privilege>\r
+ http://tizen.org/privilege/recorder\r
+ </privilege>\r
+ <feature>\r
+ http://tizen.org/feature/speech.recognition\r
+ http://tizen.org/feature/microphone\r
+ </feature>\r
+ <remarks>\r
+ ServiceAppMain should be used for working the engine after this function.\r
+ </remarks>\r
+ <param name="argc">The Number of Arguments</param>\r
+ <param name="argv">The Arguments Array</param>\r
+ <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>\r
+ <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>\r
+ <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.SendResult(Tizen.Uix.SttEngine.ResultEvent,System.String,System.String[],System.Int32,Tizen.Uix.SttEngine.ResultMessage,System.IntPtr)">\r
+ <summary>\r
+ Sends the recognition result to the engine service user.\r
+ </summary>\r
+ <feature>\r
+ http://tizen.org/feature/speech.recognition\r
+ http://tizen.org/feature/microphone\r
+ </feature>\r
+ <remarks>\r
+ This API is used in SetRecordingData() and Stop(), when Stt engine sends the recognition result to the engine service user.\r
+ This function is called in the following situations; 1) after Stop() is called, 2) the end point of speech is detected from recording, or 3) partial result is occurred.\r
+ The recognition result must be transferred to the engine service user through this function. Also, timeInfo must be transferred to ForEachResultTime().\r
+ The type of timeInfo is up to the Stt engine developer.\r
+ </remarks>\r
+ <param name="resultEvent">The result event</param>\r
+ <param name="type">The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>\r
+ <param name="result">Result texts</param>\r
+ <param name="resultCount">Result text count</param>\r
+ <param name="msg">Engine message</param>\r
+ <param name="timeInfo">The time information</param>\r
+ <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>\r
+ <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>\r
+ <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>\r
+ <precondition>\r
+ EngineMain function should be invoked before this function is called. Stop will invoke this function.\r
+ </precondition>\r
+ <postcondition>\r
+ This function invokes ForEachResultTime\r
+ </postcondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.SendError(Tizen.Uix.SttEngine.Error,System.String)">\r
+ <summary>\r
+ Sends the error to the engine service user.\r
+ </summary>\r
+ <feature>\r
+ http://tizen.org/feature/speech.recognition\r
+ http://tizen.org/feature/microphone\r
+ </feature>\r
+ <param name="error">The Error Reason</param>\r
+ <param name="msg">The error message</param>\r
+ <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>\r
+ <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>\r
+ <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>\r
+ <precondition>\r
+ Main function should be invoked before this function is called.\r
+ </precondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.SendSpeechStatus(Tizen.Uix.SttEngine.SpeechStatus)">\r
+ <summary>\r
+ Sends the speech status to the engine service user when Stt engine notifies the change of the speech status.\r
+ </summary>\r
+ <feature>\r
+ http://tizen.org/feature/speech.recognition\r
+ http://tizen.org/feature/microphone\r
+ </feature>\r
+ <remarks>\r
+ This API is invoked when Stt engine wants to notify the change of the speech status anytime. NOTE that this API can be invoked for recognizing the speech.\r
+ </remarks>\r
+ <param name="status">SpeechStatus</param>\r
+ <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>\r
+ <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>\r
+ <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>\r
+ <precondition>\r
+ Main function should be invoked before this function is called. Start() and SetRecordingData() will invoke this function.\r
+ </precondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.SetPrivateDataSetDelegate(Tizen.Uix.SttEngine.Engine.Action{System.String})">\r
+ <summary>\r
+ Sets a callback function for setting the private data.\r
+ </summary>\r
+ <privilege>\r
+ http://tizen.org/privilege/recorder\r
+ </privilege>\r
+ <feature>\r
+ http://tizen.org/feature/speech.recognition\r
+ http://tizen.org/feature/microphone\r
+ </feature>\r
+ <param name="callback">\r
+ Called when Stt engine receives the private data from the engine service user.\r
+ This callback function is called when the engine service user sends the private data to Stt engine.\r
+ In Parameters:\r
+ a = Key -- The key field of private data\r
+ b = data -- The data field of private data\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidParameter\r
+ 3. OperationFailed\r
+ </param>\r
+ <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>\r
+ <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>\r
+ <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>\r
+ <precondition>\r
+ Main function should be invoked before this function is called.\r
+ </precondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.SttEngine.Engine.SetPrivateDataRequestedDelegate(Tizen.Uix.SttEngine.Engine.OutAction{System.String})">\r
+ <summary>\r
+ Sets a callback delegate for requesting the private data.\r
+ </summary>\r
+ <privilege>\r
+ http://tizen.org/privilege/recorder\r
+ </privilege>\r
+ <feature>\r
+ http://tizen.org/feature/speech.recognition\r
+ http://tizen.org/feature/microphone\r
+ </feature>\r
+ <param name="callback">callback function\r
+ Called when Stt engine provides the engine service user with the private data.\r
+ This callback function is called when the engine service user gets the private data from Stt engine.\r
+ Out Parameters:\r
+ a = Key -- The key field of private data\r
+ b = data -- The data field of private data\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidParameter\r
+ 3. OperationFailed\r
+ </param>\r
+ <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>\r
+ <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>\r
+ <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>\r
+ <precondition>\r
+ Main function should be invoked before this function is called.\r
+ </precondition>\r
+ </member>\r
+ </members>\r
+</doc>\r
projects / platform / core / csapi / tizenfx.git / blobdiff