/// <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 mane="userData">The User data</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>
public delegate bool ResultTime(int index, TimeEvent resultEvent, string text, long startTime, long endTime, IntPtr userData);
/// <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 mane="userData">The User data</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>
public delegate bool SupportedLanguages(string language, IntPtr userData);
/// 3. InvalidParameter
/// 4. OperationFailed
/// </returns>
- /// <percondition>
- /// Start should succeed</percondition>
+ /// <precondition>
+ /// Start should succeed</precondition>
/// <postcondition>
/// If the engine supports partial result, SendResult() should be invoked.</postcondition>
public abstract Error SetRecordingData(string data, uint length);
/// 3. OperationFailed
/// 4. NetworkDown
/// </returns>
- /// <percondition>
- /// Start should succeed</percondition>
+ /// <precondition>
+ /// Start should succeed</precondition>
/// <postcondition>
/// After processing of the engine, , SendResult() should be invoked.</postcondition>
public abstract Error Stop();
/// <summary>
/// Public Constructor
/// </summary>
+ /// <feature>
+ /// http://tizen.org/feature/speech.recognition
+ /// http://tizen.org/feature/microphone
+ /// </feature>
public Engine()
{
_engine = this;
/// <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>
/// <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.
/// <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="ArgumentException">Thrown in case of Invalid Parameter</exception>
/// <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>
/// <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.
/// <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.
/// 1. None
/// 2. InvalidState
/// </returns>
- /// <percondition>
+ /// <precondition>
/// StartSynthesis should be performed
- /// </percondition>
+ /// </precondition>
public abstract Error CancelSynthesis();
/// <summary>
/// Public Constructor
/// </summary>
+ /// <feature>
+ /// http://tizen.org/feature/speech.synthesis
+ /// </feature>
public Engine()
{
_engine = this;
/// Main function for Text-To-Speech (TTS) engine.
/// This function is the main function for operating TTS engine.
/// </summary>
+ /// <feature>
+ /// http://tizen.org/feature/speech.synthesis
+ /// </feature>
/// <remarks>
/// ServiceAppMain should be used for working the engine after this function.
/// </remarks>
/// <summary>
/// Gets the speed range from Tizen platform
/// </summary>
+ /// <feature>
+ /// http://tizen.org/feature/speech.synthesis
+ /// </feature>
/// <remarks>
/// This API is used when TTS engine wants to get the speed range from Tizen platform
/// </remarks>
/// <summary>
/// Gets the pitch range from Tizen platform.
/// </summary>
+ /// <feature>
+ /// http://tizen.org/feature/speech.synthesis
+ /// </feature>
/// <remarks>
/// This API is used when TTS engine wants to get the pitch range from Tizen platform.
/// </remarks>
/// <summary>
/// Sends the synthesized result to the engine service user.
/// </summary>
+ /// <feature>
+ /// http://tizen.org/feature/speech.synthesis
+ /// </feature>
/// <remarks>
/// This API is used in StartSynthesis(), when TTS engine sends the synthesized result to the engine service user.
/// The synthesized result must be transferred to the engine service user through this function.
/// <summary>
/// Sends the error to the engine service user.
/// </summary>
+ /// <feature>
+ /// http://tizen.org/feature/speech.synthesis
+ /// </feature>
/// <param name="error">The error reason</param>
/// <param name="msg">The error message</param>
/// <precondition>
/// <summary>
/// Sets a callback function for setting the private data.
/// </summary>
+ /// <feature>
+ /// http://tizen.org/feature/speech.synthesis
+ /// </feature>
/// <param name="callback">
/// Called when the engine service user gets the private data from Tts engine.
/// In Parameters:
/// <summary>
/// Sets a callback function for setting the private data.
/// </summary>
+ /// <feature>
+ /// http://tizen.org/feature/speech.synthesis
+ /// </feature>
/// <param name="callback">callback function
/// Called when TTS 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 TTS engine.
projects / platform / core / csapi / tizenfx.git / commitdiff