objc2_av_foundation/generated/AVCaptionSettings.rs
1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use objc2_foundation::*;
4
5use crate::*;
6
7/// Keys for the captions settings dictionary.
8///
9/// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avcaptionsettingskey?language=objc)
10// NS_TYPED_ENUM
11pub type AVCaptionSettingsKey = NSString;
12
13extern "C" {
14 /// Indicates the output media type of a caption conversion operation. For example, AVMediaTypeClosedCaption.
15 ///
16 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avcaptionmediatypekey?language=objc)
17 pub static AVCaptionMediaTypeKey: Option<&'static AVCaptionSettingsKey>;
18}
19
20extern "C" {
21 /// Indicates the output media subtype of a caption conversion operation. For example, [NSNumber numberWithInt:kCMClosedCaptionFormatType_CEA608].
22 ///
23 /// Both numeric and string forms of media subtypes are accepted for caption conversions, so you could, for example, use
24 /// "
25 /// c608" instead of [NSNumber numberWithInt:kCMClosedCaptionFormatType_CEA608].
26 ///
27 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avcaptionmediasubtypekey?language=objc)
28 pub static AVCaptionMediaSubTypeKey: Option<&'static AVCaptionSettingsKey>;
29}
30
31extern "C" {
32 /// Frame duration used for the time code.
33 ///
34 /// Some formats, such as TTML, use time code notation to indicate the timing of a caption. Use the property to specify the frame rate of the time code.
35 ///
36 /// For example, if the time code steps for every 1001 / 30000 seconds, the value should be CMTime(value: 1001, scale: 30000).
37 ///
38 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avcaptiontimecodeframedurationkey?language=objc)
39 pub static AVCaptionTimeCodeFrameDurationKey: Option<&'static AVCaptionSettingsKey>;
40}
41
42extern "C" {
43 /// Indicates whether to use drop frame time code.
44 ///
45 /// Some formats, such as SCC, use time code notation to indicate the timing of a caption. Use the property to specify whether to use the drop frame time code or non-drop frame time code.
46 /// When the value for this key is a NSNumber indicating the BOOL YES, the receiver will use the drop frame time code.
47 /// When the value for this key is a NSNumber indicating the BOOL NO, the receiver will use the non-drop frame time code.
48 /// The default is NO.
49 ///
50 /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avcaptionusedropframetimecodekey?language=objc)
51 pub static AVCaptionUseDropFrameTimeCodeKey: Option<&'static AVCaptionSettingsKey>;
52}