WwiseExternalSourceManager.h 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. /*******************************************************************************
  2. The content of this file includes portions of the proprietary AUDIOKINETIC Wwise
  3. Technology released in source code form as part of the game integration package.
  4. The content of this file may not be used without valid licenses to the
  5. AUDIOKINETIC Wwise Technology.
  6. Note that the use of the game engine is subject to the Unreal(R) Engine End User
  7. License Agreement at https://www.unrealengine.com/en-US/eula/unreal
  8. License Usage
  9. Licensees holding valid licenses to the AUDIOKINETIC Wwise Technology may use
  10. this file in accordance with the end user license agreement provided with the
  11. software or, alternatively, in accordance with the terms contained
  12. in a written agreement between you and Audiokinetic Inc.
  13. Copyright (c) 2023 Audiokinetic Inc.
  14. *******************************************************************************/
  15. #pragma once
  16. #include "Wwise/WwiseFileHandlerModule.h"
  17. #include "Wwise/WwiseStreamableFileHandler.h"
  18. #include "Wwise/CookedData/WwiseLanguageCookedData.h"
  19. struct FWwiseSharedLanguageId;
  20. struct AkExternalSourceInfo;
  21. struct FWwiseExternalSourceCookedData;
  22. class FWwiseResourceCooker;
  23. #if WITH_EDITORONLY_DATA
  24. struct FWwiseSharedPlatformId;
  25. #endif
  26. class IWwiseExternalSourceManager : public IWwiseStreamableFileHandler
  27. {
  28. public:
  29. inline static IWwiseExternalSourceManager* Get()
  30. {
  31. if (auto* Module = IWwiseFileHandlerModule::GetModule())
  32. {
  33. return Module->GetExternalSourceManager();
  34. }
  35. return nullptr;
  36. }
  37. using FLoadExternalSourceCallback = TUniqueFunction<void(bool bSuccess)>;
  38. using FUnloadExternalSourceCallback = TUniqueFunction<void()>;
  39. virtual void LoadExternalSource(const FWwiseExternalSourceCookedData& InExternalSourceCookedData, const FName& InRootPath,
  40. const FWwiseLanguageCookedData& InLanguage, FLoadExternalSourceCallback&& InCallback) = 0;
  41. virtual void UnloadExternalSource(const FWwiseExternalSourceCookedData& InExternalSourceCookedData, const FName& InRootPath,
  42. const FWwiseLanguageCookedData& InLanguage, FUnloadExternalSourceCallback&& InCallback) = 0;
  43. virtual void SetGranularity(AkUInt32 Uint32) = 0;
  44. virtual TArray<uint32> PrepareExternalSourceInfos(TArray<AkExternalSourceInfo>& OutInfo,
  45. const TArray<FWwiseExternalSourceCookedData>&& InCookedData) = 0;
  46. virtual void BindPlayingIdToExternalSources(const uint32 InPlayingId, const TArray<uint32>& InMediaIds) = 0;
  47. virtual void OnEndOfEvent(const uint32 InPlayingID) = 0;
  48. virtual void SetExternalSourceMediaById(const FName& ExternalSourceName, const int32 MediaId) = 0;
  49. virtual void SetExternalSourceMediaByName(const FName& ExternalSourceName, const FName& MediaName) = 0;
  50. virtual void SetExternalSourceMediaWithIds(const int32 ExternalSourceCookie, const int32 MediaId) = 0;
  51. #if WITH_EDITORONLY_DATA
  52. virtual void Cook(FWwiseResourceCooker& InResourceCooker, const FWwiseExternalSourceCookedData& InCookedData, TFunctionRef<void(const TCHAR* Filename, void* Data, int64 Size)> WriteAdditionalFile,
  53. const FWwiseSharedPlatformId& InPlatform, const FWwiseSharedLanguageId& InLanguage) = 0;
  54. #endif
  55. virtual FString GetStagingDirectory() const { return TEXT("ExternalSources"); }
  56. };