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
|
AkAsyncFileOpenData Struct Reference
#include <AkStreamMgrModule.h>
Inheritance diagram for AkAsyncFileOpenData:
Public Member Functions | |
| ~AkAsyncFileOpenData () | |
| AkAsyncFileOpenData (const AkFileOpenData &in_copy) | |
| AkAsyncFileOpenData (const AkAsyncFileOpenData &in_copy) | |
| AkAsyncFileOpenData () | |
| AkAsyncFileOpenData (const AkOSChar *in_pszFileName, AkOpenMode in_eOpenMode=AK_OpenModeRead, AkFileSystemFlags *in_pFlags=NULL) | |
| AkAsyncFileOpenData (AkFileID in_idFile, AkOpenMode in_eOpenMode=AK_OpenModeRead, AkFileSystemFlags *in_pFlags=NULL) | |
| Functions used to manage optional stream name. The name will be used when sending stream information to the Wwise profiler. More... | |
| AKRESULT | SetStreamName (const AkOSChar *in_pszStreamName) |
| const AkOSChar * | GetStreamName () const |
 Public Member Functions inherited from AkFileOpenData | |
| 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 | |
| AkFileOpenCallback | pCallback |
| Callback function used to notify the high-level device when Open is done. More... | |
| void * | pCookie |
| Reserved. Pass this unchanged to the callback function. The I/O device uses this cookie to retrieve the owner of the transfer. More... | |
| AkFileDesc * | pFileDesc |
| File Descriptor to fill once the Open operation is complete. More... | |
| void * | pCustomData |
| Convienience pointer for the IO hook implementer. Useful for additional data used in asynchronous implementations, for example. More... | |
| Public Attributes inherited from AkFileOpenData | |
| 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
Structure used by Low Level IO Hooks (IAkLowLevelIOHook) to pass and retreive information on files to be opened by the IO hook. Please refer to AK::StreamMgr::IAkLowLevelIOHook::BatchOpen for more information about the sementics of the Open operation.
Definition at line 143 of file AkStreamMgrModule.h.
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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