SDLOnButtonEvent Class Reference

Section Contents

• buttonName
• buttonEventMode
• customButtonID

Overview

Notifies application that user has depressed or released a button to which the application has subscribed.

Further information about button events and button-presses can be found at SDLSubscribeButton.

HMI Status Requirements:

HMILevel:

• The application will receive SDLOnButtonEvent notifications for all subscribed buttons when HMILevel is FULL.

• The application will receive SDLOnButtonEvent notifications for subscribed media buttons when HMILevel is LIMITED.

• Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and PRESET_0-PRESET_9.

• The application will not receive SDLOnButtonEvent notification when HMILevel is BACKGROUND.

AudioStreamingState:

• Any

SystemContext:

• MAIN, VR. In MENU, only PRESET buttons.

• In VR, pressing any subscribable button will cancel VR.

@since SDL 1.0

@property (nonatomic, strong) SDLButtonName _Nonnull buttonName;

var buttonName: SDLButtonName { get set }

@property (nonatomic, strong) SDLButtonEventMode _Nonnull buttonEventMode;

var buttonEventMode: SDLButtonEventMode { get set }

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

var customButtonID: (NSNumber & SDLInt)? { get set }