Version
menu
Wwise SDK 2025.1.0
AkFileSystemFlags.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2025 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 /// \file
28 /// Defines the API of Audiokinetic's I/O streaming solution.
29 
30 #ifndef _AK_FILE_SYSTEM_FLAGS_H_
31 #define _AK_FILE_SYSTEM_FLAGS_H_
32 
33 /// File system flags for file descriptors mapping.
34 struct AkFileSystemFlags
35 {
36  AkFileSystemFlags()
37  : uCompanyID(0)
38  , uCodecID(0)
39  , uCustomParamSize(0)
40  , pCustomParam(0)
41  , bIsLanguageSpecific(false)
42  , bIsAutomaticStream(false)
43  , uCacheID(AK_INVALID_FILE_ID)
44  , uNumBytesPrefetch(0)
45  , uDirectoryHash(AK_INVALID_FILE_ID) {}
46 
47  AkFileSystemFlags( AkUInt32 in_uCompanyID, AkUInt32 in_uCodecID, AkUInt32 in_uCustomParamSize, void * in_pCustomParam, bool in_bIsLanguageSpecific, AkCacheID in_uCacheID )
48  : uCompanyID( in_uCompanyID )
49  , uCodecID( in_uCodecID )
50  , uCustomParamSize( in_uCustomParamSize )
51  , pCustomParam( in_pCustomParam )
52  , bIsLanguageSpecific( in_bIsLanguageSpecific )
53  , uCacheID( in_uCacheID )
54  , uNumBytesPrefetch( 0 )
55  , uDirectoryHash(AK_INVALID_FILE_ID) {}
56 
57  AkUInt32 uCompanyID; ///< Company ID (Wwise uses AKCOMPANYID_AUDIOKINETIC, defined in AkTypes.h, for soundbanks and standard streaming files, and AKCOMPANYID_AUDIOKINETIC_EXTERNAL for streaming external sources).
58  AkUInt32 uCodecID; ///< File/codec type ID (defined in AkTypes.h)
59  AkUInt32 uCustomParamSize; ///< Size of the custom parameter
60  void * pCustomParam; ///< Custom parameter
61  bool bIsLanguageSpecific;///< True when the file location depends on language
62  bool bIsAutomaticStream; ///< True when the file is opened to be used as an automatic stream. Note that you don't need to set it.
63  ///< If you pass an AkFileSystemFlags to IAkStreamMgr CreateStd|Auto(), it will be set internally to the correct value.
64  AkCacheID uCacheID; ///< Cache ID for caching system used by automatic streams. The user is responsible for guaranteeing unicity of IDs.
65  ///< When set, it supersedes the file ID passed to AK::IAkStreamMgr::CreateAuto() (ID version). Caching is optional and depends on the implementation.
66  AkUInt32 uNumBytesPrefetch; ///< Indicates the number of bytes from the beginning of the file that should be streamed into cache via a caching stream. This field is only relevant when opening caching streams via
67  ///< AK::IAkStreamMgr::PinFileInCache() and AK::SoundEngine::PinEventInStreamCache(). When using AK::SoundEngine::PinEventInStreamCache(),
68  ///< it is initialized to the prefetch size stored in the sound bank, but may be changed by the file location resolver, or set to 0 to cancel caching.
69  AkUInt32 uDirectoryHash; ///< If the implementation uses a hashed directory structure, this is the hash value that should be employed for determining the directory structure
70 };
71 
72 #endif //_AK_FILE_SYSTEM_FLAGS_H_
AkFileSystemFlags::uDirectoryHash
AkUInt32 uDirectoryHash
If the implementation uses a hashed directory structure, this is the hash value that should be employ...
Definition: AkFileSystemFlags.h:69
AkFileSystemFlags::AkFileSystemFlags
AkFileSystemFlags(AkUInt32 in_uCompanyID, AkUInt32 in_uCodecID, AkUInt32 in_uCustomParamSize, void *in_pCustomParam, bool in_bIsLanguageSpecific, AkCacheID in_uCacheID)
Definition: AkFileSystemFlags.h:47
AkFileSystemFlags::uCompanyID
AkUInt32 uCompanyID
Company ID (Wwise uses AKCOMPANYID_AUDIOKINETIC, defined in AkTypes.h, for soundbanks and standard st...
Definition: AkFileSystemFlags.h:57
AK_INVALID_FILE_ID
static const AkFileID AK_INVALID_FILE_ID
Invalid file ID.
Definition: AkConstants.h:41
AkCacheID
AkUInt64 AkCacheID
Stream cache block ID.
Definition: AkTypedefs.h:77
AkFileSystemFlags::bIsLanguageSpecific
bool bIsLanguageSpecific
True when the file location depends on language.
Definition: AkFileSystemFlags.h:61
AkFileSystemFlags
File system flags for file descriptors mapping.
Definition: AkFileSystemFlags.h:35
AkUInt32
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkNumeralTypes.h:35
AkFileSystemFlags::uCustomParamSize
AkUInt32 uCustomParamSize
Size of the custom parameter.
Definition: AkFileSystemFlags.h:59
AkFileSystemFlags::uCodecID
AkUInt32 uCodecID
File/codec type ID (defined in AkTypes.h)
Definition: AkFileSystemFlags.h:58
AkFileSystemFlags::pCustomParam
void * pCustomParam
Custom parameter.
Definition: AkFileSystemFlags.h:60

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