objc2_phase/generated/
PHASEDirectivityModel.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
10extern_class!(
11    /// *************************************************************************************************
12    ///
13    ///
14    ///
15    /// Cardioid directivity model subband parameters.
16    ///
17    /// See also [Apple's documentation](https://developer.apple.com/documentation/phase/phasecardioiddirectivitymodelsubbandparameters?language=objc)
18    #[unsafe(super(NSObject))]
19    #[derive(Debug, PartialEq, Eq, Hash)]
20    pub struct PHASECardioidDirectivityModelSubbandParameters;
21);
22
23extern_conformance!(
24    unsafe impl NSObjectProtocol for PHASECardioidDirectivityModelSubbandParameters {}
25);
26
27impl PHASECardioidDirectivityModelSubbandParameters {
28    extern_methods!(
29        #[unsafe(method(init))]
30        #[unsafe(method_family = init)]
31        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
32
33        /// The frequency of the subband, in hertz.
34        ///
35        /// Note: Values are clamped to the range [20.0, 20000.0]. Default value is 1000.0.
36        #[unsafe(method(frequency))]
37        #[unsafe(method_family = none)]
38        pub unsafe fn frequency(&self) -> c_double;
39
40        /// Setter for [`frequency`][Self::frequency].
41        #[unsafe(method(setFrequency:))]
42        #[unsafe(method_family = none)]
43        pub unsafe fn setFrequency(&self, frequency: c_double);
44
45        /// The directivity pattern.
46        ///
47        /// Note: Values are clamped to the range [0.0, 1.0]. Default value is 0.0. 0.0 is omnidirectional. 0.5 is cardioid. 1.0 is dipole.
48        #[unsafe(method(pattern))]
49        #[unsafe(method_family = none)]
50        pub unsafe fn pattern(&self) -> c_double;
51
52        /// Setter for [`pattern`][Self::pattern].
53        #[unsafe(method(setPattern:))]
54        #[unsafe(method_family = none)]
55        pub unsafe fn setPattern(&self, pattern: c_double);
56
57        /// The sharpness of the directivity pattern.
58        ///
59        /// Note: Values are clamped to the range [1.0, DBL_MAX]. Default value is 1.0. Values > 1.0 increase sharpness.
60        #[unsafe(method(sharpness))]
61        #[unsafe(method_family = none)]
62        pub unsafe fn sharpness(&self) -> c_double;
63
64        /// Setter for [`sharpness`][Self::sharpness].
65        #[unsafe(method(setSharpness:))]
66        #[unsafe(method_family = none)]
67        pub unsafe fn setSharpness(&self, sharpness: c_double);
68    );
69}
70
71/// Methods declared on superclass `NSObject`.
72impl PHASECardioidDirectivityModelSubbandParameters {
73    extern_methods!(
74        #[unsafe(method(new))]
75        #[unsafe(method_family = new)]
76        pub unsafe fn new() -> Retained<Self>;
77    );
78}
79
80extern_class!(
81    /// *************************************************************************************************
82    ///
83    ///
84    ///
85    /// Cone directivity model subband parameters.
86    ///
87    /// See also [Apple's documentation](https://developer.apple.com/documentation/phase/phaseconedirectivitymodelsubbandparameters?language=objc)
88    #[unsafe(super(NSObject))]
89    #[derive(Debug, PartialEq, Eq, Hash)]
90    pub struct PHASEConeDirectivityModelSubbandParameters;
91);
92
93extern_conformance!(
94    unsafe impl NSObjectProtocol for PHASEConeDirectivityModelSubbandParameters {}
95);
96
97impl PHASEConeDirectivityModelSubbandParameters {
98    extern_methods!(
99        #[unsafe(method(init))]
100        #[unsafe(method_family = init)]
101        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
102
103        /// Set the innerAngle and outerAngle of the Cone Directivity Model Subband
104        ///
105        /// Parameter `innerAngle`: The inner angle of the cone directivity model, must be less than or equal to outer angle.
106        ///
107        /// Parameter `outerAngle`: The outer angle of the cone directivity model, must be greater than or equal to inner angle.
108        ///
109        /// Note: The default value for each angle is 360.0. outerAngle must be >= innerAngle.
110        #[unsafe(method(setInnerAngle:outerAngle:))]
111        #[unsafe(method_family = none)]
112        pub unsafe fn setInnerAngle_outerAngle(&self, inner_angle: c_double, outer_angle: c_double);
113
114        /// The frequency of the subband, in hertz.
115        ///
116        /// Note: Default value is 1000.0.
117        #[unsafe(method(frequency))]
118        #[unsafe(method_family = none)]
119        pub unsafe fn frequency(&self) -> c_double;
120
121        /// Setter for [`frequency`][Self::frequency].
122        #[unsafe(method(setFrequency:))]
123        #[unsafe(method_family = none)]
124        pub unsafe fn setFrequency(&self, frequency: c_double);
125
126        /// The inner angle, in degrees.
127        ///
128        /// Note: Default value is 360.0.
129        #[unsafe(method(innerAngle))]
130        #[unsafe(method_family = none)]
131        pub unsafe fn innerAngle(&self) -> c_double;
132
133        /// The outer angle, in degrees.
134        ///
135        /// Note: Default value is 360.0.
136        #[unsafe(method(outerAngle))]
137        #[unsafe(method_family = none)]
138        pub unsafe fn outerAngle(&self) -> c_double;
139
140        /// The outer gain.
141        ///
142        /// Note: Values are clamped to the range [0.0, 1.0]. Default value is 1.0.
143        #[unsafe(method(outerGain))]
144        #[unsafe(method_family = none)]
145        pub unsafe fn outerGain(&self) -> c_double;
146
147        /// Setter for [`outerGain`][Self::outerGain].
148        #[unsafe(method(setOuterGain:))]
149        #[unsafe(method_family = none)]
150        pub unsafe fn setOuterGain(&self, outer_gain: c_double);
151    );
152}
153
154/// Methods declared on superclass `NSObject`.
155impl PHASEConeDirectivityModelSubbandParameters {
156    extern_methods!(
157        #[unsafe(method(new))]
158        #[unsafe(method_family = new)]
159        pub unsafe fn new() -> Retained<Self>;
160    );
161}
162
163extern_class!(
164    /// *************************************************************************************************
165    ///
166    ///
167    ///
168    /// Directivity model parameters.
169    ///
170    /// See also [Apple's documentation](https://developer.apple.com/documentation/phase/phasedirectivitymodelparameters?language=objc)
171    #[unsafe(super(NSObject))]
172    #[derive(Debug, PartialEq, Eq, Hash)]
173    pub struct PHASEDirectivityModelParameters;
174);
175
176extern_conformance!(
177    unsafe impl NSObjectProtocol for PHASEDirectivityModelParameters {}
178);
179
180impl PHASEDirectivityModelParameters {
181    extern_methods!(
182        #[unsafe(method(init))]
183        #[unsafe(method_family = init)]
184        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
185
186        #[unsafe(method(new))]
187        #[unsafe(method_family = new)]
188        pub unsafe fn new() -> Retained<Self>;
189    );
190}
191
192extern_class!(
193    /// *************************************************************************************************
194    ///
195    ///
196    ///
197    /// Cardioid directivity model parameters.
198    ///
199    /// See also [Apple's documentation](https://developer.apple.com/documentation/phase/phasecardioiddirectivitymodelparameters?language=objc)
200    #[unsafe(super(PHASEDirectivityModelParameters, NSObject))]
201    #[derive(Debug, PartialEq, Eq, Hash)]
202    pub struct PHASECardioidDirectivityModelParameters;
203);
204
205extern_conformance!(
206    unsafe impl NSObjectProtocol for PHASECardioidDirectivityModelParameters {}
207);
208
209impl PHASECardioidDirectivityModelParameters {
210    extern_methods!(
211        #[unsafe(method(initWithSubbandParameters:))]
212        #[unsafe(method_family = init)]
213        pub unsafe fn initWithSubbandParameters(
214            this: Allocated<Self>,
215            subband_parameters: &NSArray<PHASECardioidDirectivityModelSubbandParameters>,
216        ) -> Retained<Self>;
217
218        /// An array of subband parameters.
219        #[unsafe(method(subbandParameters))]
220        #[unsafe(method_family = none)]
221        pub unsafe fn subbandParameters(
222            &self,
223        ) -> Retained<NSArray<PHASECardioidDirectivityModelSubbandParameters>>;
224    );
225}
226
227/// Methods declared on superclass `PHASEDirectivityModelParameters`.
228impl PHASECardioidDirectivityModelParameters {
229    extern_methods!(
230        #[unsafe(method(init))]
231        #[unsafe(method_family = init)]
232        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
233
234        #[unsafe(method(new))]
235        #[unsafe(method_family = new)]
236        pub unsafe fn new() -> Retained<Self>;
237    );
238}
239
240extern_class!(
241    /// *************************************************************************************************
242    ///
243    ///
244    ///
245    /// Cone directivity model parameters.
246    ///
247    /// See also [Apple's documentation](https://developer.apple.com/documentation/phase/phaseconedirectivitymodelparameters?language=objc)
248    #[unsafe(super(PHASEDirectivityModelParameters, NSObject))]
249    #[derive(Debug, PartialEq, Eq, Hash)]
250    pub struct PHASEConeDirectivityModelParameters;
251);
252
253extern_conformance!(
254    unsafe impl NSObjectProtocol for PHASEConeDirectivityModelParameters {}
255);
256
257impl PHASEConeDirectivityModelParameters {
258    extern_methods!(
259        #[unsafe(method(initWithSubbandParameters:))]
260        #[unsafe(method_family = init)]
261        pub unsafe fn initWithSubbandParameters(
262            this: Allocated<Self>,
263            subband_parameters: &NSArray<PHASEConeDirectivityModelSubbandParameters>,
264        ) -> Retained<Self>;
265
266        /// An array of subband parameters.
267        #[unsafe(method(subbandParameters))]
268        #[unsafe(method_family = none)]
269        pub unsafe fn subbandParameters(
270            &self,
271        ) -> Retained<NSArray<PHASEConeDirectivityModelSubbandParameters>>;
272    );
273}
274
275/// Methods declared on superclass `PHASEDirectivityModelParameters`.
276impl PHASEConeDirectivityModelParameters {
277    extern_methods!(
278        #[unsafe(method(init))]
279        #[unsafe(method_family = init)]
280        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
281
282        #[unsafe(method(new))]
283        #[unsafe(method_family = new)]
284        pub unsafe fn new() -> Retained<Self>;
285    );
286}
objc2_phase/generated/PHASEDirectivityModel.rs

objc2_phase/generated/
PHASEDirectivityModel.rs
