objc2_speech/generated/
SFSpeechRecognitionTask.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ffi::*;
4use core::ptr::NonNull;
5use objc2::__framework_prelude::*;
6use objc2_foundation::*;
7
8use crate::*;
9
10/// [Apple's documentation](https://developer.apple.com/documentation/speech/sfspeechrecognitiontaskstate?language=objc)
11// NS_ENUM
12#[repr(transparent)]
13#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
14pub struct SFSpeechRecognitionTaskState(pub NSInteger);
15impl SFSpeechRecognitionTaskState {
16    #[doc(alias = "SFSpeechRecognitionTaskStateStarting")]
17    pub const Starting: Self = Self(0);
18    #[doc(alias = "SFSpeechRecognitionTaskStateRunning")]
19    pub const Running: Self = Self(1);
20    #[doc(alias = "SFSpeechRecognitionTaskStateFinishing")]
21    pub const Finishing: Self = Self(2);
22    #[doc(alias = "SFSpeechRecognitionTaskStateCanceling")]
23    pub const Canceling: Self = Self(3);
24    #[doc(alias = "SFSpeechRecognitionTaskStateCompleted")]
25    pub const Completed: Self = Self(4);
26}
27
28unsafe impl Encode for SFSpeechRecognitionTaskState {
29    const ENCODING: Encoding = NSInteger::ENCODING;
30}
31
32unsafe impl RefEncode for SFSpeechRecognitionTaskState {
33    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
34}
35
36extern_class!(
37    /// [Apple's documentation](https://developer.apple.com/documentation/speech/sfspeechrecognitiontask?language=objc)
38    #[unsafe(super(NSObject))]
39    #[derive(Debug, PartialEq, Eq, Hash)]
40    pub struct SFSpeechRecognitionTask;
41);
42
43unsafe impl NSObjectProtocol for SFSpeechRecognitionTask {}
44
45impl SFSpeechRecognitionTask {
46    extern_methods!(
47        #[unsafe(method(state))]
48        #[unsafe(method_family = none)]
49        pub unsafe fn state(&self) -> SFSpeechRecognitionTaskState;
50
51        #[unsafe(method(isFinishing))]
52        #[unsafe(method_family = none)]
53        pub unsafe fn isFinishing(&self) -> bool;
54
55        #[unsafe(method(finish))]
56        #[unsafe(method_family = none)]
57        pub unsafe fn finish(&self);
58
59        #[unsafe(method(isCancelled))]
60        #[unsafe(method_family = none)]
61        pub unsafe fn isCancelled(&self) -> bool;
62
63        #[unsafe(method(cancel))]
64        #[unsafe(method_family = none)]
65        pub unsafe fn cancel(&self);
66
67        #[unsafe(method(error))]
68        #[unsafe(method_family = none)]
69        pub unsafe fn error(&self) -> Option<Retained<NSError>>;
70    );
71}
72
73/// Methods declared on superclass `NSObject`.
74impl SFSpeechRecognitionTask {
75    extern_methods!(
76        #[unsafe(method(init))]
77        #[unsafe(method_family = init)]
78        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
79
80        #[unsafe(method(new))]
81        #[unsafe(method_family = new)]
82        pub unsafe fn new() -> Retained<Self>;
83    );
84}
85
86extern_protocol!(
87    /// [Apple's documentation](https://developer.apple.com/documentation/speech/sfspeechrecognitiontaskdelegate?language=objc)
88    pub unsafe trait SFSpeechRecognitionTaskDelegate: NSObjectProtocol {
89        #[optional]
90        #[unsafe(method(speechRecognitionDidDetectSpeech:))]
91        #[unsafe(method_family = none)]
92        unsafe fn speechRecognitionDidDetectSpeech(&self, task: &SFSpeechRecognitionTask);
93
94        #[cfg(feature = "SFTranscription")]
95        #[optional]
96        #[unsafe(method(speechRecognitionTask:didHypothesizeTranscription:))]
97        #[unsafe(method_family = none)]
98        unsafe fn speechRecognitionTask_didHypothesizeTranscription(
99            &self,
100            task: &SFSpeechRecognitionTask,
101            transcription: &SFTranscription,
102        );
103
104        #[cfg(feature = "SFSpeechRecognitionResult")]
105        #[optional]
106        #[unsafe(method(speechRecognitionTask:didFinishRecognition:))]
107        #[unsafe(method_family = none)]
108        unsafe fn speechRecognitionTask_didFinishRecognition(
109            &self,
110            task: &SFSpeechRecognitionTask,
111            recognition_result: &SFSpeechRecognitionResult,
112        );
113
114        #[optional]
115        #[unsafe(method(speechRecognitionTaskFinishedReadingAudio:))]
116        #[unsafe(method_family = none)]
117        unsafe fn speechRecognitionTaskFinishedReadingAudio(&self, task: &SFSpeechRecognitionTask);
118
119        #[optional]
120        #[unsafe(method(speechRecognitionTaskWasCancelled:))]
121        #[unsafe(method_family = none)]
122        unsafe fn speechRecognitionTaskWasCancelled(&self, task: &SFSpeechRecognitionTask);
123
124        #[optional]
125        #[unsafe(method(speechRecognitionTask:didFinishSuccessfully:))]
126        #[unsafe(method_family = none)]
127        unsafe fn speechRecognitionTask_didFinishSuccessfully(
128            &self,
129            task: &SFSpeechRecognitionTask,
130            successfully: bool,
131        );
132
133        #[optional]
134        #[unsafe(method(speechRecognitionTask:didProcessAudioDuration:))]
135        #[unsafe(method_family = none)]
136        unsafe fn speechRecognitionTask_didProcessAudioDuration(
137            &self,
138            task: &SFSpeechRecognitionTask,
139            duration: NSTimeInterval,
140        );
141    }
142);