objc2_av_foundation/generated/AVVideoSettings.rs
1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use objc2_foundation::*;
4
5use crate::*;
6
7extern "C" {
8 /// AVVideoSettings
9 ///
10 /// NSDictionary keys for configuring output video format
11 ///
12 ///
13 /// A video settings dictionary may take one of two forms:
14 ///
15 /// 1. For compressed video output, use only the keys in this header, AVVideoSettings.h.
16 /// 2. For uncompressed video output, start with kCVPixelBuffer* keys in
17 /// <CoreVideo
18 /// /CVPixelBuffer.h>.
19 ///
20 /// In addition to the keys in CVPixelBuffer.h, uncompressed video settings dictionaries may also contain the following keys:
21 ///
22 /// AVVideoPixelAspectRatioKey
23 /// AVVideoCleanApertureKey
24 /// AVVideoScalingModeKey
25 /// AVVideoColorPropertiesKey
26 /// AVVideoAllowWideColorKey
27 ///
28 /// It is an error to add any other AVVideoSettings.h keys to an uncompressed video settings dictionary.
29 ///
30 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodeckey?language=objc)
31 pub static AVVideoCodecKey: Option<&'static NSString>;
32}
33
34/// The type of the strings used to specify a video codec type (for instance, as values for the AVVideoCodecKey key in a video settings dictionary).
35///
36/// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodectype?language=objc)
37// NS_TYPED_ENUM
38pub type AVVideoCodecType = NSString;
39
40extern "C" {
41 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodectypehevc?language=objc)
42 pub static AVVideoCodecTypeHEVC: Option<&'static AVVideoCodecType>;
43}
44
45extern "C" {
46 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodectypeh264?language=objc)
47 pub static AVVideoCodecTypeH264: Option<&'static AVVideoCodecType>;
48}
49
50extern "C" {
51 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodectypejpeg?language=objc)
52 pub static AVVideoCodecTypeJPEG: Option<&'static AVVideoCodecType>;
53}
54
55extern "C" {
56 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodectypejpegxl?language=objc)
57 pub static AVVideoCodecTypeJPEGXL: Option<&'static AVVideoCodecType>;
58}
59
60extern "C" {
61 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodectypeappleprores4444?language=objc)
62 pub static AVVideoCodecTypeAppleProRes4444: Option<&'static AVVideoCodecType>;
63}
64
65extern "C" {
66 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodectypeappleprores4444xq?language=objc)
67 pub static AVVideoCodecTypeAppleProRes4444XQ: Option<&'static AVVideoCodecType>;
68}
69
70extern "C" {
71 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodectypeappleprores422?language=objc)
72 pub static AVVideoCodecTypeAppleProRes422: Option<&'static AVVideoCodecType>;
73}
74
75extern "C" {
76 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodectypeappleprores422hq?language=objc)
77 pub static AVVideoCodecTypeAppleProRes422HQ: Option<&'static AVVideoCodecType>;
78}
79
80extern "C" {
81 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodectypeappleprores422lt?language=objc)
82 pub static AVVideoCodecTypeAppleProRes422LT: Option<&'static AVVideoCodecType>;
83}
84
85extern "C" {
86 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodectypeappleprores422proxy?language=objc)
87 pub static AVVideoCodecTypeAppleProRes422Proxy: Option<&'static AVVideoCodecType>;
88}
89
90extern "C" {
91 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodectypeappleproresraw?language=objc)
92 pub static AVVideoCodecTypeAppleProResRAW: Option<&'static AVVideoCodecType>;
93}
94
95extern "C" {
96 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodectypeappleproresrawhq?language=objc)
97 pub static AVVideoCodecTypeAppleProResRAWHQ: Option<&'static AVVideoCodecType>;
98}
99
100extern "C" {
101 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodectypehevcwithalpha?language=objc)
102 pub static AVVideoCodecTypeHEVCWithAlpha: Option<&'static AVVideoCodecType>;
103}
104
105extern "C" {
106 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodechevc?language=objc)
107 #[deprecated]
108 pub static AVVideoCodecHEVC: Option<&'static NSString>;
109}
110
111extern "C" {
112 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodech264?language=objc)
113 #[deprecated]
114 pub static AVVideoCodecH264: Option<&'static NSString>;
115}
116
117extern "C" {
118 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodecjpeg?language=objc)
119 #[deprecated]
120 pub static AVVideoCodecJPEG: Option<&'static NSString>;
121}
122
123extern "C" {
124 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodecappleprores4444?language=objc)
125 #[deprecated]
126 pub static AVVideoCodecAppleProRes4444: Option<&'static NSString>;
127}
128
129extern "C" {
130 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocodecappleprores422?language=objc)
131 #[deprecated]
132 pub static AVVideoCodecAppleProRes422: Option<&'static NSString>;
133}
134
135extern "C" {
136 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideowidthkey?language=objc)
137 pub static AVVideoWidthKey: Option<&'static NSString>;
138}
139
140extern "C" {
141 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoheightkey?language=objc)
142 pub static AVVideoHeightKey: Option<&'static NSString>;
143}
144
145extern "C" {
146 /// The aspect ratio of the pixels in the video frame
147 ///
148 /// The value for this key is an NSDictionary containing AVVideoPixelAspectRatio*Key keys. If no value is specified for this key, the default value for the codec is used. Usually this is 1:1, meaning square pixels.
149 ///
150 /// Note that prior to macOS 10.9 and iOS 7.0, this key could only be specified as part of the dictionary given for AVVideoCompressionPropertiesKey. As of macOS 10.9 and iOS 7.0, the top level of an AVVideoSettings dictionary is the preferred place to specify this key.
151 ///
152 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideopixelaspectratiokey?language=objc)
153 pub static AVVideoPixelAspectRatioKey: Option<&'static NSString>;
154}
155
156extern "C" {
157 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideopixelaspectratiohorizontalspacingkey?language=objc)
158 pub static AVVideoPixelAspectRatioHorizontalSpacingKey: Option<&'static NSString>;
159}
160
161extern "C" {
162 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideopixelaspectratioverticalspacingkey?language=objc)
163 pub static AVVideoPixelAspectRatioVerticalSpacingKey: Option<&'static NSString>;
164}
165
166extern "C" {
167 /// Defines the region within the video dimensions that will be displayed during playback
168 ///
169 /// The value for this key is an NSDictionary containing AVVideoCleanAperture*Key keys. AVVideoCleanApertureWidthKey and AVVideoCleanApertureHeightKey define a clean rectangle which is centered on the video frame. To offset this rectangle from center, use AVVideoCleanApertureHorizontalOffsetKey and AVVideoCleanApertureVerticalOffsetKey. A positive value for AVVideoCleanApertureHorizontalOffsetKey moves the clean aperture region to the right, and a positive value for AVVideoCleanApertureVerticalOffsetKey moves the clean aperture region down.
170 ///
171 /// If no clean aperture region is specified, the entire frame will be displayed during playback.
172 ///
173 /// Note that prior to macOS 10.9 and iOS 7.0, this key could only be specified as part of the dictionary given for AVVideoCompressionPropertiesKey. As of macOS 10.9 and iOS 7.0, the top level of an AVVideoSettings dictionary is the preferred place to specify this key.
174 ///
175 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocleanaperturekey?language=objc)
176 pub static AVVideoCleanApertureKey: Option<&'static NSString>;
177}
178
179extern "C" {
180 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocleanaperturewidthkey?language=objc)
181 pub static AVVideoCleanApertureWidthKey: Option<&'static NSString>;
182}
183
184extern "C" {
185 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocleanapertureheightkey?language=objc)
186 pub static AVVideoCleanApertureHeightKey: Option<&'static NSString>;
187}
188
189extern "C" {
190 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocleanaperturehorizontaloffsetkey?language=objc)
191 pub static AVVideoCleanApertureHorizontalOffsetKey: Option<&'static NSString>;
192}
193
194extern "C" {
195 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocleanapertureverticaloffsetkey?language=objc)
196 pub static AVVideoCleanApertureVerticalOffsetKey: Option<&'static NSString>;
197}
198
199extern "C" {
200 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoscalingmodekey?language=objc)
201 pub static AVVideoScalingModeKey: Option<&'static NSString>;
202}
203
204extern "C" {
205 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoscalingmodefit?language=objc)
206 pub static AVVideoScalingModeFit: Option<&'static NSString>;
207}
208
209extern "C" {
210 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoscalingmoderesize?language=objc)
211 pub static AVVideoScalingModeResize: Option<&'static NSString>;
212}
213
214extern "C" {
215 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoscalingmoderesizeaspect?language=objc)
216 pub static AVVideoScalingModeResizeAspect: Option<&'static NSString>;
217}
218
219extern "C" {
220 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoscalingmoderesizeaspectfill?language=objc)
221 pub static AVVideoScalingModeResizeAspectFill: Option<&'static NSString>;
222}
223
224extern "C" {
225 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocolorpropertieskey?language=objc)
226 pub static AVVideoColorPropertiesKey: Option<&'static NSString>;
227}
228
229extern "C" {
230 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocolorprimarieskey?language=objc)
231 pub static AVVideoColorPrimariesKey: Option<&'static NSString>;
232}
233
234extern "C" {
235 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocolorprimaries_itu_r_709_2?language=objc)
236 pub static AVVideoColorPrimaries_ITU_R_709_2: Option<&'static NSString>;
237}
238
239extern "C" {
240 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocolorprimaries_ebu_3213?language=objc)
241 pub static AVVideoColorPrimaries_EBU_3213: Option<&'static NSString>;
242}
243
244extern "C" {
245 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocolorprimaries_smpte_c?language=objc)
246 pub static AVVideoColorPrimaries_SMPTE_C: Option<&'static NSString>;
247}
248
249extern "C" {
250 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocolorprimaries_p3_d65?language=objc)
251 pub static AVVideoColorPrimaries_P3_D65: Option<&'static NSString>;
252}
253
254extern "C" {
255 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocolorprimaries_itu_r_2020?language=objc)
256 pub static AVVideoColorPrimaries_ITU_R_2020: Option<&'static NSString>;
257}
258
259extern "C" {
260 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideotransferfunctionkey?language=objc)
261 pub static AVVideoTransferFunctionKey: Option<&'static NSString>;
262}
263
264extern "C" {
265 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideotransferfunction_itu_r_709_2?language=objc)
266 pub static AVVideoTransferFunction_ITU_R_709_2: Option<&'static NSString>;
267}
268
269extern "C" {
270 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideotransferfunction_smpte_240m_1995?language=objc)
271 pub static AVVideoTransferFunction_SMPTE_240M_1995: Option<&'static NSString>;
272}
273
274extern "C" {
275 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideotransferfunction_smpte_st_2084_pq?language=objc)
276 pub static AVVideoTransferFunction_SMPTE_ST_2084_PQ: Option<&'static NSString>;
277}
278
279extern "C" {
280 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideotransferfunction_itu_r_2100_hlg?language=objc)
281 pub static AVVideoTransferFunction_ITU_R_2100_HLG: Option<&'static NSString>;
282}
283
284extern "C" {
285 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideotransferfunction_linear?language=objc)
286 pub static AVVideoTransferFunction_Linear: Option<&'static NSString>;
287}
288
289extern "C" {
290 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideotransferfunction_iec_srgb?language=objc)
291 pub static AVVideoTransferFunction_IEC_sRGB: Option<&'static NSString>;
292}
293
294extern "C" {
295 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoycbcrmatrixkey?language=objc)
296 pub static AVVideoYCbCrMatrixKey: Option<&'static NSString>;
297}
298
299extern "C" {
300 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoycbcrmatrix_itu_r_709_2?language=objc)
301 pub static AVVideoYCbCrMatrix_ITU_R_709_2: Option<&'static NSString>;
302}
303
304extern "C" {
305 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoycbcrmatrix_itu_r_601_4?language=objc)
306 pub static AVVideoYCbCrMatrix_ITU_R_601_4: Option<&'static NSString>;
307}
308
309extern "C" {
310 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoycbcrmatrix_smpte_240m_1995?language=objc)
311 pub static AVVideoYCbCrMatrix_SMPTE_240M_1995: Option<&'static NSString>;
312}
313
314extern "C" {
315 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoycbcrmatrix_itu_r_2020?language=objc)
316 pub static AVVideoYCbCrMatrix_ITU_R_2020: Option<&'static NSString>;
317}
318
319extern "C" {
320 /// Indicates whether the client can process wide color
321 ///
322 /// Clients who wish to process wide color content should set the value of this key to
323 /// `true`, or specify AVVideoColorPropertiesKey.
324 ///
325 /// The default value,
326 /// `false`, permits implicit color conversions to occur to a non-wide gamut color space.
327 ///
328 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoallowwidecolorkey?language=objc)
329 pub static AVVideoAllowWideColorKey: Option<&'static NSString>;
330}
331
332extern "C" {
333 /// The value for this key is an instance of NSDictionary, containing properties to be passed down to the video encoder.
334 ///
335 /// Package the below keys in an instance of NSDictionary and use it as the value for AVVideoCompressionPropertiesKey in the top-level AVVideoSettings dictionary. In addition to the keys listed below, you can also include keys from VideoToolbox/VTCompressionProperties.h.
336 ///
337 /// Most keys can only be used for certain encoders. Look at individual keys for details.
338 ///
339 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideocompressionpropertieskey?language=objc)
340 pub static AVVideoCompressionPropertiesKey: Option<&'static NSString>;
341}
342
343extern "C" {
344 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoaveragebitratekey?language=objc)
345 pub static AVVideoAverageBitRateKey: Option<&'static NSString>;
346}
347
348extern "C" {
349 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoqualitykey?language=objc)
350 pub static AVVideoQualityKey: Option<&'static NSString>;
351}
352
353extern "C" {
354 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideomaxkeyframeintervalkey?language=objc)
355 pub static AVVideoMaxKeyFrameIntervalKey: Option<&'static NSString>;
356}
357
358extern "C" {
359 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideomaxkeyframeintervaldurationkey?language=objc)
360 pub static AVVideoMaxKeyFrameIntervalDurationKey: Option<&'static NSString>;
361}
362
363extern "C" {
364 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoappleprorawbitdepthkey?language=objc)
365 pub static AVVideoAppleProRAWBitDepthKey: Option<&'static NSString>;
366}
367
368extern "C" {
369 /// Enables or disables frame reordering.
370 ///
371 /// In order to achieve the best compression while maintaining image quality, some video encoders can reorder frames. This means that the order in which the frames will be emitted and stored (the decode order) will be different from the order in which they are presented to the video encoder (the display order).
372 ///
373 /// Encoding using frame reordering requires more system resources than encoding without frame reordering, so encoding performance should be taken into account when deciding whether to enable frame reordering. This is especially important when encoding video data from a real-time source, such as AVCaptureVideoDataOutput. In this situation, using a value of
374 /// `false`for AVVideoAllowFrameReorderingKey may yield the best results.
375 ///
376 /// The default is
377 /// `true`, which means that the encoder decides whether to enable frame reordering.
378 ///
379 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoallowframereorderingkey?language=objc)
380 pub static AVVideoAllowFrameReorderingKey: Option<&'static NSString>;
381}
382
383extern "C" {
384 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoprofilelevelkey?language=objc)
385 pub static AVVideoProfileLevelKey: Option<&'static NSString>;
386}
387
388extern "C" {
389 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoprofilelevelh264baseline30?language=objc)
390 pub static AVVideoProfileLevelH264Baseline30: Option<&'static NSString>;
391}
392
393extern "C" {
394 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoprofilelevelh264baseline31?language=objc)
395 pub static AVVideoProfileLevelH264Baseline31: Option<&'static NSString>;
396}
397
398extern "C" {
399 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoprofilelevelh264baseline41?language=objc)
400 pub static AVVideoProfileLevelH264Baseline41: Option<&'static NSString>;
401}
402
403extern "C" {
404 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoprofilelevelh264baselineautolevel?language=objc)
405 pub static AVVideoProfileLevelH264BaselineAutoLevel: Option<&'static NSString>;
406}
407
408extern "C" {
409 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoprofilelevelh264main30?language=objc)
410 pub static AVVideoProfileLevelH264Main30: Option<&'static NSString>;
411}
412
413extern "C" {
414 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoprofilelevelh264main31?language=objc)
415 pub static AVVideoProfileLevelH264Main31: Option<&'static NSString>;
416}
417
418extern "C" {
419 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoprofilelevelh264main32?language=objc)
420 pub static AVVideoProfileLevelH264Main32: Option<&'static NSString>;
421}
422
423extern "C" {
424 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoprofilelevelh264main41?language=objc)
425 pub static AVVideoProfileLevelH264Main41: Option<&'static NSString>;
426}
427
428extern "C" {
429 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoprofilelevelh264mainautolevel?language=objc)
430 pub static AVVideoProfileLevelH264MainAutoLevel: Option<&'static NSString>;
431}
432
433extern "C" {
434 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoprofilelevelh264high40?language=objc)
435 pub static AVVideoProfileLevelH264High40: Option<&'static NSString>;
436}
437
438extern "C" {
439 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoprofilelevelh264high41?language=objc)
440 pub static AVVideoProfileLevelH264High41: Option<&'static NSString>;
441}
442
443extern "C" {
444 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoprofilelevelh264highautolevel?language=objc)
445 pub static AVVideoProfileLevelH264HighAutoLevel: Option<&'static NSString>;
446}
447
448extern "C" {
449 /// The entropy encoding mode for H.264 compression.
450 ///
451 /// If supported by an H.264 encoder, this property controls whether the encoder should use Context-based Adaptive Variable Length Coding (CAVLC) or Context-based Adaptive Binary Arithmetic Coding (CABAC). CABAC generally gives better compression at the expense of higher computational overhead. The default value is encoder-specific and may change depending on other encoder settings. Care should be taken when using this property -- changes may result in a configuration which is not compatible with a requested Profile and Level. Results in this case are undefined, and could include encode errors or a non-compliant output stream.
452 ///
453 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoh264entropymodekey?language=objc)
454 pub static AVVideoH264EntropyModeKey: Option<&'static NSString>;
455}
456
457extern "C" {
458 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoh264entropymodecavlc?language=objc)
459 pub static AVVideoH264EntropyModeCAVLC: Option<&'static NSString>;
460}
461
462extern "C" {
463 /// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoh264entropymodecabac?language=objc)
464 pub static AVVideoH264EntropyModeCABAC: Option<&'static NSString>;
465}
466
467extern "C" {
468 /// Indicates the expected source frame rate, if known.
469 ///
470 /// The frame rate is measured in frames per second. This is not used to control the frame rate; it is provided as a hint to the video encoder so that it can set up internal configuration before compression begins. The actual frame rate will depend on frame durations and may vary. This should be set if an AutoLevel AVVideoProfileLevelKey is used, or if the source content has a high frame rate (higher than 30 fps). The encoder might have to drop frames to satisfy bit stream requirements if this key is not specified.
471 ///
472 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoexpectedsourceframeratekey?language=objc)
473 pub static AVVideoExpectedSourceFrameRateKey: Option<&'static NSString>;
474}
475
476extern "C" {
477 /// The desired average number of non-droppable frames to be encoded for each second of video.
478 ///
479 /// Some video encoders can produce a flexible mixture of non-droppable frames and droppable frames. The difference between these types is that it is necessary for a video decoder to decode a non-droppable frame in order to successfully decode subsequent frames, whereas droppable frames are optional and can be skipped without impact on decode of subsequent frames. Having a proportion of droppable frames in a sequence has advantages for temporal scalability: at playback time more or fewer frames may be decoded depending on the play rate. This property requests that the encoder emit an overall proportion of non-droppable and droppable frames so that there are the specified number of non-droppable frames per second.
480 ///
481 /// For example, to specify that the encoder should include an average of 30 non-droppable frames for each second of video:
482 ///
483 /// [myVideoSettings setObject:
484 /// @
485 /// 30 forKey:AVVideoAverageNonDroppableFrameRateKey];
486 ///
487 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoaveragenondroppableframeratekey?language=objc)
488 pub static AVVideoAverageNonDroppableFrameRateKey: Option<&'static NSString>;
489}
490
491extern "C" {
492 /// The value for this key is an instance of NSDictionary, containing properties to be passed down to the video decoder.
493 ///
494 /// Package the below keys in an instance of NSDictionary and use it as the value for AVVideoDecompressionPropertiesKey in the top-level AVVideoSettings dictionary. In addition to the keys listed below, you can also include keys from VideoToolbox/VTDecompressionProperties.h.
495 ///
496 /// Most keys can only be used for certain decoders. Look at individual keys for details.
497 ///
498 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideodecompressionpropertieskey?language=objc)
499 pub static AVVideoDecompressionPropertiesKey: Option<&'static NSString>;
500}
501
502extern "C" {
503 /// The video encoder specification includes options for choosing a specific video encoder.
504 ///
505 ///
506 /// The value for this key is a dictionary containing kVTVideoEncoderSpecification_* keys specified in the VideoToolbox framework. This key should be specified at the top level of an AVVideoSettings dictionary.
507 ///
508 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoencoderspecificationkey?language=objc)
509 pub static AVVideoEncoderSpecificationKey: Option<&'static NSString>;
510}
511
512/// [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoaperturemode?language=objc)
513// NS_TYPED_ENUM
514pub type AVVideoApertureMode = NSString;
515
516extern "C" {
517 /// Both pixel aspect ratio and clean aperture will be applied.
518 ///
519 /// An image's clean aperture is a region of video free from transition artifacts caused by the encoding of the signal.
520 ///
521 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoaperturemodecleanaperture?language=objc)
522 pub static AVVideoApertureModeCleanAperture: Option<&'static AVVideoApertureMode>;
523}
524
525extern "C" {
526 /// Only pixel aspect ratio will be applied.
527 ///
528 /// The image is not cropped to the clean aperture region, but it is scaled according to the pixel aspect ratio. Use this option when you want to see all the pixels in your video, including the edges.
529 ///
530 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoaperturemodeproductionaperture?language=objc)
531 pub static AVVideoApertureModeProductionAperture: Option<&'static AVVideoApertureMode>;
532}
533
534extern "C" {
535 /// Neither pixel aspect ratio nor clean aperture will be applied.
536 ///
537 /// The image is not cropped to the clean aperture region and is not scaled according to the pixel aspect ratio. The encoded dimensions of the image description are displayed.
538 ///
539 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avvideoaperturemodeencodedpixels?language=objc)
540 pub static AVVideoApertureModeEncodedPixels: Option<&'static AVVideoApertureMode>;
541}