API reference
API reference
Select your platform
No SDKs available
No versions available

FOvrAssetDetails Struct

An AssetDetails object contains detailed metadata for an asset file, including the asset file ID, file path, asset type, and additional metadata that characterizes the asset. You can retrieve the asset details using AssetFile_GetList()

Constructors

FOvrAssetDetails ()
This is the default constructor for the struct, which initializes the ovrAssetDetailsHandle and TOvrMessageHandlePtr to their default values.
Signature
FOvrAssetDetails::FOvrAssetDetails()
FOvrAssetDetails ( OvrHandle , MessageHandlePtr )
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
FOvrAssetDetails::FOvrAssetDetails(ovrAssetDetailsHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
MessageHandlePtr: TOvrMessageHandlePtr

Fields

AssetId : FOvrId
ID of the asset file. You can use this ID to uniquely identify a single asset. You can find more details from AssetFile_StatusById()
Signature
FOvrId FOvrAssetDetails::AssetId
AssetType : FString
One of 'default', 'store', or 'language_pack'.
The 'default' type denotes this Asset File is used purely as an implementation detail (to download extra content post-installation).
The 'store' type shows, that the Asset File should be shown in Store.
The 'language_pack' is a special type used to manage different languages and translation data, which can be downloaded post-installation.
Signature
FString FOvrAssetDetails::AssetType
DownloadStatus : FString
One of 'installed', 'available', or 'in-progress'
Signature
FString FOvrAssetDetails::DownloadStatus
Filepath : FString
File path of the asset file
Signature
FString FOvrAssetDetails::Filepath
IapStatus : FString
The status of in app purchases which are some extra content that users can buy right from apps. The value could be one of 'free', 'entitled', or 'not-entitled'.
Signature
FString FOvrAssetDetails::IapStatus
This field gives information about currently selected and installed language for the asset. The language info contains language name and tag in BCP47 format.
Signature
FOvrLanguagePackInfo FOvrAssetDetails::Language
Metadata : FString
Extra metadata associated with this asset file
Signature
FString FOvrAssetDetails::Metadata

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrAssetDetails::Clear()
Returns
void
Update ( OvrHandle , MessageHandlePtr )
Updating values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
void FOvrAssetDetails::Update(ovrAssetDetailsHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void