objc2_speech/generated/
SFSpeechRecognitionRequest.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::*;
6#[cfg(feature = "objc2-avf-audio")]
7use objc2_avf_audio::*;
8#[cfg(feature = "objc2-core-media")]
9use objc2_core_media::*;
10use objc2_foundation::*;
11
12use crate::*;
13
14extern_class!(
15    /// [Apple's documentation](https://developer.apple.com/documentation/speech/sfspeechrecognitionrequest?language=objc)
16    #[unsafe(super(NSObject))]
17    #[derive(Debug, PartialEq, Eq, Hash)]
18    pub struct SFSpeechRecognitionRequest;
19);
20
21unsafe impl NSObjectProtocol for SFSpeechRecognitionRequest {}
22
23impl SFSpeechRecognitionRequest {
24    extern_methods!(
25        #[cfg(feature = "SFSpeechRecognitionTaskHint")]
26        #[unsafe(method(taskHint))]
27        #[unsafe(method_family = none)]
28        pub unsafe fn taskHint(&self) -> SFSpeechRecognitionTaskHint;
29
30        #[cfg(feature = "SFSpeechRecognitionTaskHint")]
31        /// Setter for [`taskHint`][Self::taskHint].
32        #[unsafe(method(setTaskHint:))]
33        #[unsafe(method_family = none)]
34        pub unsafe fn setTaskHint(&self, task_hint: SFSpeechRecognitionTaskHint);
35
36        #[unsafe(method(shouldReportPartialResults))]
37        #[unsafe(method_family = none)]
38        pub unsafe fn shouldReportPartialResults(&self) -> bool;
39
40        /// Setter for [`shouldReportPartialResults`][Self::shouldReportPartialResults].
41        #[unsafe(method(setShouldReportPartialResults:))]
42        #[unsafe(method_family = none)]
43        pub unsafe fn setShouldReportPartialResults(&self, should_report_partial_results: bool);
44
45        #[unsafe(method(contextualStrings))]
46        #[unsafe(method_family = none)]
47        pub unsafe fn contextualStrings(&self) -> Retained<NSArray<NSString>>;
48
49        /// Setter for [`contextualStrings`][Self::contextualStrings].
50        #[unsafe(method(setContextualStrings:))]
51        #[unsafe(method_family = none)]
52        pub unsafe fn setContextualStrings(&self, contextual_strings: &NSArray<NSString>);
53
54        #[deprecated = "Not used anymore"]
55        #[unsafe(method(interactionIdentifier))]
56        #[unsafe(method_family = none)]
57        pub unsafe fn interactionIdentifier(&self) -> Option<Retained<NSString>>;
58
59        /// Setter for [`interactionIdentifier`][Self::interactionIdentifier].
60        #[deprecated = "Not used anymore"]
61        #[unsafe(method(setInteractionIdentifier:))]
62        #[unsafe(method_family = none)]
63        pub unsafe fn setInteractionIdentifier(&self, interaction_identifier: Option<&NSString>);
64
65        #[unsafe(method(requiresOnDeviceRecognition))]
66        #[unsafe(method_family = none)]
67        pub unsafe fn requiresOnDeviceRecognition(&self) -> bool;
68
69        /// Setter for [`requiresOnDeviceRecognition`][Self::requiresOnDeviceRecognition].
70        #[unsafe(method(setRequiresOnDeviceRecognition:))]
71        #[unsafe(method_family = none)]
72        pub unsafe fn setRequiresOnDeviceRecognition(&self, requires_on_device_recognition: bool);
73
74        #[unsafe(method(addsPunctuation))]
75        #[unsafe(method_family = none)]
76        pub unsafe fn addsPunctuation(&self) -> bool;
77
78        /// Setter for [`addsPunctuation`][Self::addsPunctuation].
79        #[unsafe(method(setAddsPunctuation:))]
80        #[unsafe(method_family = none)]
81        pub unsafe fn setAddsPunctuation(&self, adds_punctuation: bool);
82
83        #[cfg(feature = "SFSpeechLanguageModel")]
84        #[unsafe(method(customizedLanguageModel))]
85        #[unsafe(method_family = none)]
86        pub unsafe fn customizedLanguageModel(
87            &self,
88        ) -> Option<Retained<SFSpeechLanguageModelConfiguration>>;
89
90        #[cfg(feature = "SFSpeechLanguageModel")]
91        /// Setter for [`customizedLanguageModel`][Self::customizedLanguageModel].
92        #[unsafe(method(setCustomizedLanguageModel:))]
93        #[unsafe(method_family = none)]
94        pub unsafe fn setCustomizedLanguageModel(
95            &self,
96            customized_language_model: Option<&SFSpeechLanguageModelConfiguration>,
97        );
98    );
99}
100
101/// Methods declared on superclass `NSObject`.
102impl SFSpeechRecognitionRequest {
103    extern_methods!(
104        #[unsafe(method(init))]
105        #[unsafe(method_family = init)]
106        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
107
108        #[unsafe(method(new))]
109        #[unsafe(method_family = new)]
110        pub unsafe fn new() -> Retained<Self>;
111    );
112}
113
114extern_class!(
115    /// [Apple's documentation](https://developer.apple.com/documentation/speech/sfspeechurlrecognitionrequest?language=objc)
116    #[unsafe(super(SFSpeechRecognitionRequest, NSObject))]
117    #[derive(Debug, PartialEq, Eq, Hash)]
118    pub struct SFSpeechURLRecognitionRequest;
119);
120
121unsafe impl NSObjectProtocol for SFSpeechURLRecognitionRequest {}
122
123impl SFSpeechURLRecognitionRequest {
124    extern_methods!(
125        #[unsafe(method(init))]
126        #[unsafe(method_family = init)]
127        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
128
129        #[unsafe(method(initWithURL:))]
130        #[unsafe(method_family = init)]
131        pub unsafe fn initWithURL(this: Allocated<Self>, url: &NSURL) -> Retained<Self>;
132
133        #[unsafe(method(URL))]
134        #[unsafe(method_family = none)]
135        pub unsafe fn URL(&self) -> Retained<NSURL>;
136    );
137}
138
139/// Methods declared on superclass `NSObject`.
140impl SFSpeechURLRecognitionRequest {
141    extern_methods!(
142        #[unsafe(method(new))]
143        #[unsafe(method_family = new)]
144        pub unsafe fn new() -> Retained<Self>;
145    );
146}
147
148extern_class!(
149    /// [Apple's documentation](https://developer.apple.com/documentation/speech/sfspeechaudiobufferrecognitionrequest?language=objc)
150    #[unsafe(super(SFSpeechRecognitionRequest, NSObject))]
151    #[derive(Debug, PartialEq, Eq, Hash)]
152    pub struct SFSpeechAudioBufferRecognitionRequest;
153);
154
155unsafe impl NSObjectProtocol for SFSpeechAudioBufferRecognitionRequest {}
156
157impl SFSpeechAudioBufferRecognitionRequest {
158    extern_methods!(
159        #[cfg(feature = "objc2-avf-audio")]
160        #[unsafe(method(nativeAudioFormat))]
161        #[unsafe(method_family = none)]
162        pub unsafe fn nativeAudioFormat(&self) -> Retained<AVAudioFormat>;
163
164        #[cfg(feature = "objc2-avf-audio")]
165        #[unsafe(method(appendAudioPCMBuffer:))]
166        #[unsafe(method_family = none)]
167        pub unsafe fn appendAudioPCMBuffer(&self, audio_pcm_buffer: &AVAudioPCMBuffer);
168
169        #[cfg(feature = "objc2-core-media")]
170        #[unsafe(method(appendAudioSampleBuffer:))]
171        #[unsafe(method_family = none)]
172        pub unsafe fn appendAudioSampleBuffer(&self, sample_buffer: &CMSampleBuffer);
173
174        #[unsafe(method(endAudio))]
175        #[unsafe(method_family = none)]
176        pub unsafe fn endAudio(&self);
177    );
178}
179
180/// Methods declared on superclass `NSObject`.
181impl SFSpeechAudioBufferRecognitionRequest {
182    extern_methods!(
183        #[unsafe(method(init))]
184        #[unsafe(method_family = init)]
185        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
186
187        #[unsafe(method(new))]
188        #[unsafe(method_family = new)]
189        pub unsafe fn new() -> Retained<Self>;
190    );
191}