Platform 1.28 Reference Guide

OVR_Requests_AssetFile.h File Reference

Detailed Description

An asset file is an extra dynamic contents which can be downloaded post-installation at runtime. This allows reducing initial installation size, and download the contents as users progress in your app. As an example might be extra game levels which are downloaded after finishing first set of levels.
Asset files are also used as a storage layer for DLCs (downloadable content), which can be proposed to a user separately from the main app.
If your apps supports asset files, users are able to download them from within the Oculus app on PDP page of the main app (including in Home), and you also can manage the asset files from your app itself via SDK calls.

Function Documentation

ovrRequest ovr_AssetFile_Delete ( ovrID assetFileID )
A message with type ovrMessage_AssetFile_Delete will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrAssetFileDeleteResultHandle. Extract the payload from the message handle with ovr_Message_GetAssetFileDeleteResult().
ovrRequest ovr_AssetFile_DeleteById ( ovrID assetFileID )
Removes an previously installed asset file from the device by its ID. Returns an object containing the asset ID and file name, and a success flag.
Parameters
assetFileID
The asset file ID
A message with type ovrMessage_AssetFile_DeleteById will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrAssetFileDeleteResultHandle. Extract the payload from the message handle with ovr_Message_GetAssetFileDeleteResult().
ovrRequest ovr_AssetFile_DeleteByName ( const char * assetFileName )
Removes an previously installed asset file from the device by its name. Returns an object containing the asset ID and file name, and a success flag.
Parameters
assetFileName
The asset file name
A message with type ovrMessage_AssetFile_DeleteByName will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrAssetFileDeleteResultHandle. Extract the payload from the message handle with ovr_Message_GetAssetFileDeleteResult().
ovrRequest ovr_AssetFile_Download ( ovrID assetFileID )
A message with type ovrMessage_AssetFile_Download will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrAssetFileDownloadResultHandle. Extract the payload from the message handle with ovr_Message_GetAssetFileDownloadResult().
ovrRequest ovr_AssetFile_DownloadById ( ovrID assetFileID )
Downloads an asset file by its ID on demand. Returns an object containing the asset ID and filepath. Sends periodic ovrNotification_AssetFile_DownloadUpdate to track the downloads.
Parameters
assetFileID
The asset file ID
A message with type ovrMessage_AssetFile_DownloadById will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrAssetFileDownloadResultHandle. Extract the payload from the message handle with ovr_Message_GetAssetFileDownloadResult().
ovrRequest ovr_AssetFile_DownloadByName ( const char * assetFileName )
Downloads an asset file by its name on demand. Returns an object containing the asset ID and filepath. Sends periodic {notifications.asset_file.download_update}} to track the downloads.
Parameters
assetFileName
The asset file name
A message with type ovrMessage_AssetFile_DownloadByName will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrAssetFileDownloadResultHandle. Extract the payload from the message handle with ovr_Message_GetAssetFileDownloadResult().
ovrRequest ovr_AssetFile_DownloadCancel ( ovrID assetFileID )
A message with type ovrMessage_AssetFile_DownloadCancel will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrAssetFileDownloadCancelResultHandle. Extract the payload from the message handle with ovr_Message_GetAssetFileDownloadCancelResult().
ovrRequest ovr_AssetFile_DownloadCancelById ( ovrID assetFileID )
Cancels a previously spawned download request for an asset file by its ID. Returns an object containing the asset ID and file path, and a success flag.
Parameters
assetFileID
The asset file ID
A message with type ovrMessage_AssetFile_DownloadCancelById will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrAssetFileDownloadCancelResultHandle. Extract the payload from the message handle with ovr_Message_GetAssetFileDownloadCancelResult().
ovrRequest ovr_AssetFile_DownloadCancelByName ( const char * assetFileName )
Cancels a previously spawned download request for an asset file by its name. Returns an object containing the asset ID and file path, and a success flag.
Parameters
assetFileName
The asset file name
A message with type ovrMessage_AssetFile_DownloadCancelByName will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrAssetFileDownloadCancelResultHandle. Extract the payload from the message handle with ovr_Message_GetAssetFileDownloadCancelResult().
ovrRequest ovr_AssetFile_GetList ( )
Returns an array of objects with asset file names and their associated IDs, and and whether it's currently installed.
A message with type ovrMessage_AssetFile_GetList will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrAssetDetailsArrayHandle. Extract the payload from the message handle with ovr_Message_GetAssetDetailsArray().
ovrRequest ovr_AssetFile_Status ( ovrID assetFileID )
A message with type ovrMessage_AssetFile_Status will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrAssetDetailsHandle. Extract the payload from the message handle with ovr_Message_GetAssetDetails().
ovrRequest ovr_AssetFile_StatusById ( ovrID assetFileID )
Returns the details on a single asset: ID, file name, and whether it's currently installed
Parameters
assetFileID
The asset file ID
A message with type ovrMessage_AssetFile_StatusById will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrAssetDetailsHandle. Extract the payload from the message handle with ovr_Message_GetAssetDetails().
ovrRequest ovr_AssetFile_StatusByName ( const char * assetFileName )
Returns the details on a single asset: ID, file name, and whether it's currently installed
Parameters
assetFileName
The asset file name
A message with type ovrMessage_AssetFile_StatusByName will be generated in response.
First call ovr_Message_IsError() to check if an error occurred.
If no error occurred, the message will contain a payload of type ovrAssetDetailsHandle. Extract the payload from the message handle with ovr_Message_GetAssetDetails().
1
2
3
4
5
6
7
8
9
18
27
28
40
41
53
54
63
64
76
77
89
90
99
100
112
113
125
126
136
137
146
147
158
159
170
171
172
// This file was @generated with LibOVRPlatform/codegen/main. Do not modify it!

#ifndef OVR_REQUESTS_ASSETFILE_H
#define OVR_REQUESTS_ASSETFILE_H

#include "OVR_Types.h"
#include "OVR_Platform_Defs.h"



OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_AssetFile_Delete(ovrID assetFileID);

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_AssetFile_DeleteById(ovrID assetFileID);

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_AssetFile_DeleteByName(constchar *assetFileName);

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_AssetFile_Download(ovrID assetFileID);

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_AssetFile_DownloadById(ovrID assetFileID);

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_AssetFile_DownloadByName(constchar *assetFileName);

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_AssetFile_DownloadCancel(ovrID assetFileID);

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_AssetFile_DownloadCancelById(ovrID assetFileID);

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_AssetFile_DownloadCancelByName(constchar *assetFileName);

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_AssetFile_GetList();

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_AssetFile_Status(ovrID assetFileID);

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_AssetFile_StatusById(ovrID assetFileID);

OVRP_PUBLIC_FUNCTION(ovrRequest) ovr_AssetFile_StatusByName(constchar *assetFileName);

#endif
The documentation for this file was generated from the following file: OVR_Requests_AssetFile.h