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

SDLAudioControlCapabilities Class Reference

Section Contents

Overview

Undocumented

-initWithModuleName:

Constructs a newly allocated SDLAudioControlCapabilities object with audio control module name (max 100 chars)

Objective-C

- (nonnull instancetype)initWithModuleName:(nonnull NSString *)name;

Swift

init(moduleName name: String)

Parameters

name

The short friendly name of the audio control module.

Return Value

An instance of the SDLAudioControlCapabilities class.

-initWithModuleName:sourceAvailable:keepContextAvailable:volumeAvailable:equalizerAvailable:equalizerMaxChannelID:

Constructs a newly allocated SDLAudioControlCapabilities object with given parameters

Objective-C

- (nonnull instancetype)
   initWithModuleName:(nonnull NSString *)name
      sourceAvailable:(nullable NSNumber<SDLBool> *)sourceAvailable
 keepContextAvailable:(nullable NSNumber<SDLBool> *)keepContextAvailable
      volumeAvailable:(nullable NSNumber<SDLBool> *)volumeAvailable
   equalizerAvailable:(nullable NSNumber<SDLBool> *)equalizerAvailable
equalizerMaxChannelID:(nullable NSNumber<SDLInt> *)equalizerMaxChannelID;

Swift

init(moduleName name: String, sourceAvailable: (NSNumber & SDLBool)?, keepContextAvailable: (NSNumber & SDLBool)?, volumeAvailable: (NSNumber & SDLBool)?, equalizerAvailable: (NSNumber & SDLBool)?, equalizerMaxChannelID: (NSNumber & SDLInt)?)

Parameters

name

The short friendly name of the audio control module.

sourceAvailable

Availability of the control of audio source.

volumeAvailable

Availability of the volume of audio source.

equalizerAvailable

Availability of the equalizer of audio source.

equalizerMaxChannelID

Equalizer channel ID (between 1-100).

Return Value

An instance of the SDLAudioControlCapabilities class.

moduleName

@abstract The short friendly name of the audio control module. It should not be used to identify a module by mobile application.

Required, Max String length 100 chars

Objective-C

@property (readwrite, strong, nonatomic) NSString *_Nonnull moduleName;

Swift

var moduleName: String { get set }

sourceAvailable

@abstract Availability of the control of audio source.

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *sourceAvailable;

Swift

var sourceAvailable: (NSNumber & SDLBool)? { get set }

keepContextAvailable

Availability of the keepContext parameter.

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *keepContextAvailable;

Swift

var keepContextAvailable: (NSNumber & SDLBool)? { get set }

volumeAvailable

@abstract Availability of the control of audio volume.

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *volumeAvailable;

Swift

var volumeAvailable: (NSNumber & SDLBool)? { get set }

equalizerAvailable

@abstract Availability of the control of Equalizer Settings.

Optional, Boolean

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLBool> *equalizerAvailable;

Swift

var equalizerAvailable: (NSNumber & SDLBool)? { get set }

equalizerMaxChannelId

@abstract Must be included if equalizerAvailable=true, and assume all IDs starting from 1 to this value are valid

Optional, Integer 1 - 100

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSNumber<SDLInt> *equalizerMaxChannelId;

Swift

var equalizerMaxChannelId: (NSNumber & SDLInt)? { get set }
View on GitHub.com
Previous Section Next Section