AK::StreamMgr::IAkFileLocationResolver Class Reference

#include <AkStreamMgrModule.h>

Public Member Functions

virtual AKRESULT GetNextPreferredDevice (AkAsyncFileOpenData &in_FileOpen, AkDeviceID &io_idDevice)

Protected Member Functions

virtual ~IAkFileLocationResolver ()
 Virtual destructor on interface to avoid warnings. More...

Detailed Description

File location resolver interface. There is one and only one File Location Resolver that is registered to the Stream Manager (using AK::StreamMgr::SetFileLocationResolver()). Its purpose is to resolve a file name or ID to a streaming device (I/O hook) that can handle the file. When your Low-Level I/O submodule uses a single device, you should create a standalone I/O hook which implements one of the I/O hooks defined above, as well as the File Location Resolver. You then register this object to the Stream Manager as the File Location Resolver. If you wish to create multiple devices, then you should have a separate object that implements AK::StreamMgr::IAkFileLocationResolver and registers to the Stream Manager as such. This object will be used to dispatch the file open request to the appropriate device. The strategy you will use to select the correct device is up to you to implement. There is a built-in mechanism of chaining devices through GetNextPreferredDevice(). If a device can't open a file GetNextPreferredDevice will be called again to get the next device to check.

Definition at line 415 of file AkStreamMgrModule.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