4 <name>Tizen.Uix.SttEngine</name>
7 <member name="T:Interop">
15 <member name="T:Interop.Libraries">
17 Partial Libraries Class
20 <member name="T:Interop.SttEngine">
22 SttEngine Interop Class
25 <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.OutOfMemory" -->
26 <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.IoError" -->
27 <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.InvalidParameter" -->
28 <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.NetworkDown" -->
29 <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.InvalidState" -->
30 <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.InvalidLanguage" -->
31 <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.OperationFailed" -->
32 <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.NotSupportedFeature" -->
33 <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.NotSupported" -->
34 <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.PermissionDenied" -->
35 <!-- Badly formed XML comment ignored for member "F:Interop.SttEngine.ErrorCode.RecordingTimedOut" -->
36 <member name="T:Tizen.Uix.SttEngine.AudioType">
38 Enumeration for audio type.
41 <member name="F:Tizen.Uix.SttEngine.AudioType.PcmS16Le">
43 Signed 16bit audio type, Little endian
46 <member name="F:Tizen.Uix.SttEngine.AudioType.PcmU8">
48 Unsigned 8bit audio type
51 <member name="T:Tizen.Uix.SttEngine.ResultEvent">
53 Enumeration for result.
56 <member name="F:Tizen.Uix.SttEngine.ResultEvent.FinalResult">
58 Event when either the full matched or the final result is delivered
61 <member name="F:Tizen.Uix.SttEngine.ResultEvent.PartialResult">
63 Event when the partial matched result is delivered
66 <member name="F:Tizen.Uix.SttEngine.ResultEvent.Error">
68 Event when the recognition has failed
71 <member name="T:Tizen.Uix.SttEngine.TimeEvent">
73 Enumeration for result time.
76 <member name="F:Tizen.Uix.SttEngine.TimeEvent.Beginning">
78 Event when the token is beginning type
81 <member name="F:Tizen.Uix.SttEngine.TimeEvent.Middle">
83 Event when the token is middle type
86 <member name="F:Tizen.Uix.SttEngine.TimeEvent.End">
88 Event when the token is end type
91 <member name="T:Tizen.Uix.SttEngine.SpeechStatus">
93 Enumeration for speech status.
96 <member name="F:Tizen.Uix.SttEngine.SpeechStatus.BeginningPointDetected">
98 Beginning point of speech is detected
101 <member name="F:Tizen.Uix.SttEngine.SpeechStatus.EndPointDetected">
103 End point of speech is detected
106 <member name="T:Tizen.Uix.SttEngine.ResultMessage">
108 Enumeration representing the result message
111 <member name="F:Tizen.Uix.SttEngine.ResultMessage.None">
116 <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooSoon">
118 Recognition failed because the speech started too soon.
121 <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooShort">
123 Recognition failed because the speech is too short.
126 <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooLong">
128 Recognition failed because the speech is too long.
131 <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooQuiet">
133 Recognition failed because the speech is too quiet to listen.
136 <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooLoud">
138 Recognition failed because the speech is too loud to listen.
141 <member name="F:Tizen.Uix.SttEngine.ResultMessage.TooFast">
143 Recognition failed because the speech is too fast to listen.
146 <member name="T:Tizen.Uix.SttEngine.Error">
148 Enum for Error values that can occur
151 <member name="F:Tizen.Uix.SttEngine.Error.None">
156 <member name="F:Tizen.Uix.SttEngine.Error.OutOfMemory">
161 <member name="F:Tizen.Uix.SttEngine.Error.IoError">
166 <member name="F:Tizen.Uix.SttEngine.Error.InvalidParameter">
171 <member name="F:Tizen.Uix.SttEngine.Error.NetworkDown">
173 Network down(Out of network)
176 <member name="F:Tizen.Uix.SttEngine.Error.InvalidState">
181 <member name="F:Tizen.Uix.SttEngine.Error.InvalidLanguage">
186 <member name="F:Tizen.Uix.SttEngine.Error.OperationFailed">
191 <member name="F:Tizen.Uix.SttEngine.Error.NotSupportedFeature">
193 Not supported feature of current engine
196 <member name="F:Tizen.Uix.SttEngine.Error.NotSupported">
201 <member name="F:Tizen.Uix.SttEngine.Error.PermissionDenied">
206 <member name="F:Tizen.Uix.SttEngine.Error.RecordingTimedOut">
211 <member name="T:Tizen.Uix.SttEngine.Engine">
213 This Class represents the Stt Engine which has to be inherited to make the engine.
216 <member name="T:Tizen.Uix.SttEngine.Engine.Action`1">
218 An Action with 2 Input Parameter returning a Error
220 <typeparam name="T">Generic Type for Parameter 1</typeparam>
221 <param name="a">The Input Parameter 1</param>
222 <param name="b">The Input Parameter 2</param>
223 <returns>Error Value</returns>
225 <member name="T:Tizen.Uix.SttEngine.Engine.OutAction`1">
227 An Action with 2 Out Parameter returning a Error
229 <typeparam name="T">Generic Type for Parameter 1</typeparam>
230 <param name="a">The Input Parameter 1</param>
231 <param name="b">The Input Parameter 2</param>
232 <returns>Error Value</returns>
234 <member name="T:Tizen.Uix.SttEngine.Engine.ResultTime">
236 Called when Stt engine provides the time stamp of result to the engine service user.
237 This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.
239 <param name="index">The result index</param>
240 <param name="resultEvent">The token event</param>
241 <param name="text">The result text</param>
242 <param name="startTime">The time started speaking the result text</param>
243 <param name="endTime">The time finished speaking the result text</param>
244 <param mane="userData">The User data</param>
245 <returns>true to continue with the next iteration of the loop, false to break out of the loop</returns>
246 <precondition>SendResult() should be called.</precondition>
248 <member name="T:Tizen.Uix.SttEngine.Engine.SupportedLanguages">
250 Called when Stt engine informs the engine service user about whole supported language list.
251 This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function.
253 <param name="language">The language is specified as an ISO 3166 alpha-2 two letter country-code
254 followed by ISO 639-1 for the two-letter language code
255 for example, "ko_KR" for Korean, "en_US" for American English</param>
256 <param mane="userData">The User data</param>
257 <returns>true to continue with the next iteration of the loop, false to break out of the loop</returns>
258 <precondition>ForEachSupportedLanguages() should be called</precondition>
260 <member name="M:Tizen.Uix.SttEngine.Engine.GetInformation(System.String@,System.String@,System.String@,System.Boolean@)">
262 Called when the engine service user requests the basic information of Stt engine.
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.
267 <param name="engineUuid">UUID of engine</param>
268 <param name="engineName">Name of engine</param>
269 <param name="engineSetting">The engine setting application(ui app)'s app ID</param>
270 <param name="useNetwork">A variable for checking whether the network is used or not</param>
272 Following Error Codes can be returned
278 <member name="M:Tizen.Uix.SttEngine.Engine.Initialize">
280 Called when the engine service user initializes Stt engine.
281 This callback function is called by the engine service user to request for Stt engine to be started.
284 Following Error Codes can be returned
291 <member name="M:Tizen.Uix.SttEngine.Engine.Deinitialize">
293 Called when the engine service user deinitializes Stt engine.
294 This callback function is called by the engine service user to request for Stt engine to be deinitialized.
297 Following Error Codes can be returned
302 <member name="M:Tizen.Uix.SttEngine.Engine.ForEachSupportedLanguages(Tizen.Uix.SttEngine.Engine.SupportedLanguages,System.IntPtr)">
304 Called when the engine service user gets the whole supported language list.
307 In this function, the engine service user's callback function 'SupportedLanguages' is invoked repeatedly for getting all supported languages
308 and user_data must be transferred to 'SupportedLanguages'. If 'SupportedLanguages' returns false, it should be stopped to call 'SupportedLanguages'.
310 <param name="callback">The callback function</param>
311 <param name="userData">The user data which must be passed to the callback delegate 'SupportedLanguages'</param>
313 Following Error Codes can be returned
319 This callback function invokes SupportedLanguages repeatedly for getting supported languages.
322 <member name="M:Tizen.Uix.SttEngine.Engine.IsValidLanguage(System.String,System.Boolean@)">
324 Called when the engine service user checks whether the corresponding language is valid or not in Stt engine.
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
327 For example, "ko_KR" for Korean, "en_US" for American English</param>
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>
330 Following Error Codes can be returned
335 <member name="M:Tizen.Uix.SttEngine.Engine.SupportSilenceDetection">
337 Called when the engine service user checks whether Stt engine supports silence detection.
339 <returns>true to support silence detection, false not to support silence detection</returns>
341 <member name="M:Tizen.Uix.SttEngine.Engine.SupportRecognitionType(System.String,System.Boolean@)">
343 Called when the engine service user checks whether Stt engine supports the corresponding recognition type.
345 <param name="type">The type for recognition, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>
346 <param name="isSupported">A variable for checking whether Stt engine supports the corresponding recognition type.
347 true to support recognition type, false not to support recognition type</param>
349 Following Error Codes can be returned
354 <member name="M:Tizen.Uix.SttEngine.Engine.GetRecordingFormat(Tizen.Uix.SttEngine.AudioType@,System.Int32@,System.Int32@)">
356 Called when the engine service user gets the proper recording format of Stt engine.
357 The recording format is used for creating the recorder.
359 <param name="types">The format used by the recorder</param>
360 <param name="rate">The sample rate used by the recorder</param>
361 <param name="channels">The number of channels used by the recorder</param>
363 Following Error Codes can be returned
368 <member name="M:Tizen.Uix.SttEngine.Engine.SetSilenceDetection(System.Boolean)">
370 Called when the engine service user sets the silence detection.
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.
373 <param name="isSet">A variable for setting the silence detection. true to detect the silence, false not to detect the silence</param>
375 Following Error Codes can be returned
378 3. NotSupportedFeature
381 <member name="M:Tizen.Uix.SttEngine.Engine.CheckAppAgreed(System.String,System.Boolean@)">
383 Called when the engine service user requests for Stt engine to check whether the application agreed the usage of Stt engine.
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.
385 According to the need, the engine developer can provide some user interfaces to check the agreement.
387 <param name="appid">The Application ID</param>
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>
390 Following Error Codes can be returned
393 3. NotSupportedFeature
396 <member name="M:Tizen.Uix.SttEngine.Engine.NeedAppCredential">
398 Called when the engine service user checks whether Stt engine needs the application's credential.
400 <returns>true if Stt engine needs the application's credential, otherwise false </returns>
402 <member name="M:Tizen.Uix.SttEngine.Engine.ForEachResultTime(System.IntPtr,Tizen.Uix.SttEngine.Engine.ResultTime,System.IntPtr)">
404 Called when the engine service user gets the result time information(stamp).
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
408 and user_data must be transferred to 'ResultTime'. If 'ResultTime' returns false, it should be stopped to call 'ResultTime'.
409 timeInfo is transferred from SendResult. The type of timeInfo is up to the Stt engine developer.
411 <param name="timeInfo">The time information</param>
412 <param name="callback">The callback function</param>
413 <param name="userData">The user data which must be passed to the callback function ResultTime</param>
415 Following Error Codes can be returned
421 SendResult will invoke this function
424 This function invokes ResultTime repeatedly for getting result time information.
427 <member name="M:Tizen.Uix.SttEngine.Engine.Start(System.String,System.String,System.String,System.String,System.IntPtr)">
429 Called when the engine service user starts to recognize the recording data.
430 In this callback function, Stt engine must transfer the recognition result and userData to the engine service user using SendResult().
431 Also, if Stt engine needs the application's credential, it sets the credential granted to the application.
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
434 For example, "ko_KR" for Korean, "en_US" for American English</param>
435 <param name="type">The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>
436 <param name="appid">The Application ID</param>
437 <param name="credential">The credential granted to the application</param>
438 <param name="userData">The user data to be passed to the callback function</param>
440 Following Error Codes can be returned
449 The engine is not in recognition processing.
452 <member name="M:Tizen.Uix.SttEngine.Engine.SetRecordingData(System.String,System.UInt32)">
454 Called when the engine service user sets and sends the recording data for speech recognition.
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.
456 this function should be returned immediately after recording data copy.
458 <param name="data">The recording data</param>
459 <param name="length">The length of recording data</param>
461 Following Error Codes can be returned
468 Start should succeed</percondition>
470 If the engine supports partial result, SendResult() should be invoked.</postcondition>
472 <member name="M:Tizen.Uix.SttEngine.Engine.Stop">
474 Called when the engine service user stops to recognize the recording data.
475 This callback function is called by the engine service user to stop recording and to get the recognition result.
477 <returns>Following Error Codes can be returned
484 Start should succeed</percondition>
486 After processing of the engine, , SendResult() should be invoked.</postcondition>
488 <member name="M:Tizen.Uix.SttEngine.Engine.Cancel">
490 Called when the engine service user cancels to recognize the recording data.
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.
494 Following Error Codes can be returned
498 <precondition>Stt engine is in recognition processing or recording.</precondition>
500 <member name="M:Tizen.Uix.SttEngine.Engine.#ctor">
505 <member name="M:Tizen.Uix.SttEngine.Engine.EngineMain(System.Int32,System.String[])">
507 Main function for Speech-To-Text (STT) engine.
508 This function is the main function for operating Stt engine.
511 http://tizen.org/privilege/recorder
514 ServiceAppMain should be used for working the engine after this function.
516 <param name="argc">The Number of Arguments</param>
517 <param name="argv">The Arguments Array</param>
518 <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>
519 <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>
520 <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>
521 <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>
523 <member name="M:Tizen.Uix.SttEngine.Engine.SendResult(Tizen.Uix.SttEngine.ResultEvent,System.String,System.String[],System.Int32,Tizen.Uix.SttEngine.ResultMessage,System.IntPtr)">
525 Sends the recognition result to the engine service user.
528 This API is used in SetRecordingData() and Stop(), when Stt engine sends the recognition result to the engine service user.
529 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.
530 The recognition result must be transferred to the engine service user through this function. Also, timeInfo must be transferred to ForEachResultTime().
531 The type of timeInfo is up to the Stt engine developer.
533 <param name="resultEvent">The result event</param>
534 <param name="type">The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL"</param>
535 <param name="result">Result texts</param>
536 <param name="resultCount">Result text count</param>
537 <param name="msg">Engine message</param>
538 <param name="timeInfo">The time information</param>
539 <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>
540 <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>
541 <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>
542 <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>
544 EngineMain function should be invoked before this function is called. Stop will invoke this function.
547 This function invokes ForEachResultTime
550 <member name="M:Tizen.Uix.SttEngine.Engine.SendError(Tizen.Uix.SttEngine.Error,System.String)">
552 Sends the error to the engine service user.
554 <param name="error">The Error Reason</param>
555 <param name="msg">The error message</param>
556 <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>
557 <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>
558 <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>
559 <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>
561 Main function should be invoked before this function is called.
564 <member name="M:Tizen.Uix.SttEngine.Engine.SendSpeechStatus(Tizen.Uix.SttEngine.SpeechStatus)">
566 Sends the speech status to the engine service user when Stt engine notifies the change of the speech status.
569 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.
571 <param name="status">SpeechStatus</param>
572 <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>
573 <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>
574 <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>
575 <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>
577 Main function should be invoked before this function is called. Start() and SetRecordingData() will invoke this function.
580 <member name="M:Tizen.Uix.SttEngine.Engine.SetPrivateDataSetDelegate(Tizen.Uix.SttEngine.Engine.Action{System.String})">
582 Sets a callback function for setting the private data.
585 http://tizen.org/privilege/recorder
587 <param name="callback">
588 Called when Stt engine receives the private data from the engine service user.
589 This callback function is called when the engine service user sends the private data to Stt engine.
591 a = Key -- The key field of private data
592 b = data -- The data field of private data
593 Following Error Codes can be returned
598 <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>
599 <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>
600 <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>
601 <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>
603 Main function should be invoked before this function is called.
606 <member name="M:Tizen.Uix.SttEngine.Engine.SetPrivateDataRequestedDelegate(Tizen.Uix.SttEngine.Engine.OutAction{System.String})">
608 Sets a callback delegate for requesting the private data.
611 http://tizen.org/privilege/recorder
613 <param name="callback">callback function
614 Called when Stt engine provides the engine service user with the private data.
615 This callback function is called when the engine service user gets the private data from Stt engine.
617 a = Key -- The key field of private data
618 b = data -- The data field of private data
619 Following Error Codes can be returned
624 <exception cref="T:System.ArgumentException">Thrown in case of Invalid Parameter</exception>
625 <exception cref="T:System.UnauthorizedAccessException">Thrown in case of Permission denied</exception>
626 <exception cref="T:System.NotSupportedException">Thrown in case of Not supported</exception>
627 <exception cref="T:System.InvalidOperationException">thrown in case of Operation failure</exception>
629 Main function should be invoked before this function is called.