|
Wwise SDK 2025.1.1
|
#include <AkCommandTypes.h>
Public 속성 | |
| AkUInt64 | nodeID |
ID of the bus, Container node, or output device. When nodeType is set to AkNodeType_AudioDevice, a value of 0 designates the main (default) output. 더 자세히 ... | |
| AkUInt8 | nodeType |
Type of node that nodeID refers to. Must be a valid value from the AkNodeType enumeration. 더 자세히 ... | |
| AkUInt8 | fxIndex |
| Effect slot index (0-254) 더 자세히 ... | |
| AkUniqueID | fxSharesetID |
| ShareSet ID of the effect; pass AK_INVALID_UNIQUE_ID to clear the Effect slot 더 자세히 ... | |
상세한 설명
Sets an Effect ShareSet at the specified slot of a container, bus, or output device.
 | 참고: Replacing effects is preferably done through a Set Effect Event Action. |
This operation adds a reference on the audio node to an existing ShareSet.
To specify a bus, set nodeType to AkNodeType_Bus. The bus can be an Audio Bus or an Auxiliary Bus.
To specify an output device, set nodeType to AkNodeType_AudioDevice. The ID can refer to a specific ID returned by AK::SoundEngine::GetOutputID or 0 to designate the main (default) output device. In this case, only audio device effect sharesets are accepted.
When specifying any other container (e.g. Switch, Blend, Sound SFX, etc.) set nodeType to AkNodeType_Default.
| 참고: This function has unspecified behavior when adding an Effect to a currently playing Bus which does not have any Effects, or removing the last Effect on a currently playing bus. |
| 참고: This function will replace existing Effects on the node. If the target node is not at the top of the hierarchy and is in the Containers hierarchy, the option "Override Parent" in the Effect section in Wwise must be enabled for this node, otherwise the parent's Effect will still be the one in use and SetEffect will have no impact. |
This command can fail for the following reasons:
AK_InvalidParameterwhennodeIDis an invalid ID, or whenfxIndexornodeTypeis out of range.AK_IDNotFoundwhen either the Node ID or the Shareset ID are not present in the Init bank.AK_RenderedFXwhen the current effect in the slot is rendered at bank-generation time (rendered effects cannot be replaced).AK_NotCompatiblewhennodeTypeisAkNodeType_AudioDeviceand the effect shareset is not an output device effect.AK_InsufficientMemorywhen there is not enough memory to complete the operation.
- 참고
AkCommandTypes.h 파일의 1003 번째 라인에서 정의되었습니다.
이 페이지가 도움이 되었나요?
작업하는 프로젝트에 대해 알려주세요. 언제든지 도와드릴 준비가 되어 있습니다.
프로젝트를 등록하세요. 아무런 조건이나 의무 사항 없이 빠른 시작을 도와드리겠습니다.
Wwise를 시작해 보세요