Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

SDLDisplayCapability Class Reference

Section Contents

Overview

Contain the display related information and all windows related to that display.

@since SDL 6.0

-initWithDisplayName:

Init with required properties

Objective-C

- (nonnull instancetype)initWithDisplayName:(nonnull NSString *)displayName;

Swift

init(displayName: String)

Parameters

displayName

Name of the display.

-initWithDisplayName:windowTypeSupported:windowCapabilities:

Init with all the properities

Objective-C

- (nonnull instancetype)
    initWithDisplayName:(nonnull NSString *)displayName
    windowTypeSupported:
        (nullable NSArray<SDLWindowCapability *> *)windowTypeSupported
     windowCapabilities:
         (nullable NSArray<SDLWindowTypeCapabilities *> *)windowCapabilities;

Swift

init(displayName: String, windowTypeSupported: [SDLWindowCapability]?, windowCapabilities: [SDLWindowTypeCapabilities]?)

Parameters

displayName

Name of the display.

windowTypeSupported

Informs the application how many windows the app is allowed to create per type.

windowCapabilities

Contains a list of capabilities of all windows related to the app. - see: windowCapabilities

displayName

Name of the display.

Objective-C

@property (readwrite, strong, nonatomic, nullable) NSString *displayName;

Swift

var displayName: String? { get set }

windowTypeSupported

Informs the application how many windows the app is allowed to create per type.

Min size 1 Max size 100

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSArray<SDLWindowTypeCapabilities *> *windowTypeSupported;

Swift

var windowTypeSupported: [SDLWindowTypeCapabilities]? { get set }

windowCapabilities

Contains a list of capabilities of all windows related to the app. Once the app has registered the capabilities of all windows will be provided, but GetSystemCapability still allows requesting window capabilities of all windows.

After registration, only windows with capabilities changed will be included. Following cases will cause only affected windows to be included:

  1. App creates a new window. After the window is created, a system capability notification will be sent related only to the created window.
  2. App sets a new template to the window. The new template changes window capabilties. The notification will reflect those changes to the single window.

Min size 1, Max size 1000

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSArray<SDLWindowCapability *> *windowCapabilities;

Swift

var windowCapabilities: [SDLWindowCapability]? { get set }
View on GitHub.com
Previous Section Next Section