GameController · IOS API REFERENCE

GCControllerHomeButtonSettingsManager

class · iOS 27.0+ · SDK 27.1

class GCControllerHomeButtonSettingsManager

Access the game controller system Home button settings. macOS, iOS, and visionOS allow the user to assign an action that launches a chosen application to a long press of the Home button (the logo button on PlayStation and Xbox controllers). The \c GCControllerHomeButtonSettingsManager class allows your application to partially inspect the user's currently configured action, and to open the system game controller settings screen where the user can modify the action. Performing operations on `GCControllerHomeButtonSettingsManager` is only permitted while a game controller is connected.

Members (5)

get · iOS 27.0+

controllerHomeButtonInAppAction

TypeScript

get controllerHomeButtonInAppAction(): { "action": GCControllerHomeButtonSettingInAppAction; "customized": GCControllerHomeButtonSettingCustomizationStatus }

Swift declaration

var controllerHomeButtonInAppAction: (action: GCControllerHomeButtonSettingsManager.InAppAction, customized: GCControllerHomeButtonSettingsManager.SettingCustomizationStatus) { get throws }

Get the current controller Home button in-app action setting.

get · iOS 27.0+

controllerHomeButtonSystemAction

TypeScript

get controllerHomeButtonSystemAction(): { "action": GCControllerHomeButtonSettingSystemAction; "customized": GCControllerHomeButtonSettingCustomizationStatus }

Swift declaration

var controllerHomeButtonSystemAction: (action: GCControllerHomeButtonSettingsManager.SystemAction, customized: GCControllerHomeButtonSettingsManager.SettingCustomizationStatus) { get throws }

Get the current controller Home button system action setting.

method · iOS 27.0+

openControllerHomeButtonSettings

TypeScript

openControllerHomeButtonSettings(activity: GCControllerHomeButtonSettingsCustomizationActivity): void

Swift declaration

func openControllerHomeButtonSettings(for activity: GCControllerHomeButtonSettingsManager.SettingsCustomizationActivity) throws

Opens the Settings app to the screen in game controller settings where the user can change the controller shortcut action. This function returns immediately after attempting to open the Settings app. - Throws: An error if the Settings app could not be opened.

get · iOS 27.0+

settingsUpdates

TypeScript

get settingsUpdates(): SDKHandle

Swift declaration

var settingsUpdates: some AsyncSequence<(), Never> { get }

The asynchronous sequence of update notifications for the Home button settings.

init · iOS 27.0+

init

TypeScript

static init(): Promise<GCControllerHomeButtonSettingsManager>

Swift declaration

@MainActor init()

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

GCControllerHomeButtonSettingsManager.init(_:)

The iOS SDK compiler rejected this binding: call to actor-isolated initializer 'init(_:)' in a synchronous nonisolated context [#ActorIsolatedCall]

All GameController types →