SDLOnButtonPress Class Reference

Section Contents

• buttonName
• buttonPressMode
• customButtonID

Overview

Notifies application of button press events for buttons to which the application is subscribed. SDL supports two button press events defined as follows:

SHORT - Occurs when a button is depressed, then released within two seconds. The event is considered to occur immediately after the button is released.

LONG - Occurs when a button is depressed and held for two seconds or more. The event is considered to occur immediately after the two second threshold has been crossed, before the button is released.

HMI Status Requirements:

HMILevel:

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

The application will receive OnButtonPress 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 OnButtonPress notification when HMILevel is BACKGROUND or NONE.

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) SDLButtonPressMode _Nonnull buttonPressMode;

var buttonPressMode: SDLButtonPressMode { get set }

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

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