Applet Manager services: Difference between revisions

No edit summary
 
(122 intermediate revisions by 5 users not shown)
Line 10: Line 10:
! Cmd || Name || Notes
! Cmd || Name || Notes
|-
|-
| 100 || OpenSystemAppletProxy || Returns an [[#ISystemAppletProxy]].
| 100 || OpenSystemAppletProxyOld ([1.0.0-19.0.1] OpenSystemAppletProxy) || Returns an [[#ISystemAppletProxy]].
|-
| 110 || [20.0.0+] OpenSystemAppletProxy || Same as OpenSystemAppletProxyOld except this now takes a type-0x15 buffer containing an [[#AppletAttribute|AppletAttribute]].
|-
|-
| 200 || OpenLibraryAppletProxyOld ([1.0.0-2.3.0] OpenLibraryAppletProxy) || Returns an [[#ILibraryAppletProxy]].
| 200 || OpenLibraryAppletProxyOld ([1.0.0-2.3.0] OpenLibraryAppletProxy) || Returns an [[#ILibraryAppletProxy]].
Line 17: Line 19:
|-
|-
| 300 || OpenOverlayAppletProxy || Returns an [[#IOverlayAppletProxy]].
| 300 || OpenOverlayAppletProxy || Returns an [[#IOverlayAppletProxy]].
|-
| 310 || [S2] || Returns an [[#ICMenuProxy|ICMenuProxy]].
|-
|-
| 350 || OpenSystemApplicationProxy || Returns an [[#IApplicationProxy]].
| 350 || OpenSystemApplicationProxy || Returns an [[#IApplicationProxy]].
Line 23: Line 27:
|-
|-
| 410 || [6.0.0+] [[#GetSystemAppletControllerForDebug]] ||  
| 410 || [6.0.0+] [[#GetSystemAppletControllerForDebug]] ||  
|-
| 450 || [19.0.0+] [[#GetSystemProcessCommonFunctions]] ||
|-
| 460 || [20.0.0+] || Returns an [[#IAppletAlternativeFunctions]].
|-
| 500 || [S2] || Returns an [[#IChatProxy|IChatProxy]].
|-
|-
| 1000 || [6.0.0+] [[#GetDebugFunctions]] ||  
| 1000 || [6.0.0+] [[#GetDebugFunctions]] ||  
Line 58: Line 68:


The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, and various state checks must pass, otherwise 0 is returned with no output interface.
The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, and various state checks must pass, otherwise 0 is returned with no output interface.
== GetSystemProcessCommonFunctions ==
No input. Returns an [[#ISystemProcessCommonFunctions]].


== GetDebugFunctions ==
== GetDebugFunctions ==
Line 65: Line 78:


== ISystemAppletProxy ==
== ISystemAppletProxy ==
This is "nn::am::service::ISystemAppletProxy".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 95: Line 110:


=== IHomeMenuFunctions ===
=== IHomeMenuFunctions ===
This is "nn::am::service::IHomeMenuFunctions".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 116: Line 133:
|-
|-
| 41 || [12.0.0+] [[#IsRebootEnabled]]
| 41 || [12.0.0+] [[#IsRebootEnabled]]
|-
| 50 || [16.0.0+] [[#LaunchSystemApplet]]
|-
| 51 || [16.0.0+] [[#LaunchStarter]]
|-
| 60 || [19.0.0+]
|-
| 61 || [19.0.0+]
|-
|-
| 100 || [6.0.0+] [[#PopRequestLaunchApplicationForDebug]]
| 100 || [6.0.0+] [[#PopRequestLaunchApplicationForDebug]]
Line 156: Line 181:
==== IsRebootEnabled ====
==== IsRebootEnabled ====
No input, returns an output bool.
No input, returns an output bool.
==== LaunchSystemApplet ====
No input/output.
This wraps [[NS_Services|ns]] LaunchSystemApplet, ignoring the u64 returned by that cmd (and other functionality).
==== LaunchStarter ====
No input/output.
This is similar to [[#LaunchSystemApplet]], except this uses [[NS_Services|ns]] LaunchLibraryApplet with a ProgramId from global state.
The global state field is initialized elsewhere with the value of [[System_Settings|system-setting]] <code>am.debug!starter_id</code>, defaulting to ProgramId 0100000000001012 ([[Title_list|starter]]) if not available.


==== PopRequestLaunchApplicationForDebug ====
==== PopRequestLaunchApplicationForDebug ====
Line 172: Line 209:
The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.
The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.


Uses [[NS_Services#IApplicationManagerInterface]] cmd99.
Uses [[NS_Services|ns]] LaunchDevMenu.


This is used by [[qlaunch]]. On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.
This is used by [[qlaunch]]. On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.
Line 180: Line 217:


==== ILockAccessor ====
==== ILockAccessor ====
This is "nn::am::service::ILockAccessor".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 210: Line 249:


=== IGlobalStateController ===
=== IGlobalStateController ===
This is "nn::am::service::IGlobalStateController".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 239: Line 280:
|-
|-
| 30 || [12.0.0+] [[#OpenCradleFirmwareUpdater]]
| 30 || [12.0.0+] [[#OpenCradleFirmwareUpdater]]
|-
| 100 || [S2]
|}
|}


Line 297: Line 340:
==== OpenCradleFirmwareUpdater ====
==== OpenCradleFirmwareUpdater ====
No input, returns an [[#ICradleFirmwareUpdater]].
No input, returns an [[#ICradleFirmwareUpdater]].
==== Cmd100 ====
No input, returns an output handle.


=== ICradleFirmwareUpdater ===
=== ICradleFirmwareUpdater ===
Line 326: Line 372:


=== IApplicationCreator ===
=== IApplicationCreator ===
This is "nn::am::service::IApplicationCreator".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 358: Line 406:


==== IApplicationAccessor ====
==== IApplicationAccessor ====
This is "nn::am::service::IApplicationAccessor".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
! Cmd || Name
|-
| 0 || [[#GetAppletStateChangedEvent]]
|-
| 1 || [[#IsCompleted]]
|-
| 10 || [[#Start]]
|-
|-
| 0 || [[#GetAppletStateChangedEvent]] ||
| 20 || [[#RequestExit]]
|-
|-
| 1 || [[#IsCompleted]] ||
| 25 || [[#Terminate]]
|-
|-
| 10 || [[#Start]] ||
| 30 || [[#GetResult]]
|-
|-
| 20 || [[#RequestExit]] ||
| 101 || [[#RequestForApplicationToGetForeground]]  
|-
|-
| 25 || [[#Terminate]] ||
| 110 || [[#TerminateAllLibraryApplets]]
|-
|-
| 30 || [[#GetResult]] ||
| 111 || [[#AreAnyLibraryAppletsLeft]]  
|-
|-
| 101 || [[#RequestForApplicationToGetForeground]] ||
| 112 || [[#GetCurrentLibraryApplet]]  
|-
|-
| 110 || [[#TerminateAllLibraryApplets]] ||
| 120 || [[#GetApplicationId]]
|-
|-
| 111 || [[#AreAnyLibraryAppletsLeft]] ||
| 121 || [[#PushLaunchParameter]]  
|-
|-
| 112 || [[#GetCurrentLibraryApplet]] ||
| 122 || [[#GetApplicationControlProperty]]  
|-
|-
| 120 || [[#GetApplicationId]] ||
| 123 || [2.0.0+] [[#GetApplicationLaunchProperty]]  
|-
|-
| 121 || [[#PushLaunchParameter]] ||
| 124 || [6.0.0+] [[#GetApplicationLaunchRequestInfo]]  
|-
|-
| 122 || [[#GetApplicationControlProperty]] ||
| 130 || [6.0.0+] [[#SetUsers]]
|-
|-
| 123 || [2.0.0+] [[#GetApplicationLaunchProperty]] ||
| 131 || [6.0.0+] [[#CheckRightsEnvironmentAvailable]]
|-
|-
| 124 || [6.0.0+] [[#GetApplicationLaunchRequestInfo]] ||
| 132 || [6.0.0+] [[#GetNsRightsEnvironmentHandle]]  
|-
|-
| 130 || [6.0.0+] [[#SetUsers]] ||
| 140 || [6.0.0+] [[#GetDesirableUids]]
|-
|-
| 131 || [6.0.0+] [[#CheckRightsEnvironmentAvailable]] ||
| 150 || [6.0.0+] [[#ReportApplicationExitTimeout]]  
|-
|-
| 132 || [6.0.0+] [[#GetNsRightsEnvironmentHandle]] ||
| 160 || [8.0.0+] [[#SetApplicationAttribute]]
|-
|-
| 140 || [6.0.0+] [[#GetDesirableUids]] ||
| 170 || [8.0.0+] [[#HasSaveDataAccessPermission]]
|-
|-
| 150 || [6.0.0+] [[#ReportApplicationExitTimeout]] ||
| 180 || [9.0.0+] [[#PushToFriendInvitationStorageChannel]]
|-
|-
| 160 || [8.0.0+] [[#SetApplicationAttribute]] ||
| 190 || [9.0.0+] [[#PushToNotificationStorageChannel]]
|-
|-
| 170 || [8.0.0+] [[#HasSaveDataAccessPermission]] ||
| 200 || [10.0.0+] [[#RequestApplicationSoftReset]]
|-
|-
| 180 || [9.0.0+] [[#PushToFriendInvitationStorageChannel]] ||
| 201 || [10.0.0+] [[#RestartApplicationTimer]]
|-
|-
| 190 || [9.0.0+] [[#PushToNotificationStorageChannel]] ||
| 300 || [20.0.0+]
|-
|-
| 200 || [10.0.0+] [[#RequestApplicationSoftReset]] ||
| 301 || [20.0.0+]
|-
|-
| 201 || [10.0.0+] [[#RestartApplicationTimer]] ||
| 310 || [21.0.0+]
|}
|}


Line 500: Line 556:


===== IAppletAccessor =====
===== IAppletAccessor =====
This is "nn::am::service::IAppletAccessor".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 536: Line 594:


== IAppletCommonFunctions ==
== IAppletCommonFunctions ==
Added with [[7.0.0]].
This is "nn::am::service::IAppletCommonFunctions".
 
This was added with [7.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 573: Line 633:
|-
|-
| 81 || [14.0.0+] SetHandlingCaptureButtonLongPressedMessageEnabledForApplet
| 81 || [14.0.0+] SetHandlingCaptureButtonLongPressedMessageEnabledForApplet
|}
ReadThemeStorage/WriteThemeStorage: these commands copy data from/to a state buffer and the user specified buffer. The size of the state buffer is 0x400-bytes. The default content of the ThemeStorage prior to using the WriteThemeStorage cmd, is: <code>memset(statebuf, 0xAA, 0x400);</code>
=== ReadThemeStorage ===
Takes an input u64 '''offset''' and a type-0x22 output buffer, returns an output u64 '''actual_transfer_size'''.
=== WriteThemeStorage ===
Takes an input u64 '''offset''' and a type-0x21 input buffer, no output.
=== PushToAppletBoundChannel ===
Takes an input [[#IStorage]], no output.
This is similar to [[#PushToAppletBoundChannelForDebug]] (no DebugMode check), except the used s32 is loaded from elsewhere and must be in the range 31-32.
=== TryPopFromAppletBoundChannel ===
No input, returns an output [[#IStorage]].
This is similar to [[#TryPopFromAppletBoundChannelForDebug]] (no DebugMode check), except the used s32 is loaded from elsewhere and must be in the range 31-32.
=== GetDisplayLogicalResolution ===
No input, returns an output s32 '''width''' and s32 '''height'''.
=== SetDisplayMagnification ===
Takes an input float '''x''', float '''y''', float '''width''', and float '''height''', no output.
Sets the DisplayMagnification. This is essentially layer image crop, for everything non-Overlay.
'''x''' and '''width''' are multiplied with the same width value returned by [[#GetDisplayLogicalResolution]], so these should be in the range 0.0f-1.0f. Likewise for y and height, except these are multipled with the height value.
=== SetHomeButtonDoubleClickEnabled ===
Takes an input u8 bool, no output.
=== GetHomeButtonDoubleClickEnabled ===
No input, returns an output u8 bool.
=== IsHomeButtonShortPressedBlocked ===
No input, returns an output u8 bool.
=== IsVrModeCurtainRequired ===
No input, returns an output bool.
=== SetCpuBoostRequestPriority ===
Takes an input s32, no output.
== ILibraryAppletProxy ==
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
| 82 || [18.0.0+] SetBlockingCaptureButtonInEntireSystem
|-
| 90 || [15.0.0+] OpenNamedChannelAsParent
|-
| 91 || [15.0.0+] OpenNamedChannelAsChild
|-
| 100 || [15.0.0+] SetApplicationCoreUsageMode
|-
| 110 || [S2]
|-
| 111 || [S2]
|-
| 112 || [S2]
|-
| 113 || [S2]
|-
| 114 || [S2]
|-
| 115 || [S2]
|-
| 116 || [S2]
|-
| 117 || [S2]
|-
| 118 || [S2]
|-
| 119 || [S2]
|-
| 120 || [S2]
|-
| 121 || [S2]
|-
| 122 || [S2]
|-
| 123 || [S2]
|-
| 124 || [S2]
|-
| 130 || [S2]
|-
| 131 || [S2] [20.0.0+]
|-
| 135 || [S2] [20.0.0+]
|-
| 140 || [S2]
|-
|-
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
| 150 || [S2]
|-
|-
| 1 || GetSelfController || Returns an [[#ISelfController]].
| 160 || [18.0.0+] [[#GetNotificationReceiverService|GetNotificationReceiverService]]
|-
|-
| 2 || GetWindowController || Returns an [[#IWindowController]].
| 161 || [18.0.0+] [[#GetNotificationSenderService|GetNotificationSenderService]]
|-
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
| 170 || [S2]
|-
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
| 171 || [S2]
|-
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
| 200 || [S2]
|-
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
| 210 || [S2]
|-
|-
| 20 || OpenLibraryAppletSelfAccessor || Returns an [[#ILibraryAppletSelfAccessor]].
| 211 || [S2]
|-
|-
| 21 || [7.0.0+] GetAppletCommonFunctions || No input, returns an [[#IAppletCommonFunctions]].
| 220 || [S2]
|-
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
| 221 || [S2]
|}
 
=== ILibraryAppletSelfAccessor ===
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
| 230 || [S2]
|-
|-
| 0 || [[#PopInData]] ||
| 231 || [S2]
|-
|-
| 1 || [[#PushOutData]] ||
| 250 || [S2]
|-
|-
| 2 || [[#PopInteractiveInData]] ||
| 251 || [S2]
|-
|-
| 3 || [[#PushInteractiveOutData]] ||
| 252 || [S2]
|-
|-
| 5 || [[#GetPopInDataEvent]] ||
| 253 || [S2]
|-
|-
| 6 || [[#GetPopInteractiveInDataEvent]] ||
| 260 || [S2]
|-
|-
| 10 || [[#ExitProcessAndReturn]] ||
| 271 || [S2] [20.0.0+]
|-
|-
| 11 || [[#GetLibraryAppletInfo]] ||
| 280 || [S2] [20.0.0+]
|-
|-
| 12 || [[#GetMainAppletIdentityInfo]] ||
| 290 || [S2] [20.0.0+] RequestChatProhibition
|-
|-
| 13 || [[#CanUseApplicationCore]] ||
| 291 || [S2] [20.0.0+] RequestChatExpirationCheckSkip
|-
|-
| 14 || [[#GetCallerAppletIdentityInfo]] ||
| 300 || [17.0.0+] GetCurrentApplicationId
|-
|-
| 15 || [2.0.0+] [[#GetMainAppletApplicationControlProperty]] ||
| 310 || [19.0.0+] IsSystemAppletHomeMenu
|-
|-
| 16 || [2.0.0+] [[#GetMainAppletStorageId]] ||
| 311 || [20.0.0+]
|-
|-
| 17 || [3.0.0+] [[#GetCallerAppletIdentityInfoStack]] ||
| 320 || [19.0.0+] SetGpuTimeSliceBoost
|-
|-
| 18 || [4.0.0+] [[#GetNextReturnDestinationAppletIdentityInfo]] ||
| 321 || [19.0.0+] SetGpuTimeSliceBoostDueToApplication
|-
|-
| 19 || [4.0.0+] [[#GetDesirableKeyboardLayout]] ||
| 322 || [20.0.0+]
|-
|-
| 20 || [[#PopExtraStorage]] ||
| 330 || [19.0.0+]  
|-
|-
| 25 || [[#GetPopExtraStorageEvent]] ||
| 340 || [20.0.0+]
|-
|-
| 30 || [[#UnpopInData]] ||
| 341 || [20.0.0+]
|-
|-
| 31 || [[#UnpopExtraStorage]] ||
| 342 || [20.0.0+]
|-
|-
| 40 || [2.0.0+] [[#GetIndirectLayerProducerHandle]] ||
| 350 || [20.0.0+]
|-
|-
| 50 || [3.0.0+] [[#ReportVisibleError]] ||
| 360 || [20.0.0+]
|-
|-
| 51 || [4.0.0+] [[#ReportVisibleErrorWithErrorContext]] ||
| 370 || [22.0.0+] GetGpuErrorEventForApplet
|-
|-
| 60 || [4.0.0+] [[#GetMainAppletApplicationDesiredLanguage]] ||
| 2000 || [S2]
|-
|-
| 70 || [8.0.0+] [[#GetCurrentApplicationId]] ||
| 2010 || [S2]
|-
|-
| 80 || [6.0.0+] [[#RequestExitToSelf]] ||
| 3000 || [S2] [20.0.0+]
|-
|-
| 90 || [5.0.0+] [[#CreateApplicationAndPushAndRequestToLaunch]] ||
| 3010 || [S2] [20.0.0+]
|-
|}
| 100 || [4.0.0+] [[#CreateGameMovieTrimmer]] ||
 
|-
ReadThemeStorage/WriteThemeStorage: these commands copy data from/to a state buffer and the user specified buffer. The size of the state buffer is 0x400-bytes. The default content of the ThemeStorage prior to using the WriteThemeStorage cmd, is: <code>memset(statebuf, 0xAA, 0x400);</code>
| 101 || [5.0.0+] [[#ReserveResourceForMovieOperation]] ||
 
|-
=== ReadThemeStorage ===
| 102 || [5.0.0+] [[#UnreserveResourceForMovieOperation]] ||
Takes an input u64 '''offset''' and a type-0x22 output buffer, returns an output u64 '''actual_transfer_size'''.
|-
| 110 || [6.0.0+] [[#GetMainAppletAvailableUsers]] ||
|-
| 120 || [9.0.0+] [[#GetLaunchStorageInfoForDebug]] ||
|-
| 130 || [9.0.0+] [[#GetGpuErrorDetectedSystemEvent]] ||
|-
| 140 || [10.0.0+] [[#SetApplicationMemoryReservation]] ||
|-
| 150 || [10.0.0+] [[#ShouldSetGpuTimeSliceManually]] ||
|}


==== PopInData ====
=== WriteThemeStorage ===
No input, returns an output [[#IStorage]].
Takes an input u64 '''offset''' and a type-0x21 input buffer, no output.


==== PushOutData ====
=== PushToAppletBoundChannel ===
Takes an input [[#IStorage]], no output.
Takes an input [[#IStorage]], no output.


==== PopInteractiveInData ====
This is similar to [[#PushToAppletBoundChannelForDebug]] (no DebugMode check), except the used s32 is loaded from elsewhere and must be in the range 31-32.
 
=== TryPopFromAppletBoundChannel ===
No input, returns an output [[#IStorage]].
No input, returns an output [[#IStorage]].


==== PushInteractiveOutData ====
This is similar to [[#TryPopFromAppletBoundChannelForDebug]] (no DebugMode check), except the used s32 is loaded from elsewhere and must be in the range 31-32.
Takes an input [[#IStorage]], no output.


==== GetPopInDataEvent ====
=== GetDisplayLogicalResolution ===
No input, returns an output Event handle with autoclear=false.
No input, returns an output s32 '''width''' and s32 '''height'''.


==== GetPopInteractiveInDataEvent ====
=== SetDisplayMagnification ===
No input, returns an output Event handle with autoclear=false.
Takes an input float '''x''', float '''y''', float '''width''', and float '''height''', no output.


==== ExitProcessAndReturn ====
Sets the DisplayMagnification. This is essentially layer image crop, for everything non-Overlay.
No input/output.


Exits the LibraryApplet and returns to running the title which launched this LibraryApplet ([[qlaunch]] for example).
'''x''' and '''width''' are multiplied with the same width value returned by [[#GetDisplayLogicalResolution]], so these should be in the range 0.0f-1.0f. Likewise for y and height, except these are multipled with the height value.


On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.
=== SetHomeButtonDoubleClickEnabled ===
Takes an input u8 bool, no output.


==== GetLibraryAppletInfo ====
=== GetHomeButtonDoubleClickEnabled ===
No input, returns an output [[#LibraryAppletInfo]].
No input, returns an output u8 bool.


==== GetMainAppletIdentityInfo ====
=== IsHomeButtonShortPressedBlocked ===
No input, returns an output [[#AppletIdentityInfo]].
 
==== CanUseApplicationCore ====
No input, returns an output u8 bool.
No input, returns an output u8 bool.


==== GetCallerAppletIdentityInfo ====
=== IsVrModeCurtainRequired ===
No input, returns an output [[#AppletIdentityInfo]].
No input, returns an output bool.


==== GetMainAppletApplicationControlProperty ====
=== SetCpuBoostRequestPriority ===
No input, takes a type-0x16 output buffer.
Takes an input s32, no output.


This gets the [[NACP_Format|control.nacp]].
=== GetNotificationReceiverService ===
No input, returns an [[#IReceiverService|IReceiverService]].


==== GetMainAppletStorageId ====
=== GetNotificationSenderService ===
No input, returns an output u8 storageId.
No input, returns an [[#ISenderService|ISenderService]].


==== GetCallerAppletIdentityInfoStack ====
=== IReceiverService ===
Takes a type-0x6 output buffer containing an array of [[#AppletIdentityInfo]], and returns an output s32 total_entries.
This is "nn::am::service::IReceiverService".


==== GetNextReturnDestinationAppletIdentityInfo ====
This was added with [18.0.0+].
No input, returns an output [[#AppletIdentityInfo]].


==== GetDesirableKeyboardLayout ====
{| class="wikitable" border="1"
No input, returns an output u32.
|-
! Cmd || Name
|-
| 0 ||
|}


The output u32 is "nn::settings::KeyboardLayout".
==== Cmd0 ====
No input, returns an [[#INotificationReceiver|INotificationReceiver]].


This gets the value previously set by [[#SetDesirableKeyboardLayout]]. An error is returned if it's not set.
==== INotificationReceiver ====
This is "nn::am::service::INotificationReceiver".


==== PopExtraStorage ====
This was added with [18.0.0+].
No input, returns an output [[#IStorage]].


==== GetPopExtraStorageEvent ====
{| class="wikitable" border="1"
No input, returns an output Event handle with autoclear=false.
|-
! Cmd || Name
|-
| 0 || AddSource
|-
| 1 || RemoveSource
|-
| 2 || GetEvent
|-
| 3 || Receive
|-
| 4 || ReceiveWithTick
|}


==== UnpopInData ====
===== GetEvent =====
Takes an input [[#IStorage]], no output.
Unofficial name.


==== UnpopExtraStorage ====
No input, returns an Event handle.
Takes an input [[#IStorage]], no output.


==== GetIndirectLayerProducerHandle ====
===== ReceiveWithTick =====
No input, returns an output u64.
Unofficial name.


==== ReportVisibleError ====
=== ISenderService ===
Takes an input [[Error_Applet#ErrorCode|ErrorCode]], no output.
This is "nn::am::service::ISenderService".


==== ReportVisibleErrorWithErrorContext ====
This was added with [18.0.0+].
Takes an input [[Error_Applet#ErrorCode|ErrorCode]] and a type-0x15 input buffer containing an [[Error_Applet#ErrorContext|ErrorContext]], no output.


==== GetMainAppletApplicationDesiredLanguage ====
{| class="wikitable" border="1"
No input, returns an output [[Settings_services#LanguageCode|LanguageCode]].
|-
! Cmd || Name
|-
| 0 ||
|}


==== GetCurrentApplicationId ====
==== Cmd0 ====
No input, returns an output [[NCM_services#ApplicationId|ApplicationId]].
Takes a total of 0x18-bytes of input, returns an [[#INotificationSender|INotificationSender]].


Gets the [[NCM_services#ApplicationId|ApplicationId]] for the currently running Application. ApplicationId=0 when no Application is running.
=== INotificationSender ===
This is "nn::am::service::INotificationSender".


==== RequestExitToSelf ====
This was added with [18.0.0+].
No input/output.


Same as [[#RequestExit]] except this is for the current applet.
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Send
|-
| 1 || GetUnreceivedMessageCount
|}


==== CreateApplicationAndPushAndRequestToLaunch ====
== ILibraryAppletProxy ==
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and an input #IStorage, no output.
This is "nn::am::service::ILibraryAppletProxy".


This is is similar to [[#CreateApplicationAndPushAndRequestToStart]].
{| class="wikitable" border="1"
 
==== CreateGameMovieTrimmer ====
Takes an input u64 size and a TransferMemory handle, returns a GRC [[GRC_services#IGameMovieTrimmer|IGameMovieTrimmer]].
 
This is a wrapper for GRC [[GRC_services#OpenGameMovieTrimmer|OpenGameMovieTrimmer]].
 
Official sw uses an user-buffer for the tmem, with permissions=0.
 
==== ReserveResourceForMovieOperation ====
No input/output.
 
Updates state fields. This must be used before [[#CreateGameMovieTrimmer]].
 
==== UnreserveResourceForMovieOperation ====
No input/output.
 
Updates state fields. This must be used once finished with [[GRC_services#IGameMovieTrimmer|IGameMovieTrimmer]].
 
==== GetMainAppletAvailableUsers ====
Takes a type-0x6 output buffer containing an array of u128 userIDs, returns an output u8 bool and a s32 '''total_entries'''.
 
This gets the userIDs previously set by [[#SetUsers]].
 
The size of the output buffer in entries must be at least 8.
 
Normally the output bool is set to 0, however when no users are available it's set to 1 with '''total_entries''' = -1.
 
==== SetApplicationMemoryReservation ====
Takes an input u64, no output.
 
An Application must be currently running. The input u64 must be 0x1000-byte aligned.
 
==== ShouldSetGpuTimeSliceManually ====
No input, returns an output u8 bool.
 
== IOverlayAppletProxy ==
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
! Cmd || Name || Notes
Line 870: Line 899:
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
|-
| 20 || GetOverlayFunctions || Returns an [[#IOverlayFunctions]].
| 20 || OpenLibraryAppletSelfAccessor || Returns an [[#ILibraryAppletSelfAccessor]].
|-
|-
| 21 || [7.0.0+] GetAppletCommonFunctions || No input, returns an [[#IAppletCommonFunctions]].
| 21 || [7.0.0+] GetAppletCommonFunctions || No input, returns an [[#IAppletCommonFunctions]].
|-
| 22 || [15.0.0+] GetHomeMenuFunctions || No input, returns an [[#IHomeMenuFunctions]].
|-
| 23 || [15.0.0+] GetGlobalStateController || No input, returns an [[#IGlobalStateController]].
|-
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}
|}


=== IOverlayFunctions ===
=== ILibraryAppletSelfAccessor ===
This is "nn::am::service::ILibraryAppletSelfAccessor".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Cmd || Name || Notes
|-
| 0 || [[#PopInData]] ||
|-
| 1 || [[#PushOutData]] ||
|-
|-
| 0 || [[#BeginToWatchShortHomeButtonMessage]]
| 2 || [[#PopInteractiveInData]] ||
|-
|-
| 1 || [[#EndToWatchShortHomeButtonMessage]]
| 3 || [[#PushInteractiveOutData]] ||
|-
|-
| 2 || [[#GetApplicationIdForLogo]]
| 5 || [[#GetPopInDataEvent]] ||
|-
|-
| 3 || [[#SetGpuTimeSliceBoost]]
| 6 || [[#GetPopInteractiveInDataEvent]] ||
|-
|-
| 4 || [2.0.0+] [[#SetAutoSleepTimeAndDimmingTimeEnabled]]
| 10 || [[#ExitProcessAndReturn]] ||
|-
|-
| 5 || [2.0.0+] [[#TerminateApplicationAndSetReason]]
| 11 || [[#GetLibraryAppletInfo]] ||
|-
|-
| 6 || [3.0.0+] [[#SetScreenShotPermissionGlobally]]
| 12 || [[#GetMainAppletIdentityInfo]] ||
|-
|-
| 10 || [6.0.0+] [[#StartShutdownSequenceForOverlay]]
| 13 || [[#CanUseApplicationCore]] ||
|-
|-
| 11 || [6.0.0+] [[#StartRebootSequenceForOverlay]]
| 14 || [[#GetCallerAppletIdentityInfo]] ||
|-
|-
| 20 || [8.0.0+] [[#SetHandlingHomeButtonShortPressedEnabled]]
| 15 || [2.0.0+] [[#GetMainAppletApplicationControlProperty]] ||
|-
|-
| 21 || [14.0.0+] SetHandlingTouchScreenInputEnabled
| 16 || [2.0.0+] [[#GetMainAppletStorageId]] ||
|-
|-
| 30 || [9.0.0+] [[#SetHealthWarningShowingState]]
| 17 || [3.0.0+] [[#GetCallerAppletIdentityInfoStack]] ||
|-
|-
| 31 || [10.0.0+] [[#IsHealthWarningRequired]]
| 18 || [4.0.0+] [[#GetNextReturnDestinationAppletIdentityInfo]] ||
|-
|-
| 90 || [7.0.0+] [[#SetRequiresGpuResourceUse]]
| 19 || [4.0.0+] [[#GetDesirableKeyboardLayout]] ||
|-
|-
| 101 || [5.0.0+] [[#BeginToObserveHidInputForDevelop]]
| 20 || [[#PopExtraStorage]] ||
|}
|-
 
| 25 || [[#GetPopExtraStorageEvent]] ||
==== BeginToWatchShortHomeButtonMessage ====
|-
No input/output.
| 30 || [[#UnpopInData]] ||
|-
| 31 || [[#UnpopExtraStorage]] ||
|-
| 40 || [2.0.0+] [[#GetIndirectLayerProducerHandle]] ||
|-
| 50 || [3.0.0+] [[#ReportVisibleError]] ||
|-
| 51 || [4.0.0+] [[#ReportVisibleErrorWithErrorContext]] ||
|-
| 60 || [4.0.0+] [[#GetMainAppletApplicationDesiredLanguage]] ||
|-
| 70 || [8.0.0+] [[#GetCurrentApplicationId]] ||
|-
| 80 || [6.0.0+] [[#RequestExitToSelf]] ||
|-
| 90 || [5.0.0+] [[#CreateApplicationAndPushAndRequestToLaunch]] ||
|-
| 100 || [4.0.0+] [[#CreateGameMovieTrimmer]] ||
|-
| 101 || [5.0.0+] [[#ReserveResourceForMovieOperation]] ||
|-
| 102 || [5.0.0+] [[#UnreserveResourceForMovieOperation]] ||
|-
| 110 || [6.0.0+] [[#GetMainAppletAvailableUsers]] ||
|-
| 120 || [9.0.0+] [[#GetLaunchStorageInfoForDebug]] ||
|-
| 130 || [9.0.0+] [[#GetGpuErrorDetectedSystemEvent]] ||
|-
| 140 || [10.0.0+] [[#SetApplicationMemoryReservation]] ||
|-
| 150 || [10.0.0+] [[#ShouldSetGpuTimeSliceManually]] ||
|-
| 160 || [17.0.0+] [[#GetLibraryAppletInfoEx]] ||
|}


==== EndToWatchShortHomeButtonMessage ====
==== PopInData ====
No input/output.
No input, returns an output [[#IStorage]].


==== GetApplicationIdForLogo ====
==== PushOutData ====
No input, returns an output [[NCM_services#ApplicationId|ApplicationId]].
Takes an input [[#IStorage]], no output.


Gets the ApplicationId for displaying the logo screen during application launch.
==== PopInteractiveInData ====
No input, returns an output [[#IStorage]].


When no application is running, this returns success with ApplicationId=0.
==== PushInteractiveOutData ====
Takes an input [[#IStorage]], no output.


==== SetGpuTimeSliceBoost ====
==== GetPopInDataEvent ====
Takes an input u64, no output.
No input, returns an output Event handle with autoclear=false.


==== SetAutoSleepTimeAndDimmingTimeEnabled ====
==== GetPopInteractiveInDataEvent ====
Takes an input u8 bool, no output.
No input, returns an output Event handle with autoclear=false.


==== TerminateApplicationAndSetReason ====
==== ExitProcessAndReturn ====
Takes an input u32 Result, no output.
No input/output.


==== SetScreenShotPermissionGlobally ====
Exits the LibraryApplet and returns to running the title which launched this LibraryApplet ([[qlaunch]] for example).
Takes an input u8 bool, no output.
 
==== StartShutdownSequenceForOverlay ====
No input/output.


On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.
On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.


==== StartRebootSequenceForOverlay ====
==== GetLibraryAppletInfo ====
No input/output.
No input, returns an output [[#LibraryAppletInfo]].


On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.
==== GetMainAppletIdentityInfo ====
No input, returns an output [[#AppletIdentityInfo]].


==== SetHandlingHomeButtonShortPressedEnabled ====
==== CanUseApplicationCore ====
Takes an input u8 bool, no output.
No input, returns an output u8 bool.
 
 
==== SetHealthWarningShowingState ====
==== GetCallerAppletIdentityInfo ====
Takes an input u8 bool, no output.
No input, returns an output [[#AppletIdentityInfo]].
 
==== GetMainAppletApplicationControlProperty ====
No input, takes a type-0x16 output buffer.
 
This gets the [[NACP_Format|control.nacp]].


This writes the input bool into state, signals an Event, and returns 0.
==== GetMainAppletStorageId ====
No input, returns an output u8 storageId.


==== IsHealthWarningRequired ====
==== GetCallerAppletIdentityInfoStack ====
No input, returns an output u8 bool.
Takes a type-0x6 output buffer containing an array of [[#AppletIdentityInfo]], and returns an output s32 total_entries.


==== SetRequiresGpuResourceUse ====
==== GetNextReturnDestinationAppletIdentityInfo ====
Takes an input u8 bool, no output.
No input, returns an output [[#AppletIdentityInfo]].


Just returns 0.
==== GetDesirableKeyboardLayout ====
No input, returns an output u32.


==== BeginToObserveHidInputForDevelop ====
The output u32 is "nn::settings::KeyboardLayout".
No input/output.


Sets various state fields and signals an userspace-event.
This gets the value previously set by [[#SetDesirableKeyboardLayout]]. An error is returned if it's not set.


Enables HID input for the OverlayApplet, without disabling input for the foreground applet.
==== PopExtraStorage ====
No input, returns an output [[#IStorage]].


== IApplicationProxy ==
==== GetPopExtraStorageEvent ====
{| class="wikitable" border="1"
No input, returns an output Event handle with autoclear=false.
|-
 
! Cmd || Name || Notes
==== UnpopInData ====
|-
Takes an input [[#IStorage]], no output.
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
 
|-
==== UnpopExtraStorage ====
| 1 || GetSelfController || Returns an [[#ISelfController]].
Takes an input [[#IStorage]], no output.
|-
 
| 2 || GetWindowController || Returns an [[#IWindowController]].
==== GetIndirectLayerProducerHandle ====
|-
No input, returns an output u64.
| 3 || GetAudioController || Returns an [[#IAudioController]].
 
|-
==== ReportVisibleError ====
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
Takes an input [[Error_Applet#ErrorCode|ErrorCode]], no output.
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || GetApplicationFunctions || Returns an [[#IApplicationFunctions]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}


=== IApplicationFunctions ===
==== ReportVisibleErrorWithErrorContext ====
{| class="wikitable" border="1"
Takes an input [[Error_Applet#ErrorCode|ErrorCode]] and a type-0x15 input buffer containing an [[Error_Applet#ErrorContext|ErrorContext]], no output.
|-
 
! Cmd || Name
==== GetMainAppletApplicationDesiredLanguage ====
|-
No input, returns an output [[Settings_services#LanguageCode|LanguageCode]].
| 1 || [[#PopLaunchParameter]]
 
|-
==== GetCurrentApplicationId ====
| 10 || [[#CreateApplicationAndPushAndRequestToStart]]
No input, returns an output [[NCM_services#ApplicationId|ApplicationId]].
|-
 
| 11 || [3.0.0+] [[#CreateApplicationAndPushAndRequestToStartForQuest]]
Gets the [[NCM_services#ApplicationId|ApplicationId]] for the currently running Application. ApplicationId=0 when no Application is running.
|-
 
| 12 || [4.0.0+] [[#CreateApplicationAndRequestToStart]]
==== RequestExitToSelf ====
|-
No input/output.
| 13 || [4.0.0+] [[#CreateApplicationAndRequestToStartForQuest]]
 
|-
Same as [[#RequestExit]] except this is for the current applet.
| 14 || [7.0.0+] [[#CreateApplicationWithAttributeAndPushAndRequestToStartForQuest]]
 
|-
==== CreateApplicationAndPushAndRequestToLaunch ====
| 15 || [7.0.0+] [[#CreateApplicationWithAttributeAndRequestToStartForQuest]]
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and an input #IStorage, no output.
|-
 
| 20 || [[#EnsureSaveData]]
This is is similar to [[#CreateApplicationAndPushAndRequestToStart]].
|-
 
| 21 || [[#GetDesiredLanguage]]
==== CreateGameMovieTrimmer ====
|-
Takes an input u64 size and a TransferMemory handle, returns a GRC [[GRC_services#IGameMovieTrimmer|IGameMovieTrimmer]].
| 22 || [[#SetTerminateResult]]
 
|-
This is a wrapper for GRC [[GRC_services#OpenGameMovieTrimmer|OpenGameMovieTrimmer]].
| 23 || [[#GetDisplayVersion]]
 
|-
Official sw uses an user-buffer for the tmem, with permissions=0.
| 24 || [2.0.0+] [[#GetLaunchStorageInfoForDebug]]
 
|-
==== ReserveResourceForMovieOperation ====
| 25 || [3.0.0+] ExtendSaveData
No input/output.
|-
 
| 26 || [3.0.0+] GetSaveDataSize
Updates state fields. This must be used before [[#CreateGameMovieTrimmer]].
 
==== UnreserveResourceForMovieOperation ====
No input/output.
 
Updates state fields. This must be used once finished with [[GRC_services#IGameMovieTrimmer|IGameMovieTrimmer]].
 
==== GetMainAppletAvailableUsers ====
Takes a type-0x6 output buffer containing an array of u128 userIDs, returns an output u8 bool and a s32 '''total_entries'''.
 
This gets the userIDs previously set by [[#SetUsers]].
 
The size of the output buffer in entries must be at least 8.
 
Normally the output bool is set to 0, however when no users are available it's set to 1 with '''total_entries''' = -1.
 
==== SetApplicationMemoryReservation ====
Takes an input u64, no output.
 
An Application must be currently running. The input u64 must be 0x1000-byte aligned.
 
==== ShouldSetGpuTimeSliceManually ====
No input, returns an output u8 bool.
 
==== GetLibraryAppletInfoEx ====
No input, returns an output u64. Currently always returns 0.
 
== IOverlayAppletProxy ==
This is "nn::am::service::IOverlayAppletProxy".
 
{| class="wikitable" border="1"
|-
|-
| 27 || [5.0.0+] CreateCacheStorage
! Cmd || Name || Notes
|-
|-
| 28 || [11.0.0+] [[#GetSaveDataSizeMax]]
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
|-
|-
| 29 || [11.0.0+] [[#GetCacheStorageMax]]
| 1 || GetSelfController || Returns an [[#ISelfController]].
|-
|-
| 30 || [[#BeginBlockingHomeButtonShortAndLongPressed]]
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
|-
| 31 || [[#EndBlockingHomeButtonShortAndLongPressed]]
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
|-
| 32 || [[#BeginBlockingHomeButton]]
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
|-
| 33 || [[#EndBlockingHomeButton]]
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
|-
| 34 || [10.0.0+] [[#SelectApplicationLicense]]
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
|-
| 35 || [11.0.0+] [[#GetDeviceSaveDataSizeMax]]
| 20 || GetOverlayFunctions || Returns an [[#IOverlayFunctions]].
|-
|-
| 36 || [14.0.0+] GetLimitedApplicationLicense
| 21 || [7.0.0+] GetAppletCommonFunctions || No input, returns an [[#IAppletCommonFunctions]].
|-
|-
| 37 || [14.0.0+] GetLimitedApplicationLicenseUpgradableEvent
| 23 || [15.0.0+] GetGlobalStateController || No input, returns an [[#IGlobalStateController]].
|-
|-
| 40 || [[#NotifyRunning]]
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}
 
=== IOverlayFunctions ===
This is "nn::am::service::IOverlayFunctions".
 
{| class="wikitable" border="1"
|-
|-
| 50 || [2.0.0+] [[#GetPseudoDeviceId]]
! Cmd || Name
|-
|-
| 60 || [2.0.0+] [[#SetMediaPlaybackStateForApplication]]
| 0 || [[#BeginToWatchShortHomeButtonMessage]]
|-
|-
| 65 || [3.0.0+] [[#IsGamePlayRecordingSupported]]
| 1 || [[#EndToWatchShortHomeButtonMessage]]
|-
|-
| 66 || [3.0.0+] [[#InitializeGamePlayRecording]]
| 2 || [[#GetApplicationIdForLogo]]
|-
|-
| 67 || [3.0.0+] [[#SetGamePlayRecordingState]]
| 3 || [[#SetGpuTimeSliceBoost]]
|-
|-
| 68 || [4.0.0+] [[#RequestFlushGamePlayingMovieForDebug]]
| 4 || [2.0.0+] [[#SetAutoSleepTimeAndDimmingTimeEnabled]]
|-
|-
| 70 || [3.0.0+] [[#RequestToShutdown]]
| 5 || [2.0.0+] [[#TerminateApplicationAndSetReason]]
|-
|-
| 71 || [3.0.0+] [[#RequestToReboot]]
| 6 || [3.0.0+] [[#SetScreenShotPermissionGlobally]]
|-
|-
| 72 || [10.0.0+] [[#RequestToSleep]]
| 10 || [6.0.0+] [[#StartShutdownSequenceForOverlay]]
|-
|-
| 80 || [4.0.0+] [[#ExitAndRequestToShowThanksMessage]]
| 11 || [6.0.0+] [[#StartRebootSequenceForOverlay]]
|-
|-
| 90 || [4.0.0+] [[#EnableApplicationCrashReport]]
| 20 || [8.0.0+] [[#SetHandlingHomeButtonShortPressedEnabled]]
|-
|-
| 100 || [5.0.0+] [[#InitializeApplicationCopyrightFrameBuffer]]
| 21 || [14.0.0+] SetHandlingTouchScreenInputEnabled
|-
|-
| 101 || [5.0.0+] [[#SetApplicationCopyrightImage]]
| 30 || [9.0.0+] [[#SetHealthWarningShowingState]]
|-
|-
| 102 || [5.0.0+] [[#SetApplicationCopyrightVisibility]]
| 31 || [10.0.0+] [[#IsHealthWarningRequired]]
|-
|-
| 110 || [5.0.0+] [[#QueryApplicationPlayStatistics]]
| 40 || [18.0.0+] GetApplicationNintendoLogo
|-
|-
| 111 || [6.0.0+] [[#QueryApplicationPlayStatisticsByUid]]
| 41 || [18.0.0+] GetApplicationStartupMovie
|-
|-
| 120 || [5.0.0+] [[#ExecuteProgram]]
| 50 || [19.0.0+] SetGpuTimeSliceBoostForApplication
|-
|-
| 121 || [5.0.0+] [[#ClearUserChannel]]
| 60 || [19.0.0+]  
|-
|-
| 122 || [5.0.0+] [[#UnpopToUserChannel]]
| 61 || [S2]
|-
|-
| 123 || [5.0.0+] [[#GetPreviousProgramIndex]]
| 70 || [21.0.0+]  
|-
|-
| 124 || [6.0.0+] [[#EnableApplicationAllThreadDumpOnCrash]]
| 71 || [21.0.0+]  
|-
|-
| 130 || [8.0.0+] [[#GetGpuErrorDetectedSystemEvent]]
| 75 || [21.0.0+]  
|-
|-
| 131 || [11.0.0+] [[#SetDelayTimeToAbortOnGpuError]]
| 90 || [7.0.0+] [[#SetRequiresGpuResourceUse]]
|-
|-
| 140 || [9.0.0+] [[#GetFriendInvitationStorageChannelEvent]]
| 101 || [5.0.0+] [[#BeginToObserveHidInputForDevelop]]
|-
|-
| 141 || [9.0.0+] [[#TryPopFromFriendInvitationStorageChannel]]  
| 110 || [S2]
|-
|-
| 150 || [9.0.0+] [[#GetNotificationStorageChannelEvent]]
| 1000 || [S2]
|-
|}
| 151 || [9.0.0+] [[#TryPopFromNotificationStorageChannel]]
 
|-
==== BeginToWatchShortHomeButtonMessage ====
| 160 || [9.0.0+] [[#GetHealthWarningDisappearedSystemEvent]]
No input/output.
|-
 
| 170 || [9.0.0+] [[#SetHdcpAuthenticationActivated]]
==== EndToWatchShortHomeButtonMessage ====
|-
No input/output.
| 180 || [10.1.0+] [[#GetLaunchRequiredVersion]]
 
|-
==== GetApplicationIdForLogo ====
| 181 || [10.1.0+] [[#UpgradeLaunchRequiredVersion]]
No input, returns an output [[NCM_services#ApplicationId|ApplicationId]].
|-
| 190 || [11.0.0+] [[#SendServerMaintenanceOverlayNotification]]
|-
| 200 || [11.0.0+] [[#GetLastApplicationExitReason]]
|-
| 500 || [5.0.0+] [[#StartContinuousRecordingFlushForDebug]]
|-
| 1000 || [5.0.0+] [[#CreateMovieMaker]]
|-
| 1001 || [5.0.0+] [[#PrepareForJit]]
|}


The BOTW game uses this GamePlayRecording functionality from the main-nso "nninitStartup" function, with size 0x6000000(96MiB). The official GamePlayRecording-enable code does the following(this will panic on any failure):
Gets the ApplicationId for displaying the logo screen during application launch.
* [[SVC|Creates]] TransferMemory using the input buffer and size, with permissions=0.
* Uses [[#InitializeGamePlayRecording]] with the TransferMemory.
* Closes the TransferMemory handle, + TransferMemory cleanup.
* Uses [[#SetGamePlayRecordingState]] with value 0x1.
This GamePlayRecording functionality presumably enables the video-recording usable starting with [[4.0.0]].


==== PopLaunchParameter ====
When no application is running, this returns success with ApplicationId=0.
Takes an input u32 [[#LaunchParameterKind]], returns an output [[#IStorage]].


Pops a LaunchParameter [[#IStorage]], the storage will be removed from sysmodule state during this.
==== SetGpuTimeSliceBoost ====
Takes an input u64, no output.


==== CreateApplicationAndPushAndRequestToStart ====
==== SetAutoSleepTimeAndDimmingTimeEnabled ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and an input [[#IStorage]], no output. ApplicationId=0 can be used to relaunch the current application.
Takes an input u8 bool, no output.


==== CreateApplicationAndPushAndRequestToStartForQuest ====
==== TerminateApplicationAndSetReason ====
Takes 2 input u32s (loaded from struct [[#ApplicationAttributeForQuest]]), an input [[NCM_services#ApplicationId|ApplicationId]], and an input [[#IStorage]], no output.
Takes an input u32 Result, no output.


==== CreateApplicationAndRequestToStart ====
==== SetScreenShotPermissionGlobally ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.
Takes an input u8 bool, no output.


Same as [[#CreateApplicationAndPushAndRequestToStart]] except without the input storage, official sw uses this when no input storage is specified.
==== StartShutdownSequenceForOverlay ====
No input/output.
 
On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.


==== CreateApplicationAndRequestToStartForQuest ====
==== StartRebootSequenceForOverlay ====
Takes 2 input u32s (loaded from struct [[#ApplicationAttributeForQuest]]) and an input [[NCM_services#ApplicationId|ApplicationId]], no output.
No input/output.


Same as [[#CreateApplicationAndPushAndRequestToStartForQuest]] except without the input storage, official sw uses this when no input storage is specified.
On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.


==== CreateApplicationWithAttributeAndPushAndRequestToStartForQuest ====
==== SetHandlingHomeButtonShortPressedEnabled ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], a type-0x15 input buffer containing an [[#ApplicationAttribute]], an input [[#IStorage]], no output.
Takes an input u8 bool, no output.


Same as [[#CreateApplicationAndPushAndRequestToStartForQuest]] except the entire attributes structure is directly specified via the input buffer. This command replaces [[#CreateApplicationAndPushAndRequestToStartForQuest]], official user-processes no longer use [[#CreateApplicationAndPushAndRequestToStartForQuest]].
==== SetHealthWarningShowingState ====
Takes an input u8 bool, no output.


==== CreateApplicationWithAttributeAndRequestToStartForQuest ====
This writes the input bool into state, signals an Event, and returns 0.
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and a type-0x15 input buffer containing an [[#ApplicationAttribute]], no output.


Same as [[#CreateApplicationAndRequestToStartForQuest]] except the entire attributes structure is directly specified via the input buffer. This command replaces [[#CreateApplicationAndRequestToStartForQuest]], official user-processes no longer use [[#CreateApplicationAndPushAndRequestToStartForQuest]].
==== IsHealthWarningRequired ====
No input, returns an output u8 bool.


==== EnsureSaveData ====
==== SetRequiresGpuResourceUse ====
Takes an input u128 userID, returns an output u64 size.
Takes an input u8 bool, no output.


Calls sdk func <code>nn::fs::EnsureApplicationSaveData</code>. [[qlaunch]] also calls this same sdk func directly.
Just returns 0.


Creates the various savedata as specified by the application [[NACP_Format|control.nacp]] when the savedata doesn't exist.
==== BeginToObserveHidInputForDevelop ====
No input/output.


Official user-processes launch the dataErase LibraryApplet depending on the Result, the above output size is used with this.
Sets various state fields and signals an userspace-event.


==== GetDesiredLanguage ====
Enables HID input for the OverlayApplet, without disabling input for the foreground applet.
No input, returns an output [[Settings_services#LanguageCode|LanguageCode]].


==== SetTerminateResult ====
== ICMenuProxy ==
Takes an input u32 '''Result''', no output.
This is "nn::am::service::ICMenuProxy".


For example, in some cases official apps use this with [[Error_codes|error]] 0x2A2 then uses svcBreak.
This is exclusive to Switch 2.


==== GetDisplayVersion ====
{| class="wikitable" border="1"
No input, returns an output 0x10-byte struct.
|-
! Cmd || Name || Notes
|-
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
|-
| 1 || GetSelfController || Returns an [[#ISelfController]].
|-
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || GetOverlayFunctions || Returns an [[#IOverlayFunctions]].
|-
| 21 || GetAppletCommonFunctions || No input, returns an [[#IAppletCommonFunctions]].
|-
| 23 || GetGlobalStateController || No input, returns an [[#IGlobalStateController]].
|-
| 24 || || No input, returns an [[#ICMenuFunctions|ICMenuFunctions]].
|}


The output struct is "nn::oe::DisplayVersion". This the DisplayVersion string copied from the application [[NACP_Format|control.nacp]], this is always NUL-terminated.
=== ICMenuFunctions ===
This is "nn::am::service::ICMenuFunctions".


==== GetLaunchStorageInfoForDebug ====
This is exclusive to Switch 2.
No input, returns an output u8 [[Filesystem_services#StorageId|StorageId]] and u8 [[Filesystem_services#StorageId|StorageId]].


This returns two u8s loaded from state, these are the same StorageIds from [[#ApplicationLaunchProperty]].
{| class="wikitable" border="1"
 
|-
==== GetSaveDataSizeMax ====
! Cmd || Name
No input, returns two ouput s64s.
|-
 
| 0 ||
==== GetCacheStorageMax ====
|-
No input, returns an output s32 and s64.
| 1 ||
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 ||
|-
| 6 ||
|-
| 10 ||
|-
| 11 ||
|-
| 20 ||
|-
| 21 ||
|-
| 30 ||
|-
| 31 ||
|-
| 40 ||
|-
| 41 ||
|-
| 50 ||
|-
| 60 ||
|-
| 61 ||
|-
| 90 ||
|-
| 101 ||
|-
| 110 ||
|-
| 1000 ||
|-
| 200 ||
|-
| 202 ||
|-
| 210 || [20.0.0+]
|-
| 220 || [20.0.0+]
|}


==== BeginBlockingHomeButtonShortAndLongPressed ====
==== Cmd200 ====
Takes an input s64, no output.
No input, returns an [[#ILibraryAppletAgent|ILibraryAppletAgent]].


Official user-processes use hard-coded value 0 for the s64.
==== Cmd202 ====
 
Takes {...}, returns an [[#IFocusableLayer|IFocusableLayer]].
Starts blocking the Home button.


==== EndBlockingHomeButtonShortAndLongPressed ====
==== ILibraryAppletAgent ====
No input/output.
This is "nn::am::service::ILibraryAppletAgent".


Ends the blocking started by [[#BeginBlockingHomeButtonShortAndLongPressed]].
This is exclusive to Switch 2.


==== BeginBlockingHomeButton ====
{| class="wikitable" border="1"
Takes an input s64 nanoseconds, no output. The input nanoseconds can be zero.
|-
! Cmd || Name
|-
| 0 ||
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 ||
|-
| 10 ||
|-
| 20 ||
|-
| 21 ||
|-
| 31 ||
|-
| 32 ||
|-
| 33 ||
|-
| 34 ||
|-
| 35 ||
|-
| 40 ||
|-
| 41 ||
|-
| 42 ||
|}


==== EndBlockingHomeButton ====
===== Cmd0 =====
No input/output.
No input, returns an [[#IStorage|IStorage]].


==== SelectApplicationLicense ====
===== Cmd1 =====
Takes an input array of [[#ApplicationLicenseType]], returns an output [[#ApplicationLicenseType]].
Takes an unknown input interface, no output.


==== GetDeviceSaveDataSizeMax ====
===== Cmd2 =====
No input, returns two output s64s.
No input, returns an [[#IStorage|IStorage]].


==== NotifyRunning ====
===== Cmd3 =====
Takes no input. Returns an output u8 bool, which is ignored by official user-processes.
Takes an unknown input interface, no output.
 
==== GetPseudoDeviceId ====
No input, returns an output 0x10-byte "nn::util::Uuid" struct.


The 0x20-byte output data from [[NS_Services|GetSystemSeedForPseudoDeviceId]] followed by the 8-byte [[NACP_Format|SeedForPseudoDeviceId]] from the current control.nacp, is hashed with SHA1. Then "nn::util::GenerateUuidVersion5" is called with the final hash, the output from this is then returned for the Uuid.
===== Cmd10 =====
No input, returns an [[#IStorage|IStorage]].


==== SetMediaPlaybackStateForApplication ====
===== Cmd20 =====
Takes an input u8 bool, no output.
Takes an unknown input interface, no output.


==== IsGamePlayRecordingSupported ====
===== Cmd21 =====
No input, returns an output u8 bool.
Takes an unknown input interface, no output.


==== InitializeGamePlayRecording ====
==== IFocusableLayer ====
Takes a TransferMemory handle and an u64 for the size of the TransferMemory. The size must match 0x6000000 otherwise an error is returned.
This is "nn::am::service::IFocusableLayer".


==== SetGamePlayRecordingState ====
This is exclusive to Switch 2.
Takes an input u32. 0 = disable/pause, 1 = enable/restart.


==== RequestFlushGamePlayingMovieForDebug ====
{| class="wikitable" border="1"
No input/output.
|-
! Cmd || Name
|-
| 0 ||
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 10 ||
|-
| 11 ||
|-
| 20 ||
|-
| 21 ||
|-
| 32 ||
|-
| 33 ||
|-
| 40 ||
|-
| 41 ||
|-
| 42 ||
|-
| 50 || [20.0.0+]
|-
| 51 || [20.0.0+]
|-
| 60 || [20.0.0+]
|-
| 70 || [20.0.0+]
|-
| 71 || [20.0.0+]
|}


Requests to save the video recording, as if the Capture-button was held.
== IApplicationProxy ==
This is "nn::am::service::IApplicationProxy".


==== RequestToShutdown ====
{| class="wikitable" border="1"
No input/output.
|-
 
! Cmd || Name || Notes
On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.
|-
 
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
==== RequestToReboot ====
|-
No input/output.
| 1 || GetSelfController || Returns an [[#ISelfController]].
 
|-
On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || GetApplicationFunctions || Returns an [[#IApplicationFunctions]].
|-
| 40 || [S2] || Returns an [[#IPerformanceFunctions|IPerformanceFunctions]].
|-
| 60 || [S2] || Returns an [[#IGraphicsScalingParametersFunctions|IGraphicsScalingParametersFunctions]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}


==== RequestToSleep ====
=== IApplicationFunctions ===
No input/output.
This is "nn::am::service::IApplicationFunctions".


==== ExitAndRequestToShowThanksMessage ====
{| class="wikitable" border="1"
No input/output.
|-
 
! Cmd || Name
Used to exit the application and return to the kiosk menu. Official sw uses [[#UnlockExit]] immediately before this if needed.
|-
 
| 1 || [[#PopLaunchParameter]]
On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.
|-
 
| 10 || [[#CreateApplicationAndPushAndRequestToStart]]
This throws an error when the cached [[Settings_services#GetQuestFlag]] value is 0.
|-
 
| 11 || [3.0.0+] [[#CreateApplicationAndPushAndRequestToStartForQuest]]
==== EnableApplicationCrashReport ====
|-
Takes an input u8 bool, no output.
| 12 || [4.0.0+] [[#CreateApplicationAndRequestToStart]]
 
|-
==== InitializeApplicationCopyrightFrameBuffer ====
| 13 || [4.0.0+] [[#CreateApplicationAndRequestToStartForQuest]]
Takes an input TransferMemory handle, an s32 '''width''', an s32 '''height''', an u64 tmem_size, and no output.
|-
 
| 14 || [7.0.0+] [[#CreateApplicationWithAttributeAndPushAndRequestToStartForQuest]]
tmem_size must be 0x40000-byte aligned. '''width''' must be 1-1280, and '''height''' must be 1-720.
|-
 
| 15 || [7.0.0+] [[#CreateApplicationWithAttributeAndRequestToStartForQuest]]
User-processes create the tmem with an user-specified buffer with permissions=0. '''width''' = 1280 and '''height''' = 720.
|-
 
| 20 || [[#EnsureSaveData]]
This is used as an overlay for screenshots.
|-
 
| 21 || [[#GetDesiredLanguage]]
==== SetApplicationCopyrightImage ====
|-
Takes a type-0x45 input buffer, an s32 '''x''', an s32 '''y''', an s32 '''width''', an s32 '''height''', an s32 [[#WindowOriginMode]], and no output.
| 22 || [[#SetTerminateResult]]
 
|-
'''x''' and '''y''' must not have the negative bit set. '''width''' and '''height''' must not be <1.
| 23 || [[#GetDisplayVersion]]
 
|-
Sets the RGBA8 image for use with [[#InitializeApplicationCopyrightFrameBuffer]]. Overrides the current image, if this was already used previously.
| 24 || [2.0.0+] [[#GetLaunchStorageInfoForDebug]]
 
|-
==== SetApplicationCopyrightVisibility ====
| 25 || [3.0.0+] ExtendSaveData
Takes an input u8 bool, no output.
|-
 
| 26 || [3.0.0+] GetSaveDataSize
Sets the visibility for the image set by [[#SetApplicationCopyrightImage]], in screenshots. By default it's visible.
|-
 
| 27 || [5.0.0+] CreateCacheStorage
==== QueryApplicationPlayStatistics ====
|-
Takes a type-0x6 output buffer containing an array of [[Shared_Database_services|ApplicationPlayStatistics]] and a type-0x5 input buffer containing an array of [[NCM_services#ApplicationId|ApplicationId]]. Returns an output s32 for actual total output entries.
| 28 || [11.0.0+] [[#GetSaveDataSizeMax]]
 
|-
The number of entries in each array is the same.
| 29 || [11.0.0+] [[#GetCacheStorageMax]]
 
|-
See also [[NACP_Format#PlayLogQueryCapability|PlayLogQueryCapability]].
| 30 || [[#BeginBlockingHomeButtonShortAndLongPressed]]
 
|-
This uses [[Shared_Database_services|pdm:qry]] QueryApplicationPlayStatisticsForSystem.
| 31 || [[#EndBlockingHomeButtonShortAndLongPressed]]
 
|-
==== QueryApplicationPlayStatisticsByUid ====
| 32 || [[#BeginBlockingHomeButton]]
Takes a u128 userID, a type-0x6 output buffer containing an array of [[Shared_Database_services|ApplicationPlayStatistics]] and a type-0x5 input buffer containing an array of [[NCM_services#ApplicationId|ApplicationId]]. Returns an output s32 for actual total output entries.
|-
 
| 33 || [[#EndBlockingHomeButton]]
Same as [[#QueryApplicationPlayStatistics]] except this uses [[Shared_Database_services|pdm:qry]] cmd16, to get playstats specific to userIDs.  
|-
 
| 34 || [10.0.0-15.0.1] [[#SelectApplicationLicense]]
==== ExecuteProgram ====
|-
Takes an input u32 [[#ProgramSpecifyKind]] and an input u64, no output.
| 35 || [11.0.0+] [[#GetDeviceSaveDataSizeMax]]
 
|-
==== ClearUserChannel ====
| 36 || [14.0.0+] GetLimitedApplicationLicense
No input/output.
|-
 
| 37 || [14.0.0+] GetLimitedApplicationLicenseUpgradableEvent
Clears the UserChannel used by [[#UnpopToUserChannel]].
|-
 
| 40 || [[#NotifyRunning]]
==== UnpopToUserChannel ====
|-
Takes an input [[#IStorage]], no output.
| 50 || [2.0.0+] [[#GetPseudoDeviceId]]
 
|-
The input storage is pushed to the UserChannel. This is the same channel used by [[#LaunchParameterKind]] value 1.
| 60 || [2.0.0+] [[#SetMediaPlaybackStateForApplication]]
 
|-
User-processes create a storage using data specified by the user (written to offset=0 size=inputsize), with max size 0x1000. This storage is then used with this cmd.
| 65 || [3.0.0+] [[#IsGamePlayRecordingSupported]]
 
|-
==== GetPreviousProgramIndex ====
| 66 || [3.0.0+] [[#InitializeGamePlayRecording]]
No input, returns an output s32.
|-
 
| 67 || [3.0.0+] [[#SetGamePlayRecordingState]]
Gets the ProgramIndex of the Application which launched this title. The output ProgramIndex is -1 when there was no previous title.
|-
 
| 68 || [4.0.0+] [[#RequestFlushGamePlayingMovieForDebug]]
==== EnableApplicationAllThreadDumpOnCrash ====
|-
Takes an input u8 bool, no output.
| 70 || [3.0.0+] [[#RequestToShutdown]]
 
|-
==== GetGpuErrorDetectedSystemEvent ====
| 71 || [3.0.0+] [[#RequestToReboot]]
No input, returns an output Event handle with autoclear=false.
|-
 
| 72 || [10.0.0+] [[#RequestToSleep]]
This is used by sdknso during applet-application initialization. A separate thread is setup where event-waiting is handled. When the Event is signaled, official sw will Abort.
|-
 
| 80 || [4.0.0+] [[#ExitAndRequestToShowThanksMessage]]
==== SetDelayTimeToAbortOnGpuError ====
|-
Takes an input s64 "nn::TimeSpan", no output.
| 90 || [4.0.0+] [[#EnableApplicationCrashReport]]
 
|-
==== GetFriendInvitationStorageChannelEvent ====
| 100 || [5.0.0+] [[#InitializeApplicationCopyrightFrameBuffer]]  
No input, returns an output Event handle with EventClearMode=0.
|-
 
| 101 || [5.0.0+] [[#SetApplicationCopyrightImage]]
This is exposed by sdknso under <code>nn::friends::</code>. This returns a ptr to the cached Event in global state, with the Event being loaded if not previously initialized.
|-
 
| 102 || [5.0.0+] [[#SetApplicationCopyrightVisibility]]
==== TryPopFromFriendInvitationStorageChannel ====
|-
No input, returns an output [[#IStorage]].
| 110 || [5.0.0+] [[#QueryApplicationPlayStatistics]]
 
|-
This uses the same StorageChannel as [[#PushToFriendInvitationStorageChannel]].
| 111 || [6.0.0+] [[#QueryApplicationPlayStatisticsByUid]]
 
|-
This is exposed by sdknso under <code>nn::friends::</code>. When the storage_size is <0x10, this returns false. <code>data_size = storage_size-0x10;</code> Then the first 0x10-bytes from storage are read to stack, which is later copied to the output Uid on success prior to returning. Then the storage is read into the specified output buffer with storage-offset 0x10, where the size is <code>size = data_size > buf_size ? buf_size : data_size</code>. Reading is skipped if size is zero. Afterwards the used size is written to an output param. On success, true is returned.
| 112 || [20.0.0+]
 
|-
==== GetNotificationStorageChannelEvent ====
| 113 || [20.0.0+]
No input, returns an output Event handle with EventClearMode=0.
|-
| 120 || [5.0.0+] [[#ExecuteProgram]]
|-
| 121 || [5.0.0+] [[#ClearUserChannel]]
|-
| 122 || [5.0.0+] [[#UnpopToUserChannel]]
|-
| 123 || [5.0.0+] [[#GetPreviousProgramIndex]]
|-
| 124 || [6.0.0+] [[#EnableApplicationAllThreadDumpOnCrash]]
|-
| 130 || [8.0.0+] [[#GetGpuErrorDetectedSystemEvent]]
|-
| 131 || [11.0.0+] [[#SetDelayTimeToAbortOnGpuError]]
|-
| 140 || [9.0.0+] [[#GetFriendInvitationStorageChannelEvent]]
|-
| 141 || [9.0.0+] [[#TryPopFromFriendInvitationStorageChannel]]  
|-
| 150 || [9.0.0+] [[#GetNotificationStorageChannelEvent]]
|-
| 151 || [9.0.0+] [[#TryPopFromNotificationStorageChannel]]
|-
| 160 || [9.0.0+] [[#GetHealthWarningDisappearedSystemEvent]]
|-
| 170 || [9.0.0+] [[#SetHdcpAuthenticationActivated]]
|-
| 180 || [10.1.0+] [[#GetLaunchRequiredVersion]]
|-
| 181 || [10.1.0+] [[#UpgradeLaunchRequiredVersion]]
|-
| 190 || [11.0.0+] [[#SendServerMaintenanceOverlayNotification]]
|-
| 200 || [11.0.0+] [[#GetLastApplicationExitReason]]
|-
| 210 || [20.0.0+]
|-
| 220 || [20.0.0+] [[#SetAudioOutputPolicy|SetAudioOutputPolicy]]
|-
| 230 || [S2] [20.0.0+] IsTensorRtSupported
|-
| 300 || [19.0.0+] [[#CreateMovieWriter]]
|-
| 310 || [20.0.0+] [[#RequestExitApplicationAndTryPopMessage|RequestExitApplicationAndTryPopMessage]]
|-
| 320 || [20.0.0+]
|-
| 321 || [S2] [20.0.0+]
|-
| 330 || [20.2.0+] IsLanguageSelectionLimited
|-
| 500 || [5.0.0+] [[#StartContinuousRecordingFlushForDebug]]
|-
| 1000 || [5.0.0+] [[#CreateMovieMaker]]
|-
| 1001 || [5.0.0+] [[#PrepareForJit]]
|}


This is exposed by sdknso under <code>nn::notification::</code>. This returns a ptr to the cached Event in global state, with the Event being loaded if not previously initialized.
The BOTW game uses this GamePlayRecording functionality from the main-nso "nninitStartup" function, with size 0x6000000(96MiB). The official GamePlayRecording-enable code does the following(this will panic on any failure):
* [[SVC|Creates]] TransferMemory using the input buffer and size, with permissions=0.
* Uses [[#InitializeGamePlayRecording]] with the TransferMemory.
* Closes the TransferMemory handle, + TransferMemory cleanup.
* Uses [[#SetGamePlayRecordingState]] with value 0x1.
This GamePlayRecording functionality presumably enables the video-recording usable starting with [[4.0.0]].


==== TryPopFromNotificationStorageChannel ====
==== PopLaunchParameter ====
No input, returns an output [[#IStorage]].
Takes an input u32 [[#LaunchParameterKind]], returns an output [[#IStorage]].


This uses the same StorageChannel as [[#PushToNotificationStorageChannel]].
Pops a LaunchParameter [[#IStorage]], the storage will be removed from sysmodule state during this.


This is exposed by sdknso under <code>nn::notification::</code>. The storage is read into the specified output buffer, where the size is <code>size = storage_size > buf_size ? buf_size : storage_size</code>. Reading is skipped if size is zero. Afterwards the used size is written to an output param.
==== CreateApplicationAndPushAndRequestToStart ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and an input [[#IStorage]], no output. ApplicationId=0 can be used to relaunch the current application.


==== GetHealthWarningDisappearedSystemEvent ====
==== CreateApplicationAndPushAndRequestToStartForQuest ====
No input, returns an output Event with EventClearMode=0.
Takes 2 input u32s (loaded from struct [[#ApplicationAttributeForQuest]]), an input [[NCM_services#ApplicationId|ApplicationId]], and an input [[#IStorage]], no output.


==== SetHdcpAuthenticationActivated ====
==== CreateApplicationAndRequestToStart ====
Takes an input u8 bool, no output.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.


==== GetLaunchRequiredVersion ====
Same as [[#CreateApplicationAndPushAndRequestToStart]] except without the input storage, official sw uses this when no input storage is specified.
Takes an input [[NCM_services#ApplicationId|ApplicationId]], an u64, returns an output [[#LaunchRequiredVersion]].


sdknso passes hard-coded value 0 for the u64.
==== CreateApplicationAndRequestToStartForQuest ====
Takes 2 input u32s (loaded from struct [[#ApplicationAttributeForQuest]]) and an input [[NCM_services#ApplicationId|ApplicationId]], no output.


==== UpgradeLaunchRequiredVersion ====
Same as [[#CreateApplicationAndPushAndRequestToStartForQuest]] except without the input storage, official sw uses this when no input storage is specified.
Takes an input [[#LaunchRequiredVersion]], an [[NCM_services#ApplicationId|ApplicationId]], an u64, no output.


sdknso passes hard-coded value 0 for the u64.
==== CreateApplicationWithAttributeAndPushAndRequestToStartForQuest ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], a type-0x15 input buffer containing an [[#ApplicationAttribute]], an input [[#IStorage]], no output.


==== SendServerMaintenanceOverlayNotification ====
[21.0.0+] Now returns an output [[#IStorage]].
Takes two input [[PCV_services#PosixTime|PosixTime]], no output.


The second input value can optionally be 0.
Same as [[#CreateApplicationAndPushAndRequestToStartForQuest]] except the entire attributes structure is directly specified via the input buffer. This command replaces [[#CreateApplicationAndPushAndRequestToStartForQuest]], official user-processes no longer use [[#CreateApplicationAndPushAndRequestToStartForQuest]].


==== GetLastApplicationExitReason ====
==== CreateApplicationWithAttributeAndRequestToStartForQuest ====
No input, returns an output s32.
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and a type-0x15 input buffer containing an [[#ApplicationAttribute]], no output.


==== StartContinuousRecordingFlushForDebug ====
Same as [[#CreateApplicationAndRequestToStartForQuest]] except the entire attributes structure is directly specified via the input buffer. This command replaces [[#CreateApplicationAndRequestToStartForQuest]], official user-processes no longer use [[#CreateApplicationAndPushAndRequestToStartForQuest]].
Takes an input s64 nanoseconds-value, returns an output Event handle with autoclear=false.


The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise an error is returned.
==== EnsureSaveData ====
Takes an input u128 userID, returns an output u64 size.


==== CreateMovieMaker ====
Calls sdk func <code>nn::fs::EnsureApplicationSaveData</code>. [[qlaunch]] also calls this same sdk func directly.
Takes an input u64 size and a TransferMemory handle, returns an [[#IMovieMaker]].


Official sw retries using the cmd in a loop on error 0x8D4 with svcSleepThread(100000000) being used first.
Creates the various savedata as specified by the application [[NACP_Format|control.nacp]] when the savedata doesn't exist.


Official sw uses permissions=None for the TransferMemory, with an user-specified buffer. The size of the buffer used by official sw is 0x6000000.
Official user-processes launch the dataErase LibraryApplet depending on the Result, the above output size is used with this.


==== PrepareForJit ====
==== GetDesiredLanguage ====
Takes no input. Launches the [[JIT_services|jit-sysmodule]] if it has not already been launched for the current application, storing a std::shared_ptr<> for jit-sysmodule process tracking object as an IApplicationFunctions member.
No input, returns an output [[Settings_services#LanguageCode|LanguageCode]].


~IApplicationFunctions() includes:
==== SetTerminateResult ====
Takes an input u32 '''Result''', no output.


    if (this->jit_process) {
For example, in some cases official apps use this with [[Error_codes|error]] 0x2A2 then uses svcBreak.
        Terminate(this->jit_process);
        this->jit_process = nullptr;
    }


Thus the lifetime of the jit sysmodule is tied to the application which uses it, and each application gets its own fresh copy of the jit sysmodule.
==== GetDisplayVersion ====
No input, returns an output 0x10-byte struct.


=== IMovieMaker ===
The output struct is "nn::oe::DisplayVersion". This the DisplayVersion string copied from the application [[NACP_Format|control.nacp]], this is always NUL-terminated.
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetGrcMovieMaker]]
|-
| 1 || [[#GetLayerHandle]]
|}


==== GetGrcMovieMaker ====
==== GetLaunchStorageInfoForDebug ====
No input, returns a GRC [[GRC_services|IMovieMaker]].
No input, returns an output u8 [[Filesystem_services#StorageId|StorageId]] and u8 [[Filesystem_services#StorageId|StorageId]].


==== GetLayerHandle ====
This returns two u8s loaded from state, these are the same StorageIds from [[#ApplicationLaunchProperty]].
No input, returns an output u64.


== ILibraryAppletCreator ==
==== GetSaveDataSizeMax ====
{| class="wikitable" border="1"
No input, returns two ouput s64s.
|-
! Cmd || Name || Notes
|-
| 0 || [[#CreateLibraryApplet]] ||
|-
| 1 || [[#TerminateAllLibraryApplets]] ||
|-
| 2 || [[#AreAnyLibraryAppletsLeft]] ||
|-
| 10 || [[#CreateStorage]] ||
|-
| 11 || [[#CreateTransferMemoryStorage]] ||
|-
| 12 || [2.0.0+] [[#CreateHandleStorage]] ||
|}


=== CreateLibraryApplet ===
==== GetCacheStorageMax ====
Takes 2 input u32s [[#AppletId]] and [[#LibraryAppletMode]], returns an [[#ILibraryAppletAccessor]].
No input, returns an output s32 and s64.


=== TerminateAllLibraryApplets ===
==== BeginBlockingHomeButtonShortAndLongPressed ====
No input/output.
Takes an input s64, no output.


Stubbed with an ILibraryAppletCreator from [[#CreateSelfLibraryAppletCreatorForDevelop]], just returns an error.
Official user-processes use hard-coded value 0 for the s64.


Terminates all LibraryApplets which were created by the current applet (or by the Application when used from the [[#IApplicationAccessor]] cmd).
Starts blocking the Home button.


=== AreAnyLibraryAppletsLeft ===
==== EndBlockingHomeButtonShortAndLongPressed ====
No input, returns an output u8 bool.
No input/output.


Stubbed with an ILibraryAppletCreator from [[#CreateSelfLibraryAppletCreatorForDevelop]], just returns an error.
Ends the blocking started by [[#BeginBlockingHomeButtonShortAndLongPressed]].
 
==== BeginBlockingHomeButton ====
Takes an input s64 nanoseconds, no output. The input nanoseconds can be zero.
 
==== EndBlockingHomeButton ====
No input/output.


Gets whether any LibraryApplets ([[#ILibraryAppletAccessor]]) which were created by the current applet are still open (or by the Application when used from the [[#IApplicationAccessor]] cmd).
==== SelectApplicationLicense ====
Takes an input array of [[#ApplicationLicenseType]], returns an output [[#ApplicationLicenseType]].


=== CreateStorage ===
==== GetDeviceSaveDataSizeMax ====
Takes an input s64 for the storage size, returns an [[#IStorage]].
No input, returns two output s64s.


This allocates a buffer with the specified size which can then be accessed via [[#IStorageAccessor]].
==== NotifyRunning ====
Takes no input. Returns an output u8 bool, which is ignored by official user-processes.


=== CreateTransferMemoryStorage ===
==== GetPseudoDeviceId ====
Takes an input TransferMemory copy-handle, an input u8 bool, and an s64 size, returns an [[#IStorage]].
No input, returns an output 0x10-byte "nn::util::Uuid" struct.


The user-process creates the TransferMemory with permissions=0.
The 0x20-byte output data from [[NS_Services|GetSystemSeedForPseudoDeviceId]] followed by the 8-byte [[NACP_Format|SeedForPseudoDeviceId]] from the current control.nacp, is hashed with SHA1. Then "nn::util::GenerateUuidVersion5" is called with the final hash, the output from this is then returned for the Uuid.


The TransferMemory is mapped, which can then be accessed via [[#IStorageAccessor]]. The input bool controls whether writing to the storage is allowed: [[#Write]] will throw an error if this flag is not set.
==== SetMediaPlaybackStateForApplication ====
Takes an input u8 bool, no output.


=== CreateHandleStorage ===
==== IsGamePlayRecordingSupported ====
Takes an input copy-handle and an input s64, returns an [[#IStorage]]. In some cases the s64 must not have the negative bit set.
No input, returns an output u8 bool.


The input can be arbitrary, however official sw is only (?) known to use this for TransferMemory (with s64=size).
==== InitializeGamePlayRecording ====
Takes a TransferMemory handle and an u64 for the size of the TransferMemory. The size must match 0x6000000 otherwise an error is returned.


=== ILibraryAppletAccessor ===
==== SetGamePlayRecordingState ====
{| class="wikitable" border="1"
Takes an input u32. 0 = disable/pause, 1 = enable/restart.
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetAppletStateChangedEvent]] ||
|-
| 1 || [[#IsCompleted]] ||
|-
| 10 || [[#Start]] ||
|-
| 20 || [[#RequestExit]] ||
|-
| 25 || [[#Terminate]] ||
|-
| 30 || [[#GetResult]] ||
|-
| 50 || [[#SetOutOfFocusApplicationSuspendingEnabled]] ||
|-
| 60 || [10.0.0+] [[#PresetLibraryAppletGpuTimeSliceZero]] ||
|-
| 100 || [[#PushInData]] ||
|-
| 101 || [[#PopOutData]] ||
|-
| 102 || [[#PushExtraStorage]] ||
|-
| 103 || [[#PushInteractiveInData]] ||
|-
| 104 || [[#PopInteractiveOutData]] ||
|-
| 105 || [[#GetPopOutDataEvent]] ||
|-
| 106 || [[#GetPopInteractiveOutDataEvent]] ||
|-
| 110 || [[#NeedsToExitProcess]] ||
|-
| 120 || [[#GetLibraryAppletInfo]] ||
|-
| 150 || [[#RequestForAppletToGetForeground]] ||
|-
| 160 || [2.0.0+] [[#GetIndirectLayerConsumerHandle]] ||
|}


Commands <=30 are inherited from [[#IAppletAccessor]]. GetLibraryAppletInfo is identical to the [[#ILibraryAppletSelfAccessor]] cmd.
==== RequestFlushGamePlayingMovieForDebug ====
No input/output.


==== SetOutOfFocusApplicationSuspendingEnabled ====
Requests to save the video recording, as if the Capture-button was held.
Takes an input u8 bool, no output.
 
==== RequestToShutdown ====
No input/output.


Official sw will assert prior to using this if applet-service was not initialized as *Application.
On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.


==== PresetLibraryAppletGpuTimeSliceZero ====
==== RequestToReboot ====
No input/output.
No input/output.


sdknso only uses with with [[Software_Keyboard|swkbd-inline]], immediately after creating the LibraryApplet.
On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.


==== PushInData ====
==== RequestToSleep ====
Takes an input [[#IStorage]], no output.
No input/output.


==== PopOutData ====
==== ExitAndRequestToShowThanksMessage ====
No input, returns an output [[#IStorage]].
No input/output.


==== PushExtraStorage ====
Used to exit the application and return to the kiosk menu. Official sw uses [[#UnlockExit]] immediately before this if needed.
Takes an input [[#IStorage]], no output.


==== PushInteractiveInData ====
On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.
Takes an input [[#IStorage]], no output.


==== PopInteractiveOutData ====
This throws an error when the cached [[Settings_services#GetQuestFlag]] value is 0.
No input, returns an output [[#IStorage]].


==== GetPopOutDataEvent ====
==== EnableApplicationCrashReport ====
No input, returns an output handle with autoclear=false.
Takes an input u8 bool, no output.


==== GetPopInteractiveOutDataEvent ====
==== InitializeApplicationCopyrightFrameBuffer ====
No input, returns an output event handle with autoclear=false.
Takes an input TransferMemory handle, an s32 '''width''', an s32 '''height''', an u64 tmem_size, and no output.


==== NeedsToExitProcess ====
tmem_size must be 0x40000-byte aligned. '''width''' must be 1-1280, and '''height''' must be 1-720.
No input, returns an output u8 bool.


Stubbed, just returns an error.
User-processes create the tmem with an user-specified buffer with permissions=0. '''width''' = 1280 and '''height''' = 720.


==== RequestForAppletToGetForeground ====
After the validation checks pass the input is passed to [[OMM_services|ommdisp]] cmd500.
No input/output.
 
This is used as an overlay for screenshots.
 
==== SetApplicationCopyrightImage ====
Takes a type-0x45 input buffer, an s32 '''x''', an s32 '''y''', an s32 '''width''', an s32 '''height''', an s32 [[#WindowOriginMode]], and no output.
 
'''x''' and '''y''' must not have the negative bit set. '''width''' and '''height''' must not be <1.
 
Sets the RGBA8 image for use with [[#InitializeApplicationCopyrightFrameBuffer]]. Overrides the current image, if this was already used previously.
 
==== SetApplicationCopyrightVisibility ====
Takes an input u8 bool, no output.
 
Sets the visibility for the image set by [[#SetApplicationCopyrightImage]], in screenshots. By default it's visible.
 
==== QueryApplicationPlayStatistics ====
Takes a type-0x6 output buffer containing an array of [[Shared_Database_services|ApplicationPlayStatistics]] and a type-0x5 input buffer containing an array of [[NCM_services#ApplicationId|ApplicationId]]. Returns an output s32 for actual total output entries.


Stubbed, just returns an error.
The number of entries in each array is the same.


==== GetIndirectLayerConsumerHandle ====
See also [[NACP_Format#PlayLogQueryCapability|PlayLogQueryCapability]].
Takes an input PID and an input u64 AppletResourceUserId, returns an output u64 IndirectLayerConsumerHandle.


Official sw uses this during LibraryApplet creation when [[#LibraryAppletMode]] is 0x3.
This uses [[Shared_Database_services|pdm:qry]] QueryApplicationPlayStatisticsForSystem.


== ICommonStateGetter ==
==== QueryApplicationPlayStatisticsByUid ====
{| class="wikitable" border="1"
Takes a u128 userID, a type-0x6 output buffer containing an array of [[Shared_Database_services|ApplicationPlayStatistics]] and a type-0x5 input buffer containing an array of [[NCM_services#ApplicationId|ApplicationId]]. Returns an output s32 for actual total output entries.
|-
 
! Cmd || Name
Same as [[#QueryApplicationPlayStatistics]] except this uses [[Shared_Database_services|pdm:qry]] cmd16, to get playstats specific to userIDs.
|-
 
| 0 || [[#GetEventHandle]]
==== ExecuteProgram ====
|-
Takes an input u32 [[#ProgramSpecifyKind]] and an input u64, no output.
| 1 || [[#ReceiveMessage]]
 
|-
==== ClearUserChannel ====
| 2 || [[#GetThisAppletKind]]
No input/output.
|-
 
| 3 || [[#AllowToEnterSleep]]
Clears the UserChannel used by [[#UnpopToUserChannel]].
|-
 
| 4 || [[#DisallowToEnterSleep]]
==== UnpopToUserChannel ====
|-
Takes an input [[#IStorage]], no output.
| 5 || [[#GetOperationMode]]
 
|-
The input storage is pushed to the UserChannel. This is the same channel used by [[#LaunchParameterKind]] value 1.
| 6 || [[#GetPerformanceMode]]
 
|-
User-processes create a storage using data specified by the user (written to offset=0 size=inputsize), with max size 0x1000. This storage is then used with this cmd.
| 7 || [[#GetCradleStatus]]
 
|-
==== GetPreviousProgramIndex ====
| 8 || [[#GetBootMode]]
No input, returns an output s32.
|-
 
| 9 || [[#GetCurrentFocusState]]
Gets the ProgramIndex of the Application which launched this title. The output ProgramIndex is -1 when there was no previous title.
|-
 
| 10 || [[#RequestToAcquireSleepLock]]
==== EnableApplicationAllThreadDumpOnCrash ====
|-
Takes an input u8 bool, no output.
| 11 || [[#ReleaseSleepLock]]
 
|-
==== GetGpuErrorDetectedSystemEvent ====
| 12 || [[#ReleaseSleepLockTransiently]]
No input, returns an output Event handle with autoclear=false.
|-
 
| 13 || [[#GetAcquiredSleepLockEvent]]
This is used by sdknso during applet-application initialization. A separate thread is setup where event-waiting is handled. When the Event is signaled, official sw will Abort.
|-
 
| 14 || [11.0.0+] [[#GetWakeupCount]]
==== SetDelayTimeToAbortOnGpuError ====
|-
Takes an input s64 "nn::TimeSpan", no output.
| 20 || [[#PushToGeneralChannel]]
 
|-
==== GetFriendInvitationStorageChannelEvent ====
| 30 || [[#GetHomeButtonReaderLockAccessor]]
No input, returns an output Event handle with EventClearMode=0.
|-
 
| 31 || [2.0.0+] [[#GetReaderLockAccessorEx]]
This is exposed by sdknso under <code>nn::friends::</code>. This returns a ptr to the cached Event in global state, with the Event being loaded if not previously initialized.
|-
 
| 32 || [7.0.0+] [[#GetWriterLockAccessorEx]]
==== TryPopFromFriendInvitationStorageChannel ====
|-
No input, returns an output [[#IStorage]].
| 40 || [2.0.0+] [[#GetCradleFwVersion]]
 
|-
This uses the same StorageChannel as [[#PushToFriendInvitationStorageChannel]].
| 50 || [3.0.0+] [[#IsVrModeEnabled]]
 
|-
This is exposed by sdknso under <code>nn::friends::</code>. When the storage_size is <0x10, this returns false. <code>data_size = storage_size-0x10;</code> Then the first 0x10-bytes from storage are read to stack, which is later copied to the output Uid on success prior to returning. Then the storage is read into the specified output buffer with storage-offset 0x10, where the size is <code>size = data_size > buf_size ? buf_size : data_size</code>. Reading is skipped if size is zero. Afterwards the used size is written to an output param. On success, true is returned.
| 51 || [3.0.0+] [[#SetVrModeEnabled]]
 
|-
==== GetNotificationStorageChannelEvent ====
| 52 || [4.0.0+] [[#SetLcdBacklighOffEnabled]]
No input, returns an output Event handle with EventClearMode=0.
|-
 
| 53 || [7.0.0+] [[#BeginVrModeEx]]
This is exposed by sdknso under <code>nn::notification::</code>. This returns a ptr to the cached Event in global state, with the Event being loaded if not previously initialized.
|-
 
| 54 || [7.0.0+] [[#EndVrModeEx]]
==== TryPopFromNotificationStorageChannel ====
|-
No input, returns an output [[#IStorage]].
| 55 || [3.0.0+] [[#IsInControllerFirmwareUpdateSection]]
 
|-
This uses the same StorageChannel as [[#PushToNotificationStorageChannel]].
| 59 || [11.0.0+] [[#SetVrPositionForDebug]]
 
|-
This is exposed by sdknso under <code>nn::notification::</code>. The storage is read into the specified output buffer, where the size is <code>size = storage_size > buf_size ? buf_size : storage_size</code>. Reading is skipped if size is zero. Afterwards the used size is written to an output param.
| 60 || [3.0.0+] [[#GetDefaultDisplayResolution]]
 
|-
==== GetHealthWarningDisappearedSystemEvent ====
| 61 || [3.0.0+] [[#GetDefaultDisplayResolutionChangeEvent]]
No input, returns an output Event with EventClearMode=0.
|-
 
| 62 || [4.0.0+] [[#GetHdcpAuthenticationState]]
==== SetHdcpAuthenticationActivated ====
|-
Takes an input u8 bool, no output.
| 63 || [4.0.0+] [[#GetHdcpAuthenticationStateChangeEvent]]
|-
| 64 || [5.0.0+] [[#SetTvPowerStateMatchingMode]]
|-
| 65 || [5.1.0+] [[#GetApplicationIdByContentActionName]]
|-
| 66 || [6.0.0+] [[#SetCpuBoostMode]]
|-
| 67 || [10.0.0+] [[#CancelCpuBoostMode]]
|-
| 68 || [11.0.0+] [[#GetBuiltInDisplayType]]
|-
| 80 || [6.0.0+] [[#PerformSystemButtonPressingIfInFocus]]
|-
| 90 || [7.0.0+] [[#SetPerformanceConfigurationChangedNotification]]
|-
| 91 || [7.0.0+] [[#GetCurrentPerformanceConfiguration]]
|-
| 100 || [9.1.0+] [[#SetHandlingHomeButtonShortPressedEnabled]]
|-
| 110 || [11.0.0+] [[#OpenMyGpuErrorHandler]]
|-
| 120 || [13.0.0+] GetAppletLaunchedHistory
|-
| 200 || [7.0.0+] [[#GetOperationModeSystemInfo]]
|-
| 300 || [9.0.0+] [[#GetSettingsPlatformRegion]]
|-
| 400 || [10.0.0+] [[#ActivateMigrationService]]
|-
| 401 || [10.0.0+] [[#DeactivateMigrationService]]
|-
| 500 || [11.0.0+] [[#DisableSleepTillShutdown]]
|-
| 501 || [11.0.0+] [[#SuppressDisablingSleepTemporarily]]
|-
| 502 || [12.0.0+] IsSleepEnabled
|-
| 503 || [12.0.0+] IsDisablingSleepSuppressed
|-
| 900 || [11.0.0+] [[#SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled]]
|}


Officially notification messages are handled by the application itself, not sdk-nso in ExeFS. Official apps call code in sdk-nso which basically uses svcWaitSynchronization with the event from [[#GetEventHandle]] to check whether a message is available, then if so it uses [[#ReceiveMessage]]. The actual handling for message IDs is done in the app itself(see [[#AppletMessage]]).
==== GetLaunchRequiredVersion ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], an u64, returns an output [[#LaunchRequiredVersion]].


[7.0.0+] User-processes now use BeginVrModeEx/EndVrModeEx instead of [[#SetVrModeEnabled]]. Prior to using using BeginVrModeEx, [[Parental_Control_services|pctl]] IsStereoVisionPermitted is used and error 0xD08E is thrown if not allowed by pctl.
sdknso passes hard-coded value 0 for the u64.


=== GetEventHandle ===
==== UpgradeLaunchRequiredVersion ====
No input. Returns an output event handle. This is signalled when a message is available with [[#ReceiveMessage]].
Takes an input [[#LaunchRequiredVersion]], an [[NCM_services#ApplicationId|ApplicationId]], an u64, no output.


=== ReceiveMessage ===
sdknso passes hard-coded value 0 for the u64.
No input. Returns an output [[#AppletMessage]]. Error 0x680 indicates no message is available.


=== GetThisAppletKind ===
==== SendServerMaintenanceOverlayNotification ====
No input, returns an output [[#AppletKind]].
Takes two input [[PCV_services#PosixTime|PosixTime]], no output.


Stubbed, just returns an error.
The second input value can optionally be 0.


=== AllowToEnterSleep ===
==== GetLastApplicationExitReason ====
No input/output.
No input, returns an output s32.


Stubbed, just returns an error.
==== Cmd210 ====
No input, returns an output Event handle.


=== DisallowToEnterSleep ===
==== SetAudioOutputPolicy ====
No input/output.
Takes an input u8, no output.


Stubbed, just returns an error.
The input must be <=1.


=== GetOperationMode ===
==== CreateMovieWriter ====
No input. Returns an output u8 for the current [[#OperationMode]].
Takes 8-bytes of input and a handle. Returns an [[#IMovieWriter]].


=== GetPerformanceMode ===
This internally uses the GRC cmd to open an [[GRC_services|IMovieWriter]]. This is therefore not usable on NX since that cmd is stubbed.
No input. Returns an output u32 for the current [[#PerformanceMode]].


=== GetCradleStatus ===
==== RequestExitApplicationAndTryPopMessage ====
No input, returns an output u8.
Takes an input [[#IStorage|IStorage]], no output.


This uses [[#omm]] GetCradleStatus.
[21.0.0+] Now additionally takes a total of 0x18-bytes of input.


=== GetBootMode ===
==== IsLanguageSelectionLimited ====
No input, returns an output u8.
No input, returns 1-byte of output.


Returns the value from [[Process_Manager_services|pm:bm]] GetBootMode.
On NX this just writes 0 to output and returns 0.


=== GetCurrentFocusState ===
==== StartContinuousRecordingFlushForDebug ====
No input. Returns an output u8 [[#FocusState]].
Takes an input s64 nanoseconds-value, returns an output Event handle with autoclear=false.


=== RequestToAcquireSleepLock ===
The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise an error is returned.
No input/output.


=== ReleaseSleepLock ===
==== CreateMovieMaker ====
No input/output.
Takes an input u64 size and a TransferMemory handle, returns an [[#IMovieMaker]].


=== ReleaseSleepLockTransiently ===
Official sw retries using the cmd in a loop on error 0x8D4 with svcSleepThread(100000000) being used first.
No input/output.


=== GetAcquiredSleepLockEvent ===
Official sw uses permissions=None for the TransferMemory, with an user-specified buffer. The size of the buffer used by official sw is 0x6000000.
No input, returns an output Event handle with autoclear=false.


=== GetWakeupCount ===
==== PrepareForJit ====
No input, returns an output u64.
Takes no input. Launches the [[JIT_services|jit-sysmodule]] via [[NS_Services|ns]] LaunchLibraryApplet if it has not already been launched for the current application, storing a std::shared_ptr<> for jit-sysmodule process tracking object as an IApplicationFunctions member.


=== PushToGeneralChannel ===
~IApplicationFunctions() includes:
Takes an input [[#IStorage]], no output.


This is not usable under an Application, however it is usable under a LibraryApplet.
    if (this->jit_process) {
        Terminate(this->jit_process);
        this->jit_process = nullptr;
    }


Used for sending requests to [[qlaunch]]. sdk-nso creates a 0x10-byte storage which is sent to this. The following are the functions which use this, with the data written to the storage:
Thus the lifetime of the jit sysmodule is tied to the application which uses it, and each application gets its own fresh copy of the jit sysmodule.
* <code>RequestHomeMenu</code> <code>5341 4d53 0100 0000 0200 0000 0100 0000</code> Returns to the main Home Menu, equivalent to pressing the HOME button.
* <code>RequestJumpToSystemUpdate</code> <code>5341 4d53 0100 0000 0b00 0000 0100 0000</code> Equivalent to entering "System Update" under System Settings. When leaving this, it returns to the main Home Menu.


=== GetHomeButtonReaderLockAccessor ===
AM can also optionally launch jit-sysmodule automatically if the [[NACP]] enables it.
No input, returns an output [[#ILockAccessor]].


Similar to using [[#GetReaderLockAccessorEx]] with inval=0.
[S2] This is no longer usable since this returns Result 0x408 (sysmodule doesn't exist).


=== GetReaderLockAccessorEx ===
=== IMovieWriter ===
Takes an input u32, returns an output [[#ILockAccessor]].
This is "nn::am::service::IMovieWriter".


The input value must be 0-3. 0 = HomeButton.
This was added with [19.0.0+].


=== GetWriterLockAccessorEx ===
{| class="wikitable" border="1"
Takes an input u32, returns an output [[#ILockAccessor]].
|-
! Cmd || Name
|-
| 0 ||
|}


The input value must be 0-3. 0 = HomeButton.
==== Cmd0 ====
No input. Returns a GRC [[GRC_services|IMovieWriter]].


=== GetCradleFwVersion ===
=== IMovieMaker ===
No input, returns 4 output u32s.
This is "nn::am::service::IMovieMaker".


This uses [[#omm]] GetCradleFwVersion.
{| class="wikitable" border="1"
 
|-
=== IsVrModeEnabled ===
! Cmd || Name
No input, returns an output u8 bool.
|-
| 0 || [[#GetGrcMovieMaker]]
|-
| 1 || [[#GetLayerHandle]]
|}


=== SetVrModeEnabled ===
==== GetGrcMovieMaker ====
Takes an input u8 bool flag. No output.
No input, returns a GRC [[GRC_services|IMovieMaker]].


Updates internal AM state fields. If the new state doesn't match the previous state, this uses the [[Backlight_services]] {Disable/Enable}VrMode command depending on whether flag={disable/enable}.
==== GetLayerHandle ====
No input, returns an output u64.


When the VrMode is set to true, the console shows a screen rendered like vr asking the user to move his face away and hit the 'close' button. When this button is pressed, the console resets the vrMode to false.
=== IPerformanceFunctions ===
This is "nn::am::service::IPerformanceFunctions".


=== SetLcdBacklighOffEnabled ===
This is exclusive to Switch 2.
Takes an input u8 bool, no output.


Sets whether the LCD screen blacklight is turned off.
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || IsCpuOverclockEnabled
|-
| 1 || SetCpuOverclockEnabled
|}


=== BeginVrModeEx ===
=== IGraphicsScalingParametersFunctions ===
No input/output.
This is "nn::am::service::IGraphicsScalingParametersFunctions".


Identical to [[#SetVrModeEnabled]] except with hard-coded flag=1.
This is exclusive to Switch 2.


=== EndVrModeEx ===
{| class="wikitable" border="1"
No input/output.
|-
! Cmd || Name
|-
| 10 || GetGraphicsScalingParameters
|-
| 1000 || SetSupportingGraphicsScalingParametersForDebug
|-
| 1010 || SetGpuQuotaForDebug
|-
| 1020 || ClearGpuQuotaForDebug
|-
| 1030 || SetScreenRatioForDebug
|-
| 1040 || ClearScreenRatioForDebug
|-
| 1050 || SetGraphicsScaleChangedNotificationEnabled
|}


Identical to [[#SetVrModeEnabled]] except with hard-coded flag=0.
== ILibraryAppletCreator ==
This is "nn::am::service::ILibraryAppletCreator".


=== IsInControllerFirmwareUpdateSection ===
{| class="wikitable" border="1"
No input, returns an output u8 bool.
|-
! Cmd || Name || Notes
|-
| 0 || [[#CreateLibraryAppletOld|CreateLibraryAppletOld]] ([1.0.0-19.0.1] CreateLibraryApplet) ||
|-
| 1 || [[#TerminateAllLibraryApplets]] ||
|-
| 2 || [[#AreAnyLibraryAppletsLeft]] ||
|-
| 3 || [20.0.0+] [[#CreateLibraryApplet|CreateLibraryApplet]] ||
|-
| 10 || [[#CreateStorage]] ||
|-
| 11 || [[#CreateTransferMemoryStorage]] ||
|-
| 12 || [2.0.0+] [[#CreateHandleStorage]] ||
|}


=== SetVrPositionForDebug ===
=== CreateLibraryAppletOld ===
Takes 4 input s32s, no output.
Unofficial name.


The s32s are: x, y, width, height.
Takes 2 input u32s [[#AppletId]] and [[#LibraryAppletMode]], returns an [[#ILibraryAppletAccessor]].


The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.
=== TerminateAllLibraryApplets ===
No input/output.


width must be 1-1280, height must be 1-720.
Stubbed with an ILibraryAppletCreator from [[#CreateSelfLibraryAppletCreatorForDevelop]], just returns an error.


x and y must not be negative. x+width must be <=1280. y+height must be <=720.
Terminates all LibraryApplets which were created by the current applet (or by the Application when used from the [[#IApplicationAccessor]] cmd).


=== GetDefaultDisplayResolution ===
=== AreAnyLibraryAppletsLeft ===
No input, returns two output s32s '''width''' and '''height'''.
No input, returns an output u8 bool.


=== GetDefaultDisplayResolutionChangeEvent ===
Stubbed with an ILibraryAppletCreator from [[#CreateSelfLibraryAppletCreatorForDevelop]], just returns an error.
No input, returns an output Event handle with autoclear=true.


=== GetHdcpAuthenticationState ===
Gets whether any LibraryApplets ([[#ILibraryAppletAccessor]]) which were created by the current applet are still open (or by the Application when used from the [[#IApplicationAccessor]] cmd).
No input, returns an output s32.


=== GetHdcpAuthenticationStateChangeEvent ===
=== CreateLibraryApplet ===
No input, returns an output Event handle with autoclear=true.
Unofficial name.


=== SetTvPowerStateMatchingMode ===
Takes 2 input u32s [[#AppletId]] and [[#LibraryAppletMode]], an u64 ThreadId, returns an [[#ILibraryAppletAccessor]].
Takes an input s32 [[#TvPowerStateMatchingMode]], no output.


=== GetApplicationIdByContentActionName ===
The ThreadId is from the current-thread of the user-process which is using the cmd.
Takes a type-0x5 input buffer containing a string, returns an output [[NCM_services#ApplicationId|ApplicationId]].


Gets the ApplicationId for the specified ContentActionName string. Returns an error when the current [[#AppletId]] isn't 0x04 (when the current applet isn't a SystemApplication).
=== CreateStorage ===
Takes an input s64 for the storage size, returns an [[#IStorage]].


=== SetCpuBoostMode ===
This allocates a buffer with the specified size which can then be accessed via [[#IStorageAccessor]].
Takes an input u32 [[#CpuBoostMode]] and passes it to [[PPC_services#apm:sys|SetCpuBoostMode]].


=== CancelCpuBoostMode ===
=== CreateTransferMemoryStorage ===
No input/output.
Takes an input TransferMemory copy-handle, an input u8 bool, and an s64 size, returns an [[#IStorage]].


=== GetBuiltInDisplayType ===
The user-process creates the TransferMemory with permissions=0.
No input, returns an output s32.


This is not exposed by sdknso.
The TransferMemory is mapped, which can then be accessed via [[#IStorageAccessor]]. The input bool controls whether writing to the storage is allowed: [[#Write]] will throw an error if this flag is not set.


This loads a s32 index from global state (originates from [[SPL_services#GetConfig|GetConfig]] [[SMC#HardwareType|HardwareType]]), Aborts if it's out-of-bounds, then the following is returned for the output s32: global_array[loaded_index].
=== CreateHandleStorage ===
Takes an input copy-handle and an input s64, returns an [[#IStorage]]. In some cases the s64 must not have the negative bit set.


=== PerformSystemButtonPressingIfInFocus ===
The input can be arbitrary, however official sw is only (?) known to use this for TransferMemory (with s64=size).
Takes an input [[#SystemButtonType]], no output.


Just returns 0 when a state field is not value 1. Verifies that the input button is allowed, then calls the same func as [[#PerformSystemButtonPressing]] internally.
=== ILibraryAppletAccessor ===
This is "nn::am::service::ILibraryAppletAccessor".


=== SetPerformanceConfigurationChangedNotification ===
{| class="wikitable" border="1"
Takes an input u8 bool, no output.
|-
 
! Cmd || Name || Notes
=== GetCurrentPerformanceConfiguration ===
|-
No input, returns the result of calling [[PPC_services#apm:sys|GetCurrentPerformanceConfiguration]].
| 0 || [[#GetAppletStateChangedEvent]] ||
 
|-
=== OpenMyGpuErrorHandler ===
| 1 || [[#IsCompleted]] ||
No input, returns an [[#IGpuErrorHandler]].
 
The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.
 
=== GetOperationModeSystemInfo ===
No input, returns an output u32.
 
This returns the output from [[#GetOperationModeSystemInfo_2|omm GetOperationModeSystemInfo]].
 
=== GetSettingsPlatformRegion ===
No input, returns an output u8.
 
This just returns the output from [[Settings_services#GetPlatformRegion|setsys GetPlatformRegion]].
 
=== ActivateMigrationService ===
No input/output.
 
=== DeactivateMigrationService ===
No input/output.
 
=== DisableSleepTillShutdown ===
No input/output.
 
=== SuppressDisablingSleepTemporarily ===
Takes an input u64 "nn::TimeSpanType", no output.
 
=== SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled ===
No input/output.
 
=== IGpuErrorHandler ===
This is "nn::am::service::IGpuErrorHandler".
 
This was added with [11.0.0+].
 
This uses various [[NV_services#nvgem:cd|nvgem:cd]] commands.
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 10 || [[#Start]] ||
|-
|-
| 100 || [[#GetManualGpuErrorInfoSize]]
| 20 || [[#RequestExit]] ||
|-
|-
| 101 || [[#GetManualGpuErrorInfo]]
| 25 || [[#Terminate]] ||
|-
|-
| 102 || [[#GetManualGpuErrorDetectionSystemEvent]]
| 30 || [[#GetResult]] ||
|-
|-
| 103 || [[#FinishManualGpuErrorHandling]]
| 50 || [[#SetOutOfFocusApplicationSuspendingEnabled]] ||
|}
 
==== GetManualGpuErrorInfoSize ====
No input, returns an output u64.
 
==== GetManualGpuErrorInfo ====
Takes a type-0x6 output buffer, returns an output u64.
 
The OutBuffer_size must be >= the output size from [[#GetManualGpuErrorInfoSize]].
 
sdknso exposes the buffer as <code>void*</code>.
 
==== GetManualGpuErrorDetectionSystemEvent ====
No input, returns an output Event handle with EventClearMode=0.
 
==== FinishManualGpuErrorHandling ====
No input/output.
 
== ISelfController ==
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 60 || [10.0.0+] [[#PresetLibraryAppletGpuTimeSliceZero]] ||
|-
|-
| 0 || [[#Exit]]
| 70 || [S2] ||
|-
|-
| 1 || [[#LockExit]]
| 80 || [19.0.0+] RequestForLibraryAppletToGetForeground ||
|-
|-
| 2 || [[#UnlockExit]]
| 81 || [19.0.0+] GetCurrentChildLibraryApplet ||
|-
|-
| 3 || [2.0.0+] [[#EnterFatalSection]]
| 90 || [20.0.0+] ||
|-
|-
| 4 || [2.0.0+] [[#LeaveFatalSection]]
| 100 || [[#PushInData]] ||
|-
|-
| 9 || [[#GetLibraryAppletLaunchableEvent]]
| 101 || [[#PopOutData]] ||
|-
|-
| 10 || [[#SetScreenShotPermission]]
| 102 || [[#PushExtraStorage]] ||
|-
|-
| 11 || [[#SetOperationModeChangedNotification]]
| 103 || [[#PushInteractiveInData]] ||
|-
|-
| 12 || [[#SetPerformanceModeChangedNotification]]
| 104 || [[#PopInteractiveOutData]] ||
|-
|-
| 13 || [[#SetFocusHandlingMode]]
| 105 || [[#GetPopOutDataEvent]] ||
|-
|-
| 14 || [[#SetRestartMessageEnabled]]
| 106 || [[#GetPopInteractiveOutDataEvent]] ||
|-
|-
| 15 || [2.0.0+] [[#SetScreenShotAppletIdentityInfo]]
| 110 || [[#NeedsToExitProcess]] ||
|-
|-
| 16 || [2.0.0+] [[#SetOutOfFocusSuspendingEnabled]]
| 120 || [[#GetLibraryAppletInfo]] ||
|-
|-
| 17 || [3.0.0+] [[#SetControllerFirmwareUpdateSection]]
| 150 || [[#RequestForAppletToGetForeground]] ||
|-
|-
| 18 || [3.0.0+] [[#SetRequiresCaptureButtonShortPressedMessage]]
| 160 || [2.0.0+] [[#GetIndirectLayerConsumerHandle]] ||
|-
|-
| 19 || [3.0.0+] [[#SetAlbumImageOrientation]]
| 170 || [22.0.0+]
|-
|}
| 20 || [4.0.0+] [[#SetDesirableKeyboardLayout]]
 
|-
Commands <=30 are inherited from [[#IAppletAccessor]]. GetLibraryAppletInfo is identical to the [[#ILibraryAppletSelfAccessor]] cmd.
| 21 || [13.0.0+] GetScreenShotProgramId
 
|-
==== SetOutOfFocusApplicationSuspendingEnabled ====
| 40 || [[#CreateManagedDisplayLayer]]
Takes an input u8 bool, no output.
|-
 
| 41 || [4.0.0+] [[#IsSystemBufferSharingEnabled]]
Official sw will assert prior to using this if applet-service was not initialized as *Application.
|-
 
| 42 || [4.0.0+] [[#GetSystemSharedLayerHandle]]
==== PresetLibraryAppletGpuTimeSliceZero ====
|-
No input/output.
| 43 || [5.0.0+] [[#GetSystemSharedBufferHandle]]
 
sdknso only uses with with [[Software_Keyboard|swkbd-inline]], immediately after creating the LibraryApplet.
 
==== PushInData ====
Takes an input [[#IStorage]], no output.
 
==== PopOutData ====
No input, returns an output [[#IStorage]].
 
==== PushExtraStorage ====
Takes an input [[#IStorage]], no output.
 
==== PushInteractiveInData ====
Takes an input [[#IStorage]], no output.
 
==== PopInteractiveOutData ====
No input, returns an output [[#IStorage]].
 
==== GetPopOutDataEvent ====
No input, returns an output handle with autoclear=false.
 
==== GetPopInteractiveOutDataEvent ====
No input, returns an output event handle with autoclear=false.
 
==== NeedsToExitProcess ====
No input, returns an output u8 bool.
 
Stubbed, just returns an error.
 
==== RequestForAppletToGetForeground ====
No input/output.
 
Stubbed, just returns an error.
 
==== GetIndirectLayerConsumerHandle ====
Takes an input PID and an input u64 AppletResourceUserId, returns an output u64 IndirectLayerConsumerHandle.
 
Official sw uses this during LibraryApplet creation when [[#LibraryAppletMode]] is 0x3.
 
== ICommonStateGetter ==
This is "nn::am::service::ICommonStateGetter".
 
{| class="wikitable" border="1"
|-
|-
| 44 || [10.0.0+] [[#CreateManagedDisplaySeparableLayer]]
! Cmd || Name
|-
|-
| 45 || [10.0.0+] [[#SetManagedDisplayLayerSeparationMode]]
| 0 || [[#GetEventHandle]]
|-
|-
| 46 || [13.0.0+] [[#SetRecordingLayerCompositionEnabled]]
| 1 || [[#ReceiveMessage]]
|-
|-
| 50 || [[#SetHandlesRequestToDisplay]]
| 2 || [[#GetThisAppletKind]]
|-
|-
| 51 || [[#ApproveToDisplay]]
| 3 || [[#AllowToEnterSleep]]
|-
|-
| 60 || [[#OverrideAutoSleepTimeAndDimmingTime]]
| 4 || [[#DisallowToEnterSleep]]
|-
|-
| 61 || [[#SetMediaPlaybackState]]
| 5 || [[#GetOperationMode]]
|-
|-
| 62 || [[#SetIdleTimeDetectionExtension]]
| 6 || [[#GetPerformanceMode]]
|-
|-
| 63 || [[#GetIdleTimeDetectionExtension]]
| 7 || [[#GetCradleStatus]]
|-
|-
| 64 || [[#SetInputDetectionSourceSet]]
| 8 || [[#GetBootMode]]
|-
|-
| 65 || [2.0.0+] [[#ReportUserIsActive]]
| 9 || [[#GetCurrentFocusState]]
|-
|-
| 66 || [3.0.0+] [[#GetCurrentIlluminance]]
| 10 || [[#RequestToAcquireSleepLock]]
|-
|-
| 67 || [3.0.0+] [[#IsIlluminanceAvailable]]
| 11 || [[#ReleaseSleepLock]]
|-
|-
| 68 || [5.0.0+] [[#SetAutoSleepDisabled]]
| 12 || [[#ReleaseSleepLockTransiently]]
|-
|-
| 69 || [5.0.0+] [[#IsAutoSleepDisabled]]
| 13 || [[#GetAcquiredSleepLockEvent]]
|-
|-
| 70 || [4.0.0+] [[#ReportMultimediaError]]
| 14 || [11.0.0+] [[#GetWakeupCount]]
|-
|-
| 71 || [5.0.0+] [[#GetCurrentIlluminanceEx]]
| 15 || [19.0.0+]  
|-
|-
| 72 || [9.0.0+] [[#SetInputDetectionPolicy]]
| 20 || [[#PushToGeneralChannel]]
|-
|-
| 80 || [4.0.0+] [[#SetWirelessPriorityMode]]
| 30 || [[#GetHomeButtonReaderLockAccessor]]
|-
|-
| 90 || [6.0.0+] [[#GetAccumulatedSuspendedTickValue]]
| 31 || [2.0.0+] [[#GetReaderLockAccessorEx]]
|-
|-
| 91 || [6.0.0+] [[#GetAccumulatedSuspendedTickChangedEvent]]
| 32 || [7.0.0+] [[#GetWriterLockAccessorEx]]
|-
|-
| 100 || [7.0.0+] [[#SetAlbumImageTakenNotificationEnabled]]
| 40 || [2.0.0+] [[#GetCradleFwVersion]]
|-
| 50 || [3.0.0+] [[#IsVrModeEnabled]]
|-
| 51 || [3.0.0+] [[#SetVrModeEnabled]]
|-
| 52 || [4.0.0+] [[#SetLcdBacklighOffEnabled]]
|-
| 53 || [7.0.0+] [[#BeginVrModeEx]]
|-
| 54 || [7.0.0+] [[#EndVrModeEx]]
|-
| 55 || [3.0.0+] [[#IsInControllerFirmwareUpdateSection]]
|-
| 59 || [11.0.0+] [[#SetVrPositionForDebug]]
|-
| 60 || [3.0.0+] [[#GetDefaultDisplayResolution]]
|-
|-
| 110 || [8.0.0+] [[#SetApplicationAlbumUserData]]
| 61 || [3.0.0+] [[#GetDefaultDisplayResolutionChangeEvent]]
|-
|-
| 120 || [11.0.0+] [[#SaveCurrentScreenshot]]
| 62 || [4.0.0+] [[#GetHdcpAuthenticationState]]
|-
|-
| 130 || [13.0.0+] [[#SetRecordVolumeMuted]]
| 63 || [4.0.0+] [[#GetHdcpAuthenticationStateChangeEvent]]
|-
|-
| 1000 || [7.0.0+] [[#GetDebugStorageChannel]]
| 64 || [5.0.0+] [[#SetTvPowerStateMatchingMode]]
|}
|-
 
| 65 || [5.1.0+] [[#GetApplicationIdByContentActionName]]
=== Exit ===
|-
No input/output.
| 66 || [6.0.0+] [[#SetCpuBoostMode]]
 
|-
Exits the current applet. On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.
| 67 || [10.0.0+] [[#CancelCpuBoostMode]]
 
=== LockExit ===
No input/output.
 
Locks exit process of pressing X to close in HOME Menu for an application or HOME button for an applet. When locked, it will show the "waiting for software to be closed dialog" until UnlockExit is called or a 15 seconds timeout (when the latter occurs, the process is force-terminated).
 
=== UnlockExit ===
No input/output.
 
Unlocks exit process, if LockExit was previously used.
 
=== EnterFatalSection ===
No input/output.
 
=== LeaveFatalSection ===
No input/output.
 
[[#EnterFatalSection]] must be executed at least once before executing this command, otherwise error code 0x40080 will be returned. EnterFatalSection and LeaveFatalSection work in pairs, that is, N calls to EnterFatalSection must be performed first in order to perform N executions of LeaveFatalSection. Essentially, these two functions operate like how one would lock and unlock a recursive mutex.
 
=== GetLibraryAppletLaunchableEvent ===
No input, returns an output event handle with autoclear=false.
 
=== SetScreenShotPermission ===
Takes an input s32. No output.
 
Controls whether screenshot-capture is allowed.
 
{| class="wikitable" border="1"
|-
|-
! Value || Description
| 68 || [11.0.0+] [[#GetBuiltInDisplayType]]
|-
|-
| 0 || Inherit from parent applet
| 80 || [6.0.0+] [[#PerformSystemButtonPressingIfInFocus]]
|-
|-
| 1 || Enable
| 90 || [7.0.0+] [[#SetPerformanceConfigurationChangedNotification]]
|-
|-
| 2 || Disable
| 91 || [7.0.0+] [[#GetCurrentPerformanceConfiguration]]
|-
|-
|}
| 100 || [9.1.0+] [[#SetHandlingHomeButtonShortPressedEnabled]]
 
|-
=== SetOperationModeChangedNotification ===
| 110 || [11.0.0+] [[#OpenMyGpuErrorHandler]]
Takes an input u8 bool flag. No output.
|-
 
| 120 || [13.0.0+] GetAppletLaunchedHistory
=== SetPerformanceModeChangedNotification ===
|-
Takes an input u8 bool flag. No output.
| 130 || [21.0.0+] EnableStartupLogoDisappearedMessage
|-
| 200 || [7.0.0+] [[#GetOperationModeSystemInfo]]
|-
| 300 || [9.0.0+] [[#GetSettingsPlatformRegion]]
|-
| 400 || [10.0.0+] [[#ActivateMigrationService]]
|-
| 401 || [10.0.0+] [[#DeactivateMigrationService]]
|-
| 500 || [11.0.0+] [[#DisableSleepTillShutdown]]
|-
| 501 || [11.0.0+] [[#SuppressDisablingSleepTemporarily]]
|-
| 502 || [12.0.0+] IsSleepEnabled
|-
| 503 || [12.0.0+] IsDisablingSleepSuppressed
|-
| 600 || [20.0.0+] SetHidInputMagnificationForApplication ([17.0.0-18.1.0] OpenNamedChannelAsChild)
|-
| 610 || [21.0.0+]
|-
| 611 || [22.0.0+]
|-
| 650 || [S2] BeginUsingCameraResource
|-
| 651 || [S2] EndUsingCameraResource
|-
| 900 || [11.0.0+] [[#SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled]]
|-
| 910 || [17.0.0+] GetLaunchRequiredTick
|-
| 1000 || [19.0.0+] BeginVrMode3d
|-
| 1001 || [19.0.0+] EndVrMode3d
|-
| 1002 || [19.0.0+] IsVrModeEnabled3d
|-
| 1003 || [21.0.0+] GetVrLaboGoggleViewport
|-
| 1004 || [21.0.0+] GetPanelPhysicalSizeForSpecificTitle
|-
| 1005 || [21.0.0+] GetPanelResolutionForSpecificTitle
|-
| 2000 || [S2] SetRtcModeChangedMessageEnabled
|-
| 2010 || [S2] GetCurrentDisplayLayoutRatio
|}


=== SetFocusHandlingMode ===
Officially notification messages are handled by the application itself, not sdk-nso in ExeFS. Official apps call code in sdk-nso which basically uses svcWaitSynchronization with the event from [[#GetEventHandle]] to check whether a message is available, then if so it uses [[#ReceiveMessage]]. The actual handling for message IDs is done in the app itself(see [[#AppletMessage]]).
Takes 3 input u8s with each field located immediately after the previous u8, these are bool flags. No output.


=== SetRestartMessageEnabled ===
[7.0.0+] User-processes now use BeginVrModeEx/EndVrModeEx instead of [[#SetVrModeEnabled]]. Prior to using using BeginVrModeEx, [[Parental_Control_services|pctl]] IsStereoVisionPermitted is used and error 0xD08E is thrown if not allowed by pctl.
Takes an input u8 bool flag, no output.


See [[#AppletMessage]].
=== GetEventHandle ===
No input. Returns an output event handle. This is signalled when a message is available with [[#ReceiveMessage]].


=== SetScreenShotAppletIdentityInfo ===
=== ReceiveMessage ===
Takes an input [[#AppletIdentityInfo]], no output.
No input. Returns an output [[#AppletMessage]]. Error 0x680 indicates no message is available.


=== SetOutOfFocusSuspendingEnabled ===
=== GetThisAppletKind ===
Takes an input u8 bool flag. No output.
No input, returns an output [[#AppletKind]].


=== SetControllerFirmwareUpdateSection ===
Stubbed, just returns an error.
Takes an input u8 bool flag, no output.


This throws error 0x40280 when the internal state flag already matches the input value.
=== AllowToEnterSleep ===
No input/output.


=== SetRequiresCaptureButtonShortPressedMessage ===
Stubbed, just returns an error.
Takes an input u8 bool flag, no output.


See [[#AppletMessage]].
=== DisallowToEnterSleep ===
No input/output.


When enabled with a non-Overlay applet, Overlay applet will not be notified of capture button short-presses for screenshots.
Stubbed, just returns an error.


=== SetAlbumImageOrientation ===
=== GetOperationMode ===
Takes an input u32 "nn::album::ImageOrientation". No output.
No input. Returns an output u8 for the current [[#OperationMode]].


The input value must not be >3.
=== GetPerformanceMode ===
No input. Returns an output u32 for the current [[#PerformanceMode]].


=== SetDesirableKeyboardLayout ===
=== GetCradleStatus ===
Takes an input u32, no output.
No input, returns an output u8.


The input u32 is "nn::settings::KeyboardLayout".
This uses [[#omm]] GetCradleStatus.


=== CreateManagedDisplayLayer ===
=== GetBootMode ===
Returns an output u64 LayerId which is then used by the user-process with [[Display_services#OpenLayer]].
No input, returns an output u8.
 
Returns the value from [[Process_Manager_services|pm:bm]] GetBootMode.
 
=== GetCurrentFocusState ===
No input. Returns an output u8 [[#FocusState]].


=== IsSystemBufferSharingEnabled ===
=== RequestToAcquireSleepLock ===
No input/output.
No input/output.


Not available when the current applet is an Application ([[#AppletId]] == 0x01).
=== ReleaseSleepLock ===
No input/output.


Checks whether SystemBufferSharing is enabled, throwing an error otherwise.
=== ReleaseSleepLockTransiently ===
No input/output.


=== GetSystemSharedLayerHandle ===
=== GetAcquiredSleepLockEvent ===
No input, returns two output u64s "nn::vi::fbshare::SharedBufferHandle" and "nn::vi::fbshare::SharedLayerHandle".
No input, returns an output Event handle with autoclear=false.


Runs code similar to [[#IsSystemBufferSharingEnabled]] first.
=== GetWakeupCount ===
No input, returns an output u64.


=== GetSystemSharedBufferHandle ===
=== PushToGeneralChannel ===
No input, returns an output u64 "nn::vi::fbshare::SharedBufferHandle".
Takes an input [[#IStorage]], no output.


Runs code similar to [[#IsSystemBufferSharingEnabled]] first.
This is not usable under an Application, however it is usable under a LibraryApplet.


Same as [[#GetSystemSharedLayerHandle]] except this just gets the SharedBufferHandle.
Used for sending requests to [[qlaunch]]. sdk-nso creates a 0x10-byte storage which is sent to this. The following are the functions which use this, with the data written to the storage:
* <code>RequestHomeMenu</code> <code>5341 4d53 0100 0000 0200 0000 0100 0000</code> Returns to the main Home Menu, equivalent to pressing the HOME button.
* <code>RequestJumpToSystemUpdate</code> <code>5341 4d53 0100 0000 0b00 0000 0100 0000</code> Equivalent to entering "System Update" under System Settings. When leaving this, it returns to the main Home Menu.


=== CreateManagedDisplaySeparableLayer ===
=== GetHomeButtonReaderLockAccessor ===
No input, returns two output u64 LayerIds.
No input, returns an output [[#ILockAccessor]].


sdknso now uses this instead of [[#CreateManagedDisplayLayer]]. sdknso caches the output from the cmd so that it's only used once. The first u64 is used the same as the original LayerId from [[#CreateManagedDisplayLayer]]. <code>nn::vi::CreateRecordingLayer</code> uses the second LayerId, the layer creation is identical besides which LayerId is used.
Similar to using [[#GetReaderLockAccessorEx]] with inval=0.


=== SetManagedDisplayLayerSeparationMode ===
=== GetReaderLockAccessorEx ===
Takes an input u32, no output.
Takes an input u32, returns an output [[#ILockAccessor]].


sdknso exposes this as <code>nn::vi::SetRecordingLayerEnabled(bool)</code>.
The input value must be 0-3. 0 = HomeButton.


The input u32 must be 0-1.
=== GetWriterLockAccessorEx ===
Takes an input u32, returns an output [[#ILockAccessor]].


=== SetRecordingLayerCompositionEnabled ===
The input value must be 0-3. 0 = HomeButton.
Takes an input bool, no output.


=== SetHandlesRequestToDisplay ===
=== GetCradleFwVersion ===
Takes an input u8 bool, no output.
No input, returns 4 output u32s.


Sets an internal state flag. When the input flag is 0, this will in additional run the same code as [[#ApproveToDisplay]].
This uses [[#omm]] GetCradleFwVersion.


See [[#AppletMessage]].
=== IsVrModeEnabled ===
No input, returns an output u8 bool.


=== ApproveToDisplay ===
=== SetVrModeEnabled ===
No input/output.
Takes an input u8 bool flag. No output.


Used to handle the notification enabled by [[#SetHandlesRequestToDisplay]].
Updates internal AM state fields. If the new state doesn't match the previous state, this uses the [[Backlight_services]] {Disable/Enable}VrMode command depending on whether flag={disable/enable}.


=== OverrideAutoSleepTimeAndDimmingTime ===
When the VrMode is set to true, the console shows a screen rendered like vr asking the user to move his face away and hit the 'close' button. When this button is pressed, the console resets the vrMode to false.
Takes 4 input s32s, no output.


=== SetMediaPlaybackState ===
=== SetLcdBacklighOffEnabled ===
Takes an input u8 bool, no output.
Takes an input u8 bool, no output.


=== SetIdleTimeDetectionExtension ===
Sets whether the LCD screen blacklight is turned off.
Takes an input u32, no output.


The input value must be 0-2: 0 = disabled, 1 = Extended, and 2 = ExtendedUnsafe.
=== BeginVrModeEx ===
No input/output.


=== GetIdleTimeDetectionExtension ===
Identical to [[#SetVrModeEnabled]] except with hard-coded flag=1.
No input, returns an output u32.


Returns the value set by [[#SetIdleTimeDetectionExtension]].
=== EndVrModeEx ===
 
=== SetInputDetectionSourceSet ===
Takes an input u32, no output.
 
=== ReportUserIsActive ===
No input/output.
No input/output.


Uses idle:sys ReportUserIsActive.
Identical to [[#SetVrModeEnabled]] except with hard-coded flag=0.


Reports that the user is active, for idle detection (screen dimming / auto-sleep). This is equivalent to when the user uses HID input.
=== IsInControllerFirmwareUpdateSection ===
No input, returns an output u8 bool.


=== GetCurrentIlluminance ===
=== SetVrPositionForDebug ===
No input, returns an output float.
Takes 4 input s32s, no output.


Uses [[Backlight_services|lbl]] command GetAmbientLightSensorValue, where only the output float is used.
The s32s are: x, y, width, height.


=== IsIlluminanceAvailable ===
The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.
No input, returns an output u8 bool.


Uses [[Backlight_services|lbl]] command IsAmbientLightSensorAvailable.
width must be 1-1280, height must be 1-720.


User-processes can use this to determine whether to continue with using GetCurrentIlluminance(Ex).
x and y must not be negative. x+width must be <=1280. y+height must be <=720.


=== SetAutoSleepDisabled ===
=== GetDefaultDisplayResolution ===
Takes an input u8 bool, no output.
No input, returns two output s32s '''width''' and '''height'''.


=== IsAutoSleepDisabled ===
=== GetDefaultDisplayResolutionChangeEvent ===
No input, returns an output u8 bool.
No input, returns an output Event handle with autoclear=true.


=== ReportMultimediaError ===
=== GetHdcpAuthenticationState ===
Takes an input Result and a type-0x5 input buffer, no output.
No input, returns an output s32.


The buffer contains a 0x138-byte "movie::MultimediaTelemetryReport" struct.
=== GetHdcpAuthenticationStateChangeEvent ===
No input, returns an output Event handle with autoclear=true.


=== GetCurrentIlluminanceEx ===
=== SetTvPowerStateMatchingMode ===
No input, returns an output u8 bool and float.
Takes an input s32 [[#TvPowerStateMatchingMode]], no output.
 
=== GetApplicationIdByContentActionName ===
Takes a type-0x5 input buffer containing a string, returns an output [[NCM_services#ApplicationId|ApplicationId]].
 
Gets the ApplicationId for the specified ContentActionName string. Returns an error when the current [[#AppletId]] isn't 0x04 (when the current applet isn't a SystemApplication).


Uses [[Backlight_services|lbl]] command GetAmbientLightSensorValue.
=== SetCpuBoostMode ===
Takes an input u32 [[#CpuBoostMode]] and passes it to [[PPC_services#apm:sys|SetCpuBoostMode]].


=== SetInputDetectionPolicy ===
=== CancelCpuBoostMode ===
Takes an input [[#InputDetectionPolicy]], no output.
No input/output.


=== SetWirelessPriorityMode ===
=== GetBuiltInDisplayType ===
Takes an input s32 [[#WirelessPriorityMode]], no output.
No input, returns an output s32.


=== GetAccumulatedSuspendedTickValue ===
This is not exposed by sdknso.
No input, returns an output u64 tick value.


Gets the total time in ticks that the process was suspended, relative to when the applet-service was last initialized.
This loads a s32 index from global state (originates from [[SPL_services#GetConfig|GetConfig]] [[SMC#HardwareType|HardwareType]]), Aborts if it's out-of-bounds, then the following is returned for the output s32: global_array[loaded_index].


=== GetAccumulatedSuspendedTickChangedEvent ===
=== PerformSystemButtonPressingIfInFocus ===
No input, returns an output Event handle with autoclear=true.
Takes an input [[#SystemButtonType]], no output.


This is signaled when the output from [[#GetAccumulatedSuspendedTickValue]] is updated.
Just returns 0 when a state field is not value 1. Verifies that the input button is allowed, then calls the same func as [[#PerformSystemButtonPressing]] internally.


=== SetAlbumImageTakenNotificationEnabled ===
=== SetPerformanceConfigurationChangedNotification ===
Takes an input u8 bool, no output.
Takes an input u8 bool, no output.


See [[#AppletMessage]].
=== GetCurrentPerformanceConfiguration ===
No input, returns the result of calling [[PPC_services#apm:sys|GetCurrentPerformanceConfiguration]].


=== SetApplicationAlbumUserData ===
=== OpenMyGpuErrorHandler ===
Takes a type-0x21 input buffer, no output.
No input, returns an [[#IGpuErrorHandler]].


The buffer contains arbitrary UserData.
The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.


The size must be <=0x400. The input buffer is copied to a buffer loaded from a state ptr (throwing an error when the state ptr is not set), with the u32 size being written to statebuf+0x400 afterwards.
=== GetOperationModeSystemInfo ===
No input, returns an output u32.
 
This returns the output from [[#GetOperationModeSystemInfo_2|omm GetOperationModeSystemInfo]].


=== SaveCurrentScreenshot ===
=== GetSettingsPlatformRegion ===
Takes an input s32 [[Capture_services#AlbumReportOption|AlbumReportOption]], no output.
No input, returns an output u8.
 
This just returns the output from [[Settings_services#GetPlatformRegion|setsys GetPlatformRegion]].
 
=== ActivateMigrationService ===
No input/output.
 
Besides various other functionality, if required this eventually uses [[NS_Services|ns]] LaunchLibraryApplet to launch [[Migration_services|migration]].
 
=== DeactivateMigrationService ===
No input/output.
 
=== DisableSleepTillShutdown ===
No input/output.


sdknso exposes this under "nn::album::".
=== SuppressDisablingSleepTemporarily ===
Takes an input u64 "nn::TimeSpanType", no output.


=== SetRecordVolumeMuted ===
=== SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled ===
Takes an input bool, no output.
No input/output.


=== GetDebugStorageChannel ===
=== IGpuErrorHandler ===
No input, returns an output [[#IStorageChannel]].
This is "nn::am::service::IGpuErrorHandler".


The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise an error is returned.
This was added with [11.0.0+].


== IStorageChannel ==
This uses various [[NV_services#nvgem:cd|nvgem:cd]] commands.
Added with [[7.0.0]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
! Cmd || Name
|-
|-
| 0 || Push || No input, returns an output [[#IStorage]].
| 100 || [[#GetManualGpuErrorInfoSize]]
|-
|-
| 1 || Unpop || No input, returns an output [[#IStorage]].
| 101 || [[#GetManualGpuErrorInfo]]
|-
|-
| 2 || Pop || No input, returns an output [[#IStorage]].
| 102 || [[#GetManualGpuErrorDetectionSystemEvent]]
|-
|-
| 3 || GetPopEventHandle || No input, returns an output handle.
| 103 || [[#FinishManualGpuErrorHandling]]
|-
| 4 || Clear || No input/output.
|}
|}


== IWindowController ==
==== GetManualGpuErrorInfoSize ====
No input, returns an output u64.
 
==== GetManualGpuErrorInfo ====
Takes a type-0x6 output buffer, returns an output u64.
 
The OutBuffer_size must be >= the output size from [[#GetManualGpuErrorInfoSize]].
 
sdknso exposes the buffer as <code>void*</code>.
 
==== GetManualGpuErrorDetectionSystemEvent ====
No input, returns an output Event handle with EventClearMode=0.
 
==== FinishManualGpuErrorHandling ====
No input/output.
 
== ISelfController ==
This is "nn::am::service::ISelfController".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
! Cmd || Name
|-
|-
| 0 || [[#CreateWindow]] ||
| 0 || [[#Exit]]
|-
|-
| 1 || [[#GetAppletResourceUserId]] ||
| 1 || [[#LockExit]]
|-
|-
| 2 || [6.0.0+] [[#GetAppletResourceUserIdOfCallerApplet]] ||
| 2 || [[#UnlockExit]]
|-
|-
| 10 || [[#AcquireForegroundRights]] ||
| 3 || [2.0.0+] [[#EnterFatalSection]]
|-
|-
| 11 || [[#ReleaseForegroundRights]] ||
| 4 || [2.0.0+] [[#LeaveFatalSection]]
|-
|-
| 12 || [[#RejectToChangeIntoBackground]] ||
| 9 || [[#GetLibraryAppletLaunchableEvent]]
|-
|-
| 20 || [7.0.0+] [[#SetAppletWindowVisibility]] ||
| 10 || [[#SetScreenShotPermission]]
|-
|-
| 21 || [7.0.0+] [[#SetAppletGpuTimeSlice]] ||
| 11 || [[#SetOperationModeChangedNotification]]
|}
 
=== CreateWindow ===
Takes an input u32, returns an output [[#IWindow]].
 
Stubbed, just returns an error.
 
=== GetAppletResourceUserId ===
No input, returns an output u64 [[#AppletResourceUserId]].
 
=== GetAppletResourceUserIdOfCallerApplet ===
No input, returns an output u64 [[#AppletResourceUserId]].
 
=== AcquireForegroundRights ===
No input/output.
 
Just returns 0.
 
=== ReleaseForegroundRights ===
No input/output.
 
Just returns 0.
 
=== RejectToChangeIntoBackground ===
No input/output.
 
Just returns 0.
 
=== SetAppletWindowVisibility ===
Takes an input u8 bool, no output.
 
=== SetAppletGpuTimeSlice ===
Takes an input s64, no output.
 
The input s64 must not be negative.
 
== IAudioController ==
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 12 || [[#SetPerformanceModeChangedNotification]]
|-
|-
| 0 || [[#SetExpectedMasterVolume]]
| 13 || [[#SetFocusHandlingMode]]
|-
|-
| 1 || [[#GetMainAppletExpectedMasterVolume]]
| 14 || [[#SetRestartMessageEnabled]]
|-
|-
| 2 || [[#GetLibraryAppletExpectedMasterVolume]]
| 15 || [2.0.0+] [[#SetScreenShotAppletIdentityInfo]]
|-
|-
| 3 || [[#ChangeMainAppletMasterVolume]]
| 16 || [2.0.0+] [[#SetOutOfFocusSuspendingEnabled]]
|-
|-
| 4 || [[#SetTransparentVolumeRate]]
| 17 || [3.0.0+] [[#SetControllerFirmwareUpdateSection]]
|}
 
GetMainAppletExpectedMasterVolume/SetExpectedMasterVolume are used for saving/restoring state for LibraryApplet launching, with SetExpectedMasterVolume being used with new state prior to launching a LibraryApplet. With official sw these applet funcs are used directly in the main-codebin.
 
=== SetExpectedMasterVolume ===
Takes two input floats, no output.
 
Writes the input floats to state: first one is used by [[#GetMainAppletExpectedMasterVolume]], second one is used by [[#GetLibraryAppletExpectedMasterVolume]].
 
=== GetMainAppletExpectedMasterVolume ===
No input, returns an output float.
 
=== GetLibraryAppletExpectedMasterVolume ===
No input, returns an output float.
 
=== ChangeMainAppletMasterVolume ===
Takes an input float and an input u64, no output.
 
=== SetTransparentVolumeRate ===
Takes an input float, no output.
 
== IDisplayController ==
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 18 || [3.0.0+] [[#SetRequiresCaptureButtonShortPressedMessage]]
|-
|-
| 0 || [[#GetLastForegroundCaptureImage]]
| 19 || [3.0.0+] [[#SetAlbumImageOrientation]]
|-
|-
| 1 || [[#UpdateLastForegroundCaptureImage]]
| 20 || [4.0.0+] [[#SetDesirableKeyboardLayout]]
|-
|-
| 2 || [[#GetLastApplicationCaptureImage]]
| 21 || [13.0.0+] GetScreenShotProgramId
|-
|-
| 3 || [[#GetCallerAppletCaptureImage]]
| 22 || [19.0.0+] GetScreenShotAcdIndex
|-
|-
| 4 || [[#UpdateCallerAppletCaptureImage]]
| 23 || [19.0.0+] GetScreenShotApparentPlatform
|-
|-
| 5 || [[#GetLastForegroundCaptureImageEx]]
| 24 || [19.0.0+] GetScreenShotApplicationProperty
|-
|-
| 6 || [[#GetLastApplicationCaptureImageEx]]
| 40 || [[#CreateManagedDisplayLayer]]
|-
|-
| 7 || [[#GetCallerAppletCaptureImageEx]]
| 41 || [4.0.0+] [[#IsSystemBufferSharingEnabled]]
|-
|-
| 8 || [2.0.0+] [[#TakeScreenShotOfOwnLayer]]
| 42 || [4.0.0+] [[#GetSystemSharedLayerHandle]]
|-
|-
| 9 || [5.0.0+] [[#CopyBetweenCaptureBuffers]]
| 43 || [5.0.0+] [[#GetSystemSharedBufferHandle]]
|-
|-
| 10 || [[#AcquireLastApplicationCaptureBuffer]]
| 44 || [10.0.0+] [[#CreateManagedDisplaySeparableLayer]]
|-
|-
| 11 || [[#ReleaseLastApplicationCaptureBuffer]]
| 45 || [10.0.0+] [[#SetManagedDisplayLayerSeparationMode]]
|-
|-
| 12 || [[#AcquireLastForegroundCaptureBuffer]]
| 46 || [13.0.0+] [[#SetRecordingLayerCompositionEnabled]]
|-
|-
| 13 || [[#ReleaseLastForegroundCaptureBuffer]]
| 50 || [[#SetHandlesRequestToDisplay]]
|-
|-
| 14 || [[#AcquireCallerAppletCaptureBuffer]]
| 51 || [[#ApproveToDisplay]]
|-
|-
| 15 || [[#ReleaseCallerAppletCaptureBuffer]]
| 60 || [[#OverrideAutoSleepTimeAndDimmingTime]]
|-
|-
| 16 || [[#AcquireLastApplicationCaptureBufferEx]]
| 61 || [[#SetMediaPlaybackState]]
|-
|-
| 17 || [[#AcquireLastForegroundCaptureBufferEx]]
| 62 || [[#SetIdleTimeDetectionExtension]]
|-
|-
| 18 || [[#AcquireCallerAppletCaptureBufferEx]]
| 63 || [[#GetIdleTimeDetectionExtension]]
|-
|-
| 20 || [3.0.0+] [[#ClearCaptureBuffer]]
| 64 || [[#SetInputDetectionSourceSet]]
|-
|-
| 21 || [3.0.0+] [[#ClearAppletTransitionBuffer]]
| 65 || [2.0.0+] [[#ReportUserIsActive]]
|-
|-
| 22 || [4.0.0+] [[#AcquireLastApplicationCaptureSharedBuffer]]
| 66 || [3.0.0+] [[#GetCurrentIlluminance]]
|-
|-
| 23 || [4.0.0+] [[#ReleaseLastApplicationCaptureSharedBuffer]]
| 67 || [3.0.0+] [[#IsIlluminanceAvailable]]
|-
|-
| 24 || [4.0.0+] [[#AcquireLastForegroundCaptureSharedBuffer]]
| 68 || [5.0.0+] [[#SetAutoSleepDisabled]]
|-
|-
| 25 || [4.0.0+] [[#ReleaseLastForegroundCaptureSharedBuffer]]
| 69 || [5.0.0+] [[#IsAutoSleepDisabled]]
|-
| 70 || [4.0.0+] [[#ReportMultimediaError]]
|-
| 71 || [5.0.0+] [[#GetCurrentIlluminanceEx]]
|-
| 72 || [9.0.0+] [[#SetInputDetectionPolicy]]
|-
| 73 || [21.0.0+]
|-
| 80 || [4.0.0+] [[#SetWirelessPriorityMode]]
|-
| 90 || [6.0.0+] [[#GetAccumulatedSuspendedTickValue]]
|-
| 91 || [6.0.0+] [[#GetAccumulatedSuspendedTickChangedEvent]]
|-
| 100 || [7.0.0+] [[#SetAlbumImageTakenNotificationEnabled]]
|-
| 110 || [8.0.0+] [[#SetApplicationAlbumUserData]]
|-
| 120 || [11.0.0+] [[#SaveCurrentScreenshot]]
|-
| 130 || [13.0.0+] [[#SetRecordVolumeMuted]]
|-
| 200 || [20.0.0+]
|-
| 210 || [20.0.0+]
|-
| 211 || [20.0.0+]
|-
| 220 || [20.0.0+]
|-
| 221 || [20.0.0+]
|-
| 230 || [20.0.0+]
|-
| 1000 || [7.0.0+] [[#GetDebugStorageChannel]]
|-
| 2000 || [S2] [[#GetGraphicsSupervisor]]
|-
| 2100 || [S2] SetRecordingLayerEnabled
|-
| 2200 || [S2] SetSharingLayerEnabled
|-
| 2300 || [S2] [20.0.0+] SetCopyrightLayerEnabled
|-
|-
| 26 || [4.0.0+] [[#AcquireCallerAppletCaptureSharedBuffer]]
| 2400 || [S2] SetRtcScreenSharingAudioEnabled
|-
|-
| 27 || [4.0.0+] [[#ReleaseCallerAppletCaptureSharedBuffer]]
| 2401 || [S2] [20.0.0+] SetStreamPlayMirroringAudioEnabled
|-
|-
| 28 || [6.0.0+] [[#TakeScreenShotOfOwnLayerEx]]
| 2402 || [S2] [20.0.0+]
|}
|}


=== GetLastForegroundCaptureImage ===
=== Exit ===
Takes a type-0x6 output buffer.
No input/output.


Stubbed, just returns an error.
Exits the current applet. On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.


=== UpdateLastForegroundCaptureImage ===
=== LockExit ===
No input/output.
No input/output.


=== GetLastApplicationCaptureImage ===
Locks exit process of pressing X to close in HOME Menu for an application or HOME button for an applet. When locked, it will show the "waiting for software to be closed dialog" until UnlockExit is called or a 15 seconds timeout (when the latter occurs, the process is force-terminated).
Takes a type-0x6 output buffer.


Stubbed, just returns an error.
=== UnlockExit ===
No input/output.


=== GetCallerAppletCaptureImage ===
Unlocks exit process, if LockExit was previously used.
Takes a type-0x6 output buffer.


Stubbed, just returns an error.
=== EnterFatalSection ===
No input/output.


=== UpdateCallerAppletCaptureImage ===
=== LeaveFatalSection ===
No input/output.
No input/output.


Calls the same func internally as [[#UpdateLastForegroundCaptureImage]], except this passes param value 2 instead of 1.
[[#EnterFatalSection]] must be executed at least once before executing this command, otherwise error code 0x40080 will be returned. EnterFatalSection and LeaveFatalSection work in pairs, that is, N calls to EnterFatalSection must be performed first in order to perform N executions of LeaveFatalSection. Essentially, these two functions operate like how one would lock and unlock a recursive mutex.


=== GetLastForegroundCaptureImageEx ===
=== GetLibraryAppletLaunchableEvent ===
Takes a type-0x6 output buffer, returns an output u8 bool.
No input, returns an output event handle with autoclear=false.


The buffer size must match 0x384000.
=== SetScreenShotPermission ===
Takes an input s32. No output.


=== GetLastApplicationCaptureImageEx ===
Controls whether screenshot-capture is allowed.
Takes a type-0x6 output buffer, returns an output u8 bool.


The buffer size must match 0x384000.
{| class="wikitable" border="1"
 
|-
Calls the same internal func as [[#GetLastForegroundCaptureImageEx]], except that the last param is set to value 0 instead of 1.
! Value || Description
 
|-
=== GetCallerAppletCaptureImageEx ===
| 0 || Inherit from parent applet
Takes a type-0x6 output buffer, returns an output u8 bool.
|-
| 1 || Enable
|-
| 2 || Disable
|-
|}


The buffer size must match 0x384000.
=== SetOperationModeChangedNotification ===
Takes an input u8 bool flag. No output.


Calls the same internal func as [[#GetLastForegroundCaptureImageEx]], except that the last param is set to value 2 instead of 1.
=== SetPerformanceModeChangedNotification ===
Takes an input u8 bool flag. No output.


=== TakeScreenShotOfOwnLayer ===
=== SetFocusHandlingMode ===
Takes an input u8 bool and a s32, no output.
Takes 3 input u8s with each field located immediately after the previous u8, these are bool flags. No output.


=== CopyBetweenCaptureBuffers ===
=== SetRestartMessageEnabled ===
Takes two input s32s, no output.
Takes an input u8 bool flag, no output.


=== AcquireLastApplicationCaptureBuffer ===
See [[#AppletMessage]].
No input, returns an output handle.


Stubbed, just returns an error.
=== SetScreenShotAppletIdentityInfo ===
Takes an input [[#AppletIdentityInfo]], no output.


=== ReleaseLastApplicationCaptureBuffer ===
=== SetOutOfFocusSuspendingEnabled ===
No input/output.
Takes an input u8 bool flag. No output.


Clears a state field if it's not already 0, returning an error otherwise. On newer sysvers: then a func is called which just returns 0, then this cmd returns 0.
=== SetControllerFirmwareUpdateSection ===
Takes an input u8 bool flag, no output.


=== AcquireLastForegroundCaptureBuffer ===
This throws error 0x40280 when the internal state flag already matches the input value.
No input, returns an output handle.


Stubbed, just returns an error.
=== SetRequiresCaptureButtonShortPressedMessage ===
Takes an input u8 bool flag, no output.


=== ReleaseLastForegroundCaptureBuffer ===
See [[#AppletMessage]].
No input/output.


Same as [[#ReleaseLastApplicationCaptureBuffer]] except with a different state field + different input param for the called func.
When enabled with a non-Overlay applet, Overlay applet will not be notified of capture button short-presses for screenshots.


=== AcquireCallerAppletCaptureBuffer ===
=== SetAlbumImageOrientation ===
No input, returns an output handle.
Takes an input u32 "nn::album::ImageOrientation". No output.


Stubbed, just returns an error.
The input value must not be >3.


=== ReleaseCallerAppletCaptureBuffer ===
=== SetDesirableKeyboardLayout ===
No input/output.
Takes an input u32, no output.


Same as [[#ReleaseLastApplicationCaptureBuffer]] except with a different state field + different input param for the called func.
The input u32 is "nn::settings::KeyboardLayout".


=== AcquireLastApplicationCaptureBufferEx ===
=== CreateManagedDisplayLayer ===
No input, returns an output TransferMemory handle and an output u8 bool.
Returns an output u64 LayerId which is then used by the user-process with [[Display_services#OpenLayer]].


The state field used by [[#ReleaseLastApplicationCaptureBuffer]] must be 0. Calls a func which just returns an error (this is only the case on newer sysvers), hence this cmd will just return that error. If that func would have returned successfully, the state field would be set to 1 and the cmd would return 0.
=== IsSystemBufferSharingEnabled ===
No input/output.


On old sysvers, the output TransferMemory is size 0x384000 with permissions=RW.
Not available when the current applet is an Application ([[#AppletId]] == 0x01).


=== AcquireLastForegroundCaptureBufferEx ===
Checks whether SystemBufferSharing is enabled, throwing an error otherwise.
No input, returns an output TransferMemory handle and an output u8 bool.


Same as [[#AcquireLastApplicationCaptureBufferEx]] except this uses the [[#ReleaseLastForegroundCaptureBuffer]] state field, and uses a different input param value for the called func.
=== GetSystemSharedLayerHandle ===
No input, returns two output u64s "nn::vi::fbshare::SharedBufferHandle" and "nn::vi::fbshare::SharedLayerHandle".


=== AcquireCallerAppletCaptureBufferEx ===
Runs code similar to [[#IsSystemBufferSharingEnabled]] first.
No input, returns an output TransferMemory handle and an output u8 bool.


Same as [[#AcquireLastApplicationCaptureBufferEx]] except this uses the [[#ReleaseCallerAppletCaptureBuffer]] state field, and uses a different input param value for the called func.
=== GetSystemSharedBufferHandle ===
No input, returns an output u64 "nn::vi::fbshare::SharedBufferHandle".


=== ClearCaptureBuffer ===
Runs code similar to [[#IsSystemBufferSharingEnabled]] first.
Takes an input u8 bool, a s32 CaptureSharedBuffer, and an u32 color, returns no output.


Clear the input CaptureSharedBuffer with the specified RGBA8 color.
Same as [[#GetSystemSharedLayerHandle]] except this just gets the SharedBufferHandle.


=== ClearAppletTransitionBuffer ===
=== CreateManagedDisplaySeparableLayer ===
No input, returns two output u64 LayerIds.
 
sdknso now uses this instead of [[#CreateManagedDisplayLayer]]. sdknso caches the output from the cmd so that it's only used once. The first u64 is used the same as the original LayerId from [[#CreateManagedDisplayLayer]]. <code>nn::vi::CreateRecordingLayer</code> uses the second LayerId, the layer creation is identical besides which LayerId is used.
 
=== SetManagedDisplayLayerSeparationMode ===
Takes an input u32, no output.
Takes an input u32, no output.


Clear the AppletTransitionBuffer with the specified RGBA8 color.
sdknso exposes this as <code>nn::vi::SetRecordingLayerEnabled(bool)</code>.


=== AcquireLastApplicationCaptureSharedBuffer ===
The input u32 must be 0-1.
No input, returns an output u8 bool and an s32.


This loads data from state.
=== SetRecordingLayerCompositionEnabled ===
Takes an input bool, no output.


=== ReleaseLastApplicationCaptureSharedBuffer ===
=== SetHandlesRequestToDisplay ===
No input/output.
Takes an input u8 bool, no output.


Depending on whether a state field is 0, this just returns an error or returns 0.
Sets an internal state flag. When the input flag is 0, this will in additional run the same code as [[#ApproveToDisplay]].


=== AcquireLastForegroundCaptureSharedBuffer ===
See [[#AppletMessage]].
No input, returns an output u8 bool and an s32.


Calls the same func internally as [[#AcquireLastApplicationCaptureSharedBuffer]], except this passes value 1 for the last param instead of 0.
=== ApproveToDisplay ===
 
=== ReleaseLastForegroundCaptureSharedBuffer ===
No input/output.
No input/output.


Calls the same func internally as [[#ReleaseLastApplicationCaptureSharedBuffer]], except this passes value 1 for the last param instead of 0.
Used to handle the notification enabled by [[#SetHandlesRequestToDisplay]].


=== AcquireCallerAppletCaptureSharedBuffer ===
=== OverrideAutoSleepTimeAndDimmingTime ===
No input, returns an output u8 bool and an s32.
Takes 4 input s32s, no output.


Calls the same func internally as [[#AcquireLastApplicationCaptureSharedBuffer]], except this passes value 2 for the last param instead of 0.
=== SetMediaPlaybackState ===
Takes an input u8 bool, no output.


=== ReleaseCallerAppletCaptureSharedBuffer ===
=== SetIdleTimeDetectionExtension ===
No input/output.
Takes an input u32, no output.


Calls the same func internally as [[#ReleaseLastApplicationCaptureSharedBuffer]], except this passes value 2 for the last param instead of 0.
The input value must be 0-2: 0 = disabled, 1 = Extended, and 2 = ExtendedUnsafe.
 
=== GetIdleTimeDetectionExtension ===
No input, returns an output u32.


=== TakeScreenShotOfOwnLayerEx ===
Returns the value set by [[#SetIdleTimeDetectionExtension]].
Takes two input u8 bools and a s32, no output.


Calls the same func internally as [[#TakeScreenShotOfOwnLayer]], except the last bool param is the last cmd param bool instead of hard-coded 0. This flag indicates whether the screenshot should be taken Immediately.
=== SetInputDetectionSourceSet ===
Takes an input u32, no output.


== ISystemAppletControllerForDebug ==
=== ReportUserIsActive ===
{| class="wikitable" border="1"
No input/output.
|-
! Cmd || Name
|-
| 1 || RequestLaunchApplicationForDebug
|-
| 2 || [7.0.0+] [[#GetDebugStorageChannel]]
|-
| 3 || [7.0.0+] [[#CreateStorageForDebug]]
|-
| 4 || [12.0.0+] [[#CreateCradleFirmwareUpdaterForDebug]]
|}


=== GetDebugStorageChannel ===
Uses idle:sys ReportUserIsActive.
No input. Returns an output [[#IStorageChannel]].


=== CreateStorageForDebug ===
Reports that the user is active, for idle detection (screen dimming / auto-sleep). This is equivalent to when the user uses HID input.
Takes a total of 8-bytes of input. Returns an [[#IStorage]].


=== CreateCradleFirmwareUpdaterForDebug ===
=== GetCurrentIlluminance ===
No input. Returns an [[#ICradleFirmwareUpdater]].
No input, returns an output float.


== IProcessWindingController ==
Uses [[Backlight_services|lbl]] command GetAmbientLightSensorValue, where only the output float is used.
{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetLaunchReason]] ||
|-
| 11 || [[#OpenCallingLibraryApplet]] ||
|-
| 21 || [[#PushContext]] ||
|-
| 22 || [[#PopContext]] ||
|-
| 23 || [[#CancelWindingReservation]] ||
|-
| 30 || [[#WindAndDoReserved]] ||
|-
| 40 || [[#ReserveToStartAndWaitAndUnwindThis]] ||
|-
| 41 || [4.0.0+] [[#ReserveToStartAndWait]] ||
|}


=== GetLaunchReason ===
=== IsIlluminanceAvailable ===
No input, returns an output [[#AppletProcessLaunchReason]].
No input, returns an output u8 bool.


Used by LibraryApplets.
Uses [[Backlight_services|lbl]] command IsAmbientLightSensorAvailable.


=== OpenCallingLibraryApplet ===
User-processes can use this to determine whether to continue with using GetCurrentIlluminance(Ex).
No input, returns an output [[#ILibraryAppletAccessor]].


The objptr from state is cleared during this, an error is thrown if it's already 0.
=== SetAutoSleepDisabled ===
Takes an input u8 bool, no output.


=== PushContext ===
=== IsAutoSleepDisabled ===
Takes an input [[#IStorage]], no output.
No input, returns an output u8 bool.


=== PopContext ===
=== ReportMultimediaError ===
No input, returns an output [[#IStorage]].
Takes an input Result and a type-0x5 input buffer, no output.


=== CancelWindingReservation ===
The buffer contains a 0x138-byte "movie::MultimediaTelemetryReport" struct.
No input/output.


=== WindAndDoReserved ===
=== GetCurrentIlluminanceEx ===
No input/output.
No input, returns an output u8 bool and float.
 
Uses [[Backlight_services|lbl]] command GetAmbientLightSensorValue.
 
=== SetInputDetectionPolicy ===
Takes an input [[#InputDetectionPolicy]], no output.
 
=== SetWirelessPriorityMode ===
Takes an input s32 [[#WirelessPriorityMode]], no output.
 
=== GetAccumulatedSuspendedTickValue ===
No input, returns an output u64 tick value.
 
Gets the total time in ticks that the process was suspended, relative to when the applet-service was last initialized.
 
=== GetAccumulatedSuspendedTickChangedEvent ===
No input, returns an output Event handle with autoclear=true.


=== ReserveToStartAndWaitAndUnwindThis ===
This is signaled when the output from [[#GetAccumulatedSuspendedTickValue]] is updated.
Takes an input [[#ILibraryAppletAccessor]], no output.


=== ReserveToStartAndWait ===
=== SetAlbumImageTakenNotificationEnabled ===
Takes an input [[#ILibraryAppletAccessor]], no output.
Takes an input u8 bool, no output.


== IDebugFunctions ==
See [[#AppletMessage]].
{| class="wikitable" border="1"
 
|-
=== SetApplicationAlbumUserData ===
! Cmd || Name
Takes a type-0x21 input buffer, no output.
|-
 
| 0 || [[#NotifyMessageToHomeMenuForDebug]]
The buffer contains arbitrary UserData.
|-
 
| 1 || [1.0.0-9.2.0] [[#OpenMainApplication]]
The size must be <=0x400. The input buffer is copied to a buffer loaded from a state ptr (throwing an error when the state ptr is not set), with the u32 size being written to statebuf+0x400 afterwards.
|-
 
| 10 || [[#PerformSystemButtonPressing]]
=== SaveCurrentScreenshot ===
|-
Takes an input s32 [[Capture_services#AlbumReportOption|AlbumReportOption]], no output.
| 20 || [[#InvalidateTransitionLayer]]
 
|-
sdknso exposes this under "nn::album::".
| 30 || [6.0.0+] [[#RequestLaunchApplicationWithUserAndArgumentForDebug]]
 
|-
=== SetRecordVolumeMuted ===
| 31 || [12.0.0+] RequestLaunchApplicationByApplicationLaunchInfoForDebug
Takes an input bool, no output.
 
=== GetDebugStorageChannel ===
No input, returns an output [[#IStorageChannel]].
 
The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise an error is returned.
 
=== GetGraphicsSupervisor ===
This is exclusive to S2.
 
No input. Returns an output TIPC handle to [[Switch_2:_GSV_services|GraphicsSupervisor]].
 
== IStorageChannel ==
This is "nn::am::service::IStorageChannel".
 
This was added with [7.0.0+].
 
{| class="wikitable" border="1"
|-
|-
| 40 || [6.0.0+] [[#GetAppletResourceUsageInfo]]
! Cmd || Name || Notes
|-
|-
| 100 || [7.0.0+] [[#SetCpuBoostModeForApplet]]
| 0 || Push || No input, returns an output [[#IStorage]].
|-
|-
| 101 || [10.0.0+] [[#CancelCpuBoostModeForApplet]]
| 1 || Unpop || No input, returns an output [[#IStorage]].
|-
|-
| 110 || [9.0.0+] [[#PushToAppletBoundChannelForDebug]]
| 2 || Pop || No input, returns an output [[#IStorage]].
|-
|-
| 111 || [9.0.0+] [[#TryPopFromAppletBoundChannelForDebug]]
| 3 || GetPopEventHandle || No input, returns an output handle.
|-
|-
| 120 || [9.0.0+] [[#AlarmSettingNotificationEnableAppEventReserve]]
| 4 || Clear || No input/output.
|}
 
== IWindowController ==
This is "nn::am::service::IWindowController".
 
{| class="wikitable" border="1"
|-
|-
| 121 || [9.0.0+] [[#AlarmSettingNotificationDisableAppEventReserve]]
! Cmd || Name || Notes
|-
| 0 || [[#CreateWindow]] ||
|-
| 1 || [[#GetAppletResourceUserId]] ||
|-
|-
| 122 || [9.0.0+] [[#AlarmSettingNotificationPushAppEventNotify]]
| 2 || [6.0.0+] [[#GetAppletResourceUserIdOfCallerApplet]] ||
|-
|-
| 130 || [9.0.0+] [[#FriendInvitationSetApplicationParameter]]
| 10 || [[#AcquireForegroundRights]] ||
|-
|-
| 131 || [9.0.0+] [[#FriendInvitationClearApplicationParameter]]
| 11 || [[#ReleaseForegroundRights]] ||
|-
|-
| 132 || [9.0.0+] [[#FriendInvitationPushApplicationParameter]]
| 12 || [[#RejectToChangeIntoBackground]] ||
|-
|-
| 140 || [14.0.0+] RestrictPowerOperationForSecureLaunchModeForDebug
| 20 || [7.0.0+] [[#SetAppletWindowVisibility]] ||
|-
|-
| 900 || [12.0.0+] GetGrcProcessLaunchedSystemEvent
| 21 || [7.0.0+] [[#SetAppletGpuTimeSlice]] ||
|}
|}


=== NotifyMessageToHomeMenuForDebug ===
=== CreateWindow ===
Takes an input [[#AppletMessage]], no output.
Takes an input u32, returns an output [[#IWindow]].


Stubbed, just returns an error.
Stubbed, just returns an error.


=== OpenMainApplication ===
=== GetAppletResourceUserId ===
No input, returns an output [[#IApplicationAccessor]].
No input, returns an output u64 [[#AppletResourceUserId]].
 
=== GetAppletResourceUserIdOfCallerApplet ===
No input, returns an output u64 [[#AppletResourceUserId]].


Should not be used when no Application is running (svcBreak).
=== AcquireForegroundRights ===
No input/output.


=== PerformSystemButtonPressing ===
Just returns 0.
Takes an input [[#SystemButtonType]], no output.


=== InvalidateTransitionLayer ===
=== ReleaseForegroundRights ===
No input/output.
No input/output.


=== RequestLaunchApplicationWithUserAndArgumentForDebug ===
Just returns 0.
Takes an input u8 bool flag, an [[NCM_services#ApplicationId|ApplicationId]], a type-0x5 input buffer containing an array of u128 userIDs, and a type-0x5 input buffer, no output.


Requests to launch the specified Application, with the specified users. When the bool flag is true, the content of the second input buffer is used to create a storage which is pushed to the UserChannel for this Application (see [[#LaunchParameterKind]]).
=== RejectToChangeIntoBackground ===
No input/output.


=== GetAppletResourceUsageInfo ===
Just returns 0.
No input, returns an output [[#AppletResourceUsageInfo]].


=== SetCpuBoostModeForApplet ===
=== SetAppletWindowVisibility ===
Takes an input u32 [[#CpuBoostMode]] and passes it to [[PPC_services#apm:sys|SetCpuBoostMode]].
Takes an input u8 bool, no output.


The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.
=== SetAppletGpuTimeSlice ===
Takes an input s64, no output.


=== CancelCpuBoostModeForApplet ===
The input s64 must not be negative.
No input/output.


=== PushToAppletBoundChannelForDebug ===
== IAudioController ==
Takes an input [[#IStorage]] and a s32, no output.
This is "nn::am::service::IAudioController".


The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#SetExpectedMasterVolume]]
|-
| 1 || [[#GetMainAppletExpectedMasterVolume]]
|-
| 2 || [[#GetLibraryAppletExpectedMasterVolume]]
|-
| 3 || [[#ChangeMainAppletMasterVolume]]
|-
| 4 || [[#SetTransparentVolumeRate]]
|-
| 5 || [20.0.0+]
|}


The s32 must match the value already stored in state when the state value is non-zero, otherwise an error is returned. When the state value is 0, the s32 is written into state. Then the input storage is pushed to the StorageChannel.
GetMainAppletExpectedMasterVolume/SetExpectedMasterVolume are used for saving/restoring state for LibraryApplet launching, with SetExpectedMasterVolume being used with new state prior to launching a LibraryApplet. With official sw these applet funcs are used directly in the main-codebin.


=== TryPopFromAppletBoundChannelForDebug ===
=== SetExpectedMasterVolume ===
Takes an input s32, returns an output [[#IStorage]].
Takes two input floats, no output.


The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.
Writes the input floats to state: first one is used by [[#GetMainAppletExpectedMasterVolume]], second one is used by [[#GetLibraryAppletExpectedMasterVolume]].


The s32 must not be 0 and must match the value previously saved by [[#PushToAppletBoundChannelForDebug]], otherwise errors are returned. Then the output storage is popped from the StorageChannel.
=== GetMainAppletExpectedMasterVolume ===
No input, returns an output float.


=== AlarmSettingNotificationEnableAppEventReserve ===
=== GetLibraryAppletExpectedMasterVolume ===
Takes an input [[#IStorage]] and an [[NCM_services#ApplicationId|ApplicationId]], no output.
No input, returns an output float.


Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state.
=== ChangeMainAppletMasterVolume ===
Takes an input float and an input u64, no output.


=== AlarmSettingNotificationDisableAppEventReserve ===
=== SetTransparentVolumeRate ===
No input/output.
Takes an input float, no output.


Clears the StorageChannel/saved-ApplicationId used by [[#AlarmSettingNotificationEnableAppEventReserve]].
== IDisplayController ==
This is "nn::am::service::IDisplayController".


=== AlarmSettingNotificationPushAppEventNotify ===
Takes an input [[#IStorage]], no output.
Same as [[#PushToNotificationStorageChannel]] except this uses the MainApplication.
=== FriendInvitationSetApplicationParameter ===
Takes an input [[#IStorage]] and an [[NCM_services#ApplicationId|ApplicationId]], no output.
Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state.
=== FriendInvitationClearApplicationParameter ===
No input/output.
Clears the StorageChannel/saved-ApplicationId used by [[#FriendInvitationSetApplicationParameter]].
=== FriendInvitationPushApplicationParameter ===
Takes an input [[#IStorage]], no output.
Same as [[#PushToFriendInvitationStorageChannel]] except this uses the MainApplication.
== IStorage ==
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
! Cmd || Name
|-
|-
| 0 || Open || No input. Returns an [[#IStorageAccessor]].
| 0 || [[#GetLastForegroundCaptureImage]]
|-
|-
| 1 || [2.0.0+] OpenTransferStorage || No input. Returns an [[#ITransferStorageAccessor]].
| 1 || [[#UpdateLastForegroundCaptureImage]]
|}
 
Open can only be used when the IStorage was created by [[#CreateStorage]] or [[#CreateTransferMemoryStorage]]. OpenTransferStorage can only be used when the IStorage was created by [[#CreateHandleStorage]].
 
Only 1 *Accessor session can be open for each IStorage at a time.
 
== IStorageAccessor ==
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
| 2 || [[#GetLastApplicationCaptureImage]]
|-
|-
| 0 || GetSize || No input. Returns an s64.
| 3 || [[#GetCallerAppletCaptureImage]]
|-
|-
| 10 || Write || Takes an input s64 and a type-0x21 input buffer.
| 4 || [[#UpdateCallerAppletCaptureImage]]
|-
|-
| 11 || Read || Takes an input s64 and a type-0x22 output buffer.
| 5 || [[#GetLastForegroundCaptureImageEx]]
|}
 
== ITransferStorageAccessor ==
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
| 6 || [[#GetLastApplicationCaptureImageEx]]
|-
|-
| 0 || GetSize || No input. Returns an output s64.
| 7 || [[#GetCallerAppletCaptureImageEx]]
|-
|-
| 1 || GetHandle || No input. Returns an output s64 and handle.
| 8 || [2.0.0+] [[#TakeScreenShotOfOwnLayer]]
|}
 
These commands return the data originally from [[#CreateHandleStorage]] input, both return the same s64.
 
= appletOE =
This is "nn::am::service::IApplicationProxyService".
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
| 9 || [5.0.0+] [[#CopyBetweenCaptureBuffers]]
|-
| 10 || [[#AcquireLastApplicationCaptureBuffer]]
|-
| 11 || [[#ReleaseLastApplicationCaptureBuffer]]
|-
| 12 || [[#AcquireLastForegroundCaptureBuffer]]
|-
|-
| 0 || [[#OpenApplicationProxy]] ||
| 13 || [[#ReleaseLastForegroundCaptureBuffer]]
|}
 
This is used by all regular-applications, including [[flog]] and "Retail Interactive Display Menu". Only one session can be open for this service at a time.
 
== OpenApplicationProxy ==
Returns an [[#IApplicationProxy]]. See [[#appletAE]].
 
Takes a [[IPC_Marshalling|reserved]] input u64 (official user-processes use hard-coded value 0), a PID, and a process copy-handle (cur-proc handle alias).
 
On failure, official user-processes will retry using this command in a loop while the retval is 0x19280, with svcSleepThread(10000000) being called first.
 
= idle:sys =
This is "nn::idle::detail::IPolicyManagerSystem"
 
This was moved to [[OMM_services|omm]] with [14.0.0+].
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 14 || [[#AcquireCallerAppletCaptureBuffer]]
|-
|-
| 0 || GetAutoPowerDownEvent
| 15 || [[#ReleaseCallerAppletCaptureBuffer]]
|-
|-
| 1 || [7.0.0+] IsAutoPowerDownRequested ([1.0.0-3.0.2] )
| 16 || [[#AcquireLastApplicationCaptureBufferEx]]
|-
|-
| 2 || [1.0.0-3.0.2]
| 17 || [[#AcquireLastForegroundCaptureBufferEx]]
|-
|-
| 3 || [[#SetHandlingContext]]
| 18 || [[#AcquireCallerAppletCaptureBufferEx]]
|-
|-
| 4 || LoadAndApplySettings
| 20 || [3.0.0+] [[#ClearCaptureBuffer]]
|-
|-
| 5 || ReportUserIsActive
| 21 || [3.0.0+] [[#ClearAppletTransitionBuffer]]
|}
 
== SetHandlingContext ==
[3.0.0+] Now takes an additional 0x10-bytes of input.
 
[13.0.0+] Total input size is now 0x30 instead of 0x38.
 
= omm =
This is "nn::omm::detail::IOperationModeManager"
 
Operation Mode Manager (OMM) is a service responsible for arbitrating the operation changes between docked and handheld modes.
Besides [[PTM_services|PTM]], this is the only service that interacts with the [[Dock]] through [[USB_services|usb:pd*]].
 
This was moved to [[OMM_services|omm]] with [14.0.0+].
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 22 || [4.0.0+] [[#AcquireLastApplicationCaptureSharedBuffer]]
|-
|-
| 0 || GetOperationMode
| 23 || [4.0.0+] [[#ReleaseLastApplicationCaptureSharedBuffer]]
|-
|-
| 1 || GetOperationModeChangeEvent
| 24 || [4.0.0+] [[#AcquireLastForegroundCaptureSharedBuffer]]
|-
|-
| 2 || EnableAudioVisual
| 25 || [4.0.0+] [[#ReleaseLastForegroundCaptureSharedBuffer]]
|-
|-
| 3 || DisableAudioVisual
| 26 || [4.0.0+] [[#AcquireCallerAppletCaptureSharedBuffer]]
|-
|-
| 4 || EnterSleepAndWait
| 27 || [4.0.0+] [[#ReleaseCallerAppletCaptureSharedBuffer]]
|-
|-
| 5 || GetCradleStatus
| 28 || [6.0.0+] [[#TakeScreenShotOfOwnLayerEx]]
|-
|}
| 6 || FadeInDisplay
 
|-
=== GetLastForegroundCaptureImage ===
| 7 || FadeOutDisplay
Takes a type-0x6 output buffer.
|-
 
| 8 || [2.0.0+] GetCradleFwVersion
Stubbed, just returns an error.
|-
 
| 9 || [2.0.0+] NotifyCecSettingsChanged
=== UpdateLastForegroundCaptureImage ===
|-
No input/output.
| 10 || [3.0.0+] SetOperationModePolicy
|-
| 11 || [3.0.0+] GetDefaultDisplayResolution
|-
| 12 || [3.0.0+] GetDefaultDisplayResolutionChangeEvent
|-
| 13 || [3.0.0+] UpdateDefaultDisplayResolution
|-
| 14 || [3.0.0+] ShouldSleepOnBoot
|-
| 15 || [4.0.0+] NotifyHdcpApplicationExecutionStarted
|-
| 16 || [4.0.0+] NotifyHdcpApplicationExecutionFinished
|-
| 17 || [4.0.0+] NotifyHdcpApplicationDrawingStarted
|-
| 18 || [4.0.0+] NotifyHdcpApplicationDrawingFinished
|-
| 19 || [4.0.0+] GetHdcpAuthenticationFailedEvent
|-
| 20 || [4.0.0+] GetHdcpAuthenticationFailedEmulationEnabled
|-
| 21 || [4.0.0+] SetHdcpAuthenticationFailedEmulation
|-
| 22 || [4.0.0+] GetHdcpStateChangeEvent
|-
| 23 || [4.0.0+] GetHdcpState
|-
| 24 || [5.0.0+] ShowCardUpdateProcessing
|-
| 25 || [5.0.0+] SetApplicationCecSettingsAndNotifyChanged
|-
| 26 || [7.0.0+] [[#GetOperationModeSystemInfo]]
|-
| 27 || [9.0.0+] GetAppletFullAwakingSystemEvent
|-
| 28 || [12.0.0+] [[#CreateCradleFirmwareUpdater]]
|}


== GetOperationModeSystemInfo ==
=== GetLastApplicationCaptureImage ===
No input, returns an output u32.
Takes a type-0x6 output buffer.


This is used by [[#GetOperationModeSystemInfo|ICommonStateGetter GetOperationModeSystemInfo]].
Stubbed, just returns an error.


== CreateCradleFirmwareUpdater ==
=== GetCallerAppletCaptureImage ===
No input. Returns an [[#ICradleFirmwareUpdater]].
Takes a type-0x6 output buffer.


== ICradleFirmwareUpdater ==
Stubbed, just returns an error.
This is "nn::omm::detail::ICradleFirmwareUpdater".


This was added with [12.0.0+].
=== UpdateCallerAppletCaptureImage ===
No input/output.


{| class="wikitable" border="1"
Calls the same func internally as [[#UpdateLastForegroundCaptureImage]], except this passes param value 2 instead of 1.
|-
! Cmd || Name
|-
| 0 || Start
|-
| 1 || Finish
|-
| 2 || GetUpdateDeviceStatus
|-
| 3 || GetUpdateProgress
|-
| 4 || GetUpdateDeviceStatusChangeEvent
|-
| 5 || GetUpdateProgress2
|}


= spsm =
=== GetLastForegroundCaptureImageEx ===
This is "nn::spsm::detail::IPowerStateInterface".
Takes a type-0x6 output buffer, returns an output u8 bool.


This was moved to [[OMM_services|omm]] with [14.0.0+].
The buffer size must match 0x384000.


{| class="wikitable" border="1"
=== GetLastApplicationCaptureImageEx ===
|-
Takes a type-0x6 output buffer, returns an output u8 bool.
! Cmd || Name
 
|-
The buffer size must match 0x384000.
| 0 || GetCurrentState
|-
| 1 || EnterSleep
|-
| 2 || GetLastWakeReason
|-
| 3 || Shutdown
|-
| 4 || GetNotificationMessageEventHandle
|-
| 5 || ReceiveNotificationMessage
|-
| 6 || AnalyzeLogForLastSleepWakeSequence
|-
| 7 || ResetEventLog
|-
| 8 || AnalyzePerformanceLogForLastSleepWakeSequence
|-
| 9 || ChangeHomeButtonLongPressingTime
|-
| 10 || PutErrorState
|-
| 11 || [1.0.0-3.0.2] InvalidateCurrentHomeButtonPressing
|}


[3.0.0+] Cmd11 now takes a total of 8-bytes of input.
Calls the same internal func as [[#GetLastForegroundCaptureImageEx]], except that the last param is set to value 0 instead of 1.


= tcap =
=== GetCallerAppletCaptureImageEx ===
This is "nn::tcap::server::IManager".
Takes a type-0x6 output buffer, returns an output u8 bool.


This was removed with [11.0.0+].
The buffer size must match 0x384000.


{| class="wikitable" border="1"
Calls the same internal func as [[#GetLastForegroundCaptureImageEx]], except that the last param is set to value 2 instead of 1.
|-
! Cmd || Name
|-
| 0 || GetContinuousHighSkinTemperatureEvent
|-
| 1 || SetOperationMode
|-
| 2 || LoadAndApplySettings
|}


= caps:su =
=== TakeScreenShotOfOwnLayer ===
This is "nn::capsrv::sf::IScreenShotApplicationService".
Takes an input u8 bool and a s32, no output.


This was added with [[6.0.0]].
=== CopyBetweenCaptureBuffers ===
Takes two input s32s, no output.


This can be used by applications to save screenshots.
=== AcquireLastApplicationCaptureBuffer ===
No input, returns an output handle.


{| class="wikitable" border="1"
Stubbed, just returns an error.
|-
! Cmd || Name || Notes
|-
| 32 || [7.0.0+] SetShimLibraryVersion || Takes a total of 0x10-bytes of input and a PID, no output.
|-
| 201 || SaveScreenShot ||
|-
| 203 || SaveScreenShotEx0 ||
|-
| 205 || [8.0.0+] SaveScreenShotEx1 ||
|-
| 210 || SaveScreenShotEx2 || Takes a total of 0x50-bytes of input, a type-0x15 input buffer, and a type-0x45 input buffer.  Returns a total of 0x20-bytes of output.
|}


'''SetShimLibraryVersion''' is a wrapper for [[Capture_services|caps:c]] cmd33. Commands '''SaveScreenShot''', '''SaveScreenShotEx0''', '''SaveScreenShotEx1''' and '''SaveScreenShotEx2''' are wrappers for [[Display_services|caps:sc]] cmd210.
=== ReleaseLastApplicationCaptureBuffer ===
No input/output.


== SaveScreenShot ==
Clears a state field if it's not already 0, returning an error otherwise. On newer sysvers: then a func is called which just returns 0, then this cmd returns 0.
Takes two input u32s, an u64 AppletResourceUserId, a PID, and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].


Official user-processes doesn't use this, instead [[#SaveScreenShotEx0]] is used: ScreenShotAttributeEx0 is all-zero, except +4 is set to an input u32 and u32 +0xC = 0x1.
=== AcquireLastForegroundCaptureBuffer ===
No input, returns an output handle.


This cmd internally uses an all-zero ScreenShotAttributeEx0, with u32 +0 = input u32 and u32 +0x8 = 0x3.
Stubbed, just returns an error.


== SaveScreenShotEx0 ==
=== ReleaseLastForegroundCaptureBuffer ===
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a PID, and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].
No input/output.


== SaveScreenShotEx1 ==
Same as [[#ReleaseLastApplicationCaptureBuffer]] except with a different state field + different input param for the called func.
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a PID, a type-0x15 input buffer containing an [[Capture_services|ApplicationData]], and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].


== SaveScreenShotEx2 ==
=== AcquireCallerAppletCaptureBuffer ===
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a type-0x15 input buffer containing an [[Capture_services|UserIdList]], and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].
No input, returns an output handle.


= Library Applets =
Stubbed, just returns an error.
This section documents library applet launching.


Before starting the applet, [[#IStorage]]s are [[#ILibraryAppletCreator|created]] and written, then passed to [[#ILibraryAppletAccessor]] PushInData. The [[#IStorage]] session is closed afterwards. The first [[#IStorage]] is [[#CommonArguments]], followed by any applet-specific [[#IStorage]]s.
=== ReleaseCallerAppletCaptureBuffer ===
No input/output.


Once the applet finishes running successfully, [[#ILibraryAppletAccessor]] PopOutData can be used to get the applet-specific [[#IStorage]] containing the applet output data.
Same as [[#ReleaseLastApplicationCaptureBuffer]] except with a different state field + different input param for the called func.


== CommonArguments ==
=== AcquireLastApplicationCaptureBufferEx ===
The first [[#CreateStorage|IStorage]] passed to applets should contain the common library applet arguments. This is populated by <code>nn::la::CommonArgumentsWriter</code> and has the following format.
No input, returns an output TransferMemory handle and an output u8 bool.


This struct is 0x20-bytes.
The state field used by [[#ReleaseLastApplicationCaptureBuffer]] must be 0. Calls a func which just returns an error (this is only the case on newer sysvers), hence this cmd will just return that error. If that func would have returned successfully, the state field would be set to 1 and the cmd would return 0.


Official sw handles the first 8-bytes separately, which is a header. With CommonArguments version 0x0, the header is 4-bytes, while starting with version 0x1 it's 8-bytes.
On old sysvers, the output TransferMemory is size 0x384000 with permissions=RW.


{| class="wikitable" border="1"
=== AcquireLastForegroundCaptureBufferEx ===
|-
No input, returns an output TransferMemory handle and an output u8 bool.
! Offset || Size || Typical Value || Notes
|-
| 0x0 || 4 || 1 || Common Arguments version
|-
| 0x4 || 4 || 0x20 || Common Arguments size
|-
| 0x8 || 4 || || Library applet version (API version)
|-
| 0xC || 4 || 0 || Theme color
|-
| 0x10 || 1 || 0 || Play startup sound
|-
| 0x18 || 8 || N/A || System tick (see [[SVC#svcGetSystemTick|svcGetSystemTick]])
|-
|}


= AppletId =
Same as [[#AcquireLastApplicationCaptureBufferEx]] except this uses the [[#ReleaseLastForegroundCaptureBuffer]] state field, and uses a different input param value for the called func.
This is "nn::applet::AppletId". See also [[:Category:Library Applets]].
 
=== AcquireCallerAppletCaptureBufferEx ===
No input, returns an output TransferMemory handle and an output u8 bool.
 
Same as [[#AcquireLastApplicationCaptureBufferEx]] except this uses the [[#ReleaseCallerAppletCaptureBuffer]] state field, and uses a different input param value for the called func.
 
=== ClearCaptureBuffer ===
Takes an input u8 bool, a s32 CaptureSharedBuffer, and an u32 color, returns no output.
 
Clear the input CaptureSharedBuffer with the specified RGBA8 color.
 
=== ClearAppletTransitionBuffer ===
Takes an input u32, no output.
 
Clear the AppletTransitionBuffer with the specified RGBA8 color.
 
=== AcquireLastApplicationCaptureSharedBuffer ===
No input, returns an output u8 bool and an s32.


{| class="wikitable" border="1"
This loads data from state.
|-
 
! Value
=== ReleaseLastApplicationCaptureSharedBuffer ===
! ProgramId
No input/output.
! Description
 
|-
Depending on whether a state field is 0, this just returns an error or returns 0.
| 0x00
 
|
=== AcquireLastForegroundCaptureSharedBuffer ===
| None
No input, returns an output u8 bool and an s32.
|-
 
| 0x01
Calls the same func internally as [[#AcquireLastApplicationCaptureSharedBuffer]], except this passes value 1 for the last param instead of 0.
|
 
| Application (not valid for use with LibraryApplets)
=== ReleaseLastForegroundCaptureSharedBuffer ===
|-
No input/output.
| 0x02
 
| 010000000000100C
Calls the same func internally as [[#ReleaseLastApplicationCaptureSharedBuffer]], except this passes value 1 for the last param instead of 0.
| OverlayApplet (overlayDisp)
 
|-
=== AcquireCallerAppletCaptureSharedBuffer ===
| 0x03
No input, returns an output u8 bool and an s32.
| 0100000000001000
 
| SystemAppletMenu (qlaunch)
Calls the same func internally as [[#AcquireLastApplicationCaptureSharedBuffer]], except this passes value 2 for the last param instead of 0.
|-
 
| 0x04
=== ReleaseCallerAppletCaptureSharedBuffer ===
| 0100000000001012
No input/output.
| SystemApplication (starter)
 
|-
Calls the same func internally as [[#ReleaseLastApplicationCaptureSharedBuffer]], except this passes value 2 for the last param instead of 0.
| 0x0A
 
| 0100000000001001
=== TakeScreenShotOfOwnLayerEx ===
| [[Auth_Applet|LibraryAppletAuth (auth)]]
Takes two input u8 bools and a s32, no output.
 
Calls the same func internally as [[#TakeScreenShotOfOwnLayer]], except the last bool param is the last cmd param bool instead of hard-coded 0. This flag indicates whether the screenshot should be taken Immediately.
 
== ISystemAppletControllerForDebug ==
This is "nn::am::service::ISystemAppletControllerForDebug".
 
{| class="wikitable" border="1"
|-
|-
| 0x0B
! Cmd || Name
| 0100000000001002
| [[Cabinet_Applet|LibraryAppletCabinet (cabinet)]]
|-
|-
| 0x0C
| 1 || RequestLaunchApplicationForDebug
| 0100000000001003
| [[Controller_Applet|LibraryAppletController (controller)]]
|-
|-
| 0x0D
| 2 || [7.0.0+] [[#GetDebugStorageChannel]]
| 0100000000001004
| LibraryAppletDataErase (dataErase)
|-
|-
| 0x0E
| 3 || [7.0.0+] [[#CreateStorageForDebug]]
| 0100000000001005
| [[Error_Applet|LibraryAppletError (error)]]
|-
|-
| 0x0F
| 4 || [12.0.0+] [[#CreateCradleFirmwareUpdaterForDebug]]
| 0100000000001006
|}
| LibraryAppletNetConnect (netConnect)
 
=== GetDebugStorageChannel ===
No input. Returns an output [[#IStorageChannel]].
 
=== CreateStorageForDebug ===
Takes a total of 8-bytes of input. Returns an [[#IStorage]].
 
=== CreateCradleFirmwareUpdaterForDebug ===
No input. Returns an [[#ICradleFirmwareUpdater]].
 
== IProcessWindingController ==
This is "nn::am::service::IProcessWindingController".
 
GetProcessWindingController throws an error when used from non-LibraryApplet (at least with Application).
 
{| class="wikitable" border="1"
|-
|-
| 0x10
! Cmd || Name || Notes
| 0100000000001007
| [[Profile_Selector|LibraryAppletPlayerSelect (playerSelect)]]
|-
|-
| 0x11
| 0 || [[#GetLaunchReason]] ||
| 0100000000001008
| [[Software_Keyboard|LibraryAppletSwkbd (swkbd)]]
|-
|-
| 0x12
| 11 || [[#OpenCallingLibraryApplet]] ||
| 0100000000001009
| [[MiiEdit_Applet|LibraryAppletMiiEdit (miiEdit)]]
|-
|-
| 0x13
| 21 || [[#PushContext]] ||
| 010000000000100A
| [[Internet_Browser#010000000000100A|LibraryAppletWeb (web)]]
|-
|-
| 0x14
| 22 || [[#PopContext]] ||
| 010000000000100B
| [[Internet_Browser#ShopN|LibraryAppletShop (shop)]]
|-
|-
| 0x15
| 23 || [[#CancelWindingReservation]] ||
| 010000000000100D
| [[Album_Applet|LibraryAppletPhotoViewer (photoViewer)]]
|-
|-
| 0x16
| 30 || [[#WindAndDoReserved]] ||
| 010000000000100E
| LibraryAppletSet (set)
|-
|-
| 0x17
| 40 || [[#ReserveToStartAndWaitAndUnwindThis]] ||
| 010000000000100F
| [[Internet_Browser#Offline_Applet|LibraryAppletOfflineWeb (offlineWeb)]]
|-
|-
| 0x18
| 41 || [4.0.0+] [[#ReserveToStartAndWait]] ||
| 0100000000001010
|}
| [[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]]
 
|-
=== GetLaunchReason ===
| 0x19
No input, returns an output [[#AppletProcessLaunchReason]].
| 0100000000001011
 
| [[Internet_Browser#WifiWebAuthApplet|LibraryAppletWifiWebAuth (wifiWebAuth)]]
Used by LibraryApplets.
|-
 
| 0x1A
=== OpenCallingLibraryApplet ===
| 0100000000001013
No input, returns an output [[#ILibraryAppletAccessor]].
| [[MyPage_Applet|LibraryAppletMyPage (myPage)]]
 
The objptr from state is cleared during this, an error is thrown if it's already 0.
 
=== PushContext ===
Takes an input [[#IStorage]], no output.
 
=== PopContext ===
No input, returns an output [[#IStorage]].
 
=== CancelWindingReservation ===
No input/output.
 
=== WindAndDoReserved ===
No input/output.
 
=== ReserveToStartAndWaitAndUnwindThis ===
Takes an input [[#ILibraryAppletAccessor]], no output.
 
=== ReserveToStartAndWait ===
Takes an input [[#ILibraryAppletAccessor]], no output.
 
== ISystemProcessCommonFunctions ==
This is "nn::am::service::ISystemProcessCommonFunctions".
 
This was added with [19.0.0+].
 
{| class="wikitable" border="1"
|-
|-
| 0x1B
! Cmd || Name
| 010000000000101A
| LibraryAppletGift (gift)
|-
|-
| 0x1C
| 1 ||
| 010000000000101C
|}
| LibraryAppletUserMigration (userMigration)
 
=== Cmd1 ===
No input. Returns an [[#IApplicationObserver]].
 
=== IApplicationObserver ===
This is "nn::am::service::IApplicationObserver".
 
This was added with [19.0.0+].
 
{| class="wikitable" border="1"
|-
|-
| 0x1D
! Cmd || Name
| 010000000000101D
| [9.0.0+] LibraryAppletPreomiaSys (EncounterSys)
|-
|-
| 0x1E
| 1 ||  
| 0100000000001020
| [9.0.0+] LibraryAppletStory (story)
|-
|-
| 0x1F
| 2 ||  
| 010070000E3C0000
| [9.0.0+] LibraryAppletPreomiaUsr (EncounterUsr)
|-
|-
| 0x20
| 10 ||  
| 010086000E49C000
| [9.0.0+] LibraryAppletPreomiaUsrDummy (EncounterUsrDummy)
|-
|-
| 0x21
| 20 ||  
| 0100000000001038
| [10.0.0+] LibraryAppletSample (sample)
|-
|-
| 0x3E8
| 30 ||  
|  
| [10.0.0+] DevlopmentTool
|-
|-
| 0x3F1
| 40 || [S2] [20.0.0+]
| 010000000000D619
|}
| [10.0.0+] CombinationLA
 
== IAppletAlternativeFunctions ==
This is "nn::am::service::IAppletAlternativeFunctions".
 
This was added with [20.0.0+].
 
{| class="wikitable" border="1"
|-
|-
| 0x3F2
! Cmd || Name
| 010000000000D610
| [10.0.0+] AeSystemApplet
|-
|-
| 0x3F3
| 0 ||  
| 010000000000D611
| [10.0.0+] AeOverlayApplet
|-
|-
| 0x3F4
| 1 ||  
| 010000000000D612
| [10.0.0+] AeStarter
|-
|-
| 0x3F5
| 2 ||
| 010000000000D613
|}
| [10.0.0+] AeLibraryAppletAlone
 
== IChatProxy ==
This is "nn::am::service::IChatProxy".
 
This is exclusive to Switch 2.
 
{| class="wikitable" border="1"
|-
|-
| 0x3F6
! Cmd || Name || Notes
| 010000000000D614
| [10.0.0+] AeLibraryApplet1
|-
|-
| 0x3F7
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
| 010000000000D615
| [10.0.0+] AeLibraryApplet2
|-
|-
| 0x3F8
| 1 || GetSelfController || Returns an [[#ISelfController]].
| 010000000000D616
| [10.0.0+] AeLibraryApplet3
|-
|-
| 0x3F9
| 2 || GetWindowController || Returns an [[#IWindowController]].
| 010000000000D617
| [10.0.0+] AeLibraryApplet4
|-
|-
| 0x3FA
| 3 || GetAudioController || Returns an [[#IAudioController]].
| 010000000000D60A
| [10.0.0+] AppletISA
|-
|-
| 0x3FB
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
| 010000000000D60B
| [10.0.0+] AppletIOA
|-
|-
| 0x3FC
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
| 010000000000D60C
|-
| [10.0.0+] AppletISTA
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
|-
| 0x3FD
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
| 010000000000D60D
| [10.0.0+] AppletILA1
|-
|-
| 0x3FE
| 20 || || Returns an [[#IChatFunctions]].
| 010000000000D60E
| [10.0.0+] AppletILA2
|}
|}


= LibraryAppletMode =
=== IChatFunctions ===
This is "nn::applet::LibraryAppletMode".
This is "nn::am::service::IChatFunctions".
 
This is exclusive to Switch 2.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Value
! Cmd || Name
! Description
|-
|-
| 0x0
| 1 ||  
| AllForeground
|-
|-
| 0x1
| 102 ||  
| PartialForeground
|-
|-
| 0x2
| 103 ||  
| NoUi
|-
|-
| 0x3
| 104 ||  
| PartialForegroundWithIndirectDisplay (see also [[#GetIndirectLayerConsumerHandle]], only used by swkbd [[Software_Keyboard|InlineKeyboard]])
|-
|-
| 0x4
| 110 ||  
| AllForegroundInitiallyHidden (can be used by [7.0.0+] [[Internet_Browser|WebSession]])
|}
 
= AppletMessage =
This is "nn::am::AppletMessage".
 
{| class="wikitable" border="1"
|-
|-
! Value
| 120 ||
! Description
|-
|-
| 0 || None
| 121 ||  
|-
|-
| 1 || ChangeIntoForeground
| 130 ||  
|-
|-
| 2 || ChangeIntoBackground
| 140 || [20.0.0+]
|-
|-
| 4 || Exit
| 141 || [20.0.0+]
|-
|-
| 6 || ApplicationExited
| 200 ||  
|-
|-
| 15 || [[#FocusState|FocusStateChanged]]
| 201 ||  
|-
|-
| 16 || [[#SetRestartMessageEnabled|Resume]]
| 210 || [20.0.0+]
|-
|-
| 20 || DetectShortPressingHomeButton
| 220 || [20.0.0+]
|}
 
== IDebugFunctions ==
This is "nn::am::service::IDebugFunctions".
 
{| class="wikitable" border="1"
|-
|-
| 21 || DetectLongPressingHomeButton
! Cmd || Name
|-
|-
| 22 || DetectShortPressingPowerButton
| 0 || [[#NotifyMessageToHomeMenuForDebug]]
|-
|-
| 23 || DetectMiddlePressingPowerButton
| 1 || [1.0.0-9.2.0] [[#OpenMainApplication]]
|-
|-
| 24 || DetectLongPressingPowerButton
| 10 || [[#PerformSystemButtonPressing]]
|-
|-
| 25 || RequestToPrepareSleep
| 20 || [[#InvalidateTransitionLayer]]
|-
|-
| 26 || FinishedSleepSequence
| 30 || [6.0.0+] [[#RequestLaunchApplicationWithUserAndArgumentForDebug]]
|-
|-
| 27 || SleepRequiredByHighTemperature
| 31 || [12.0.0+] [[#RequestLaunchApplicationByApplicationLaunchInfoForDebug]]
|-
|-
| 28 || SleepRequiredByLowBattery
| 40 || [6.0.0+] [[#GetAppletResourceUsageInfo]]
|-
|-
| 29 || AutoPowerDown
| 50 || [15.0.0+] AddSystemProgramIdAndAppletIdForDebug
|-
|-
| 30 || [[#OperationMode|OperationModeChanged]]
| 51 || [16.0.0+] AddOperationConfirmedLibraryAppletIdForDebug
|-
|-
| 31 || [[#PerformanceMode|PerformanceModeChanged]]
| 52 || [17.0.0+] GetProgramIdFromAppletIdForDebug
|-
|-
| 32 || DetectReceivingCecSystemStandby
| 53 || [18.0.0+] GetProgramIdFromAppletIdAndLibraryAppletModeForDebug
|-
|-
| 33 || SdCardRemoved
| 100 || [7.0.0+] [[#SetCpuBoostModeForApplet]]
|-
|-
| 50 || LaunchApplicationRequested
| 101 || [10.0.0+] [[#CancelCpuBoostModeForApplet]]
|-
|-
| 51 || [[#SetHandlesRequestToDisplay|RequestToDisplay]]
| 110 || [9.0.0+] [[#PushToAppletBoundChannelForDebug]]
|-
|-
| 55 || ShowApplicationLogo
| 111 || [9.0.0+] [[#TryPopFromAppletBoundChannelForDebug]]
|-
|-
| 56 || HideApplicationLogo
| 120 || [9.0.0+] [[#AlarmSettingNotificationEnableAppEventReserve]]
|-
|-
| 57 || ForceHideApplicationLogo
| 121 || [9.0.0+] [[#AlarmSettingNotificationDisableAppEventReserve]]
|-
|-
| 60 || FloatingApplicationDetected
| 122 || [9.0.0+] [[#AlarmSettingNotificationPushAppEventNotify]]
|-
|-
| 90 || [[#SetRequiresCaptureButtonShortPressedMessage|DetectShortPressingCaptureButton]]
| 130 || [9.0.0+] [[#FriendInvitationSetApplicationParameter]]
|-
|-
| 92 || [[#SetAlbumImageTakenNotificationEnabled|AlbumScreenShotTaken]]
| 131 || [9.0.0+] [[#FriendInvitationClearApplicationParameter]]
|-
|-
| 93 || AlbumRecordingSaved
| 132 || [9.0.0+] [[#FriendInvitationPushApplicationParameter]]
|}
 
= OperationMode =
This is "nn::oe::OperationMode".
 
{| class="wikitable" border="1"
|-
|-
! Value
| 140 || [14.0.0+] [[#RestrictPowerOperationForSecureLaunchModeForDebug|RestrictPowerOperationForSecureLaunchModeForDebug]]
! Description
|-
|-
| 0 || Handheld
| 150 || [21.0.0+]
|-
|-
| 1 || Console
| 200 || [15.0.0+] [[#CreateFloatingLibraryAppletAccepterForDebug|CreateFloatingLibraryAppletAccepterForDebug]]
|}
 
= PerformanceMode =
This is "nn::oe::PerformanceMode".
 
{| class="wikitable" border="1"
|-
|-
! Value
| 300 || [16.0.0+] TerminateAllRunningApplicationsForDebug
! Description
|-
|-
| -1 || Invalid
| 400 || [S2] LaunchDebugAppletForDebug
|-
|-
| 0 || Normal
| 401 || [S2] TerminateDebugAppletForDebug
|-
|-
| 1 || Boost
| 402 || [S2] IsDebugAppletLaunchedForDebug
|}
 
= FocusState =
This is "nn::oe::FocusState".
 
{| class="wikitable" border="1"
|-
|-
! Value
| 403 || [S2]
! Description
|-
|-
| 1 || InFocus
| 410 || [18.0.0+] [[#CreateGeneralStorageForDebug|CreateGeneralStorageForDebug]]
|-
|-
| 2 || OutOfFocus
| 411 || [18.0.0+] [[#ReadGeneralStorageForDebug|ReadGeneralStorageForDebug]]
|-
|-
| 3 || Background
| 412 || [18.0.0+] [[#WriteGeneralStorageForDebug|WriteGeneralStorageForDebug]]
|}
 
= CpuBoostMode =
This is "nn::oe::CpuBoostMode".
 
{| class="wikitable" border="1"
|-
|-
! Value
| 430 || [20.0.0+]
! Description
|-
|-
| 0 || Normal
| 431 || [20.0.0+]
|-
|-
| 1 || FastLoad
| 900 || [12.0.0+] GetGrcProcessLaunchedSystemEvent
|}
 
= WindowOriginMode =
This is "nn::oe::WindowOriginMode".
 
{| class="wikitable" border="1"
|-
|-
! Value
| 910 || [20.0.0+]
! Description
|-
|-
| 0 || LowerLeft
| 2000 || [S2] [20.0.0+]
|-
|-
| 1 || UpperLeft
| 10000 || [S2]
|}
|}


= WirelessPriorityMode =
=== NotifyMessageToHomeMenuForDebug ===
This is "nn::oe::WirelessPriorityMode".
Takes an input [[#AppletMessage]], no output.
 
Stubbed, just returns an error.


{| class="wikitable" border="1"
=== OpenMainApplication ===
|-
No input, returns an output [[#IApplicationAccessor]].
! Value
 
! Description
Should not be used when no Application is running (svcBreak).
|-
 
| 0 || Default
=== PerformSystemButtonPressing ===
|-
Takes an input [[#SystemButtonType]], no output.
| 1 || OptimizedForWlan
 
|}
=== InvalidateTransitionLayer ===
No input/output.
 
=== RequestLaunchApplicationWithUserAndArgumentForDebug ===
Takes an input u8 bool flag, an [[NCM_services#ApplicationId|ApplicationId]], a type-0x5 input buffer containing an array of u128 userIDs, and a type-0x5 input buffer, no output.


= TvPowerStateMatchingMode =
Requests to launch the specified Application, with the specified users. When the bool flag is true, the content of the second input buffer is used to create a storage which is pushed to the UserChannel for this Application (see [[#LaunchParameterKind]]).
This is "nn::oe::TvPowerStateMatchingMode". This is used with [[#SetTvPowerStateMatchingMode]].


{| class="wikitable" border="1"
=== RequestLaunchApplicationByApplicationLaunchInfoForDebug ===
|-
Takes a total of 0x58-bytes of input, a type-0x5 input buffer containing an array of 0x10-byte entries, and a type-0x5 input buffer. No output.
! Value
! Description
|-
| 0 || Unknown
|-
| 1 || Unknown
|}


= SystemButtonType =
[19.0.0+] Takes a total of 0x88-bytes of input, a type-0x5 input buffer containing an array of 0x10-byte entries, and a type-0x5 input buffer. No output.
This is "nn::am::service::SystemButtonType". This is used with [[#PerformSystemButtonPressingIfInFocus]]/[[#PerformSystemButtonPressing]].


{| class="wikitable" border="1"
=== GetAppletResourceUsageInfo ===
|-
No input, returns an output [[#AppletResourceUsageInfo]].
! Value
 
! Description
=== SetCpuBoostModeForApplet ===
|-
Takes an input u32 [[#CpuBoostMode]] and passes it to [[PPC_services#apm:sys|SetCpuBoostMode]].
| 1 || PerformHomeButtonShortPressing
 
|-
The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.
| 2 || PerformHomeButtonLongPressing
|-
| 3 || Short-pressing with the Power-button. Only available with [[#PerformSystemButtonPressing]].
|-
| 4 || Long-pressing with the Power-button. Only available with [[#PerformSystemButtonPressing]].
|-
| 5 || Shutdown the system. Only available with [[#PerformSystemButtonPressing]].
|-
| 6 || PerformCaptureButtonShortPressing
|-
| 7 || PerformCaptureButtonLongPressing
|}


= LaunchParameterKind =
=== CancelCpuBoostModeForApplet ===
{| class="wikitable" border="1"
No input/output.
|-
! Value
! Description
|-
| 1 || UserChannel. Application-specific LaunchParameter.
|-
| 2 || account PreselectedUser
|-
| 3 || Unknown if used by anything?
|}


= LibraryAppletExitReason =
=== PushToAppletBoundChannelForDebug ===
{| class="wikitable" border="1"
Takes an input [[#IStorage]] and a s32, no output.
|-
! Value
! Description
|-
| 0 || Normal
|-
| 1 || Canceled
|-
| 2 || Abnormal
|-
| 10 || Unexpected
|}


= ProgramSpecifyKind =
The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.
This is "nn::am::service::ProgramSpecifyKind". This controls the type of the u64 passed to [[#ExecuteProgram]].


{| class="wikitable" border="1"
The s32 must match the value already stored in state when the state value is non-zero, otherwise an error is returned. When the state value is 0, the s32 is written into state. Then the input storage is pushed to the StorageChannel.
|-
! Value
! Description
|-
| 0 || u8 ProgramIndex. "ExecuteProgram". [[NS_Services|NS]] handles ProgramIndex by launching ApplicationId+ProgramIndex. After using [[#ExecuteProgram]] with this successfully, official user-processes will enter an infinite loop with sleep-thread value 86400000000000.
|-
| 1 || [[NCM_services#ApplicationId|ApplicationId]]. "JumpToSubApplicationProgramForDevelopment". Only available when [[Settings_services#GetDebugModeFlag|DebugMode]] is 1.
|-
| 2 || u64 = value 0. "RestartProgram"
|}


ProgramIndex values where the title is not installed should not be used: [[qlaunch]] will display an error message and the current title will become "corrupted", however Home Menu will have an option to repair it.
=== TryPopFromAppletBoundChannelForDebug ===
Takes an input s32, returns an output [[#IStorage]].


= InputDetectionPolicy =
The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.
This is u32 enum "nn::applet::InputDetectionPolicy".


{| class="wikitable" border="1"
The s32 must not be 0 and must match the value previously saved by [[#PushToAppletBoundChannelForDebug]], otherwise errors are returned. Then the output storage is popped from the StorageChannel.
|-
! Value
! Description
|-
| 0 || Unknown
|-
| 1 || Unknown
|}


= AppletResourceUserId =
=== AlarmSettingNotificationEnableAppEventReserve ===
This is "nn::applet::AppletResourceUserId". Used by a number of non-AM services.
Takes an input [[#IStorage]] and an [[NCM_services#ApplicationId|ApplicationId]], no output.
 
Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state.


= AppletAttribute =
When launching an Application with a matching ApplicationId, this storage is popped, then pushed to [[#PushToNotificationStorageChannel|NotificationStorageChannel]].
This is "nn::am::AppletAttribute". This struct is 0x8-bytes.


{| class="wikitable" border="1"
=== AlarmSettingNotificationDisableAppEventReserve ===
|-
No input/output.
! Offset || Size || Description
|-
| 0x0 || 0x1 || Flag. When non-zero, two state fields are set to 1.
|-
| 0x1 || 0x7F || Unused
|}


This is used by [[#OpenLibraryAppletProxy]].
Clears the StorageChannel/saved-ApplicationId used by [[#AlarmSettingNotificationEnableAppEventReserve]].


= AppletProcessLaunchReason =
=== AlarmSettingNotificationPushAppEventNotify ===
This is "nn::am::service::AppletProcessLaunchReason". This struct is 0x4-bytes.
Takes an input [[#IStorage]], no output.


{| class="wikitable" border="1"
Same as [[#PushToNotificationStorageChannel]] except this uses the MainApplication.
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || Flag. When non-zero, LibraryApplets then use [[#OpenCallingLibraryApplet]].
|-
| 0x1 || 0x2 || Always 0.
|-
| 0x3 || 0x1 || Always 0.
|}


= LibraryAppletInfo =
=== FriendInvitationSetApplicationParameter ===
This is "nn::am::service::LibraryAppletInfo". This struct is 0x8-bytes.
Takes an input [[#IStorage]] and an [[NCM_services#ApplicationId|ApplicationId]], no output.


{| class="wikitable" border="1"
Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state.
|-
 
! Offset || Size || Description
When launching an Application with a matching ApplicationId, this storage is popped, then pushed to [[#PushToFriendInvitationStorageChannel|FriendInvitationStorageChannel]].
|-
| 0x0 || 0x4 || [[#AppletId]]
|-
| 0x4 || 0x4 || [[#LibraryAppletMode]]
|}


= AppletKind =
=== FriendInvitationClearApplicationParameter ===
This is "nn::am::service::AppletKind". This is 8-bytes.
No input/output.


= AppletIdentityInfo =
Clears the StorageChannel/saved-ApplicationId used by [[#FriendInvitationSetApplicationParameter]].
This struct is "nn::am::service::AppletIdentityInfo". This struct is 0x10-bytes.


{| class="wikitable" border="1"
=== FriendInvitationPushApplicationParameter ===
|-
Takes an input [[#IStorage]], no output.
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#AppletId]]
|-
| 0x4 || 0x4 || Padding
|-
| 0x8 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
|}


= ApplicationAttributeForQuest =
Same as [[#PushToFriendInvitationStorageChannel]] except this uses the MainApplication.
This struct is "nn::applet::ApplicationAttributeForQuest".


{| class="wikitable" border="1"
=== RestrictPowerOperationForSecureLaunchModeForDebug ===
|-
No input/output.
! Offset || Size || Description
|-
| 0x0 || 0x4 || See [[#ApplicationAttribute]].
|-
| 0x4 || 0x4 || See [[#ApplicationAttribute]].
|-
| 0x8 || 0x4 || [7.0.0+] See [[#ApplicationAttribute]].
|}


User-processes copy the first 0x8-bytes (0xC-bytes with [[#CreateApplicationWithAttributeAndPushAndRequestToStartForQuest]]/[[#CreateApplicationWithAttributeAndRequestToStartForQuest]]) to a [[#ApplicationAttribute]] with the rest of the struct being cleared, which is then passed to the actual cmd (CreateApplication*ToStartForQuest).
This runs the same functionality as [[#DisableSleepTillShutdown|DisableSleepTillShutdown]].


= ApplicationAttribute =
=== CreateFloatingLibraryAppletAccepterForDebug ===
This struct is "nn::am::ApplicationAttribute". This struct is 0x20-bytes.
Takes a PID, an input u64 reserved_pid, a type-0x5 input buffer containing an array of u32s, returns an [[#appletAE|IAllSystemAppletProxiesService]].
 
If a state field is already set it must match the PID, otherwise when state==0 the PID is written into state etc.
 
=== CreateGeneralStorageForDebug ===
Takes two input u64s Id and size, no output.
 
The high-byte of Id must be 0.
 
Goes through a linked-list to check whether there's already an entry with a matching Id. If there's a matching Id, return 0 if the size matches, otherwise return error.
 
When no entry is found, a new entry is added with a buffer allocated using the input size.
 
=== ReadGeneralStorageForDebug ===
Takes a type-0x22 output buffer, two input u64s Id and offset, returns an output u64 out_size.
 
The high-byte of Id must be 0.
 
Reads data from the buffer previously allocated by [[#CreateGeneralStorageForDebug|CreateGeneralStorageForDebug]] with the specified Id.
 
The out_size is always the buffer-size (an error is thrown when bounds-check fails).
 
=== WriteGeneralStorageForDebug ===
Takes a type-0x21 input buffer, two input u64s Id and offset.
 
Same as [[#ReadGeneralStorageForDebug|ReadGeneralStorageForDebug]] except this writes into the buffer, and no out_size.
 
== IStorage ==
This is "nn::am::service::IStorage".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Cmd || Name || Notes
|-
|-
| 0x0 || 0x4 || Default is 0 for non-Quest. Only used when non-zero: unknown value in seconds.
| 0 || Open || No input. Returns an [[#IStorageAccessor]].
|-
|-
| 0x4 || 0x4 || Default is 0 for non-Quest. Only used when non-zero: unknown value in seconds.
| 1 || [2.0.0+] OpenTransferStorage || No input. Returns an [[#ITransferStorageAccessor]].
|-
| 0x8 || 0x4 || float audio volume. Must be in the range of 0.0f-1.0f. The default is 1.0f.
|-
| 0xC || 0x14 || Unused. Default is 0.
|}
|}


Internally AM only uses the first 0xC-bytes from ApplicationAttribute, regardless of the cmd.
Open can only be used when the IStorage was created by [[#CreateStorage]] or [[#CreateTransferMemoryStorage]]. OpenTransferStorage can only be used when the IStorage was created by [[#CreateHandleStorage]].
 
Only 1 *Accessor session can be open for each IStorage at a time.


= ApplicationLaunchProperty =
== IStorageAccessor ==
This struct is 0x10-bytes.
This is "nn::am::service::IStorageAccessor".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Cmd || Name || Notes
|-
|-
| 0x0 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
| 0 || GetSize || No input. Returns an s64.
|-
|-
| 0x8 || 0x4 || Application title-version.
| 10 || Write || Takes an input s64 and a type-0x21 input buffer.
|-
|-
| 0xC || 0x1 || [[Filesystem_services#StorageId|StorageId]] for the Application base title.
| 11 || Read || Takes an input s64 and a type-0x22 output buffer.
|-
|}
| 0xD || 0x1 || [[Filesystem_services#StorageId|StorageId]] for the Application update title.
 
== ITransferStorageAccessor ==
This is "nn::am::service::ITransferStorageAccessor".
 
{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetSize || No input. Returns an output s64.
|-
| 1 || GetHandle || No input. Returns an output s64 and handle.
|}
 
These commands return the data originally from [[#CreateHandleStorage]] input, both return the same s64.
 
= appletOE =
This is "nn::am::service::IApplicationProxyService".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 2000 || [S2] [[#OpenCompatApplicationFunctions|OpenCompatApplicationFunctions]]
|-
| 0 || [[#OpenApplicationProxy]]
|-
| 10 || [S2] [[#OpenApplicationProxy2|OpenApplicationProxy2]]
|}
 
This is used by all regular-applications, including [[flog]] and "Retail Interactive Display Menu". Only one session can be open for this service at a time.
 
== OpenApplicationProxy ==
Takes a reserved input u64 (official user-processes use hard-coded value 0), a PID, and a process copy-handle (cur-proc handle alias). Returns an [[#IApplicationProxy]].
 
On failure, official user-processes will retry using this command in a loop while the retval is 0x19280, with svcSleepThread(10000000) being called first.
 
== OpenApplicationProxy2 ==
Unofficial name.
 
Takes an input u32, an u64 pid_reserved, a PID, and a process copy-handle (cur-proc handle alias). Returns an [[#IApplicationProxy]].
 
= idle:sys =
This is "nn::idle::detail::IPolicyManagerSystem"
 
This was moved to [[OMM_services|omm]] with [14.0.0+].
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
|-
| 0xE || 0x1 || Unknown.
| 0 || GetAutoPowerDownEvent
|-
|-
| 0xF || 0x1 || Padding.
| 1 || [7.0.0+] IsAutoPowerDownRequested ([1.0.0-3.0.2] )
|}
|-
| 2 || [1.0.0-3.0.2]
|-
| 3 || [[#SetHandlingContext]]
|-
| 4 || LoadAndApplySettings
|-
| 5 || ReportUserIsActive
|}
 
== SetHandlingContext ==
[3.0.0+] Now takes an additional 0x10-bytes of input.
 
[13.0.0+] Total input size is now 0x30 instead of 0x38.
 
= omm =
This is "nn::omm::detail::IOperationModeManager"
 
Operation Mode Manager (OMM) is a service responsible for arbitrating the operation changes between docked and handheld modes.
Besides [[PTM_services|PTM]], this is the only service that interacts with the [[Dock]] through [[USB_services|usb:pd*]].
 
This was moved to [[OMM_services|omm]] with [14.0.0+].
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetOperationMode
|-
| 1 || GetOperationModeChangeEvent
|-
| 2 || EnableAudioVisual
|-
| 3 || DisableAudioVisual
|-
| 4 || EnterSleepAndWait
|-
| 5 || GetCradleStatus
|-
| 6 || FadeInDisplay
|-
| 7 || FadeOutDisplay
|-
| 8 || [2.0.0+] GetCradleFwVersion
|-
| 9 || [2.0.0+] NotifyCecSettingsChanged
|-
| 10 || [3.0.0+] SetOperationModePolicy
|-
| 11 || [3.0.0+] GetDefaultDisplayResolution
|-
| 12 || [3.0.0+] GetDefaultDisplayResolutionChangeEvent
|-
| 13 || [3.0.0+] UpdateDefaultDisplayResolution
|-
| 14 || [3.0.0+] ShouldSleepOnBoot
|-
| 15 || [4.0.0+] NotifyHdcpApplicationExecutionStarted
|-
| 16 || [4.0.0+] NotifyHdcpApplicationExecutionFinished
|-
| 17 || [4.0.0+] NotifyHdcpApplicationDrawingStarted
|-
| 18 || [4.0.0+] NotifyHdcpApplicationDrawingFinished
|-
| 19 || [4.0.0+] GetHdcpAuthenticationFailedEvent
|-
| 20 || [4.0.0+] GetHdcpAuthenticationFailedEmulationEnabled
|-
| 21 || [4.0.0+] SetHdcpAuthenticationFailedEmulation
|-
| 22 || [4.0.0+] GetHdcpStateChangeEvent
|-
| 23 || [4.0.0+] GetHdcpState
|-
| 24 || [5.0.0+] ShowCardUpdateProcessing
|-
| 25 || [5.0.0+] SetApplicationCecSettingsAndNotifyChanged
|-
| 26 || [7.0.0+] [[#GetOperationModeSystemInfo]]
|-
| 27 || [9.0.0+] GetAppletFullAwakingSystemEvent
|-
| 28 || [12.0.0+] [[#CreateCradleFirmwareUpdater]]
|}
 
== GetOperationModeSystemInfo ==
No input, returns an output u32.
 
This is used by [[#GetOperationModeSystemInfo|ICommonStateGetter GetOperationModeSystemInfo]].
 
== CreateCradleFirmwareUpdater ==
No input. Returns an [[#ICradleFirmwareUpdater]].
 
== ICradleFirmwareUpdater ==
This is "nn::am::service::ICradleFirmwareUpdater".
 
This was added with [12.0.0+].
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Start
|-
| 1 || Finish
|-
| 2 || GetUpdateDeviceStatus
|-
| 3 || GetUpdateProgress
|-
| 4 || GetUpdateDeviceStatusChangeEvent
|-
| 5 || GetUpdateProgress2
|}
 
= spsm =
This is "nn::spsm::detail::IPowerStateInterface".
 
This was moved to [[OMM_services|omm]] with [14.0.0+].
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetCurrentState
|-
| 1 || EnterSleep
|-
| 2 || GetLastWakeReason
|-
| 3 || Shutdown
|-
| 4 || GetNotificationMessageEventHandle
|-
| 5 || ReceiveNotificationMessage
|-
| 6 || AnalyzeLogForLastSleepWakeSequence
|-
| 7 || ResetEventLog
|-
| 8 || AnalyzePerformanceLogForLastSleepWakeSequence
|-
| 9 || ChangeHomeButtonLongPressingTime
|-
| 10 || PutErrorState
|-
| 11 || [1.0.0-3.0.2] InvalidateCurrentHomeButtonPressing
|}
 
[3.0.0+] Cmd11 now takes a total of 8-bytes of input.
 
= tcap =
This is "nn::tcap::server::IManager".
 
This was removed with [11.0.0+].
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetContinuousHighSkinTemperatureEvent
|-
| 1 || SetOperationMode
|-
| 2 || LoadAndApplySettings
|}
 
= caps:su =
This is "nn::capsrv::sf::IScreenShotApplicationService".
 
This was added with [6.0.0+].
 
This can be used by applications to save screenshots.
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 32 || [7.0.0+] [[#SetShimLibraryVersion]]
|-
| 201 || [[#SaveScreenShot]]
|-
| 203 || [[#SaveScreenShotEx0]]
|-
| 205 || [8.0.0+] [[#SaveScreenShotEx1]]
|-
| 210 || [[#SaveScreenShotEx2]]
|}
 
== SetShimLibraryVersion ==
Takes a total of 0x10-bytes of input and a PID, no output.
 
This is a wrapper for [[Capture_services|caps:c]] cmd33. Commands '''SaveScreenShot''', '''SaveScreenShotEx0''', '''SaveScreenShotEx1''' and '''SaveScreenShotEx2''' are wrappers for [[Display_services|caps:sc]] cmd210.
 
== SaveScreenShot ==
Takes two input u32s, an u64 AppletResourceUserId, a PID, and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].
 
Official user-processes doesn't use this, instead [[#SaveScreenShotEx0]] is used: ScreenShotAttributeEx0 is all-zero, except +4 is set to an input u32 and u32 +0xC = 0x1.
 
This cmd internally uses an all-zero ScreenShotAttributeEx0, with u32 +0 = input u32 and u32 +0x8 = 0x3.
 
== SaveScreenShotEx0 ==
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a PID, and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].
 
== SaveScreenShotEx1 ==
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a PID, a type-0x15 input buffer containing an [[Capture_services|ApplicationData]], and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].
 
== SaveScreenShotEx2 ==
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a type-0x15 input buffer containing an [[Capture_services|UserIdList]], and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].
 
= apm =
This is "nn::am::service::IApmManager".
 
This was added with [8.0.0+].
 
[S2] Official sw no longer uses this (stubbed out).
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#OpenSession]]
|-
| 1 || GetPerformanceMode
|-
| 6 || [7.0.0+] [[#IsCpuOverclockEnabled]]
|}
 
== OpenSession ==
Returns an [[#ISession]].
 
== IsCpuOverclockEnabled ==
No input, returns an output u8 bool.
 
== ISession ==
This is "nn::am::service::IApmSession".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetPerformanceConfiguration
|-
| 1 || GetPerformanceConfiguration
|-
| 2 || [8.0.0+] SetCpuOverclockEnabled
|}
 
= (S2) adraw:a =
This is "nn::appletdraw::sfif::IAppletRoot".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || [[#OpenResourceSession]]
|-
| 2 || [[#OpenAppletSession]]
|}
 
== OpenResourceSession ==
Unofficial name.
 
Takes a PID and an input [[#AppletResourceUserId|AppletResourceUserId]]. Returns a [[#IResourceSession]].
 
== OpenAppletSession ==
Unofficial name.
 
Takes a PID and an input [[#AppletResourceUserId|AppletResourceUserId]]. Returns a [[#IAppletSession]].
 
== IResourceSession ==
This is "nn::appletdraw::sfif::IResourceSession".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || [[#Ping|Ping]]
|-
| 10 || 
|-
| 11 || 
|}
 
=== Ping ===
Unofficial name.
 
Takes an input u64. Returns an output u64.
 
The output u64 should match the input u64. Official software sends the current system tick value.
 
=== Cmd10 ===
Takes a handle, a u64 and an int. Returns a handle.
 
=== Cmd11 ===
No input/output.
 
== IAppletSession ==
This is "nn::appletdraw::sfif::IAppletSession".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || [[#Ping|Ping]]
|-
| 2 || [[#GetEvent|GetEvent]]
|-
| 3 || [20.1.1+]
|-
| 10 || 
|-
| 11 || 
|-
| 12 || 
|-
| 13 || 
|-
| 15 || 
|-
| 16 || [20.1.1+]
|-
| 17 || [20.1.1+]
|-
| 18 || [20.1.1+]
|-
| 19 || [20.1.1+]
|-
| 21 || 
|-
| 22 || 
|-
| 23 || [20.1.1+]
|-
| 24 || [20.1.1+]
|-
| 31 || [[#GetFrameBufferInfo|GetFrameBufferInfo]]
|-
| 8001 || [[#GetFrameBufferInfoForDebug|GetFrameBufferInfoForDebug]]
|-
| 8003 || [19.0.0-19.1.0]
|-
| 8004 || 
|}
 
=== GetEvent ===
Unofficial name.
 
No input. Returns an output Event handle.
 
=== Cmd3 ===
Takes a handle. No output.
 
=== Cmd10 ===
Takes an input u32. No output.
 
=== Cmd11 ===
Takes an input u32. No output.
 
=== Cmd12 ===
Takes an input u64. Returns an output u32.
 
=== Cmd13 ===
Takes an input u32. Returns an output u32.
 
=== Cmd15 ===
Takes an input u32. Returns three output u32s.
 
=== Cmd16 ===
No input. Returns an output u32.
 
=== Cmd17 ===
Takes an input u32. Returns an output u32 and an output u16.
 
=== Cmd18 ===
Takes an input u32. Returns three output u32s and an output u16.
 
=== Cmd19 ===
Takes an input u32. Returns an output u32 and an output u16.
 
=== Cmd21 ===
Takes an input u32. Returns a struct of size 0x40.
 
=== Cmd22 ===
Takes a struct of size 0x20. Returns a struct of size 0x40.
 
=== Cmd23 ===
No input. Returns a struct of size 0xC8.
 
=== Cmd24 ===
Takes an ipc-buf with size 0xD8. No output.
 
=== GetFrameBufferInfo ===
Unofficial name.
 
No input. Returns an [[#(S2)_AdrawFrameBufferInfo|AdrawFrameBufferInfo]].
 
[[#(S2)_AdrawFrameBufferInfo|Id]] is "adrawfb".
 
=== GetFrameBufferInfoForDebug ===
Unofficial name.
 
No input. Returns an [[#(S2)_AdrawFrameBufferInfo|AdrawFrameBufferInfo]].
 
=== Cmd8003 ===
Takes an input u64. Returns a struct with size 0x18.
 
=== Cmd8004 ===
Takes an input u32. Returns an output u64.
 
= (S2) appletOE =
This is "nn::am::service::IApplicationProxyServiceForNxCompat".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#OpenApplicationProxy]]
|-
| 2000 || [[#OpenCompatApplicationFunctions]]
|}
 
== OpenCompatApplicationFunctions ==
No input. Returns an [[#INxCompatApplicationFunctions]].
 
== INxCompatApplicationFunctions ==
This is "nn::am::service::INxCompatApplicationFunctions".
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 2000 || [[#GetGraphicsSupervisorForNxCompat]]
|-
| 2001 ||
|-
| 2002 || 
|-
| 2003 || [[#SetCopyright]]
|-
| 2004 || 
|-
| 2010 || 
|-
| 2020 || [[#Initialize]]
|-
| 2030 || [[#GetVsyncEvent]]
|-
| 2040 || [[#GetVsyncTimestamp]]
|-
| 2050 ||
|-
| 2060 ||
|-
| 2070 || [[#CreateMovieMaker]]
|}
 
=== GetGraphicsSupervisorForNxCompat ===
Unofficial name.
 
No input. Returns an output TIPC handle to [[Switch_2:_GSV_services|GraphicsSupervisor]].
 
Same as [[#GetGraphicsSupervisor]] but for compat mode.
 
=== SetCopyright ===
Unofficial name.
 
Takes an input bool. No output.
 
Called directly after "nn::vi::WriteToCopyrightFramebuffer".
 
=== Initialize ===
Unofficial name.
 
No input/output.
 
Called during init.
 
=== GetVsyncEvent ===
Unofficial name.
 
No input. Returns an Event handle.
 
=== GetVsyncTimestamp ===
Unofficial name.
 
No input. Returns an output u64.
 
When event from [[#GetVsyncEvent]] triggers, this returns a timestamp.
 
= Library Applets =
This section documents library applet launching.
 
Before starting the applet, [[#IStorage]]s are [[#ILibraryAppletCreator|created]] and written, then passed to [[#ILibraryAppletAccessor]] PushInData. The [[#IStorage]] session is closed afterwards. The first [[#IStorage]] is [[#CommonArguments]], followed by any applet-specific [[#IStorage]]s.
 
Once the applet finishes running successfully, [[#ILibraryAppletAccessor]] PopOutData can be used to get the applet-specific [[#IStorage]] containing the applet output data.
 
== CommonArguments ==
The first [[#CreateStorage|IStorage]] passed to applets should contain the common library applet arguments. This is populated by <code>nn::la::CommonArgumentsWriter</code> and has the following format.
 
This struct is 0x20-bytes.
 
Official sw handles the first 8-bytes separately, which is a header. With CommonArguments version 0x0, the header is 4-bytes, while starting with version 0x1 it's 8-bytes.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Typical Value || Notes
|-
| 0x0 || 4 || 1 || Common Arguments version
|-
| 0x4 || 4 || 0x20 || Common Arguments size
|-
| 0x8 || 4 || || Library applet version (API version)
|-
| 0xC || 4 || 0 || Theme color
|-
| 0x10 || 1 || 0 || Play startup sound
|-
| 0x18 || 8 || N/A || System tick (see [[SVC#svcGetSystemTick|svcGetSystemTick]])
|-
|}
 
= AppletId =
This is "nn::applet::AppletId". See also [[:Category:Library Applets]].
 
{| class="wikitable" border="1"
|-
! Value
! ProgramId
! Description
|-
| 0x00000000
|
| None
|-
| 0x00000001
|
| Application (not valid for use with LibraryApplets)
|-
| 0x00000002
| 0x010000000000100C
| OverlayApplet (overlayDisp)
|-
| 0x00000003
| 0x0100000000001000
| SystemAppletMenu (qlaunch)
|-
| 0x00000004
| 0x0100000000001012
| SystemApplication (starter)
|-
| 0x0000000A
| 0x0100000000001001
| [[Auth_Applet|LibraryAppletAuth (auth)]]
|-
| 0x0000000B
| 0x0100000000001002
| [[Cabinet_Applet|LibraryAppletCabinet (cabinet)]]
|-
| 0x0000000C
| 0x0100000000001003
| [[Controller_Applet|LibraryAppletController (controller)]]
|-
| 0x0000000D
| 0x0100000000001004
| LibraryAppletDataErase (dataErase)
|-
| 0x0000000E
| 0x0100000000001005
| [[Error_Applet|LibraryAppletError (error)]]
|-
| 0x0000000F
| 0x0100000000001006
| LibraryAppletNetConnect (netConnect)
|-
| 0x00000010
| 0x0100000000001007
| [[Profile_Selector|LibraryAppletPlayerSelect (playerSelect)]]
|-
| 0x00000011
| 0x0100000000001008
| [[Software_Keyboard|LibraryAppletSwkbd (swkbd)]]
|-
| 0x00000012
| 0x0100000000001009
| [[MiiEdit_Applet|LibraryAppletMiiEdit (miiEdit)]]
|-
| 0x00000013
| [22.0.0+] 0x0100000000001043 ([1.0.0-21.2.0] 0x010000000000100A)
| [[Internet_Browser#010000000000100A|LibraryAppletWeb (web)]]
|-
| 0x00000014
| 0x010000000000100B
| [[Internet_Browser#ShopN|LibraryAppletShop (shop)]]
|-
| 0x00000015
| 0x010000000000100D
| [[Album_Applet|LibraryAppletPhotoViewer (photoViewer)]]
|-
| 0x00000016
| 0x010000000000100E
| LibraryAppletSet (set)
|-
| 0x00000017
| 0x010000000000100F
| [[Internet_Browser#Offline_Applet|LibraryAppletOfflineWeb (offlineWeb)]] (LibraryAppletOfflineWebApp_0 in Ounce)
|-
| 0x00000018
| [22.0.0+] 0x0100000000001042 ([1.0.0-21.2.0] 0x0100000000001010)
| [[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]]
|-
| 0x00000019
| [22.0.0+] 0x0100000000001043 ([1.0.0-21.2.0] 0x0100000000001011)
| [[Internet_Browser#WifiWebAuthApplet|LibraryAppletWifiWebAuth (wifiWebAuth)]]
|-
| 0x0000001A
| 0x0100000000001013
| [[MyPage_Applet|LibraryAppletMyPage (myPage)]]
|-
| 0x0000001B
| 0x010000000000101A
| LibraryAppletGift (gift)
|-
| 0x0000001C
| 0x010000000000101C
| LibraryAppletUserMigration (userMigration)
|-
| 0x0000001D
| 0x010000000000101D
| [9.0.0+] LibraryAppletPreomiaSys (EncounterSys)
|-
| 0x0000001E
| 0x0100000000001020
| [9.0.0+] LibraryAppletStory (story)
|-
| 0x0000001F
| 0x010070000E3C0000
| [9.0.0+] LibraryAppletPreomiaUsr (EncounterUsr)
|-
| 0x00000020
| 0x010086000E49C000
| [9.0.0+] LibraryAppletPreomiaUsrDummy (EncounterUsrDummy)
|-
| 0x00000021
| 0x0100000000001038
| [10.0.0+] LibraryAppletSample (sample)
|-
| 0x00000022
| 0x0100000000001007
| [13.0.0+] LibraryAppletPromoteQualification (playerSelect)
|-
| 0x00000032
| 0x010000000000100F
| [17.0.0+] LibraryAppletOfflineWebApp_3 ([[Internet_Browser#Offline_Applet|LibraryAppletOfflineWeb (offlineWeb)]] in NX)
|-
| 0x00000033
| 0x010000000000100F
| [17.0.0+] LibraryAppletOfflineWebSystem ([[Internet_Browser#Offline_Applet|LibraryAppletOfflineWeb (offlineWeb)]] in NX)
|-
| 0x00000035
| [22.0.0+] 0x0100000000001042 ([17.0.0-21.2.0] 0x0100000000001010, [16.0.0-16.1.0] 0x0100000000001042)
| [17.0.0+] LibraryAppletLhub ([16.0.0-16.1.0] ) ([[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]] in NX)
|-
| 0x00000036
| [22.0.0+] 0x0100000000001042 ([17.0.0-21.2.0] 0x0100000000001010, [16.0.0-16.1.0] 0x0100000000001042)
| [17.0.0+] LibraryAppletLogin ([16.0.0-16.1.0] ) ([[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]] in NX)
|-
| 0x00000037
| [22.0.0+] 0x0100000000001042 ([17.0.0-21.2.0] 0x0100000000001010, [16.0.0-16.1.0] 0x0100000000001042)
| [17.0.0+] LibraryAppletShare ([16.0.0-16.1.0] ) ([[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]] in NX)
|-
| 0x00000038
| 0x0100000000001043
| [16.0.0-16.1.0]
|-
| 0x00000050
| 0x0100000000001007
| [18.0.0+]
|-
| 0x00000051
| 0x0100000000001007
| [18.0.0+]
|-
| 0x00000052
| 0x0100000000001001
| [22.0.0+]
|-
| 0x00000064
| 0x0100000000001048
| [20.0.0+] [[Splay_Applet|splay]]
|-
| 0x00000066
| 0x0100000000001054
| [21.0.0+]
|-
| 0x000003E8
|
| [10.0.0-16.1.0] DevlopmentTool
|-
| 0x000003F1
| 0x010000000000D619
| [10.0.0-16.1.0] CombinationLA
|-
| 0x000003F2
| 0x010000000000D610
| [10.0.0-16.1.0] AeSystemApplet
|-
| 0x000003F3
| 0x010000000000D611
| [10.0.0-16.1.0] AeOverlayApplet
|-
| 0x000003F4
| 0x010000000000D612
| [10.0.0-16.1.0] AeStarter
|-
| 0x000003F5
| 0x010000000000D613
| [10.0.0-16.1.0] AeLibraryAppletAlone
|-
| 0x000003F6
| 0x010000000000D614
| [10.0.0-16.1.0] AeLibraryApplet1
|-
| 0x000003F7
| 0x010000000000D615
| [10.0.0-16.1.0] AeLibraryApplet2
|-
| 0x000003F8
| 0x010000000000D616
| [10.0.0-16.1.0] AeLibraryApplet3
|-
| 0x000003F9
| 0x010000000000D617
| [10.0.0-16.1.0] AeLibraryApplet4
|-
| 0x000003FA
| 0x010000000000D60A
| [10.0.0-16.1.0] AppletISA
|-
| 0x000003FB
| 0x010000000000D60B
| [10.0.0-16.1.0] AppletIOA
|-
| 0x000003FC
| 0x010000000000D60C
| [10.0.0-16.1.0] AppletISTA
|-
| 0x000003FD
| 0x010000000000D60D
| [10.0.0-16.1.0] AppletILA1
|-
| 0x000003FE
| 0x010000000000D60E
| [10.0.0-16.1.0] AppletILA2
|-
| 0x0100000A
|
| [[Auth_Applet|LibraryAppletAuth]]
|-
| 0x0100000B
|
| [[Cabinet_Applet|LibraryAppletCabinet]]
|-
| 0x0100000C
|
| [[Controller_Applet|LibraryAppletController]]
|-
| 0x0100000D
|
| [S2]
|-
| 0x0100000E
|
| [S2] LibraryAppletError
|-
| 0x01000010
|
| [S2] LibraryAppletPlayerSelect
|-
| 0x01010011
|
| [S2] SwkbdModeless
|-
| 0x01020011
|
| [S2] Swkbd
|-
| 0x01010012
|
| [S2] [[MiiEdit_Applet|LibraryAppletMiiEdit]] (for ShowMiiEdit)
|-
| 0x01020012
|
| [S2] [[MiiEdit_Applet|LibraryAppletMiiEdit]] (for AppendMii)
|-
| 0x01070012
|
| [S2] [[MiiEdit_Applet|LibraryAppletMiiEdit]] (for CreateMii)
|-
| 0x01080012
|
| [S2] [[MiiEdit_Applet|LibraryAppletMiiEdit]] (for EditMii)
|-
| 0x01000013
|
| [S2] OpenWeb
|-
| 0x01000014
|
| [S2] LibraryAppletShop
|-
| 0x01000015
|
| [S2] [[Album_Applet|Album]]
|-
| 0x01000017
|
| [S2] LibraryAppletOffline (for Gen0)
|-
| 0x01000018
|
| [S2] [[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare]] (for Lobby)
|-
| 0x0100001A
|
| [S2] [[MyPage_Applet|MyPageApplet]]
|-
| 0x01000022
|
| [S2] LibraryAppletPromoteQualification
|-
| 0x01000024
|
| [S2] SplayApplet
|-
| 0x01030024
|
| [S2] SplayApplet
|-
| 0x01010025
|
| [S2] SaveDataBackup (System Settings menu for Save Data Cloud)
|-
| 0x01020025
|
| [S2] SaveDataBackup (Same as above except with ApplicationId specified)
|-
| 0x01000028
|
| [S2] Eula
|-
| 0x01000032
|
| [S2] LibraryAppletOfflineWebApp_3
|-
| 0x01000033
|
| [S2] LibraryAppletOfflineWebSystem
|-
| 0x01000035
|
| [S2] LibraryAppletLhub
|-
| 0x01000036
|
| [S2] LibraryAppletLogin
|-
| 0x01000037
|
| [S2] LibraryAppletShare
|-
| 0x01000050
|
| [S2] PlayerSelect
|-
| 0x01000051
|
| [S2] PlayerSelect
|-
| 0x01000052
|
| [S2] PlayerSelect
|-
| 0x01000065
|
| [S2] Chat (ForChatStart)
|-
| 0x01010065
|
| [S2] Chat (ForCameraConfiguration)
|-
| 0x01020065
|
| [S2] Chat (ForFullScreen)
|-
| 0x01030065
|
| [S2] Chat (ForCameraSharingGuide)
|-
| 0x700000C8
| 0x010000000000D65B
| [18.0.0+]
|-
| 0x700000C9
| 0x010000000000D65C
| [18.0.0+]
|-
| 0x700000DC
| 0x010000000000D619
| [17.0.0+] CombinationLA
|-
| 0x700000E6
| 0x010000000000D610
| [17.0.0+] AeSystemApplet
|-
| 0x700000E7
| 0x010000000000D611
| [17.0.0+] AeOverlayApplet
|-
| 0x700000E8
| 0x010000000000D612
| [17.0.0+] AeStarter
|-
| 0x700000E9
| 0x010000000000D613
| [17.0.0+] AeLibraryAppletAlone
|-
| 0x700000EA
| 0x010000000000D614
| [17.0.0+] AeLibraryApplet1
|-
| 0x700000EB
| 0x010000000000D615
| [17.0.0+] AeLibraryApplet2
|-
| 0x700000EC
| 0x010000000000D616
| [17.0.0+] AeLibraryApplet3
|-
| 0x700000ED
| 0x010000000000D617
| [17.0.0+] AeLibraryApplet4
|-
| 0x700000F0
| 0x010000000000D60A
| [17.0.0+] AppletISA
|-
| 0x700000F1
| 0x010000000000D60B
| [17.0.0+] AppletIOA
|-
| 0x700000F2
| 0x010000000000D60C
| [17.0.0+] AppletISTA
|-
| 0x700000F3
| 0x010000000000D60D
| [17.0.0+] AppletILA1
|-
| 0x700000F4
| 0x010000000000D60E
| [17.0.0+] AppletILA2
|-
| 0x700000FA
| 0x010000000000D677
| [20.1.0+]
|}
 
= LibraryAppletMode =
This is "nn::applet::LibraryAppletMode".
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| AllForeground
|-
| 0x1
| PartialForeground
|-
| 0x2
| NoUi
|-
| 0x3
| PartialForegroundWithIndirectDisplay (see also [[#GetIndirectLayerConsumerHandle]], only used by swkbd [[Software_Keyboard|InlineKeyboard]])
|-
| 0x4
| AllForegroundInitiallyHidden (can be used by [7.0.0+] [[Internet_Browser|WebSession]])
|}
 
= AppletMessage =
This is "nn::am::AppletMessage".
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || None
|-
| 1 || ChangeIntoForeground
|-
| 2 || ChangeIntoBackground
|-
| 4 || Exit
|-
| 6 || ApplicationExited
|-
| 7 ||
|-
| 15 || [[#FocusState|FocusStateChanged]]
|-
| 16 || [[#SetRestartMessageEnabled|Resume]]
|-
| 20 || DetectShortPressingHomeButton
|-
| 21 || DetectLongPressingHomeButton
|-
| 22 || DetectShortPressingPowerButton
|-
| 23 || DetectMiddlePressingPowerButton
|-
| 24 || DetectLongPressingPowerButton
|-
| 25 || RequestToPrepareSleep
|-
| 26 || FinishedSleepSequence
|-
| 27 || SleepRequiredByHighTemperature
|-
| 28 || SleepRequiredByLowBattery
|-
| 29 || AutoPowerDown
|-
| 30 || [[#OperationMode|OperationModeChanged]]
|-
| 31 || [[#PerformanceMode|PerformanceModeChanged]]
|-
| 32 || DetectReceivingCecSystemStandby
|-
| 33 || SdCardRemoved
|-
| 34 ||
|-
| 50 || LaunchApplicationRequested
|-
| 51 || [[#SetHandlesRequestToDisplay|RequestToDisplay]]
|-
| 55 || ShowApplicationLogo
|-
| 56 || HideApplicationLogo
|-
| 57 || ForceHideApplicationLogo
|-
| 58 ||
|-
| 59 ||
|-
| 60 || FloatingApplicationDetected
|-
| 61 || [7.0.0+] PerformanceConfigurationChanged
|-
| 70 ||
|-
| 71 ||
|-
| 72 ||
|-
| 73 ||
|-
| 75 ||
|-
| 80 ||
|-
| 81 ||
|-
| 82 ||
|-
| 83 ||
|-
| 85 ||
|-
| 86 ||
|-
| 90 || [[#SetRequiresCaptureButtonShortPressedMessage|DetectShortPressingCaptureButton]]
|-
| 92 || [[#SetAlbumImageTakenNotificationEnabled|AlbumScreenShotTaken]]
|-
| 93 || AlbumRecordingSaved
|-
| 94 ||
|-
| 100 ||
|-
| 101 ||
|-
| 110 || [14.0.0+] DetectShortPressingCaptureButtonForApplet
|-
| 111 || [14.0.0+] DetectLongPressingCaptureButtonForApplet
|-
| 1000 ||
|}
 
= OperationMode =
This is "nn::oe::OperationMode".
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Handheld
|-
| 1 || Console
|}
 
= PerformanceMode =
This is "nn::oe::PerformanceMode".
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| -1 || Invalid
|-
| 0 || Normal
|-
| 1 || Boost
|}
 
= FocusState =
This is "nn::oe::FocusState".
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 1 || InFocus
|-
| 2 || OutOfFocus
|-
| 3 || Background
|}
 
= CpuBoostMode =
This is "nn::oe::CpuBoostMode".
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Normal
|-
| 1 || FastLoad
|}
 
= WindowOriginMode =
This is "nn::oe::WindowOriginMode".
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || LowerLeft
|-
| 1 || UpperLeft
|}
 
= WirelessPriorityMode =
This is "nn::oe::WirelessPriorityMode".
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Default
|-
| 1 || OptimizedForWlan
|}
 
= TvPowerStateMatchingMode =
This is "nn::oe::TvPowerStateMatchingMode". This is used with [[#SetTvPowerStateMatchingMode]].
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Unknown
|-
| 1 || Unknown
|}
 
= SystemButtonType =
This is "nn::am::service::SystemButtonType". This is used with [[#PerformSystemButtonPressingIfInFocus]]/[[#PerformSystemButtonPressing]].
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 1 || PerformHomeButtonShortPressing
|-
| 2 || PerformHomeButtonLongPressing
|-
| 3 || Short-pressing with the Power-button. Only available with [[#PerformSystemButtonPressing]].
|-
| 4 || Long-pressing with the Power-button. Only available with [[#PerformSystemButtonPressing]].
|-
| 5 || Shutdown the system. Only available with [[#PerformSystemButtonPressing]].
|-
| 6 || PerformCaptureButtonShortPressing
|-
| 7 || PerformCaptureButtonLongPressing
|}
 
= LaunchParameterKind =
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 1 || UserChannel. Application-specific LaunchParameter.
|-
| 2 || account PreselectedUser
|-
| 3 || Unknown if used by anything?
|}
 
= LibraryAppletExitReason =
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Normal
|-
| 1 || Canceled
|-
| 2 || Abnormal
|-
| 10 || Unexpected
|}
 
= ProgramSpecifyKind =
This is "nn::am::service::ProgramSpecifyKind". This controls the type of the u64 passed to [[#ExecuteProgram]].
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || u8 ProgramIndex. "ExecuteProgram". [[NS_Services|NS]] handles ProgramIndex by launching ApplicationId+ProgramIndex. After using [[#ExecuteProgram]] with this successfully, official user-processes will enter an infinite loop with sleep-thread value 86400000000000.
|-
| 1 || [[NCM_services#ApplicationId|ApplicationId]]. "JumpToSubApplicationProgramForDevelopment". Only available when [[Settings_services#GetDebugModeFlag|DebugMode]] is 1.
|-
| 2 || u64 = value 0. "RestartProgram"
|}
 
ProgramIndex values where the title is not installed should not be used: [[qlaunch]] will display an error message and the current title will become "corrupted", however Home Menu will have an option to repair it.
 
= InputDetectionPolicy =
This is u32 enum "nn::applet::InputDetectionPolicy".
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Unknown
|-
| 1 || Unknown
|}
 
= AppletResourceUserId =
This is "nn::applet::AppletResourceUserId". Used by a number of non-AM services.
 
= AppletAttribute =
This is "nn::am::AppletAttribute". This struct is 0x80 bytes.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || Flag. When non-zero, two state fields are set to 1.
|-
| 0x1 || 0x7F || Unused
|}
 
This is used by [[#OpenLibraryAppletProxy]].
 
= AppletProcessLaunchReason =
This is "nn::am::service::AppletProcessLaunchReason". This struct is 0x4-bytes.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || Flag. When non-zero, LibraryApplets then use [[#OpenCallingLibraryApplet]].
|-
| 0x1 || 0x2 || Always 0.
|-
| 0x3 || 0x1 || Always 0.
|}
 
= LibraryAppletInfo =
This is "nn::am::service::LibraryAppletInfo". This struct is 0x8-bytes.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#AppletId]]
|-
| 0x4 || 0x4 || [[#LibraryAppletMode]]
|}
 
= AppletKind =
This is "nn::am::service::AppletKind". This is 8-bytes.
 
= AppletIdentityInfo =
This struct is "nn::am::service::AppletIdentityInfo". This struct is 0x10-bytes.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#AppletId]]
|-
| 0x4 || 0x4 || Padding
|-
| 0x8 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
|}
 
= ApplicationAttributeForQuest =
This struct is "nn::applet::ApplicationAttributeForQuest".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || See [[#ApplicationAttribute]].
|-
| 0x4 || 0x4 || See [[#ApplicationAttribute]].
|-
| 0x8 || 0x4 || [7.0.0+] See [[#ApplicationAttribute]].
|}
 
User-processes copy the first 0x8-bytes (0xC-bytes with [[#CreateApplicationWithAttributeAndPushAndRequestToStartForQuest]]/[[#CreateApplicationWithAttributeAndRequestToStartForQuest]]) to a [[#ApplicationAttribute]] with the rest of the struct being cleared, which is then passed to the actual cmd (CreateApplication*ToStartForQuest).
 
= ApplicationAttribute =
This struct is "nn::am::ApplicationAttribute". This struct is 0x20-bytes.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Default is 0 for non-Quest. Only used when non-zero: unknown value in seconds.
|-
| 0x4 || 0x4 || Default is 0 for non-Quest. Only used when non-zero: unknown value in seconds.
|-
| 0x8 || 0x4 || float audio volume. Must be in the range of 0.0f-1.0f. The default is 1.0f.
|-
| 0xC || 0x14 || Unused. Default is 0.
|}
 
Internally AM only uses the first 0xC-bytes from ApplicationAttribute, regardless of the cmd.
 
= ApplicationLaunchProperty =
This struct is 0x10-bytes.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
|-
| 0x8 || 0x4 || Application title-version.
|-
| 0xC || 0x1 || [[Filesystem_services#StorageId|StorageId]] for the Application base title.
|-
| 0xD || 0x1 || [[Filesystem_services#StorageId|StorageId]] for the Application update title.
|-
| 0xE || 0x1 || Unknown.
|-
| 0xF || 0x1 || Padding.
|}
 
= ApplicationLaunchRequestInfo =
This is "nn::applet::ApplicationLaunchRequestInfo". This struct is 0x10-bytes.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Unknown. The default is 0x0 with [[#CreateSystemApplication]], 0x3 with [[#CreateApplication]].
|-
| 0x4 || 0x4 || Unknown. The default is 0x0 with [[#CreateSystemApplication]], 0x3 with [[#CreateApplication]].
|-
| 0x8 || 0x8 || Unknown. The default is 0x0.
|}
 
= AppletResourceUsageInfo =
This is "nn::am::service::AppletResourceUsageInfo". This struct is 0x20-bytes.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Unknown counter.
|-
| 0x4 || 0x4 || Unknown counter.
|-
| 0x8 || 0x4 || Output from [[NS_Services|NS GetRightsEnvironmentCountForDebug]].
|-
| 0xC || 0x14 || Always zero.
|}
 
= ApplicationLicenseType =
This is "nn::oe::ApplicationLicenseType". This is 1-byte.
 
= LaunchRequiredVersion =
This is "nn::oe::LaunchRequiredVersion". This is a 0x40-byte struct with 1-byte alignment.
 
= ServerEnvironmentType =
This is "nn::oe::ServerEnvironmentType".
 
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || dd
|-
| 1 || lp
|-
| 2 || sd
|-
| 3 || sp
|-
| 4 || dp
|}
 
= (S2) AdrawFrameBufferInfo =
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || Id
|-
| 0x8 || 0x2 || Width
|-
| 0xA || 0x2 || Height
|-
| 0xC || 0x4 || BlockCount
|-
| 0x10 || 0x8 ||
|-
| 0x18 || 0x8 ||
|-
| 0x20 || 0x8 ||
|}
 
= (S2) ImageInfo =
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 ||
|-
| 0x8 || 0x8 || Address
|-
| 0x10 || 0x8 ||
|-
| 0x18 || 0x8 ||
|-
| 0x20 || 0x8 ||
|-
| 0x28 || 0x8 ||
|-
| 0x30 || 0x8 ||
|-
| 0x38 || 0x4 || Offset
|-
| 0x3C || 0x4 || Size
|-
| 0x40 || 0x8 ||
|-
| 0x48 || 0x8 ||
|-
| 0x50 || 0x8 ||
|-
| 0x58 || 0x8 ||
|-
| 0x60 || 0x8 ||
|-
| 0x68 || 0x8 ||
|-
| 0x70 || 0x8 ||
|-
| 0x78 || 0x8 ||
|-
| 0x80 || 0x8 ||
|-
| 0x88 || 0x8 ||
|-
| 0x90 || 0x4 || Flags
|}
 
= Notes =
AM-sysmodule will only initialize [[Shared_Database_services|pdm:ntfy]] / use pdm:ntfy service commands when the value from [[Process_Manager_services|pm:bm]] GetBootMode is not 0x1 (Maintenance).


= ApplicationLaunchRequestInfo =
An object constructor also writes the output from [[Process_Manager_services|pm:bm]] GetBootMode into the created object. A vfunc for this object checks whether this field is Maintenance: if so, it calls a vfunc then a func and returns. Otherwise after calling various (v)funcs, if required this eventually uses [[OMM_services|ommdisp]] cmd600.
This is "nn::applet::ApplicationLaunchRequestInfo". This struct is 0x10-bytes.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Unknown. The default is 0x0 with [[#CreateSystemApplication]], 0x3 with [[#CreateApplication]].
|-
| 0x4 || 0x4 || Unknown. The default is 0x0 with [[#CreateSystemApplication]], 0x3 with [[#CreateApplication]].
|-
| 0x8 || 0x8 || Unknown. The default is 0x0.
|}
 
= AppletResourceUsageInfo =
This is "nn::am::service::AppletResourceUsageInfo". This struct is 0x20-bytes.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Unknown counter.
|-
| 0x4 || 0x4 || Unknown counter.
|-
| 0x8 || 0x4 || Output from [[NS_Services|NS GetRightsEnvironmentCountForDebug]].
|-
| 0xC || 0x14 || Always zero.
|}
 
= ApplicationLicenseType =
This is "nn::oe::ApplicationLicenseType". This is 1-byte.
 
= LaunchRequiredVersion =
This is "nn::oe::LaunchRequiredVersion". This is a 0x40-byte struct with 1-byte alignment.
 
= Notes =
AM-sysmodule will only initialize [[Shared_Database_services|pdm:ntfy]] / use pdm:ntfy service commands when the value from [[Process_Manager_services|pm:bm]] GetBootMode is not 0x1.


[[Category:Services]]
[[Category:Services]]