Class VRApplications


  • public class VRApplications
    extends java.lang.Object
    Application management.
    • Method Detail

      • nVRApplications_AddApplicationManifest

        public static int nVRApplications_AddApplicationManifest​(long pchApplicationManifestFullPath,
                                                                 boolean bTemporary)
        Unsafe version of: AddApplicationManifest
      • VRApplications_AddApplicationManifest

        public static int VRApplications_AddApplicationManifest​(java.nio.ByteBuffer pchApplicationManifestFullPath,
                                                                boolean bTemporary)
        
        public static int VRApplications_AddApplicationManifest​(java.lang.CharSequence pchApplicationManifestFullPath,
                                                                boolean bTemporary)
        
        Adds an application manifest to the list to load when building the list of installed applications.

        Temporary manifests are not automatically loaded.

      • nVRApplications_RemoveApplicationManifest

        public static int nVRApplications_RemoveApplicationManifest​(long pchApplicationManifestFullPath)
        Unsafe version of: RemoveApplicationManifest
      • VRApplications_RemoveApplicationManifest

        public static int VRApplications_RemoveApplicationManifest​(java.nio.ByteBuffer pchApplicationManifestFullPath)
        
        public static int VRApplications_RemoveApplicationManifest​(java.lang.CharSequence pchApplicationManifestFullPath)
        
        Removes an application manifest from the list to load when building the list of installed applications.
      • nVRApplications_IsApplicationInstalled

        public static boolean nVRApplications_IsApplicationInstalled​(long pchAppKey)
        Unsafe version of: IsApplicationInstalled
      • VRApplications_IsApplicationInstalled

        public static boolean VRApplications_IsApplicationInstalled​(java.nio.ByteBuffer pchAppKey)
        
        public static boolean VRApplications_IsApplicationInstalled​(java.lang.CharSequence pchAppKey)
        
        Returns true if an application is installed.
      • VRApplications_GetApplicationCount

        public static int VRApplications_GetApplicationCount()
        Returns the number of applications available in the list.
      • nVRApplications_GetApplicationKeyByIndex

        public static int nVRApplications_GetApplicationKeyByIndex​(int unApplicationIndex,
                                                                   long pchAppKeyBuffer,
                                                                   int unAppKeyBufferLen)
        Unsafe version of: GetApplicationKeyByIndex
      • VRApplications_GetApplicationKeyByIndex

        public static int VRApplications_GetApplicationKeyByIndex​(int unApplicationIndex,
                                                                  @Nullable
                                                                  java.nio.ByteBuffer pchAppKeyBuffer)
        Returns the key of the specified application. The index is at least 0 and is less than the return value of GetApplicationCount. The buffer should be at least VR.k_unMaxApplicationKeyLength in order to fit the key.
      • nVRApplications_GetApplicationKeyByProcessId

        public static int nVRApplications_GetApplicationKeyByProcessId​(int unProcessId,
                                                                       long pchAppKeyBuffer,
                                                                       int unAppKeyBufferLen)
        Unsafe version of: GetApplicationKeyByProcessId
      • VRApplications_GetApplicationKeyByProcessId

        public static int VRApplications_GetApplicationKeyByProcessId​(int unProcessId,
                                                                      @Nullable
                                                                      java.nio.ByteBuffer pchAppKeyBuffer)
        Returns the key of the application for the specified Process Id. The buffer should be at least VR.k_unMaxApplicationKeyLength in order to fit the key.
      • nVRApplications_LaunchApplication

        public static int nVRApplications_LaunchApplication​(long pchAppKey)
        Unsafe version of: LaunchApplication
      • VRApplications_LaunchApplication

        public static int VRApplications_LaunchApplication​(java.nio.ByteBuffer pchAppKey)
        
        public static int VRApplications_LaunchApplication​(java.lang.CharSequence pchAppKey)
        
        Launches the application. The existing scene application will exit and then the new application will start.

        This call is not valid for dashboard overlay applications.

      • nVRApplications_LaunchTemplateApplication

        public static int nVRApplications_LaunchTemplateApplication​(long pchTemplateAppKey,
                                                                    long pchNewAppKey,
                                                                    long pKeys,
                                                                    int unKeys)
        Unsafe version of: LaunchTemplateApplication
      • VRApplications_LaunchTemplateApplication

        public static int VRApplications_LaunchTemplateApplication​(java.nio.ByteBuffer pchTemplateAppKey,
                                                                   java.nio.ByteBuffer pchNewAppKey,
                                                                   AppOverrideKeys.Buffer pKeys)
        
        public static int VRApplications_LaunchTemplateApplication​(java.lang.CharSequence pchTemplateAppKey,
                                                                   java.lang.CharSequence pchNewAppKey,
                                                                   AppOverrideKeys.Buffer pKeys)
        
        Launches an instance of an application of type template, with its app key being pchNewAppKey (which must be unique) and optionally override sections from the manifest file via AppOverrideKeys.
      • nVRApplications_LaunchApplicationFromMimeType

        public static int nVRApplications_LaunchApplicationFromMimeType​(long pchMimeType,
                                                                        long pchArgs)
      • VRApplications_LaunchApplicationFromMimeType

        public static int VRApplications_LaunchApplicationFromMimeType​(java.nio.ByteBuffer pchMimeType,
                                                                       java.nio.ByteBuffer pchArgs)
        
        public static int VRApplications_LaunchApplicationFromMimeType​(java.lang.CharSequence pchMimeType,
                                                                       java.lang.CharSequence pchArgs)
        
        Launches the application currently associated with this mime type and passes it the option args, typically the filename or object name of the item being launched.
      • nVRApplications_LaunchDashboardOverlay

        public static int nVRApplications_LaunchDashboardOverlay​(long pchAppKey)
        Unsafe version of: LaunchDashboardOverlay
      • VRApplications_LaunchDashboardOverlay

        public static int VRApplications_LaunchDashboardOverlay​(java.nio.ByteBuffer pchAppKey)
        
        public static int VRApplications_LaunchDashboardOverlay​(java.lang.CharSequence pchAppKey)
        
        Launches the dashboard overlay application if it is not already running. This call is only valid for dashboard overlay applications.
      • nVRApplications_CancelApplicationLaunch

        public static boolean nVRApplications_CancelApplicationLaunch​(long pchAppKey)
        Unsafe version of: CancelApplicationLaunch
      • VRApplications_CancelApplicationLaunch

        public static boolean VRApplications_CancelApplicationLaunch​(java.nio.ByteBuffer pchAppKey)
        
        public static boolean VRApplications_CancelApplicationLaunch​(java.lang.CharSequence pchAppKey)
        
        Cancel a pending launch for an application.
      • nVRApplications_IdentifyApplication

        public static int nVRApplications_IdentifyApplication​(int unProcessId,
                                                              long pchAppKey)
        Unsafe version of: IdentifyApplication
      • VRApplications_IdentifyApplication

        public static int VRApplications_IdentifyApplication​(int unProcessId,
                                                             java.nio.ByteBuffer pchAppKey)
        
        public static int VRApplications_IdentifyApplication​(int unProcessId,
                                                             java.lang.CharSequence pchAppKey)
        
        Identifies a running application. OpenVR can't always tell which process started in response to a URL. This function allows a URL handler (or the process itself) to identify the app key for the now running application. Passing a process ID of 0 identifies the calling process. The application must be one that's known to the system via a call to AddApplicationManifest.
      • nVRApplications_GetApplicationProcessId

        public static int nVRApplications_GetApplicationProcessId​(long pchAppKey)
        Unsafe version of: GetApplicationProcessId
      • VRApplications_GetApplicationProcessId

        public static int VRApplications_GetApplicationProcessId​(java.nio.ByteBuffer pchAppKey)
        
        public static int VRApplications_GetApplicationProcessId​(java.lang.CharSequence pchAppKey)
        
        Returns the process ID for an application. Return 0 if the application was not found or is not running.
      • nVRApplications_GetApplicationsErrorNameFromEnum

        public static long nVRApplications_GetApplicationsErrorNameFromEnum​(int error)
      • nVRApplications_GetApplicationPropertyString

        public static int nVRApplications_GetApplicationPropertyString​(long pchAppKey,
                                                                       int eProperty,
                                                                       long pchPropertyValueBuffer,
                                                                       int unPropertyValueBufferLen,
                                                                       long peError)
        Unsafe version of: GetApplicationPropertyString
      • nVRApplications_GetApplicationPropertyBool

        public static boolean nVRApplications_GetApplicationPropertyBool​(long pchAppKey,
                                                                         int eProperty,
                                                                         long peError)
        Unsafe version of: GetApplicationPropertyBool
      • nVRApplications_GetApplicationPropertyUint64

        public static long nVRApplications_GetApplicationPropertyUint64​(long pchAppKey,
                                                                        int eProperty,
                                                                        long peError)
        Unsafe version of: GetApplicationPropertyUint64
      • VRApplications_GetApplicationPropertyUint64

        public static long VRApplications_GetApplicationPropertyUint64​(java.nio.ByteBuffer pchAppKey,
                                                                       int eProperty,
                                                                       java.nio.IntBuffer peError)
        
        public static long VRApplications_GetApplicationPropertyUint64​(java.lang.CharSequence pchAppKey,
                                                                       int eProperty,
                                                                       java.nio.IntBuffer peError)
        
        Returns a uint64 value for an application property. Returns 0 in all error cases.
        Parameters:
        eProperty - must be:
        VR.EVRApplicationProperty_VRApplicationProperty_LastLaunchTime_Uint64
      • nVRApplications_SetApplicationAutoLaunch

        public static int nVRApplications_SetApplicationAutoLaunch​(long pchAppKey,
                                                                   boolean bAutoLaunch)
        Unsafe version of: SetApplicationAutoLaunch
      • VRApplications_SetApplicationAutoLaunch

        public static int VRApplications_SetApplicationAutoLaunch​(java.nio.ByteBuffer pchAppKey,
                                                                  boolean bAutoLaunch)
        
        public static int VRApplications_SetApplicationAutoLaunch​(java.lang.CharSequence pchAppKey,
                                                                  boolean bAutoLaunch)
        
        Sets the application auto-launch flag. This is only valid for applications which return true for VR.EVRApplicationProperty_VRApplicationProperty_IsDashboardOverlay_Bool.
      • nVRApplications_GetApplicationAutoLaunch

        public static boolean nVRApplications_GetApplicationAutoLaunch​(long pchAppKey)
        Unsafe version of: GetApplicationAutoLaunch
      • VRApplications_GetApplicationAutoLaunch

        public static boolean VRApplications_GetApplicationAutoLaunch​(java.nio.ByteBuffer pchAppKey)
        
        public static boolean VRApplications_GetApplicationAutoLaunch​(java.lang.CharSequence pchAppKey)
        
        Gets the application auto-launch flag. This is only valid for applications which return true for VR.EVRApplicationProperty_VRApplicationProperty_IsDashboardOverlay_Bool.
      • nVRApplications_SetDefaultApplicationForMimeType

        public static int nVRApplications_SetDefaultApplicationForMimeType​(long pchAppKey,
                                                                           long pchMimeType)
      • VRApplications_SetDefaultApplicationForMimeType

        public static int VRApplications_SetDefaultApplicationForMimeType​(java.nio.ByteBuffer pchAppKey,
                                                                          java.nio.ByteBuffer pchMimeType)
        
        public static int VRApplications_SetDefaultApplicationForMimeType​(java.lang.CharSequence pchAppKey,
                                                                          java.lang.CharSequence pchMimeType)
        
        Adds this mime-type to the list of supported mime types for this application.
      • nVRApplications_GetDefaultApplicationForMimeType

        public static boolean nVRApplications_GetDefaultApplicationForMimeType​(long pchMimeType,
                                                                               long pchAppKeyBuffer,
                                                                               int unAppKeyBufferLen)
      • VRApplications_GetDefaultApplicationForMimeType

        public static boolean VRApplications_GetDefaultApplicationForMimeType​(java.nio.ByteBuffer pchMimeType,
                                                                              @Nullable
                                                                              java.nio.ByteBuffer pchAppKeyBuffer)
        
        public static boolean VRApplications_GetDefaultApplicationForMimeType​(java.lang.CharSequence pchMimeType,
                                                                              @Nullable
                                                                              java.nio.ByteBuffer pchAppKeyBuffer)
        
        Return the app key that will open this mime type.
      • nVRApplications_GetApplicationSupportedMimeTypes

        public static boolean nVRApplications_GetApplicationSupportedMimeTypes​(long pchAppKey,
                                                                               long pchMimeTypesBuffer,
                                                                               int unMimeTypesBuffer)
      • VRApplications_GetApplicationSupportedMimeTypes

        public static boolean VRApplications_GetApplicationSupportedMimeTypes​(java.nio.ByteBuffer pchAppKey,
                                                                              @Nullable
                                                                              java.nio.ByteBuffer pchMimeTypesBuffer)
        
        public static boolean VRApplications_GetApplicationSupportedMimeTypes​(java.lang.CharSequence pchAppKey,
                                                                              @Nullable
                                                                              java.nio.ByteBuffer pchMimeTypesBuffer)
        
        Get the list of supported mime types for this application, comma-delimited.
      • nVRApplications_GetApplicationsThatSupportMimeType

        public static int nVRApplications_GetApplicationsThatSupportMimeType​(long pchMimeType,
                                                                             long pchAppKeysThatSupportBuffer,
                                                                             int unAppKeysThatSupportBuffer)
      • VRApplications_GetApplicationsThatSupportMimeType

        public static int VRApplications_GetApplicationsThatSupportMimeType​(java.nio.ByteBuffer pchMimeType,
                                                                            @Nullable
                                                                            java.nio.ByteBuffer pchAppKeysThatSupportBuffer)
        
        public static int VRApplications_GetApplicationsThatSupportMimeType​(java.lang.CharSequence pchMimeType,
                                                                            @Nullable
                                                                            java.nio.ByteBuffer pchAppKeysThatSupportBuffer)
        
        public static java.lang.String VRApplications_GetApplicationsThatSupportMimeType​(java.lang.CharSequence pchMimeType,
                                                                                         int unAppKeysThatSupportBuffer)
        
        Get the list of app-keys that support this mime type, comma-delimited, the return value is number of bytes you need to return the full string.
      • nVRApplications_GetApplicationLaunchArguments

        public static int nVRApplications_GetApplicationLaunchArguments​(int unHandle,
                                                                        long pchArgs,
                                                                        int unArgs)
      • VRApplications_GetApplicationLaunchArguments

        public static int VRApplications_GetApplicationLaunchArguments​(int unHandle,
                                                                       @Nullable
                                                                       java.nio.ByteBuffer pchArgs)
        
        public static java.lang.String VRApplications_GetApplicationLaunchArguments​(int unHandle,
                                                                                    int unArgs)
        
        Get the args list from an app launch that had the process already running, you call this when you get a VR.EVREventType_VREvent_ApplicationMimeTypeLoad.
      • nVRApplications_GetStartingApplication

        public static int nVRApplications_GetStartingApplication​(long pchAppKeyBuffer,
                                                                 int unAppKeyBufferLen)
        Unsafe version of: GetStartingApplication
      • VRApplications_GetStartingApplication

        public static int VRApplications_GetStartingApplication​(java.nio.ByteBuffer pchAppKeyBuffer)
        Returns the app key for the application that is starting up.
      • VRApplications_GetTransitionState

        public static int VRApplications_GetTransitionState()
        Returns the application transition state.
      • nVRApplications_PerformApplicationPrelaunchCheck

        public static int nVRApplications_PerformApplicationPrelaunchCheck​(long pchAppKey)
      • nVRApplications_GetApplicationsTransitionStateNameFromEnum

        public static long nVRApplications_GetApplicationsTransitionStateNameFromEnum​(int state)
      • VRApplications_IsQuitUserPromptRequested

        public static boolean VRApplications_IsQuitUserPromptRequested()
        Returns true if the outgoing scene app has requested a save prompt before exiting.
      • nVRApplications_LaunchInternalProcess

        public static int nVRApplications_LaunchInternalProcess​(long pchBinaryPath,
                                                                long pchArguments,
                                                                long pchWorkingDirectory)
        Unsafe version of: LaunchInternalProcess
      • VRApplications_LaunchInternalProcess

        public static int VRApplications_LaunchInternalProcess​(java.nio.ByteBuffer pchBinaryPath,
                                                               java.nio.ByteBuffer pchArguments,
                                                               java.nio.ByteBuffer pchWorkingDirectory)
        
        public static int VRApplications_LaunchInternalProcess​(java.lang.CharSequence pchBinaryPath,
                                                               java.lang.CharSequence pchArguments,
                                                               java.lang.CharSequence pchWorkingDirectory)
        
        Starts a subprocess within the calling application. This suppresses all application transition UI and automatically identifies the new executable as part of the same application. On success the calling process should exit immediately. If working directory is NULL or "" the directory portion of the binary path will be the working directory.
      • VRApplications_GetCurrentSceneProcessId

        public static int VRApplications_GetCurrentSceneProcessId()
        Returns the current scene process ID according to the application system. A scene process will get scene focus once it starts rendering, but it will appear here once it calls VR_Init with the Scene application. type.