Wwise SDK 2021.1.14

Wwise Authoring API에 대한 더 자세한 정보는 Wwise Authoring API (WAAPI, Wwise 저작 API) 사용하기 를 참고하세요.

ak.soundengine.executeActionOnEvent
Play 동작에 지정된 에벤트에 참조된 모든 노드의 동작을 실행합니다. AK::SoundEngine::ExecuteActionOnEvent를 참고하세요.

ak.soundengine.postEvent
사운드 엔진으로 Event를 비동기적으로 발송 (이벤트 ID 사용). AK::SoundEngine::PostEvent 참고.

ak.soundengine.postMsgMonitor
Profiler의 Capture Log 뷰에 메시지를 표시합니다.

ak.soundengine.postTrigger
지정된 Trigger를 전달합니다. AK::SoundEngine::PostTrigger 참고.

ak.soundengine.registerGameObj
게임 오브젝트를 등록합니다. 게임 오브젝트를 두 번 등록해도 아무런 작업이 실행되지 않습니다. 등록했던 횟수와 상관 없이 한 번 등록 해제하는 것만으로 등록이 해제됩니다. AK::SoundEngine::RegisterGameObj 참고.

ak.soundengine.resetRTPCValue
실시간 매개 변수 컨트롤 값을 Wwise 프로젝트에 지정된 기본값으로 재설정합니다. AK::SoundEngine::ResetRTPCValue 참고.

ak.soundengine.seekOnEvent
지정된 Event의 Play Actions에 참조된 모든 재생 오브젝트를 탐색합니다. AK::SoundEngine::SeekOnEvent 참고.

ak.soundengine.setDefaultListeners
등록된 모든 후속 게임 오브젝트의 기본 활성화 리스너를 지정합니다. AK::SoundEngine::SetDefaultListeners 참고.

ak.soundengine.setGameObjectAuxSendValues
Auxiliary Buss가 지정된 게임 오브젝트를 전송하도록 설정합니다. AK::SoundEngine::SetGameObjectAuxSendValues 참고.

ak.soundengine.setGameObjectOutputBusVolume
특정 게임 오브젝트에 사용되는 출력 버스 볼륨 (직접)을 설정합니다. AK::SoundEngine::SetGameObjectOutputBusVolume 참고.

ak.soundengine.setListeners
단일 게임 오브젝트의 활성화된 리스너를 설정합니다. 기본 설정으로는 모든 새로운 게임 오브젝트에 활성화된 리스너가 없지만, SetDefaultListeners()로 이 동작을 오버라이드할 수 있습니다. 비활성화된 리스너는 계산되지 않습니다. AK::SoundEngine::SetListeners를 참고하세요.

ak.soundengine.setListenerSpatialization
리스너의 공간화 매개 변수를 설정합니다. 이를 통해 각 오디오 채널의 특정 리스너에 대한 볼륨 상쇄값을 정의할 수 있습니다. AK::SoundEngine::SetListenerSpatialization을 참고하세요.

ak.soundengine.setMultiplePositions
단일 게임 오브젝트의 복수의 위치를 설정합니다. 하나의 게임 오브젝트에 대해 복수의 위치를 설정하면 하나의 보이스 리소스만으로 여러 개의 방사(emission) 소스를 시뮬레이션할 수 있습니다. 이 방법은 뚫린 벽이나, 구역 사운드, 한 공간에서 동일한 사운드를 방사하는 복수의 오브젝트를 시뮬레이션할 때 사용할 수 있습니다. AK::SoundEngine::SetMultiplePositions를 참고하세요.

ak.soundengine.setObjectObstructionAndOcclusion
게임 오브젝트의 방해(obstruction)와 차단(occlusion) 레벨을 설정합니다. 이 함수는 특정 리스너에게 오브젝트가 어떻게 들릴 지를 정하는 데 사용됩니다. AK::SoundEngine::SetObjectObstructionAndOcclusion을 참고하세요.

ak.soundengine.setPosition
게임 오브젝트의 위치를 설정합니다. AK::SoundEngine::SetPosition을 참고하세요.

ak.soundengine.setRTPCValue
실시간 매개 변수 컨트롤의 값을 설정합니다. AK::SoundEngine::SetRTPCValue를 참고하세요.

ak.soundengine.setScalingFactor
게임 오브젝트의 척도 비율을 설정합니다. 크고 작게 영향을 받는 구역의 사운드를 시뮬레이션하기 위해 해당 게임 오브젝트에 대한 감쇠 계산을 변경할 수 있습니다. AK::SoundEngine::SetScalingFactor를 참고하세요.

ak.soundengine.setState
State Group의 State를 설정합니다. AK::SoundEngine::SetState를 참고하세요.

ak.soundengine.setSwitch
Switch Group의 State를 설정합니다. AK::SoundEngine::SetSwitch를 참고하세요.

ak.soundengine.stopAll
특정 게임 오브젝트 ID와 연관된 현재 콘텐츠 재생을 중지합니다. 지정된 게임 오브젝트가 없는 경우, 모든 사운드가 중지됩니다. AK::SoundEngine::StopAll을 참고하세요.

ak.soundengine.stopPlayingID
특정 재생 ID와 연관된 현재 콘텐츠 재생을 중지합니다. AK::SoundEngine::StopPlayingID를 참고하세요.

ak.soundengine.unregisterGameObj
게임 오브젝트를 등록 해제합니다. 게임 오브젝트를 두 번 등록해도 아무런 작업이 실행되지 않습니다. 등록했던 횟수와 상관 없이 한 번 등록 해제하는 것만으로 등록이 해제됩니다. 사용 중인 게임 오브젝트를 등록 해제할 수 있지만, 해당 게임 오브젝트의 매개 변수 컨트롤을 잃게 됩니다. 예를 들어, 이 게임 오브젝트와 연관된 사운드가 3D 이동 사운드일 경우가 있습니다. 게임 오브젝트가 등록 해제되면 이동이 멈추고, 해당 게임 오브젝트에 대한 컨트롤을 다시 복구시킬 수 없습니다. AK::SoundEngine::UnregisterGameObj를 참고하세요.

ak.wwise.core.audio.import
Wwise 오브젝트를 생성하고 오디오 파일을 불러옵니다. 이 함수는 Audio File Importer 내 Tab Delimited (탭으로 구분된) 가져오기에서 사용 가능한 동일한 가져오기 처리자를 사용합니다. 해당 함수는 생성, 교체, 또는 재사용된 모든 오브젝트의 배열을 반환합니다. 오브젝트를 어떻게 반환할 것인지 지정하는 옵션을 사용하세요. 더 자세한 정보는 오디오 파일 가져오기 및 구조체 생성하기 를 참고하세요.

ak.wwise.core.audio.importTabDelimited
스크립팅된 오브젝트 생성 및 탭으로 구분된 파일에서 오디오 파일 가져오기.

ak.wwise.core.audioSourcePeaks.getMinMaxPeaksInRegion
오디오 음원의 정해진 영역 내 min/max 피크를 바이너리 문자열 형태로 구합니다 (채널당 하나). 문자열은 Base64 인코딩, 16 비트 signed int 배열로 돼있으며, 인터리브된 min/max 값이 있습니다. getCrossChannelPeaks가 true일 경우, 하나의 바이너리 문자열만 모든 채널의 피크를 전역적으로 나타냅니다.

ak.wwise.core.audioSourcePeaks.getMinMaxPeaksInTrimmedRegion
각 채널의 오디오 음원 내 트리밍된 전체 영역 내 min/max 피크를 바이너리 문자열의 배열 형태로 구합니다 (채널당 하나). 문자열은 Base64 인코딩, 16 비트 signed int 배열로 돼있으며, 인터리브된 min/max 값이 있습니다. getCrossChannelPeaks가 true일 경우, 모든 채널의 피크를 전역적으로 나타내는 바이너리 문자열은 단 하나입니다.

ak.wwise.core.getInfo
전역적 Wwise 정보를 불러옵니다.

ak.wwise.core.log.get
특정 채널의 최근 로그를 불러옵니다. 로그에 요소가 추가될 때 알림을 받으려면 ak.wwise.core.log.itemAdded 을(를) 참고하세요.

ak.wwise.core.object.copy
특정 상위 항목에 오브젝트를 복사합니다.

ak.wwise.core.object.create
'type' 타입의 오브젝트를 'parent'의 하위 항목으로 생성합니다. 오브젝트 생성에 대한 더 많은 정보는 오디오 파일 가져오기 및 구조체 생성하기 를 참고하세요. 또한, 오디오 파일을 Wwise로 가져오는 방법은 ak.wwise.core.audio.import 를 참고하세요.

ak.wwise.core.object.delete
특정 오브젝트를 삭제합니다.

ak.wwise.core.object.get
옵션에 지정된 내용에 따라, 쿼리 결과의 각 오브젝트에 대해 쿼리를 실행하고 데이터를 반환합니다. 해당 쿼리는 선택 사항인 'transform' 인자를 이용해 'waql' 인자나 'from' 인자를 지정할 수 있습니다. 더 자세한 정보는 Using the Wwise Authoring Query Language (WAQL) 이나 Wwise 프로젝트 쿼리하기 를 참고하세요. 선택 옵션에 대해서는 Return Options 을 참고하세요.

ak.wwise.core.object.getAttenuationCurve
특정 감쇠(attenuation) 오브젝트에 대해 지정된 감쇠 곡선을 구합니다.

ak.wwise.core.object.getPropertyAndReferenceNames
오브젝트의 속성 목록과 레퍼런스 이름을 불러옵니다.

ak.wwise.core.object.getPropertyInfo
오브젝트 속성에 대한 정보를 불러옵니다. 이 함수는 속성의 값을 반환하지 않습니다. 속성 값을 불러오려면 ak.wwise.core.object.get 및 Return Options 을 참고하세요.

ak.wwise.core.object.getPropertyNames
ak.wwise.core.object.getTypes
Wwise의 오브젝트 모델에 등록된 모든 오브젝트 타입의 목록을 불러옵니다. 이 함수는 Wwise Objects Reference 와 같은 내용을 반환합니다.

ak.wwise.core.object.isPropertyEnabled
의존하고 있는 속성들의 값에 따라 특정 속성이 활성화된 경우 true를 반환합니다.

ak.wwise.core.object.move
오브젝트를 원하는 상위 계층으로 이동시킵니다. 이동시킨 오브젝트를 반환합니다.

ak.wwise.core.object.setAttenuationCurve
특정 감쇠(attenuation) 오브젝트에 대해 지정된 감쇠 곡선을 설정합니다.

ak.wwise.core.object.setName
오브젝트의 이름을 변경합니다.

ak.wwise.core.object.setNotes
오브젝트의 노트를 설정합니다.

ak.wwise.core.object.setProperty
특정 플랫폼에 대해 오브젝트의 속성 값을 설정합니다. 각 오브젝트 타입에 사용할 수 있는 속성에 대한 더 자세한 정보는 Wwise Objects Reference 를 참고하세요. 오브젝트에 레퍼런스를 설정하는 부분은 ak.wwise.core.object.setReference 를 참고하세요. 오브젝트의 속성 값을 구하는 부분은 ak.wwise.core.object.get 을 참고하세요.

ak.wwise.core.object.setRandomizer
지정된 플랫폼에 대해 오브젝트 속성의 랜더마이저 값을 설정합니다. 각 오브젝트 타입에 사용할 수 있는 속성에 대한 더 자세한 정보는 Wwise Objects Reference 를 참고하세요.

ak.wwise.core.object.setReference
오브젝트의 레퍼런스 값을 설정합니다. 각 오브젝트 타입에 사용할 수 있는 레퍼런스에 대한 더 자세한 정보는 Wwise Objects Reference 를 참고하세요.

ak.wwise.core.plugin.getList
ak.wwise.core.plugin.getProperties
ak.wwise.core.plugin.getProperty
ak.wwise.core.profiler.enableProfilerData
캡처할 데이터 타입을 지정합니다. 사용자의 프로파일러 설정을 오버라이드합니다.

ak.wwise.core.profiler.getAudioObjects
특정 프로파일러 캡처 시간에 Audio Object를 불러옵니다.

ak.wwise.core.profiler.getBusses
특정 프로파일러 캡처 시간에 버스를 불러옵니다.

ak.wwise.core.profiler.getCursorTime
지정된 프로파일러 커서의 현재 시간을 반환합니다 (단위: 밀리세컨드).

ak.wwise.core.profiler.getRTPCs
특정 프로파일러 캡처 시간에 활성화된 RTPC를 불러옵니다.

ak.wwise.core.profiler.getVoiceContributions
보이스 볼륨, 파이프라인 ID로부터 결정된 보이스 경로의 고주파수 및 저주파수에 영향을 끼치는 모든 매개 변수를 불러옵니다.

ak.wwise.core.profiler.getVoices
특정 프로파일러 캡처 시간에 보이스를 불러옵니다.

ak.wwise.core.profiler.startCapture
프로파일러 캡처를 시작하고 캡처 시작시 시간을 반환합니다 (단위: 밀리세컨드).

ak.wwise.core.profiler.stopCapture
프로파일러 캡처를 중단하고 캡처 종료시 시간을 반환합니다 (단위: 밀리세컨드).

ak.wwise.core.project.save
현재 프로젝트를 저장합니다.

ak.wwise.core.remote.connect
실행 파일을 실행하는 Wwise Sound Engine에 Wwise Authoring 애플리케이션을 연결합니다. 호스트는 반드시 커뮤니케이션이 활성화된 코드를 실행해야 합니다. "host"만 있을 경우, Wwise가 가장 처음 발견하는 Sound Engine 인스턴스로 연결합니다. 서로 다른 인스턴스 간 구별을 위해 연결할 애플리케이션 이름을 사용할 수도 있습니다.

ak.wwise.core.remote.disconnect
실행 파일을 실행하는 Wwise Sound Engine으로부터 Wwise Authoring 애플리케이션을 연결 해제합니다.

ak.wwise.core.remote.getAvailableConsoles
Sound Engine 인스턴스로 Wwise Authoring을 연결하기 위해 사용 가능한 모든 콘솔을 불러옵니다.

ak.wwise.core.remote.getConnectionStatus
연결 상태를 불러옵니다.

ak.wwise.core.soundbank.generate
SoundBank 목록을 WAAPI 요청에 정의된 가져오기 정의와 함께 생성합니다. SoundBank를 디스크에 작성하지 않는 옵션을 선택할 경우, SoundBank 구조체 정보와 base64 뱅크 데이터를 구할 때 ak.wwise.core.soundbank.generated 를 구독하세요.

ak.wwise.core.soundbank.getInclusions
Retrieves a SoundBank's inclusion list.

ak.wwise.core.soundbank.setInclusions
Modifies a SoundBank's inclusion list. The 'operation' argument determines how the 'inclusions' argument modifies the SoundBank's inclusion list; 'inclusions' may be added to / removed from / replace the SoundBank's inclusion list.

ak.wwise.core.switchContainer.addAssignment
Assigns a Switch Container's child to a Switch. This is the equivalent of doing a drag&drop of the child to a state in the Assigned Objects view. The child is always added at the end for each state.

ak.wwise.core.switchContainer.getAssignments
Returns the list of assignments between a Switch Container's children and states.

ak.wwise.core.switchContainer.removeAssignment
Removes an assignment between a Switch Container's child and a State.

ak.wwise.core.transport.create
Creates a transport object for the given Wwise object. The return transport object can be used to play, stop, pause and resume the Wwise object via the other transport functions.

ak.wwise.core.transport.destroy
Destroys the given transport object.

ak.wwise.core.transport.executeAction
Executes an action on the given transport object, or all transport objects if none is specified.

ak.wwise.core.transport.getList
Returns the list of transport objects.

ak.wwise.core.transport.getState
Gets the state of the given transport object.

ak.wwise.core.undo.beginGroup
Begins an undo group. Make sure to call ak.wwise.core.undo.endGroup exactly once for every ak.wwise.core.beginUndoGroup call you make. Calls to ak.wwise.core.undo.beginGroup can be nested. When closing a WAMP session, a check is made to ensure that all undo groups are closed. If not, a cancelGroup is called for each of the groups still open.

ak.wwise.core.undo.cancelGroup
Cancels the last undo group. Please note that this does not revert the operations made since the last ak.wwise.core.undo.beginGroup call.

ak.wwise.core.undo.endGroup
Ends the last undo group.

ak.wwise.debug.enableAsserts
Enables debug assertions. Every call to enableAsserts with 'false' increments the ref count. Calling with true decrements the ref count. This is only available with Debug builds.

ak.wwise.debug.enableAutomationMode
Enables or disables the automation mode for Wwise. 이 옵션은 메시지 상자나 대화 상자로 인해 발생할 수 있는 중단을 줄여줍니다. For instance, enabling the automation mode silently accepts: project migration, project load log, EULA acceptance, project licence display and generic message boxes.

ak.wwise.debug.testAssert
Private use only.

ak.wwise.debug.testCrash
Private use only.

ak.wwise.ui.bringToForeground
Bring Wwise main window to foreground. Refer to SetForegroundWindow and AllowSetForegroundWindow on MSDN for more information on the restrictions. Refer to ak.wwise.core.getInfo to obtain the Wwise process ID for AllowSetForegroundWindow.

ak.wwise.ui.captureScreen
Captures a part of the Wwise UI relative to a view.

ak.wwise.ui.commands.execute
Executes a command. Some commands can take a list of objects as parameters. Refer to Wwise Authoring Command Identifiers for the available commands.

ak.wwise.ui.commands.getCommands
Gets the list of commands.

ak.wwise.ui.commands.register
Registers an array of add-on commands. Registered commands remain until the Wwise process is terminated. Refer to 명령어 추가 정의하기 for more information about registering commands. Also refer to ak.wwise.ui.commands.executed.

ak.wwise.ui.commands.unregister
Unregisters an array of add-on UI commands.

ak.wwise.ui.getSelectedObjects
Retrieves the list of objects currently selected by the user in the active view.

ak.wwise.ui.project.close
Closes the current project.

ak.wwise.ui.project.open
Opens a project, specified by path. Please refer to ak.wwise.core.project.loaded for further explanations on how to be notified when the operation has completed.

ak.wwise.waapi.getFunctions
Retrieves the list of functions.

ak.wwise.waapi.getSchema
Retrieves the JSON schema of a Waapi URI.

ak.wwise.waapi.getTopics
Retrieves the list of topics to which a client can subscribe.