Version
menu_open
|
Wwise SDK 2024.1.4
|
AK.Wwise::ISourceControl Class Referenceabstract
#include <ISourceControl.h>
Classes | |
| struct | FilenameToIconMapItem |
| struct | FilenameToStatusMapItem |
| class | IFileOperationResult |
| class | IOperationResult |
| The base interface for operations that return information to Wwise. More... | |
| struct | OperationListItem |
| Operation list item. This is the type used in the AK::Wwise::ISourceControl::OperationList SourceControlContainers::IAkList template class. More... | |
| class | PluginInfo |
| Plug-in information structure. This structure gives a simple overview of the plug-in's capabilities. More... | |
Map types | |
| typedef SourceControlContainers::IAkMap< LPCWSTR, LPCWSTR, FilenameToIconMapItem, const FilenameToIconMapItem & > | FilenameToIconMap |
| typedef SourceControlContainers::IAkMap< LPCWSTR, LPCWSTR, FilenameToStatusMapItem, const FilenameToStatusMapItem & > | FilenameToStatusMap |
| typedef SourceControlContainers::IAkMap< LPCWSTR, LPCWSTR, LPCWSTR, LPCWSTR > | IConnectParameterMap |
| virtual void | Init (AK::Wwise::ISourceControlUtilities *in_pUtilities, bool in_bAutoAccept)=0 |
| This function is called when the plug-in is initialized after its creation. More... | |
| virtual void | Term ()=0 |
| This function is called when the plug-in is terminated before its destruction. More... | |
| virtual void | Destroy ()=0 |
| This function destroys the plug-in. The implementation is generally '{ delete this; }'. More... | |
| virtual OperationResult | Connect (const IConnectParameterMap ¶meterMap)=0 |
| This method connects the source control plugin. More... | |
| virtual OperationResult | Disconnect ()=0 |
| This method disconnects the source control plugin. More... | |
| virtual bool | ShowConfigDlg ()=0 |
| virtual AK::Wwise::ISourceControl::OperationResult | GetOperationList (OperationMenuType in_menuType, const StringList &in_rFilenameList, OperationList &out_rOperationList)=0 |
| virtual LPCWSTR | GetOperationName (DWORD in_dwOperationID)=0 |
| Gets the operation name to display in user interface. More... | |
| virtual DWORD | GetOperationEffect (DWORD in_dwOperationID)=0 |
| Gets the operation effect on the file(s) involved in the operation. More... | |
| virtual AK::Wwise::ISourceControl::OperationResult | GetFileStatus (const StringList &in_rFilenameList, FilenameToStatusMap &out_rFileStatusMap, DWORD in_dwTimeoutMs=INFINITE)=0 |
| virtual AK::Wwise::ISourceControl::OperationResult | GetFileStatusIcons (const StringList &in_rFilenameList, FilenameToIconMap &out_rFileIconsMap, DWORD in_dwTimeoutMs=INFINITE)=0 |
| virtual AK::Wwise::ISourceControl::OperationResult | GetFileStatusAndIcons (const StringList &in_rFilenameList, FilenameToStatusMap &out_rFileStatusMap, FilenameToIconMap &out_rFileIconsMap, DWORD in_dwTimeoutMs=INFINITE)=0 |
| virtual AK::Wwise::ISourceControl::OperationResult | GetMissingFilesInDirectories (const StringList &in_rDirectoryList, StringList &out_rFilenameList)=0 |
| virtual IOperationResult * | DoOperation (DWORD in_dwOperationID, const StringList &in_rFilenameList, const StringList *in_pTargetFilenameList=NULL)=0 |
| virtual AK::Wwise::ISourceControl::OperationResult | PreCreateOrModify (const StringList &in_rFilenameList, CreateOrModifyOperation in_eOperation, bool &out_rContinue)=0 |
| virtual AK::Wwise::ISourceControl::OperationResult | PostCreateOrModify (const StringList &in_rFilenameList, CreateOrModifyOperation in_eOperation, bool &out_rContinue)=0 |
| virtual AK::Wwise::ISourceControl::OperationResult | GetFilesForOperation (DWORD in_dwOperationID, const StringList &in_rFilenameList, StringList &out_rFilenameList, FilenameToStatusMap &out_rFileStatusMap)=0 |
| virtual AK::Wwise::ISourceControl::OperationResult | CheckFilesForOperation (DWORD in_dwOperationID, const StringList &in_rFilenameList, BooleanList &out_rFileStatusList)=0 |
| virtual AK::Wwise::ISourceControl::OperationResult | FilesUnderSourceControl (const StringList &in_rFilenameList, BooleanList &out_rFileStatusList)=0 |
Detailed Description
Wwise source control plug-in interface. This is the interface that the plug-in must implement. It contains all the necessary functions to perform source control operations and manage the Wwise source control UI.
 | Warning: The functions in this interface are not thread-safe, unless stated otherwise. |
Definition at line 64 of file ISourceControl.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