diff options
Diffstat (limited to 'SmartDeviceLink/SDLConfiguration.h')
-rw-r--r-- | SmartDeviceLink/SDLConfiguration.h | 57 |
1 files changed, 42 insertions, 15 deletions
diff --git a/SmartDeviceLink/SDLConfiguration.h b/SmartDeviceLink/SDLConfiguration.h index 679f16e01..52706376b 100644 --- a/SmartDeviceLink/SDLConfiguration.h +++ b/SmartDeviceLink/SDLConfiguration.h @@ -11,6 +11,7 @@ @class SDLLifecycleConfiguration; @class SDLLockScreenConfiguration; @class SDLLogConfiguration; +@class SDLStreamingMediaConfiguration; NS_ASSUME_NONNULL_BEGIN @@ -26,19 +27,41 @@ NS_ASSUME_NONNULL_BEGIN */ @property (copy, nonatomic, readonly) SDLLockScreenConfiguration *lockScreenConfig; - /** The log configuration. */ @property (copy, nonatomic, readonly) SDLLogConfiguration *loggingConfig; /** + The configuration + */ +@property (copy, nonatomic, readonly) SDLStreamingMediaConfiguration *streamingMediaConfig; + +/** + Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and a default logging configuration. + + @param lifecycleConfiguration The lifecycle configuration to be used. + @return The configuration + */ +- (instancetype)initWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfiguration __deprecated_msg(("Use initWithLifecycle:lockScreen:logging: instead")); + +/** Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and a default logging configuration. @param lifecycleConfiguration The lifecycle configuration to be used. @return The configuration */ -- (instancetype)initWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfiguration; ++ (instancetype)configurationWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfiguration __deprecated_msg(("Use configurationWithLifecycle:lockScreen:logging: instead")); + +/** + * Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and a default logging configuration. + * + * @param lifecycleConfig The lifecycle configuration to be used. + * @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil. + * + * @return The configuration + */ +- (instancetype)initWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig __deprecated_msg(("Use initWithLifecycle:lockScreen:logging: instead")); /** * Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and a default logging configuration. @@ -48,7 +71,7 @@ NS_ASSUME_NONNULL_BEGIN * * @return The configuration */ -- (instancetype)initWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig; ++ (instancetype)configurationWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig __deprecated_msg(("Use configurationWithLifecycle:lockScreen:logging: instead")); /** Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration. @@ -61,32 +84,36 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig logging:(nullable SDLLogConfiguration *)logConfig; /** - Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and a default logging configuration. + Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration. - @param lifecycleConfiguration The lifecycle configuration to be used. + @param lifecycleConfig The lifecycle configuration to be used. + @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil. + @param logConfig The logging configuration to be used, or `defaultConfiguration` if nil. @return The configuration */ -+ (instancetype)configurationWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfiguration; ++ (instancetype)configurationWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig logging:(nullable SDLLogConfiguration *)logConfig; /** - * Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and a default logging configuration. - * - * @param lifecycleConfig The lifecycle configuration to be used. - * @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil. - * - * @return The configuration + Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration. + + @param lifecycleConfig The lifecycle configuration to be used. + @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil. + @param logConfig The logging configuration to be used, or `defaultConfiguration` if nil. + @param streamingMediaConfig The streaming media configuration to be used, or nil because it is not needed. + @return The configuration */ -+ (instancetype)configurationWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig; +- (instancetype)initWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig logging:(nullable SDLLogConfiguration *)logConfig streamingMedia:(nullable SDLStreamingMediaConfiguration *)streamingMediaConfig; /** - Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration. + Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration. @param lifecycleConfig The lifecycle configuration to be used. @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil. @param logConfig The logging configuration to be used, or `defaultConfiguration` if nil. + @param streamingMediaConfig The streaming media configuration to be used, or nil because it is not needed. @return The configuration */ -+ (instancetype)configurationWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig logging:(nullable SDLLogConfiguration *)logConfig; ++ (instancetype)configurationWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig logging:(nullable SDLLogConfiguration *)logConfig streamingMedia:(nullable SDLStreamingMediaConfiguration *)streamingMediaConfig; @end |