AK::SoundFrame::ISoundFrame Class Reference

List of all members.

Public Types
enum	ShowLocation {   ShowLocation_Editor = 1, ShowLocation_MultiEditor, ShowLocation_ListView, ShowLocation_ReferenceView,   ShowLocation_SchematicView, ShowLocation_ProjectExplorer0, ShowLocation_ProjectExplorer1, ShowLocation_ProjectExplorer2,   ShowLocation_ProjectExplorer3, ShowLocation_ProjectExplorer4, ShowLocation_Transport }
	Show location type. More...
Public Member Functions
virtual bool	Connect (DWORD in_dwProcessID=0)=0
virtual bool	IsConnected () const =0
virtual bool	GetConversionSettingsList (IConversionSettingsList **out_ppConversionSettingsList) const =0
virtual bool	ConvertExternalSources (LPCWSTR *in_pszPlatforms, long in_cPlatforms, LPCWSTR *in_pszFileSourcesInput, long in_cFileSourcesInput, LPCWSTR *in_pszFileSourcesOutput, long in_cFileSourcesOutput)=0
virtual bool	ShowWwiseObject (const GUID *in_pGuids, long in_cGuids, ShowLocation in_eLocation)=0
General Information
virtual const WCHAR *	GetCurrentProjectName () const =0
virtual GUID	GetCurrentProjectID () const =0
virtual const WCHAR *	GetCurrentProjectOriginalRoot () const =0
Sound Engine Operations
virtual bool	PlayEvents (const AkUniqueID *in_pEvents, long in_cEvents, AkGameObjectID in_gameObjectID=IGameObject::s_WwiseGameObject)=0
virtual bool	PlayEvents (LPCWSTR *in_pszEvents, long in_cEvents, AkGameObjectID in_gameObjectID=IGameObject::s_WwiseGameObject)=0
virtual bool	ExecuteActionOnEvent (AkUniqueID in_eventID, AK::SoundEngine::AkActionOnEventType in_ActionType, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)=0
virtual bool	SeekOnEvent (AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkTimeMs in_iPosition, bool in_bSeekToNearestMarker=false, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)=0
virtual bool	SeekOnEvent (AkUniqueID in_eventID, AkGameObjectID in_gameObjectID, AkReal32 in_fPercent, bool in_bSeekToNearestMarker=false, AkPlayingID in_PlayingID=AK_INVALID_PLAYING_ID)=0
virtual bool	SetPlayBackMode (bool in_bPlayback) const =0
virtual bool	GetCurrentState (AkStateGroupID in_stateGroupID, IState **out_ppCurrentState) const =0
virtual bool	GetCurrentState (LPCWSTR in_szStateGroupName, IState **out_ppCurrentState) const =0
virtual bool	SetCurrentState (AkStateGroupID in_stateGroupID, AkStateID in_currentStateID)=0
virtual bool	SetCurrentState (LPCWSTR in_szStateGroupName, LPCWSTR in_szCurrentStateName)=0
virtual bool	GetCurrentSwitch (AkSwitchGroupID in_switchGroupID, ISwitch **out_ppCurrentSwitch, AkGameObjectID in_gameObjectID=IGameObject::s_WwiseGameObject) const =0
virtual bool	GetCurrentSwitch (LPCWSTR in_szSwitchGroupName, ISwitch **out_ppCurrentSwitch, AkGameObjectID in_gameObjectID=IGameObject::s_WwiseGameObject) const =0
virtual bool	SetCurrentSwitch (AkSwitchGroupID in_switchGroupID, AkSwitchStateID in_currentSwitchID, AkGameObjectID in_gameObjectID=IGameObject::s_WwiseGameObject)=0
virtual bool	SetCurrentSwitch (LPCWSTR in_szSwitchGroupName, LPCWSTR in_szCurrentSwitchName, AkGameObjectID in_gameObjectID=IGameObject::s_WwiseGameObject)=0
virtual bool	RegisterGameObject (AkGameObjectID in_gameObjectID, LPCWSTR in_szGameObjectName=L"")=0
virtual bool	UnregisterGameObject (AkGameObjectID in_gameObjectID)=0
virtual bool	SetRTPCValue (AkRtpcID in_gameParameterID, AkRtpcValue in_value, AkGameObjectID in_gameObjectID=IGameObject::s_WwiseGameObject)=0
virtual bool	SetRTPCValue (LPCWSTR in_szGameParameterName, AkRtpcValue in_value, AkGameObjectID in_gameObjectID=IGameObject::s_WwiseGameObject)=0
virtual bool	ResetRTPCValue (AkRtpcID in_gameParameterID, AkGameObjectID in_gameObjectID=IGameObject::s_WwiseGameObject)=0
virtual bool	ResetRTPCValue (LPCWSTR in_szGameParameterName, AkGameObjectID in_gameObjectID=IGameObject::s_WwiseGameObject)=0
virtual bool	PostTrigger (AkTriggerID in_triggerID, AkGameObjectID in_gameObjectID=IGameObject::s_WwiseGameObject)=0
virtual bool	PostTrigger (LPCWSTR in_szTriggerName, AkGameObjectID in_gameObjectID=IGameObject::s_WwiseGameObject)=0
virtual bool	SetActiveListeners (AkGameObjectID in_gameObjectID, AkUInt32 in_uiListenerMask)=0
virtual bool	SetAttenuationScalingFactor (AkGameObjectID in_GameObjectID, AkReal32 in_fAttenuationScalingFactor)=0
virtual bool	SetPosition (AkGameObjectID in_gameObjectID, const AkSoundPosition &in_rPosition)=0
virtual bool	SetListenerPosition (const AkListenerPosition &in_rPosition, AkUInt32 in_uiIndex=0)=0
virtual bool	SetMultiplePositions (AkGameObjectID in_GameObjectID, const AkSoundPosition *in_pPositions, AkUInt16 in_NumPositions, AK::SoundEngine::MultiPositionType in_eMultiPositionType=AK::SoundEngine::MultiPositionType_MultiDirections)=0
virtual bool	SetListenerScalingFactor (AkUInt32 in_uiIndex, AkReal32 in_fAttenuationScalingFactor)=0
virtual bool	SetListenerSpatialization (AkUInt32 in_uiIndex, bool in_bSpatialized, AkChannelConfig in_channelConfig, AkReal32 *in_pVolumeOffsets=NULL)=0
virtual bool	SetGameObjectAuxSendValues (AkGameObjectID in_gameObjectID, AkAuxSendValue *in_aAuxSendValues, AkUInt32 in_uNumSendValues)=0
virtual bool	SetGameObjectOutputBusVolume (AkGameObjectID in_gameObjectID, AkReal32 in_fControlValue)=0
virtual bool	SetObjectObstructionAndOcclusion (AkGameObjectID in_ObjectID, AkUInt32 in_uListener, AkReal32 in_fObstructionLevel, AkReal32 in_fOcclusionLevel)=0
virtual bool	PostMsgMonitor (LPCWSTR in_pszMessage)=0
virtual bool	StopAll (AkGameObjectID in_GameObjID=AK_INVALID_GAME_OBJECT)=0
virtual bool	StopPlayingID (AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)=0
Events
virtual bool	GetEventList (IEventList **out_ppEventList) const =0
virtual bool	GetEvent (AkUniqueID in_eventID, IEvent **out_ppEvent) const =0
virtual bool	GetEvent (LPCWSTR in_pszEvent, IEvent **out_ppEvent) const =0
virtual bool	GetEvents (const AkUniqueID *in_pEvents, long in_cEvents, IEventList **out_ppEventList) const =0
virtual bool	GetEvents (LPCWSTR *in_pszEvents, long in_cEvents, IEventList **out_ppEventList) const =0
Dialogue Events
virtual bool	GetDialogueEventList (IDialogueEventList **out_ppDialogueEventList) const =0
virtual bool	GetDialogueEvent (AkUniqueID in_dialogueEventID, IDialogueEvent **out_ppDialogueEvent) const =0
virtual bool	GetDialogueEvent (LPCWSTR in_pszDialogueEvent, IDialogueEvent **out_ppDialogueEvent) const =0
virtual bool	GetDialogueEvents (const AkUniqueID *in_pDialogueEvents, long in_cDialogueEvents, IDialogueEventList **out_ppDialogueEventList) const =0
virtual bool	GetDialogueEvents (LPCWSTR *in_pszDialogueEvents, long in_cDialogueEvents, IDialogueEventList **out_ppDialogueEventList) const =0
Sound Objects
virtual bool	GetSoundObject (AkUniqueID in_soundObjectID, ISoundObject **out_ppSoundObject) const =0
virtual bool	GetSoundObjects (const AkUniqueID *in_pSoundObjects, long in_cSoundObjects, ISoundObjectList **out_ppSoundObjectList) const =0
State Groups
virtual bool	GetStateGroupList (IStateGroupList **out_ppStateGroupList) const =0
virtual bool	GetStateGroup (AkUniqueID in_stateGroupID, IStateGroup **out_ppStateGroup) const =0
virtual bool	GetStateGroup (LPCWSTR in_pszStateGroup, IStateGroup **out_ppStateGroup) const =0
virtual bool	GetStateGroups (const AkUniqueID *in_pStateGroups, long in_cStateGroups, IStateGroupList **out_ppStateGroupList) const =0
virtual bool	GetStateGroups (LPCWSTR *in_pszStateGroups, long in_cStateGroups, IStateGroupList **out_ppStateGroupList) const =0
Switch Groups
virtual bool	GetSwitchGroupList (ISwitchGroupList **out_ppSwitchGroupList) const =0
virtual bool	GetSwitchGroup (AkUniqueID in_switchGroupID, ISwitchGroup **out_ppSwitchGroup) const =0
virtual bool	GetSwitchGroup (LPCWSTR in_pszSwitchGroup, ISwitchGroup **out_ppSwitchGroup) const =0
virtual bool	GetSwitchGroups (const AkUniqueID *in_pSwitchGroups, long in_cSwitchGroups, ISwitchGroupList **out_ppSwitchGroupList) const =0
virtual bool	GetSwitchGroups (LPCWSTR *in_pszSwitchGroups, long in_cSwitchGroups, ISwitchGroupList **out_ppSwitchGroupList) const =0
Game Parameters
Note: Game parameters and RTPCs are different concepts. For details on their relationship, please refer to the documentation for the Wwise authoring tool.
virtual bool	GetGameParameterList (IGameParameterList **out_ppGameParameterList) const =0
virtual bool	GetGameParameter (AkUniqueID in_gameParameterID, IGameParameter **out_ppGameParameter) const =0
virtual bool	GetGameParameter (LPCWSTR in_pszGameParameter, IGameParameter **out_ppGameParameter) const =0
virtual bool	GetGameParameters (const AkUniqueID *in_pGameParameters, long in_cGameParameters, IGameParameterList **out_ppGameParameterList) const =0
virtual bool	GetGameParameters (LPCWSTR *in_pszGameParameters, long in_cGameParameters, IGameParameterList **out_ppGameParameterList) const =0
Triggers
virtual bool	GetTriggerList (ITriggerList **out_ppTriggerList) const =0
virtual bool	GetTrigger (AkUniqueID in_triggerID, ITrigger **out_ppTrigger) const =0
virtual bool	GetTrigger (LPCWSTR in_pszTrigger, ITrigger **out_ppTrigger) const =0
virtual bool	GetTriggers (const AkUniqueID *in_pTriggers, long in_cTriggers, ITriggerList **out_ppTriggerList) const =0
virtual bool	GetTriggers (LPCWSTR *in_pszTriggers, long in_cTriggers, ITriggerList **out_ppTriggerList) const =0
Arguments
Note: Arguments are used by dialogue events. Use the IDialogueEvent interface to obtain the list of arguments referenced by a dialogue event. Once you obtain their ID, you may use the methods below to get refreshed copies of IArguments (after an argument notification for example).
virtual bool	GetArgument (AkUniqueID in_ArgumentID, IArgument **out_ppArgument) const =0
virtual bool	GetArguments (const AkUniqueID *in_pArguments, long in_cArguments, IArgumentList **out_ppArgumentList) const =0
Auxiliary busses
virtual bool	GetAuxBusList (IAuxBusList **out_ppAuxBusList) const =0
virtual bool	GetAuxBus (AkUniqueID in_AuxBusID, IAuxBus **out_ppAuxBus) const =0
virtual bool	GetAuxBus (LPCWSTR in_pszAuxBus, IAuxBus **out_ppAuxBus) const =0
virtual bool	GetAuxBus (const AkUniqueID *in_pAuxBus, long in_cAuxBus, IAuxBusList **out_ppAuxBusList) const =0
virtual bool	GetAuxBus (LPCWSTR *in_pszAuxBus, long in_cAuxBus, IAuxBusList **out_ppAuxBusList) const =0
SoundBanks
virtual bool	GetSoundBank (AkUniqueID in_SoundBankID, ISoundBank **out_ppArgument) const =0
virtual bool	GetSoundBankList (ISoundBankList **out_ppSoundBankList) const =0
Game Objects
virtual bool	GetGameObjectList (IGameObjectList **out_ppGameObjectList) const =0
Original Files
virtual bool	GetEventOriginalFileList (LPCWSTR in_pszEvent, IOriginalFileList **out_ppOriginalFileList) const =0
virtual bool	GetDialogueEventOriginalFileList (LPCWSTR in_pszDialogueEvent, IOriginalFileList **out_ppOriginalFileList) const =0
Voice Content
virtual bool	EventHasVoiceContent (LPCWSTR in_pszEvent) const =0
virtual bool	DialogueEventHasVoiceContent (LPCWSTR in_pszDialogueEvent) const =0
Notifications
virtual bool	ListenAttenuation (const AkUniqueID *in_pSoundObjects, long in_cSoundObjects)=0
Wwise Operations
virtual bool	ProcessDefinitionFiles (LPCWSTR *in_pszPaths, long in_cFiles)=0
virtual bool	GetSoundBankGenerationSettings (bool in_bUser, SoundBankGenerationSettings &out_settings)=0
virtual bool	GenerateSoundBanks (LPCWSTR *in_pszBanks, long in_cBanks, LPCWSTR *in_pszPlatforms, long in_cPlatforms, LPCWSTR *in_pszLanguages, long in_cLanguages, SoundBankGenerationSettings *in_pSettings=NULL)=0
Object IDs
virtual bool	GetAkUniqueID (const GUID &in_guid, AkUniqueID &out_uniqueID) const =0
virtual bool	GetWwiseObjectPath (const AK::SoundFrame::ISFObject *in_pObject, const AK::SoundFrame::ISFObject *in_pParent, LPWSTR out_szBuffer, long in_lLength) const =0
Drag And Drop
enum	DnDType {   TypeUnknown = 0, TypeEvent = 1, TypeStates = 2, TypeSwitches = 3,   TypeGameParameters = 4, TypeTriggers = 5, TypeAuxBus = 6, TypeDialogueEvent = 7,   TypeSoundBank = 8 }
	Type of object contained in IDataObject. More...
virtual DnDType	GetDnDType (IDataObject *in_pDataObject)=0
virtual bool	ProcessEventDnD (IDataObject *in_pDataObject, IEventList **out_ppEventList)=0
virtual bool	ProcessStateGroupDnD (IDataObject *in_pDataObject, IStateGroupList **out_ppStateGroupList)=0
virtual bool	ProcessSwitchGroupDnD (IDataObject *in_pDataObject, ISwitchGroupList **out_ppSwitchGroupList)=0
virtual bool	ProcessGameParameterDnD (IDataObject *in_pDataObject, IGameParameterList **out_ppGameParameterList)=0
virtual bool	ProcessTriggerDnD (IDataObject *in_pDataObject, ITriggerList **out_ppTriggerList)=0
virtual bool	ProcessAuxBusDnD (IDataObject *in_pDataObject, IAuxBusList **out_ppAuxBusList)=0
virtual bool	ProcessDialogueEventDnD (IDataObject *in_pDataObject, IDialogueEventList **out_ppDialogueEventList)=0
virtual bool	ProcessSoundBankDnD (IDataObject *in_pDataObject, ISoundBankList **out_ppSoundBankList)=0

Detailed Description

Interface through which the client communicates with the instance of Wwise.

Warning:

The functions in this class are not thread-safe, unless stated otherwise.

See also:

• AK::SoundFrame::Create()

Definition at line 85 of file SF.h.

• include/AK/SoundFrame/SF.h