Artifacts/bin/platform/Tizen.Uix.SttEngine.xml

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Tizen.Uix.SttEngine</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="T:Interop">\r
   8             <summary>\r
   9             Partial Interop Class\r
  10             </summary>\r
  11             <summary>\r
  12             Partial Interop Class\r
  13             </summary>\r
  14         </member>\r
  15         <member name="T:Interop.Libraries">\r
  16             <summary>\r
  17             Partial Libraries Class\r
  18             </summary>\r
  19         </member>\r
  20         <member name="T:Interop.SttEngine">\r
  21             <summary>\r
  22             SttEngine Interop Class\r
  23             </summary>\r
  24         </member>\r
  25         <!-- "F:Interop.SttEngine.ErrorCode.OutOfMemory" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
  26         <!-- "F:Interop.SttEngine.ErrorCode.IoError" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
  27         <!-- "F:Interop.SttEngine.ErrorCode.InvalidParameter" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
  28         <!-- "F:Interop.SttEngine.ErrorCode.NetworkDown" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
  29         <!-- "F:Interop.SttEngine.ErrorCode.InvalidState" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
  30         <!-- "F:Interop.SttEngine.ErrorCode.InvalidLanguage" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
  31         <!-- "F:Interop.SttEngine.ErrorCode.OperationFailed" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
  32         <!-- "F:Interop.SttEngine.ErrorCode.NotSupportedFeature" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
  33         <!-- "F:Interop.SttEngine.ErrorCode.NotSupported" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
  34         <!-- "F:Interop.SttEngine.ErrorCode.PermissionDenied" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
  35         <!-- "F:Interop.SttEngine.ErrorCode.RecordingTimedOut" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
  36         <member name="T:Tizen.Uix.SttEngine.AudioType">\r
  37             <summary>\r
  38             Enumeration for audio type.\r
  39             </summary>\r
  40         </member>\r
  41         <member name="F:Tizen.Uix.SttEngine.AudioType.PcmS16Le">\r
  42             <summary>\r
  43             Signed 16bit audio type, Little endian\r
  44             </summary>\r
  45         </member>\r
  46         <member name="F:Tizen.Uix.SttEngine.AudioType.PcmU8">\r
  47             <summary>\r
  48             Unsigned 8bit audio type\r
  49             </summary>\r
  50         </member>\r
  51         <member name="T:Tizen.Uix.SttEngine.ResultEvent">\r
  52             <summary>\r
  53             Enumeration for result.\r
  54             </summary>\r
  55         </member>\r
  56         <member name="F:Tizen.Uix.SttEngine.ResultEvent.FinalResult">\r
  57             <summary>\r
  58             Event when either the full matched or the final result is delivered\r
  59             </summary>\r
  60         </member>\r
  61         <member name="F:Tizen.Uix.SttEngine.ResultEvent.PartialResult">\r
  62             <summary>\r
  63             Event when the partial matched result is delivered\r
  64             </summary>\r
  65         </member>\r
  66         <member name="F:Tizen.Uix.SttEngine.ResultEvent.Error">\r
  67             <summary>\r
  68             Event when the recognition has failed\r
  69             </summary>\r
  70         </member>\r
  71         <member name="T:Tizen.Uix.SttEngine.TimeEvent">\r
  72             <summary>\r
  73             Enumeration for result time.\r
  74             </summary>\r
  75         </member>\r
  76         <member name="F:Tizen.Uix.SttEngine.TimeEvent.Beginning">\r
  77             <summary>\r
  78             Event when the token is beginning type\r
  79             </summary>\r
  80         </member>\r
  81         <member name="F:Tizen.Uix.SttEngine.TimeEvent.Middle">\r
  82             <summary>\r
  83             Event when the token is middle type\r
  84             </summary>\r
  85         </member>\r
  86         <member name="F:Tizen.Uix.SttEngine.TimeEvent.End">\r
  87             <summary>\r
  88             Event when the token is end type\r
  89             </summary>\r
  90         </member>\r
  91         <member name="T:Tizen.Uix.SttEngine.SpeechStatus">\r
  92             <summary>\r
  93             Enumeration for speech status.\r
  94             </summary>\r
  95         </member>\r
  96         <member name="F:Tizen.Uix.SttEngine.SpeechStatus.BeginningPointDetected">\r
  97             <summary>\r
  98             Beginning point of speech is detected\r
  99             </summary>\r
 100         </member>\r
 101         <member name="F:Tizen.Uix.SttEngine.SpeechStatus.EndPointDetected">\r
 102             <summary>\r
 103             End point of speech is detected\r
 104             </summary>\r
 105         </member>\r
 106         <member name="T:Tizen.Uix.SttEngine.ResultMessage">\r
 107             <summary>\r
 108             Enumeration representing the result message\r
 109             </summary>\r
 110         </member>\r
 111         <member name="F:Tizen.Uix.SttEngine.ResultMessage.None">\r
 112             <summary>\r
 113             No Error\r
 114             </summary>\r
 115         </member>\r
 116         <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooSoon">\r
 117             <summary>\r
 118             Recognition failed  because the speech started too soon.\r
 119             </summary>\r
 120         </member>\r
 121         <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooShort">\r
 122             <summary>\r
 123             Recognition failed  because the speech is too short.\r
 124             </summary>\r
 125         </member>\r
 126         <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooLong">\r
 127             <summary>\r
 128             Recognition failed  because the speech is too long.\r
 129             </summary>\r
 130         </member>\r
 131         <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooQuiet">\r
 132             <summary>\r
 133             Recognition failed  because the speech is too quiet to listen.\r
 134             </summary>\r
 135         </member>\r
 136         <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooLoud">\r
 137             <summary>\r
 138             Recognition failed  because the speech is too loud to listen.\r
 139             </summary>\r
 140         </member>\r
 141         <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooFast">\r
 142             <summary>\r
 143             Recognition failed  because the speech is too fast to listen.\r
 144             </summary>\r
 145         </member>\r
 146         <member name="T:Tizen.Uix.SttEngine.Error">\r
 147             <summary>\r
 148             Enum for Error values that can occur\r
 149             </summary>\r
 150         </member>\r
 151         <member name="F:Tizen.Uix.SttEngine.Error.None">\r
 152             <summary>\r
 153             Successful, No error\r
 154             </summary>\r
 155         </member>\r
 156         <member name="F:Tizen.Uix.SttEngine.Error.OutOfMemory">\r
 157             <summary>\r
 158             Out of Memory\r
 159             </summary>\r
 160         </member>\r
 161         <member name="F:Tizen.Uix.SttEngine.Error.IoError">\r
 162             <summary>\r
 163             I/O error\r
 164             </summary>\r
 165         </member>\r
 166         <member name="F:Tizen.Uix.SttEngine.Error.InvalidParameter">\r
 167             <summary>\r
 168             Invalid parameter\r
 169             </summary>\r
 170         </member>\r
 171         <member name="F:Tizen.Uix.SttEngine.Error.NetworkDown">\r
 172             <summary>\r
 173             Network down(Out of network)\r
 174             </summary>\r
 175         </member>\r
 176         <member name="F:Tizen.Uix.SttEngine.Error.InvalidState">\r
 177             <summary>\r
 178             Invalid state\r
 179             </summary>\r
 180         </member>\r
 181         <member name="F:Tizen.Uix.SttEngine.Error.InvalidLanguage">\r
 182             <summary>\r
 183             Invalid language\r
 184             </summary>\r
 185         </member>\r
 186         <member name="F:Tizen.Uix.SttEngine.Error.OperationFailed">\r
 187             <summary>\r
 188             Operation failed\r
 189             </summary>\r
 190         </member>\r
 191         <member name="F:Tizen.Uix.SttEngine.Error.NotSupportedFeature">\r
 192             <summary>\r
 193             Not supported feature of current engine\r
 194             </summary>\r
 195         </member>\r
 196         <member name="F:Tizen.Uix.SttEngine.Error.NotSupported">\r
 197             <summary>\r
 198             NOT supported\r
 199             </summary>\r
 200         </member>\r
 201         <member name="F:Tizen.Uix.SttEngine.Error.PermissionDenied">\r
 202             <summary>\r
 203             Permission denied\r
 204             </summary>\r
 205         </member>\r
 206         <member name="F:Tizen.Uix.SttEngine.Error.RecordingTimedOut">\r
 207             <summary>\r
 208             Recording timed out\r
 209             </summary>\r
 210         </member>\r
 211         <member name="T:Tizen.Uix.SttEngine.Engine">\r
 212             <summary>\r
 213             This Class represents the Stt Engine which has to be inherited to make the engine.\r
 214             </summary>\r
 215         </member>\r
 216         <member name="T:Tizen.Uix.SttEngine.Engine.Action`1">\r
 217             <summary>\r
 218             An Action with 2 Input Parameter returning a Error\r
 219             </summary>\r
 220             <typeparam name="T">Generic Type for Parameter 1</typeparam>\r
 221             <param name="a">The Input Parameter 1</param>\r
 222             <param name="b">The Input Parameter 2</param>\r
 223             <returns>Error Value</returns>\r
 224         </member>\r
 225         <member name="T:Tizen.Uix.SttEngine.Engine.OutAction`1">\r
 226             <summary>\r
 227             An Action with 2 Out Parameter returning a Error\r
 228             </summary>\r
 229             <typeparam name="T">Generic Type for Parameter 1</typeparam>\r
 230             <param name="a">The Input Parameter 1</param>\r
 231             <param name="b">The Input Parameter 2</param>\r
 232             <returns>Error Value</returns>\r
 233         </member>\r
 234         <member name="T:Tizen.Uix.SttEngine.Engine.ResultTime">\r
 235             <summary>\r
 236             Called when Stt engine provides the time stamp of result to the engine service user.\r
 237             This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.\r
 238             </summary>\r
 239             <param name="index">The result index</param>\r
 240             <param name="resultEvent">The token event</param>\r
 241             <param name="text">The result text</param>\r
 242             <param name="startTime">The time started speaking the result text</param>\r
 243             <param name="endTime">The time finished speaking the result text</param>\r
 244             <param name="userData">The User data</param>\r
 245             <returns>true to continue with the next iteration of the loop, false to break out of the loop</returns>\r
 246             <precondition>SendResult() should be called.</precondition>\r
 247         </member>\r
 248         <member name="T:Tizen.Uix.SttEngine.Engine.SupportedLanguages">\r
 249             <summary>\r
 250             Called when Stt engine informs the engine service user about whole supported language list.\r
 251             This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.\r
 252             </summary>\r
 253             <param name="language">The language is specified as an ISO 3166 alpha-2 two letter country-code\r
 254             followed by ISO 639-1 for the two-letter language code\r
 255             for example, "ko_KR" for Korean, "en_US" for American English</param>\r
 256             <param name="userData">The User data</param>\r
 257             <returns>true to continue with the next iteration of the loop, false to break out of the loop</returns>\r
 258             <precondition>ForEachSupportedLanguages() should be called</precondition>\r
 259         </member>\r
 260         <member name="M:Tizen.Uix.SttEngine.Engine.GetInformation(System.String@,System.String@,System.String@,System.Boolean@)">\r
 261             <summary>\r
 262             Called when the engine service user requests the basic information of Stt engine.\r
 263             </summary>\r
 264             <remarks>\r
 265             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
 266             </remarks>\r
 267             <param name="engineUuid">UUID of engine</param>\r
 268             <param name="engineName">Name of engine</param>\r
 269             <param name="engineSetting">The engine setting application(ui app)'s app ID</param>\r
 270             <param name="useNetwork">A variable for checking whether the network is used or not</param>\r
 271             <returns>\r
 272             Following Error Codes can be returned\r
 273             1. None\r
 274             2. OperationFailed\r
 275             3. InvalidParameter\r
 276             </returns>\r
 277         </member>\r
 278         <member name="M:Tizen.Uix.SttEngine.Engine.Initialize">\r
 279             <summary>\r
 280             Called when the engine service user initializes Stt engine.\r
 281             This callback function is called by the engine service user to request for Stt engine to be started.\r
 282             </summary>\r
 283             <returns>\r
 284             Following Error Codes can be returned\r
 285             1. None\r
 286             2. InvalidParameter\r
 287             3. InvalidState\r
 288             4. OperationFailed\r
 289             </returns>\r
 290         </member>\r
 291         <member name="M:Tizen.Uix.SttEngine.Engine.Deinitialize">\r
 292             <summary>\r
 293             Called when the engine service user deinitializes Stt engine.\r
 294             This callback function is called by the engine service user to request for Stt engine to be deinitialized.\r
 295             </summary>\r
 296             <returns>\r
 297             Following Error Codes can be returned\r
 298             1. None\r
 299             2. InvalidState\r
 300             </returns>\r
 301         </member>\r
 302         <member name="M:Tizen.Uix.SttEngine.Engine.ForEachSupportedLanguages(Tizen.Uix.SttEngine.Engine.SupportedLanguages,System.IntPtr)">\r
 303             <summary>\r
 304             Called when the engine service user gets the whole supported language list.\r
 305             </summary>\r
 306             <remarks>\r
 307             In this function, the engine service user's callback function 'SupportedLanguages' is invoked repeatedly for getting all supported languages\r
 308             and user_data must be transferred to 'SupportedLanguages'. If 'SupportedLanguages' returns false, it should be stopped to call 'SupportedLanguages'.\r
 309             </remarks>\r
 310             <param name="callback">The callback function</param>\r
 311             <param name="userData">The user data which must be passed to the callback delegate 'SupportedLanguages'</param>\r
 312             <returns>\r
 313             Following Error Codes can be returned\r
 314             1. None\r
 315             2. InvalidState\r
 316             3. InvalidParameter\r
 317             </returns>\r
 318             <postcondition>\r
 319             This callback function invokes SupportedLanguages repeatedly for getting supported languages.\r
 320             </postcondition>\r
 321         </member>\r
 322         <member name="M:Tizen.Uix.SttEngine.Engine.IsValidLanguage(System.String,System.Boolean@)">\r
 323             <summary>\r
 324             Called when the engine service user checks whether the corresponding language is valid or not in Stt engine.\r
 325             </summary>\r
 326             <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
 327             For example, "ko_KR" for Korean, "en_US" for American English</param>\r
 328             <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
 329             <returns>\r
 330             Following Error Codes can be returned\r
 331             1. None\r
 332             2. InvalidParameter\r
 333             </returns>\r
 334         </member>\r
 335         <member name="M:Tizen.Uix.SttEngine.Engine.SupportSilenceDetection">\r
 336             <summary>\r
 337             Called when the engine service user checks whether Stt engine supports silence detection.\r
 338             </summary>\r
 339             <returns>true to support silence detection, false not to support silence detection</returns>\r
 340         </member>\r
 341         <member name="M:Tizen.Uix.SttEngine.Engine.SupportRecognitionType(System.String,System.Boolean@)">\r
 342             <summary>\r
 343             Called when the engine service user checks whether Stt engine supports the corresponding recognition type.\r
 344             </summary>\r
 345             <param name="type">The type for recognition, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>\r
 346             <param name="isSupported">A variable for checking whether Stt engine supports the corresponding recognition type.\r
 347             true to support recognition type, false not to support recognition type</param>\r
 348             <returns>\r
 349             Following Error Codes can be returned\r
 350             1. None\r
 351             2. InvalidParameter\r
 352             </returns>\r
 353         </member>\r
 354         <member name="M:Tizen.Uix.SttEngine.Engine.GetRecordingFormat(Tizen.Uix.SttEngine.AudioType@,System.Int32@,System.Int32@)">\r
 355             <summary>\r
 356             Called when the engine service user gets the proper recording format of Stt engine.\r
 357             The recording format is used for creating the recorder.\r
 358             </summary>\r
 359             <param name="types">The format used by the recorder</param>\r
 360             <param name="rate">The sample rate used by the recorder</param>\r
 361             <param name="channels">The number of channels used by the recorder</param>\r
 362             <returns>\r
 363             Following Error Codes can be returned\r
 364             1. None\r
 365             2. InvalidState\r
 366             </returns>\r
 367         </member>\r
 368         <member name="M:Tizen.Uix.SttEngine.Engine.SetSilenceDetection(System.Boolean)">\r
 369             <summary>\r
 370             Called when the engine service user sets the silence detection.\r
 371             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
 372             </summary>\r
 373             <param name="isSet">A variable for setting the silence detection. true to detect the silence, false not to detect the silence</param>\r
 374             <returns>\r
 375             Following Error Codes can be returned\r
 376             1. None\r
 377             2. InvalidState\r
 378             3. NotSupportedFeature\r
 379             </returns>\r
 380         </member>\r
 381         <member name="M:Tizen.Uix.SttEngine.Engine.CheckAppAgreed(System.String,System.Boolean@)">\r
 382             <summary>\r
 383             Called when the engine service user requests for Stt engine to check whether the application agreed the usage of Stt engine.\r
 384             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
 385             According to the need, the engine developer can provide some user interfaces to check the agreement.\r
 386             </summary>\r
 387             <param name="appid">The Application ID</param>\r
 388             <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
 389             <returns>\r
 390             Following Error Codes can be returned\r
 391             1. None\r
 392             2. InvalidState\r
 393             3. NotSupportedFeature\r
 394             </returns>\r
 395         </member>\r
 396         <member name="M:Tizen.Uix.SttEngine.Engine.NeedAppCredential">\r
 397             <summary>\r
 398             Called when the engine service user checks whether Stt engine needs the application's credential.\r
 399             </summary>\r
 400             <returns>true if Stt engine needs the application's credential, otherwise false </returns>\r
 401         </member>\r
 402         <member name="M:Tizen.Uix.SttEngine.Engine.ForEachResultTime(System.IntPtr,Tizen.Uix.SttEngine.Engine.ResultTime,System.IntPtr)">\r
 403             <summary>\r
 404             Called when the engine service user gets the result time information(stamp).\r
 405             </summary>\r
 406             <remarks>\r
 407             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
 408             and user_data must be transferred to 'ResultTime'. If 'ResultTime' returns false, it should be stopped to call 'ResultTime'.\r
 409             timeInfo is transferred from SendResult. The type of timeInfo is up to the Stt engine developer.\r
 410             </remarks>\r
 411             <param name="timeInfo">The time information</param>\r
 412             <param name="callback">The callback function</param>\r
 413             <param name="userData">The user data which must be passed to the callback function ResultTime</param>\r
 414             <returns>\r
 415             Following Error Codes can be returned\r
 416             1. None\r
 417             2. InvalidState\r
 418             3. InvalidParameter\r
 419             </returns>\r
 420             <precondition>\r
 421             SendResult will invoke this function\r
 422             </precondition>\r
 423             <postcondition>\r
 424             This function invokes ResultTime repeatedly for getting result time information.\r
 425             </postcondition>\r
 426         </member>\r
 427         <member name="M:Tizen.Uix.SttEngine.Engine.Start(System.String,System.String,System.String,System.String,System.IntPtr)">\r
 428             <summary>\r
 429             Called when the engine service user starts to recognize the recording data.\r
 430             In this callback function, Stt engine must transfer the recognition result and userData to the engine service user using SendResult().\r
 431             Also, if Stt engine needs the application's credential, it sets the credential granted to the application.\r
 432             </summary>\r
 433             <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
 434             For example, "ko_KR" for Korean, "en_US" for American English</param>\r
 435             <param name="type">The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>\r
 436             <param name="appid">The Application ID</param>\r
 437             <param name="credential">The credential granted to the application</param>\r
 438             <param name="userData">The user data to be passed to the callback function</param>\r
 439             <returns>\r
 440             Following Error Codes can be returned\r
 441             1. None\r
 442             2. InvalidState\r
 443             3. InvalidParameter\r
 444             4. InvalidLanguage\r
 445             5. OperationFailed\r
 446             6. NetworkDown\r
 447             </returns>\r
 448             <precondition>\r
 449             The engine is not in recognition processing.\r
 450             </precondition>\r
 451         </member>\r
 452         <member name="M:Tizen.Uix.SttEngine.Engine.SetRecordingData(System.String,System.UInt32)">\r
 453             <summary>\r
 454             Called when the engine service user sets and sends the recording data for speech recognition.\r
 455             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
 456             this function should be returned immediately after recording data copy.\r
 457             </summary>\r
 458             <param name="data">The recording data</param>\r
 459             <param name="length">The length of recording data</param>\r
 460             <returns>\r
 461             Following Error Codes can be returned\r
 462             1. None\r
 463             2. InvalidState\r
 464             3. InvalidParameter\r
 465             4. OperationFailed\r
 466             </returns>\r
 467             <precondition>\r
 468             Start should succeed</precondition>\r
 469             <postcondition>\r
 470             If the engine supports partial result, SendResult() should be invoked.</postcondition>\r
 471         </member>\r
 472         <member name="M:Tizen.Uix.SttEngine.Engine.Stop">\r
 473             <summary>\r
 474             Called when the engine service user stops to recognize the recording data.\r
 475             This callback function is called by the engine service user to stop recording and to get the recognition result.\r
 476             </summary>\r
 477             <returns>Following Error Codes can be returned\r
 478             1. None\r
 479             2. InvalidState\r
 480             3. OperationFailed\r
 481             4. NetworkDown\r
 482             </returns>\r
 483             <precondition>\r
 484             Start should succeed</precondition>\r
 485             <postcondition>\r
 486             After processing of the engine, , SendResult() should be invoked.</postcondition>\r
 487         </member>\r
 488         <member name="M:Tizen.Uix.SttEngine.Engine.Cancel">\r
 489             <summary>\r
 490             Called when the engine service user cancels to recognize the recording data.\r
 491             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
 492             </summary>\r
 493             <returns>\r
 494             Following Error Codes can be returned\r
 495             1. None\r
 496             2. InvalidState\r
 497             </returns>\r
 498             <precondition>Stt engine is in recognition processing or recording.</precondition>\r
 499         </member>\r
 500         <member name="M:Tizen.Uix.SttEngine.Engine.#ctor">\r
 501             <summary>\r
 502             Public Constructor\r
 503             </summary>\r
 504             <feature>\r
 505             http://tizen.org/feature/speech.recognition\r
 506             http://tizen.org/feature/microphone\r
 507             </feature>\r
 508         </member>\r
 509         <member name="M:Tizen.Uix.SttEngine.Engine.EngineMain(System.Int32,System.String[])">\r
 510             <summary>\r
 511             Main function for Speech-To-Text (STT) engine.\r
 512             This function is the main function for operating Stt engine.\r
 513             </summary>\r
 514             <privilege>\r
 515             http://tizen.org/privilege/recorder\r
 516             </privilege>\r
 517             <feature>\r
 518             http://tizen.org/feature/speech.recognition\r
 519             http://tizen.org/feature/microphone\r
 520             </feature>\r
 521             <remarks>\r
 522             ServiceAppMain should be used for working the engine after this function.\r
 523             </remarks>\r
 524             <param name="argc">The Number of Arguments</param>\r
 525             <param name="argv">The Arguments Array</param>\r
 526             <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>\r
 527             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>\r
 528             <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>\r
 529             <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>\r
 530         </member>\r
 531         <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
 532             <summary>\r
 533             Sends the recognition result to the engine service user.\r
 534             </summary>\r
 535             <feature>\r
 536             http://tizen.org/feature/speech.recognition\r
 537             http://tizen.org/feature/microphone\r
 538             </feature>\r
 539             <remarks>\r
 540             This API is used in SetRecordingData() and Stop(), when Stt engine sends the recognition result to the engine service user.\r
 541             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
 542             The recognition result must be transferred to the engine service user through this function. Also, timeInfo must be transferred to ForEachResultTime().\r
 543             The type of timeInfo is up to the Stt engine developer.\r
 544             </remarks>\r
 545             <param name="resultEvent">The result event</param>\r
 546             <param name="type">The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>\r
 547             <param name="result">Result texts</param>\r
 548             <param name="resultCount">Result text count</param>\r
 549             <param name="msg">Engine message</param>\r
 550             <param name="timeInfo">The time information</param>\r
 551             <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>\r
 552             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>\r
 553             <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>\r
 554             <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>\r
 555             <precondition>\r
 556             EngineMain function should be invoked before this function is called. Stop will invoke this function.\r
 557             </precondition>\r
 558             <postcondition>\r
 559             This function invokes ForEachResultTime\r
 560             </postcondition>\r
 561         </member>\r
 562         <member name="M:Tizen.Uix.SttEngine.Engine.SendError(Tizen.Uix.SttEngine.Error,System.String)">\r
 563             <summary>\r
 564             Sends the error to the engine service user.\r
 565             </summary>\r
 566             <feature>\r
 567             http://tizen.org/feature/speech.recognition\r
 568             http://tizen.org/feature/microphone\r
 569             </feature>\r
 570             <param name="error">The Error Reason</param>\r
 571             <param name="msg">The error message</param>\r
 572             <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>\r
 573             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>\r
 574             <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>\r
 575             <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>\r
 576             <precondition>\r
 577             Main function should be invoked before this function is called.\r
 578             </precondition>\r
 579         </member>\r
 580         <member name="M:Tizen.Uix.SttEngine.Engine.SendSpeechStatus(Tizen.Uix.SttEngine.SpeechStatus)">\r
 581             <summary>\r
 582             Sends the speech status to the engine service user when Stt engine notifies the change of the speech status.\r
 583             </summary>\r
 584             <feature>\r
 585             http://tizen.org/feature/speech.recognition\r
 586             http://tizen.org/feature/microphone\r
 587             </feature>\r
 588             <remarks>\r
 589             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
 590             </remarks>\r
 591             <param name="status">SpeechStatus</param>\r
 592             <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>\r
 593             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>\r
 594             <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>\r
 595             <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>\r
 596             <precondition>\r
 597             Main function should be invoked before this function is called. Start() and SetRecordingData() will invoke this function.\r
 598             </precondition>\r
 599         </member>\r
 600         <member name="M:Tizen.Uix.SttEngine.Engine.SetPrivateDataSetDelegate(Tizen.Uix.SttEngine.Engine.Action{System.String})">\r
 601             <summary>\r
 602             Sets a callback function for setting the private data.\r
 603             </summary>\r
 604             <privilege>\r
 605             http://tizen.org/privilege/recorder\r
 606             </privilege>\r
 607             <feature>\r
 608             http://tizen.org/feature/speech.recognition\r
 609             http://tizen.org/feature/microphone\r
 610             </feature>\r
 611             <param name="callback">\r
 612             Called when Stt engine receives the private data from the engine service user.\r
 613             This callback function is called when the engine service user sends the private data to Stt engine.\r
 614             In Parameters:\r
 615             a = Key -- The key field of private data\r
 616             b = data -- The data field of private data\r
 617             Following Error Codes can be returned\r
 618             1. None\r
 619             2. InvalidParameter\r
 620             3. OperationFailed\r
 621             </param>\r
 622             <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>\r
 623             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>\r
 624             <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>\r
 625             <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>\r
 626             <precondition>\r
 627             Main function should be invoked before this function is called.\r
 628             </precondition>\r
 629         </member>\r
 630         <member name="M:Tizen.Uix.SttEngine.Engine.SetPrivateDataRequestedDelegate(Tizen.Uix.SttEngine.Engine.OutAction{System.String})">\r
 631             <summary>\r
 632             Sets a callback delegate for requesting the private data.\r
 633             </summary>\r
 634             <privilege>\r
 635             http://tizen.org/privilege/recorder\r
 636             </privilege>\r
 637             <feature>\r
 638             http://tizen.org/feature/speech.recognition\r
 639             http://tizen.org/feature/microphone\r
 640             </feature>\r
 641             <param name="callback">callback function\r
 642             Called when Stt engine provides the engine service user with the private data.\r
 643             This callback function is called when the engine service user gets the private data from Stt engine.\r
 644             Out Parameters:\r
 645             a = Key -- The key field of private data\r
 646             b = data -- The data field of private data\r
 647             Following Error Codes can be returned\r
 648             1. None\r
 649             2. InvalidParameter\r
 650             3. OperationFailed\r
 651             </param>\r
 652             <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>\r
 653             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>\r
 654             <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>\r
 655             <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>\r
 656             <precondition>\r
 657             Main function should be invoked before this function is called.\r
 658             </precondition>\r
 659         </member>\r
 660     </members>\r
 661 </doc>\r