-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>Tizen.Uix.TtsEngine</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.TtsEngine">
- <summary>
- TtsEngine Interop Class
- </summary>
- </member>
- <!-- Badly formed XML comment ignored for member "F:Interop.TtsEngine.ErrorCode.OutOfMemory" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.TtsEngine.ErrorCode.IoError" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.TtsEngine.ErrorCode.InvalidParameter" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.TtsEngine.ErrorCode.NetworkDown" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.TtsEngine.ErrorCode.PermissionDenied" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.TtsEngine.ErrorCode.InvalidState" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.TtsEngine.ErrorCode.InvalidVoice" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.TtsEngine.ErrorCode.OperationFailed" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.TtsEngine.ErrorCode.NotSupportedFeature" -->
- <!-- Badly formed XML comment ignored for member "F:Interop.TtsEngine.ErrorCode.NotSupported" -->
- <member name="T:Tizen.Uix.TtsEngine.AudioType">
- <summary>
- Enumeration for audio type.
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.AudioType.RawS16">
- <summary>
- Signed 16-bit audio type
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.AudioType.RawU8">
- <summary>
- Unsigned 8-bit audio type
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.AudioType.Max">
- <summary>
- Maximum Value
- </summary>
- </member>
- <member name="T:Tizen.Uix.TtsEngine.ResultEvent">
- <summary>
- Enumeration for result.
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.ResultEvent.Fail">
- <summary>
- Event when the voice synthesis is failed
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.ResultEvent.Start">
- <summary>
- Event when the sound data is first data by callback function
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.ResultEvent.Continue">
- <summary>
- Event when the next sound data exist, not first and not last
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.ResultEvent.Finish">
- <summary>
- Event when the sound data is last data or sound data is only one result
- </summary>
- </member>
- <member name="T:Tizen.Uix.TtsEngine.VoiceType">
- <summary>
- Enumeration for Voice Type
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.VoiceType.Male">
- <summary>
- male voice type.
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.VoiceType.Female">
- <summary>
- female voice type.
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.VoiceType.Child">
- <summary>
- child's voice type.
- </summary>
- </member>
- <member name="T:Tizen.Uix.TtsEngine.Error">
- <summary>
- Enum for Error values that can occur
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.Error.None">
- <summary>
- Successful, No error
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.Error.OutOfMemory">
- <summary>
- Out of Memory
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.Error.IoError">
- <summary>
- I/O error
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.Error.InvalidParameter">
- <summary>
- Invalid parameter
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.Error.NetworkDown">
- <summary>
- Network down(Out of network)
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.Error.InvalidState">
- <summary>
- Invalid state
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.Error.InvalidVoice">
- <summary>
- Invalid voice
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.Error.OperationFailed">
- <summary>
- Operation failed
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.Error.NotSupportedFeature">
- <summary>
- Not supported feature of current engine
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.Error.NotSupported">
- <summary>
- NOT supported
- </summary>
- </member>
- <member name="F:Tizen.Uix.TtsEngine.Error.PermissionDenied">
- <summary>
- Permission denied
- </summary>
- </member>
- <member name="T:Tizen.Uix.TtsEngine.Engine">
- <summary>
- This Class represents the Tts Engine which has to be inherited to make the engine.
- </summary>
- </member>
- <member name="T:Tizen.Uix.TtsEngine.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.TtsEngine.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.TtsEngine.Engine.SupportedVoice">
- <summary>
- Called when TTS engine informs the engine service user about whole supported language and voice type list.
- This callback function is implemented by the engine service user.Therefore, the engine developer does NOT have to implement this callback function.
- </summary>
- <remarks>
- This callback function is called by ForEachSupportedVoices() to inform the whole supported voice list. userData must be transferred from ForEachSupportedVoices().
- </remarks>
- <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 voice type</param>
- <param name="userData">The user data passed from ForEachSupportedVoices()</param>
- <returns>true to continue with the next iteration of the loop false to break out of the loop</returns>
- <precondition>ForEachSupportedVoices() will invoke this callback function.</precondition>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.StartSynthesis(System.String,System.Int32,System.String,System.Int32,System.String,System.String,System.IntPtr)">
- <summary>
- Called when the engine service user starts to synthesize a voice, asynchronously.
- </summary>
- <remarks>
- In this callback function, TTS engine must transfer the synthesized result to the engine service user using SendResult().
- Also, if TTS engine needs the application's credential, it can set the credential granted to the application.
- </remarks>
- <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 voice type</param>
- <param name="text">Texts</param>
- <param name="speed">The speed of speaking</param>
- <param name="appid">The Application ID</param>
- <param name="credential">The credential granted to the application</param>
- <param name="userData">The user data which must be passed to SendResult() function</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- 3. InvalidParameter
- 4. InvalidVoice
- 5. OperationFailed
- 6. NetworkDown
- 7. PermissionDenied
- </returns>
- <postcondition>This function invokes SendResult()</postcondition>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.GetInformation(System.String@,System.String@,System.String@,System.Boolean@)">
- <summary>
- Called when the engine service user requests the basic information of TTS engine.
- </summary>
- <remarks>
- The allocated engineUuid, engineName, and engineSetting will be released internally.
- 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">The status for using network</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- </returns>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.Initialize">
- <summary>
- Called when the engine service user initializes TTS engine.
- </summary>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- 3. NotSupportedFeature
- 4. PermissionDenied
- </returns>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.Deinitialize">
- <summary>
- Called when the engine service user deinitializes TTS engine.
- </summary>
- <remarks>
- NOTE that the engine may be terminated automatically. When this callback function is invoked, the release of resources is necessary.
- </remarks>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- </returns>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.ForEachSupportedVoices(Tizen.Uix.TtsEngine.Engine.SupportedVoice,System.IntPtr)">
- <summary>
- Called when the engine service user gets the whole supported voice list.
- </summary>
- <remarks>
- In this function, the engine service user's callback function 'SupportedVoice()' is invoked repeatedly for getting all supported voices,
- and userData must be transferred to 'SupportedVoice()'. If 'SupportedVoice()' returns false, it should be stopped to call 'SupportedVoice()'.</remarks>
- <param name="callback">The callback function</param>
- <param name="userData">The user data which must be passed to SupportedVoice()</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. OperationFailed
- </returns>
- <postcondition>This callback function invokes SupportedVoice() repeatedly for getting all supported voices.</postcondition>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.IsValidVoice(System.String,System.Int32,System.Boolean@)">
- <summary>
- Called when the engine service user checks whether the voice is valid or not in TTS 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="type">The voice type</param>
- <param name="isValid">A variable for checking whether the corresponding voice 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.TtsEngine.Engine.SetPitch(System.Int32)">
- <summary>
- Called when the engine service user sets the default pitch of TTS engine.
- </summary>
- <param name="pitch">The default pitch</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- 3. OperationFailed
- 4. InvalidParameter
- </returns>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.LoadVoice(System.String,System.Int32)">
- <summary>
- Called when the engine service user requests to load the corresponding voice type for the first time.
- </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 voice type</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- 3. OperationFailed
- 4. InvalidVoice
- 5. InvalidParameter
- 6. OutOfMemory
- </returns>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.UnloadVoice(System.String,System.Int32)">
- <summary>
- Called when the engine service user requests to unload the corresponding voice type or to stop using voice.
- </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 voice type</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- 3. OperationFailed
- 4. InvalidVoice
- 5. InvalidParameter
- </returns>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.CheckAppAgreed(System.String,System.Boolean@)">
- <summary>
- Called when the engine service user requests for TTS engine to check whether the application agreed the usage of TTS engine.
- This callback function is called when the engine service user requests for TTS 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>
- <remarks>
- If the TTS engine developer wants not to check the agreement, the developer has need to return proper values as isAgreed in accordance with the intention.
- true if the developer regards that every application agreed the usage of the engine, false if the developer regards that every application disagreed.
- NOTE that, however, there may be any legal issue unless the developer checks the agreement.
- Therefore, we suggest that the engine developers should provide a function to check the agreement.
- </remarks>
- <param name="appid">The Application ID</param>
- <param name="isAgreed">A variable for checking whether the application agreed to use TTS engine or not. true to agree, false to disagree</param>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- 3. NotSupportedFeature
- 4. InvalidParameter
- </returns>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.NeedAppCredential">
- <summary>
- Called when the engine service user checks whether TTS engine needs the application's credential.
- </summary>
- <returns> true if TTS engine needs the application's credential, otherwise false </returns>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.CancelSynthesis">
- <summary>
- Called when the engine service user cancels to synthesize a voice.
- </summary>
- <returns>
- Following Error Codes can be returned
- 1. None
- 2. InvalidState
- </returns>
- <precondition>
- StartSynthesis should be performed
- </precondition>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.#ctor">
- <summary>
- Public Constructor
- </summary>
- <feature>
- http://tizen.org/feature/speech.synthesis
- </feature>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.EngineMain(System.Int32,System.String[])">
- <summary>
- 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>
- <param name="argc">The argument count(original)</param>
- <param name="argv">The argument(original)</param>
- <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</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.TtsEngine.Engine.GetSpeedRange(System.Int32@,System.Int32@,System.Int32@)">
- <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>
- <param name="min">The minimum speed value</param>
- <param name="normal">The normal speed value</param>
- <param name="max">The maximum speed value</param>
- <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.TtsEngine.Engine.GetPitchRange(System.Int32@,System.Int32@,System.Int32@)">
- <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>
- <param name="min">The minimum pitch value</param>
- <param name="normal">The normal pitch value</param>
- <param name="max">The maximum pitch value</param>
- <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.TtsEngine.Engine.SendResult(Tizen.Uix.TtsEngine.ResultEvent,System.IntPtr,System.Int32,Tizen.Uix.TtsEngine.AudioType,System.Int32)">
- <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.
- </remarks>
- <param name="resultEvent">The result event</param>
- <param name="data">Result data</param>
- <param name="dataSize">Result data size</param>
- <param name="audioType">The audio type</param>
- <param name="rate">The sample rate</param>
- <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</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. StartSynthesis() will invoke this function.
- </precondition>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.SendError(Tizen.Uix.TtsEngine.Error,System.String)">
- <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>
- EngineMain function should be invoked before this function is called.
- </precondition>
- </member>
- <member name="M:Tizen.Uix.TtsEngine.Engine.SetPrivateDataSetDelegate(Tizen.Uix.TtsEngine.Engine.Action{System.String})">
- <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:
- 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
- 4. NotSupported
- </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.TtsEngine.Engine.SetPrivateDataRequestedDelegate(Tizen.Uix.TtsEngine.Engine.OutAction{System.String})">
- <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.
- 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
- 4. NotSupported
- </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.TtsEngine</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.TtsEngine">\r
+ <summary>\r
+ TtsEngine Interop Class\r
+ </summary>\r
+ </member>\r
+ <!-- "F:Interop.TtsEngine.ErrorCode.OutOfMemory" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.TtsEngine.ErrorCode.IoError" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.TtsEngine.ErrorCode.InvalidParameter" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.TtsEngine.ErrorCode.NetworkDown" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.TtsEngine.ErrorCode.PermissionDenied" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.TtsEngine.ErrorCode.InvalidState" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.TtsEngine.ErrorCode.InvalidVoice" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.TtsEngine.ErrorCode.OperationFailed" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.TtsEngine.ErrorCode.NotSupportedFeature" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "F:Interop.TtsEngine.ErrorCode.NotSupported" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <member name="T:Tizen.Uix.TtsEngine.AudioType">\r
+ <summary>\r
+ Enumeration for audio type.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.AudioType.RawS16">\r
+ <summary>\r
+ Signed 16-bit audio type\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.AudioType.RawU8">\r
+ <summary>\r
+ Unsigned 8-bit audio type\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.AudioType.Max">\r
+ <summary>\r
+ Maximum Value\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Uix.TtsEngine.ResultEvent">\r
+ <summary>\r
+ Enumeration for result.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.ResultEvent.Fail">\r
+ <summary>\r
+ Event when the voice synthesis is failed\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.ResultEvent.Start">\r
+ <summary>\r
+ Event when the sound data is first data by callback function\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.ResultEvent.Continue">\r
+ <summary>\r
+ Event when the next sound data exist, not first and not last\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.ResultEvent.Finish">\r
+ <summary>\r
+ Event when the sound data is last data or sound data is only one result\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Uix.TtsEngine.VoiceType">\r
+ <summary>\r
+ Enumeration for Voice Type\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.VoiceType.Male">\r
+ <summary>\r
+ male voice type.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.VoiceType.Female">\r
+ <summary>\r
+ female voice type.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.VoiceType.Child">\r
+ <summary>\r
+ child's voice type.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Uix.TtsEngine.Error">\r
+ <summary>\r
+ Enum for Error values that can occur\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.Error.None">\r
+ <summary>\r
+ Successful, No error\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.Error.OutOfMemory">\r
+ <summary>\r
+ Out of Memory\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.Error.IoError">\r
+ <summary>\r
+ I/O error\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.Error.InvalidParameter">\r
+ <summary>\r
+ Invalid parameter\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.Error.NetworkDown">\r
+ <summary>\r
+ Network down(Out of network)\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.Error.InvalidState">\r
+ <summary>\r
+ Invalid state\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.Error.InvalidVoice">\r
+ <summary>\r
+ Invalid voice\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.Error.OperationFailed">\r
+ <summary>\r
+ Operation failed\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.Error.NotSupportedFeature">\r
+ <summary>\r
+ Not supported feature of current engine\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.Error.NotSupported">\r
+ <summary>\r
+ NOT supported\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Uix.TtsEngine.Error.PermissionDenied">\r
+ <summary>\r
+ Permission denied\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Uix.TtsEngine.Engine">\r
+ <summary>\r
+ This Class represents the Tts Engine which has to be inherited to make the engine.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Uix.TtsEngine.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.TtsEngine.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.TtsEngine.Engine.SupportedVoice">\r
+ <summary>\r
+ Called when TTS engine informs the engine service user about whole supported language and voice type 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
+ <remarks>\r
+ This callback function is called by ForEachSupportedVoices() to inform the whole supported voice list. userData must be transferred from ForEachSupportedVoices().\r
+ </remarks>\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 voice type</param>\r
+ <param name="userData">The user data passed from ForEachSupportedVoices()</param>\r
+ <returns>true to continue with the next iteration of the loop false to break out of the loop</returns>\r
+ <precondition>ForEachSupportedVoices() will invoke this callback function.</precondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.TtsEngine.Engine.StartSynthesis(System.String,System.Int32,System.String,System.Int32,System.String,System.String,System.IntPtr)">\r
+ <summary>\r
+ Called when the engine service user starts to synthesize a voice, asynchronously.\r
+ </summary>\r
+ <remarks>\r
+ In this callback function, TTS engine must transfer the synthesized result to the engine service user using SendResult().\r
+ Also, if TTS engine needs the application's credential, it can set the credential granted to the application.\r
+ </remarks>\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 voice type</param>\r
+ <param name="text">Texts</param>\r
+ <param name="speed">The speed of speaking</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 which must be passed to SendResult() function</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ 3. InvalidParameter\r
+ 4. InvalidVoice\r
+ 5. OperationFailed\r
+ 6. NetworkDown\r
+ 7. PermissionDenied\r
+ </returns>\r
+ <postcondition>This function invokes SendResult()</postcondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.TtsEngine.Engine.GetInformation(System.String@,System.String@,System.String@,System.Boolean@)">\r
+ <summary>\r
+ Called when the engine service user requests the basic information of TTS engine.\r
+ </summary>\r
+ <remarks>\r
+ The allocated engineUuid, engineName, and engineSetting will be released internally.\r
+ In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary.\r
+ 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">The status for using network</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.TtsEngine.Engine.Initialize">\r
+ <summary>\r
+ Called when the engine service user initializes TTS engine.\r
+ </summary>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ 3. NotSupportedFeature\r
+ 4. PermissionDenied\r
+ </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.TtsEngine.Engine.Deinitialize">\r
+ <summary>\r
+ Called when the engine service user deinitializes TTS engine.\r
+ </summary>\r
+ <remarks>\r
+ NOTE that the engine may be terminated automatically. When this callback function is invoked, the release of resources is necessary.\r
+ </remarks>\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.TtsEngine.Engine.ForEachSupportedVoices(Tizen.Uix.TtsEngine.Engine.SupportedVoice,System.IntPtr)">\r
+ <summary>\r
+ Called when the engine service user gets the whole supported voice list.\r
+ </summary>\r
+ <remarks>\r
+ In this function, the engine service user's callback function 'SupportedVoice()' is invoked repeatedly for getting all supported voices,\r
+ and userData must be transferred to 'SupportedVoice()'. If 'SupportedVoice()' returns false, it should be stopped to call 'SupportedVoice()'.</remarks>\r
+ <param name="callback">The callback function</param>\r
+ <param name="userData">The user data which must be passed to SupportedVoice()</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. OperationFailed\r
+ </returns>\r
+ <postcondition>This callback function invokes SupportedVoice() repeatedly for getting all supported voices.</postcondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.TtsEngine.Engine.IsValidVoice(System.String,System.Int32,System.Boolean@)">\r
+ <summary>\r
+ Called when the engine service user checks whether the voice is valid or not in TTS 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="type">The voice type</param>\r
+ <param name="isValid">A variable for checking whether the corresponding voice 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.TtsEngine.Engine.SetPitch(System.Int32)">\r
+ <summary>\r
+ Called when the engine service user sets the default pitch of TTS engine.\r
+ </summary>\r
+ <param name="pitch">The default pitch</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ 3. OperationFailed\r
+ 4. InvalidParameter\r
+ </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.TtsEngine.Engine.LoadVoice(System.String,System.Int32)">\r
+ <summary>\r
+ Called when the engine service user requests to load the corresponding voice type for the first time.\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 voice type</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ 3. OperationFailed\r
+ 4. InvalidVoice\r
+ 5. InvalidParameter\r
+ 6. OutOfMemory\r
+ </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.TtsEngine.Engine.UnloadVoice(System.String,System.Int32)">\r
+ <summary>\r
+ Called when the engine service user requests to unload the corresponding voice type or to stop using voice.\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 voice type</param>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ 3. OperationFailed\r
+ 4. InvalidVoice\r
+ 5. InvalidParameter\r
+ </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.TtsEngine.Engine.CheckAppAgreed(System.String,System.Boolean@)">\r
+ <summary>\r
+ Called when the engine service user requests for TTS engine to check whether the application agreed the usage of TTS engine.\r
+ This callback function is called when the engine service user requests for TTS 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
+ <remarks>\r
+ If the TTS engine developer wants not to check the agreement, the developer has need to return proper values as isAgreed in accordance with the intention.\r
+ true if the developer regards that every application agreed the usage of the engine, false if the developer regards that every application disagreed.\r
+ NOTE that, however, there may be any legal issue unless the developer checks the agreement.\r
+ Therefore, we suggest that the engine developers should provide a function to check the agreement.\r
+ </remarks>\r
+ <param name="appid">The Application ID</param>\r
+ <param name="isAgreed">A variable for checking whether the application agreed to use TTS 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
+ 4. InvalidParameter\r
+ </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.TtsEngine.Engine.NeedAppCredential">\r
+ <summary>\r
+ Called when the engine service user checks whether TTS engine needs the application's credential.\r
+ </summary>\r
+ <returns> true if TTS engine needs the application's credential, otherwise false </returns>\r
+ </member>\r
+ <member name="M:Tizen.Uix.TtsEngine.Engine.CancelSynthesis">\r
+ <summary>\r
+ Called when the engine service user cancels to synthesize a voice.\r
+ </summary>\r
+ <returns>\r
+ Following Error Codes can be returned\r
+ 1. None\r
+ 2. InvalidState\r
+ </returns>\r
+ <precondition>\r
+ StartSynthesis should be performed\r
+ </precondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.TtsEngine.Engine.#ctor">\r
+ <summary>\r
+ Public Constructor\r
+ </summary>\r
+ <feature>\r
+ http://tizen.org/feature/speech.synthesis\r
+ </feature>\r
+ </member>\r
+ <member name="M:Tizen.Uix.TtsEngine.Engine.EngineMain(System.Int32,System.String[])">\r
+ <summary>\r
+ Main function for Text-To-Speech (TTS) engine.\r
+ This function is the main function for operating TTS engine.\r
+ </summary>\r
+ <feature>\r
+ http://tizen.org/feature/speech.synthesis\r
+ </feature>\r
+ <remarks>\r
+ ServiceAppMain should be used for working the engine after this function.\r
+ </remarks>\r
+ <param name="argc">The argument count(original)</param>\r
+ <param name="argv">The argument(original)</param>\r
+ <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</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.TtsEngine.Engine.GetSpeedRange(System.Int32@,System.Int32@,System.Int32@)">\r
+ <summary>\r
+ Gets the speed range from Tizen platform\r
+ </summary>\r
+ <feature>\r
+ http://tizen.org/feature/speech.synthesis\r
+ </feature>\r
+ <remarks>\r
+ This API is used when TTS engine wants to get the speed range from Tizen platform\r
+ </remarks>\r
+ <param name="min">The minimum speed value</param>\r
+ <param name="normal">The normal speed value</param>\r
+ <param name="max">The maximum speed value</param>\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.TtsEngine.Engine.GetPitchRange(System.Int32@,System.Int32@,System.Int32@)">\r
+ <summary>\r
+ Gets the pitch range from Tizen platform.\r
+ </summary>\r
+ <feature>\r
+ http://tizen.org/feature/speech.synthesis\r
+ </feature>\r
+ <remarks>\r
+ This API is used when TTS engine wants to get the pitch range from Tizen platform.\r
+ </remarks>\r
+ <param name="min">The minimum pitch value</param>\r
+ <param name="normal">The normal pitch value</param>\r
+ <param name="max">The maximum pitch value</param>\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.TtsEngine.Engine.SendResult(Tizen.Uix.TtsEngine.ResultEvent,System.IntPtr,System.Int32,Tizen.Uix.TtsEngine.AudioType,System.Int32)">\r
+ <summary>\r
+ Sends the synthesized result to the engine service user.\r
+ </summary>\r
+ <feature>\r
+ http://tizen.org/feature/speech.synthesis\r
+ </feature>\r
+ <remarks>\r
+ This API is used in StartSynthesis(), when TTS engine sends the synthesized result to the engine service user.\r
+ The synthesized result must be transferred to the engine service user through this function.\r
+ </remarks>\r
+ <param name="resultEvent">The result event</param>\r
+ <param name="data">Result data</param>\r
+ <param name="dataSize">Result data size</param>\r
+ <param name="audioType">The audio type</param>\r
+ <param name="rate">The sample rate</param>\r
+ <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</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. StartSynthesis() will invoke this function.\r
+ </precondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.TtsEngine.Engine.SendError(Tizen.Uix.TtsEngine.Error,System.String)">\r
+ <summary>\r
+ Sends the error to the engine service user.\r
+ </summary>\r
+ <feature>\r
+ http://tizen.org/feature/speech.synthesis\r
+ </feature>\r
+ <param name="error">The error reason</param>\r
+ <param name="msg">The error message</param>\r
+ <precondition>\r
+ EngineMain function should be invoked before this function is called.\r
+ </precondition>\r
+ </member>\r
+ <member name="M:Tizen.Uix.TtsEngine.Engine.SetPrivateDataSetDelegate(Tizen.Uix.TtsEngine.Engine.Action{System.String})">\r
+ <summary>\r
+ Sets a callback function for setting the private data.\r
+ </summary>\r
+ <feature>\r
+ http://tizen.org/feature/speech.synthesis\r
+ </feature>\r
+ <param name="callback">\r
+ Called when the engine service user gets the private data from Tts 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
+ 4. NotSupported\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.TtsEngine.Engine.SetPrivateDataRequestedDelegate(Tizen.Uix.TtsEngine.Engine.OutAction{System.String})">\r
+ <summary>\r
+ Sets a callback function for setting the private data.\r
+ </summary>\r
+ <feature>\r
+ http://tizen.org/feature/speech.synthesis\r
+ </feature>\r
+ <param name="callback">callback function\r
+ Called when TTS 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 TTS 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
+ 4. NotSupported\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