menu
 
Version
2024.1.1.8691

2024.1.1.8691

2023.1.9.8628

2022.1.18.8567

2021.1.14.8108

2019.2.15.7667

2019.1.11.7296

2018.1.11.6987

2017.2.10.6745

2017.1.9.6501

2016.2.6.6153

2015.1.9.5624


menu_open
Wwise SDK 2024.1.1
AkFileOpenData Struct Reference

#include <IAkStreamMgr.h>

Inheritance diagram for AkFileOpenData:
AkAsyncFileOpenData

Public Member Functions

 AkFileOpenData ()
 
 AkFileOpenData (const AkOSChar *in_pszFileName, AkOpenMode in_eOpenMode=AK_OpenModeRead, AkFileSystemFlags *in_pFlags=NULL)
 
 AkFileOpenData (AkFileID in_idFile, AkOpenMode in_eOpenMode=AK_OpenModeRead, AkFileSystemFlags *in_pFlags=NULL)
 
 AkFileOpenData (const AkOSChar *in_pszFileName, AkFileSystemFlags *in_pFlags)
 
 AkFileOpenData (AkFileID in_idFile, AkFileSystemFlags *in_pFlags)
 
bool IsValid () const
 

Public Attributes

const AkOSCharpszFileName
 File name. Only one of pszFileName or fileID should be valid (pszFileName null while fileID is not AK_INVALID_FILE_ID, or vice versa) More...
 
AkFileID fileID
 File ID. Only one of pszFileName or fileID should be valid (pszFileName null while fileID is not AK_INVALID_FILE_ID, or vice versa) More...
 
AkFileSystemFlagspFlags
 Flags for opening, null when unused. More...
 
AkOpenMode eOpenMode
 Open mode. More...
 

Detailed Description

Contains parameters for the IAkFileLocationResolver::Open() call and related functions. Files can be designated with a file name or a file ID. Only one of the two members should be valid.

Note
pszFileName is stored on the stack and will be valid only through the function call.

Definition at line 188 of file IAkStreamMgr.h.


Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise