UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::IoStore::FOnDemandMountArgs Struct Reference

#include <IoStoreOnDemand.h>

Public Attributes

TUniquePtr< FOnDemandTocToc
 
FString MountId
 
FString TocRelativeUrl
 
FString FilePath
 
FName HostGroupName = FOnDemandHostGroup::DefaultName
 
FOnDemandHostGroup HostGroup
 
EOnDemandMountOptions Options = EOnDemandMountOptions::StreamOnDemand
 

Detailed Description

Arguments for mounting on-demand container TOC(s).

On-demand content can be mounted by providing:

  1. a serialized TOC
  2. a filepath to a TOC on disk
  3. a URL from where to fetch the TOC using HTTP

The chunk URLs are derived from the provided TOC URL or from the serialized chunks directory property in the TOC, i.e. if the TocRelativeUrl is not specified the TOC ChunksDirectory property needs to form a qualified path from the host. Example: http(s)://<Host>/<TocRelativePath>/chunks/<1-Byte Hex>/<hash>.iochunk http(s)://<Host>/<TOC.ChunksDirectory>/chunks/<1-Byte Hex>/<hash>.iochunk

Member Data Documentation

◆ FilePath

FString UE::IoStore::FOnDemandMountArgs::FilePath

Serialize the TOC from the specified file path.

◆ HostGroup

FOnDemandHostGroup UE::IoStore::FOnDemandMountArgs::HostGroup

List of URLs from where to download the chunks.

◆ HostGroupName

FName UE::IoStore::FOnDemandMountArgs::HostGroupName = FOnDemandHostGroup::DefaultName

Name of a new or existing host group.

◆ MountId

FString UE::IoStore::FOnDemandMountArgs::MountId

Mandatory ID to be used for unmounting all container file(s) included in the TOC.

◆ Options

EOnDemandMountOptions UE::IoStore::FOnDemandMountArgs::Options = EOnDemandMountOptions::StreamOnDemand

Mount options.

◆ Toc

TUniquePtr<FOnDemandToc> UE::IoStore::FOnDemandMountArgs::Toc

Mount an already serialized TOC.

◆ TocRelativeUrl

FString UE::IoStore::FOnDemandMountArgs::TocRelativeUrl

Relative URL from the primary endpoint from where to download the TOC.


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