GameApi 28
Library used by GameApi Builder tool
Loading...
Searching...
No Matches
vr::IVRApplications Class Reference

#include <openvr_mingw.h>

Public Member Functions

EVRApplicationError AddApplicationManifest (const char *pchApplicationManifestFullPath, bool bTemporary=false)
EVRApplicationError RemoveApplicationManifest (const char *pchApplicationManifestFullPath)
bool IsApplicationInstalled (const char *pchAppKey)
uint32_t GetApplicationCount ()
EVRApplicationError GetApplicationKeyByIndex (uint32_t unApplicationIndex, VR_OUT_STRING() char *pchAppKeyBuffer, uint32_t unAppKeyBufferLen)
EVRApplicationError GetApplicationKeyByProcessId (uint32_t unProcessId, VR_OUT_STRING() char *pchAppKeyBuffer, uint32_t unAppKeyBufferLen)
EVRApplicationError LaunchApplication (const char *pchAppKey)
EVRApplicationError LaunchTemplateApplication (const char *pchTemplateAppKey, const char *pchNewAppKey, VR_ARRAY_COUNT(unKeys) const AppOverrideKeys_t *pKeys, uint32_t unKeys)
vr::EVRApplicationError LaunchApplicationFromMimeType (const char *pchMimeType, const char *pchArgs)
EVRApplicationError LaunchDashboardOverlay (const char *pchAppKey)
bool CancelApplicationLaunch (const char *pchAppKey)
EVRApplicationError IdentifyApplication (uint32_t unProcessId, const char *pchAppKey)
uint32_t GetApplicationProcessId (const char *pchAppKey)
const char * GetApplicationsErrorNameFromEnum (EVRApplicationError error)
uint32_t GetApplicationPropertyString (const char *pchAppKey, EVRApplicationProperty eProperty, VR_OUT_STRING() char *pchPropertyValueBuffer, uint32_t unPropertyValueBufferLen, EVRApplicationError *peError=nullptr)
bool GetApplicationPropertyBool (const char *pchAppKey, EVRApplicationProperty eProperty, EVRApplicationError *peError=nullptr)
uint64_t GetApplicationPropertyUint64 (const char *pchAppKey, EVRApplicationProperty eProperty, EVRApplicationError *peError=nullptr)
EVRApplicationError SetApplicationAutoLaunch (const char *pchAppKey, bool bAutoLaunch)
bool GetApplicationAutoLaunch (const char *pchAppKey)
EVRApplicationError SetDefaultApplicationForMimeType (const char *pchAppKey, const char *pchMimeType)
bool GetDefaultApplicationForMimeType (const char *pchMimeType, VR_OUT_STRING() char *pchAppKeyBuffer, uint32_t unAppKeyBufferLen)
bool GetApplicationSupportedMimeTypes (const char *pchAppKey, VR_OUT_STRING() char *pchMimeTypesBuffer, uint32_t unMimeTypesBuffer)
uint32_t GetApplicationsThatSupportMimeType (const char *pchMimeType, VR_OUT_STRING() char *pchAppKeysThatSupportBuffer, uint32_t unAppKeysThatSupportBuffer)
uint32_t GetApplicationLaunchArguments (uint32_t unHandle, VR_OUT_STRING() char *pchArgs, uint32_t unArgs)
EVRApplicationError GetStartingApplication (VR_OUT_STRING() char *pchAppKeyBuffer, uint32_t unAppKeyBufferLen)
EVRApplicationTransitionState GetTransitionState ()
EVRApplicationError PerformApplicationPrelaunchCheck (const char *pchAppKey)
const char * GetApplicationsTransitionStateNameFromEnum (EVRApplicationTransitionState state)
bool IsQuitUserPromptRequested ()
EVRApplicationError LaunchInternalProcess (const char *pchBinaryPath, const char *pchArguments, const char *pchWorkingDirectory)
uint32_t GetCurrentSceneProcessId ()

Member Function Documentation

◆ AddApplicationManifest()

EVRApplicationError vr::IVRApplications::AddApplicationManifest ( const char * pchApplicationManifestFullPath,
bool bTemporary = false )
inline

Adds an application manifest to the list to load when building the list of installed applications. Temporary manifests are not automatically loaded

◆ CancelApplicationLaunch()

bool vr::IVRApplications::CancelApplicationLaunch ( const char * pchAppKey)
inline

Cancel a pending launch for an application

◆ GetApplicationAutoLaunch()

bool vr::IVRApplications::GetApplicationAutoLaunch ( const char * pchAppKey)
inline

Gets the application auto-launch flag. This is only valid for applications which return true for VRApplicationProperty_IsDashboardOverlay_Bool.

◆ GetApplicationCount()

uint32_t vr::IVRApplications::GetApplicationCount ( )
inline

Returns the number of applications available in the list

◆ GetApplicationKeyByIndex()

EVRApplicationError vr::IVRApplications::GetApplicationKeyByIndex ( uint32_t unApplicationIndex,
VR_OUT_STRING() char * pchAppKeyBuffer,
uint32_t unAppKeyBufferLen )
inline

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 k_unMaxApplicationKeyLength in order to fit the key.

◆ GetApplicationKeyByProcessId()

EVRApplicationError vr::IVRApplications::GetApplicationKeyByProcessId ( uint32_t unProcessId,
VR_OUT_STRING() char * pchAppKeyBuffer,
uint32_t unAppKeyBufferLen )
inline

Returns the key of the application for the specified Process Id. The buffer should be at least k_unMaxApplicationKeyLength in order to fit the key.

◆ GetApplicationLaunchArguments()

uint32_t vr::IVRApplications::GetApplicationLaunchArguments ( uint32_t unHandle,
VR_OUT_STRING() char * pchArgs,
uint32_t unArgs )
inline

Get the args list from an app launch that had the process already running, you call this when you get a VREvent_ApplicationMimeTypeLoad

◆ GetApplicationProcessId()

uint32_t vr::IVRApplications::GetApplicationProcessId ( const char * pchAppKey)
inline

Returns the process ID for an application. Return 0 if the application was not found or is not running.

◆ GetApplicationPropertyBool()

bool vr::IVRApplications::GetApplicationPropertyBool ( const char * pchAppKey,
EVRApplicationProperty eProperty,
EVRApplicationError * peError = nullptr )
inline

Returns a bool value for an application property. Returns false in all error cases.

◆ GetApplicationPropertyString()

uint32_t vr::IVRApplications::GetApplicationPropertyString ( const char * pchAppKey,
EVRApplicationProperty eProperty,
VR_OUT_STRING() char * pchPropertyValueBuffer,
uint32_t unPropertyValueBufferLen,
EVRApplicationError * peError = nullptr )
inline

Returns a value for an application property. The required buffer size to fit this value will be returned.

◆ GetApplicationPropertyUint64()

uint64_t vr::IVRApplications::GetApplicationPropertyUint64 ( const char * pchAppKey,
EVRApplicationProperty eProperty,
EVRApplicationError * peError = nullptr )
inline

Returns a uint64 value for an application property. Returns 0 in all error cases.

◆ GetApplicationsErrorNameFromEnum()

const char * vr::IVRApplications::GetApplicationsErrorNameFromEnum ( EVRApplicationError error)
inline

Returns a string for an applications error

◆ GetApplicationsThatSupportMimeType()

uint32_t vr::IVRApplications::GetApplicationsThatSupportMimeType ( const char * pchMimeType,
VR_OUT_STRING() char * pchAppKeysThatSupportBuffer,
uint32_t unAppKeysThatSupportBuffer )
inline

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

◆ GetApplicationsTransitionStateNameFromEnum()

const char * vr::IVRApplications::GetApplicationsTransitionStateNameFromEnum ( EVRApplicationTransitionState state)
inline

Returns a string for an application transition state

◆ GetApplicationSupportedMimeTypes()

bool vr::IVRApplications::GetApplicationSupportedMimeTypes ( const char * pchAppKey,
VR_OUT_STRING() char * pchMimeTypesBuffer,
uint32_t unMimeTypesBuffer )
inline

Get the list of supported mime types for this application, comma-delimited

◆ GetCurrentSceneProcessId()

uint32_t vr::IVRApplications::GetCurrentSceneProcessId ( )
inline

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.

◆ GetDefaultApplicationForMimeType()

bool vr::IVRApplications::GetDefaultApplicationForMimeType ( const char * pchMimeType,
VR_OUT_STRING() char * pchAppKeyBuffer,
uint32_t unAppKeyBufferLen )
inline

return the app key that will open this mime type

◆ GetStartingApplication()

EVRApplicationError vr::IVRApplications::GetStartingApplication ( VR_OUT_STRING() char * pchAppKeyBuffer,
uint32_t unAppKeyBufferLen )
inline

Returns the app key for the application that is starting up

◆ GetTransitionState()

EVRApplicationTransitionState vr::IVRApplications::GetTransitionState ( )
inline

Returns the application transition state

◆ IdentifyApplication()

EVRApplicationError vr::IVRApplications::IdentifyApplication ( uint32_t unProcessId,
const char * pchAppKey )
inline

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.

◆ IsApplicationInstalled()

bool vr::IVRApplications::IsApplicationInstalled ( const char * pchAppKey)
inline

Returns true if an application is installed

◆ IsQuitUserPromptRequested()

bool vr::IVRApplications::IsQuitUserPromptRequested ( )
inline

Returns true if the outgoing scene app has requested a save prompt before exiting

◆ LaunchApplication()

EVRApplicationError vr::IVRApplications::LaunchApplication ( const char * pchAppKey)
inline

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.

◆ LaunchApplicationFromMimeType()

vr::EVRApplicationError vr::IVRApplications::LaunchApplicationFromMimeType ( const char * pchMimeType,
const char * pchArgs )
inline

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

◆ LaunchDashboardOverlay()

EVRApplicationError vr::IVRApplications::LaunchDashboardOverlay ( const char * pchAppKey)
inline

Launches the dashboard overlay application if it is not already running. This call is only valid for dashboard overlay applications.

◆ LaunchInternalProcess()

EVRApplicationError vr::IVRApplications::LaunchInternalProcess ( const char * pchBinaryPath,
const char * pchArguments,
const char * pchWorkingDirectory )
inline

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.

◆ LaunchTemplateApplication()

EVRApplicationError vr::IVRApplications::LaunchTemplateApplication ( const char * pchTemplateAppKey,
const char * pchNewAppKey,
VR_ARRAY_COUNT(unKeys) const AppOverrideKeys_t * pKeys,
uint32_t unKeys )
inline

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_t

◆ PerformApplicationPrelaunchCheck()

EVRApplicationError vr::IVRApplications::PerformApplicationPrelaunchCheck ( const char * pchAppKey)
inline

Returns errors that would prevent the specified application from launching immediately. Calling this function will cause the current scene application to quit, so only call it when you are actually about to launch something else. What the caller should do about these failures depends on the failure: VRApplicationError_OldApplicationQuitting - An existing application has been told to quit. Wait for a VREvent_ProcessQuit and try again. VRApplicationError_ApplicationAlreadyStarting - This application is already starting. This is a permanent failure. VRApplicationError_LaunchInProgress - A different application is already starting. This is a permanent failure. VRApplicationError_None - Go ahead and launch. Everything is clear.

◆ RemoveApplicationManifest()

EVRApplicationError vr::IVRApplications::RemoveApplicationManifest ( const char * pchApplicationManifestFullPath)
inline

Removes an application manifest from the list to load when building the list of installed applications.

◆ SetApplicationAutoLaunch()

EVRApplicationError vr::IVRApplications::SetApplicationAutoLaunch ( const char * pchAppKey,
bool bAutoLaunch )
inline

Sets the application auto-launch flag. This is only valid for applications which return true for VRApplicationProperty_IsDashboardOverlay_Bool.

◆ SetDefaultApplicationForMimeType()

EVRApplicationError vr::IVRApplications::SetDefaultApplicationForMimeType ( const char * pchAppKey,
const char * pchMimeType )
inline

Adds this mime-type to the list of supported mime types for this application

The documentation for this class was generated from the following file: