summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLImageField.h
blob: 610b1a55cc29661dabf096a6f36bfb2b9c62b77c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
//  SDLImageField.h
//

#import "SDLRPCMessage.h"

#import "SDLFileType.h"
#import "SDLImageFieldName.h"

@class SDLImageResolution;

NS_ASSUME_NONNULL_BEGIN

/**
 A struct used in DisplayCapabilities describing the capability of an image field
 */
@interface SDLImageField : SDLRPCStruct

/**
 The name that identifies the field.

 Required
 */
@property (strong, nonatomic) SDLImageFieldName name;

/**
 The image types that are supported in this field.

 Required
 */
@property (strong, nonatomic) NSArray<SDLFileType> *imageTypeSupported;

/**
 The image resolution of this field

 Optional
 */
@property (nullable, strong, nonatomic) SDLImageResolution *imageResolution;

/// Convenience initalizer for the ImageField RPC struct
/// @param name The name identifying this image field
/// @param imageTypeSupported The image data types this field supports
/// @param imageResolution The native resolution of this image field
- (instancetype)initWithName:(SDLImageFieldName)name imageTypeSupported:(NSArray<SDLFileType> *)imageTypeSupported imageResolution:(nullable SDLImageResolution *)imageResolution;

@end

NS_ASSUME_NONNULL_END