Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2023.1.8
List of all members | Public Member Functions | Public Attributes
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 AkOSChar * pszFileName
 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...
 
AkFileSystemFlags * pFlags
 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 225 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