버전
menu_open
Wwise SDK 2024.1.0
ak.soundengine.getState

State Group의 현재 State를 구합니다. When using setState just prior to getState, allow a brief delay (no more than 10ms) for the information to update in the sound engine.

Arguments

이름 타입 설명
stateGroup * any of: State Group의 ID (GUID), 고유 수식된 이름, 또는 경로
string The name of the object qualified by its type or Short ID in the form of type:name or Global:shortId. Only object types that have globally-unique names or Short Ids are supported. Ex: Event:Play_Sound_01, Global:245489792
string 해당 형식의 오브젝트 GUID: {aabbcc00-1122-3344-5566-77889900aabb}.
string Wwise 오브젝트의 프로젝트 경로로서, 카테고리 및 Work-Unit 포함. 예: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.

(필수 *)

인자 스키마

Options

이름 타입 설명
return array 모든 오브젝트에 대해 반환되는 내용을 지정합니다. 사용 가능한 속성 및 참조에 대한 더 자세한 정보는 Wwise 오브젝트 레퍼런스 를 참고하세요.
반환 표현식 배열이 어느 Wwise 오브젝트가 반환될 지를 정의합니다. 여기에는 이름, ID, 또는 Volume이나 Pitch같은 오브젝트 속성, 등의 접근자가 포함돼 있습니다.
return [...] any of: 반환 표현식.
string Wwise 오브젝트의 하나 또는 여러 개의 내장 접근자를 지정합니다. 사용 가능한 값:
  • id
  • name
  • notes
  • type
  • pluginName
  • shortId
  • classId
  • category
  • filePath
  • workunit
  • parent
  • owner
  • path
  • isPlayable
  • childrenCount
  • totalSize
  • mediaSize
  • objectSize
  • structureSize
  • sound:convertedWemFilePath
  • sound:originalWavFilePath
  • soundbank:bnkFilePath
  • music:transitionRoot
  • music:playlistRoot
  • audioSource:playbackDuration
  • audioSource:maxDurationSource
  • audioSource:trimValues
  • audioSource:maxRadiusAttenuation
  • audioSource:language
  • workunit:isDefault
  • workunit:type
  • workunit:isDirty
  • switchContainerChild:context
  • convertedWemFilePath
  • originalFilePath
  • originalRelativeFilePath
  • convertedFilePath
  • originalWavFilePath
  • soundbankBnkFilePath
  • musicTransitionRoot
  • musicPlaylistRoot
  • playbackDuration
  • duration
  • maxDurationSource
  • audioSourceTrimValues
  • maxRadiusAttenuation
  • audioSourceLanguage
  • workunitIsDefault
  • workunitType
  • workunitIsDirty
  • switchContainerChildContext
  • isExplicitMute
  • isExplicitSolo
  • isImplicitMute
  • isImplicitSolo
  • isIncluded
  • points
  • stateProperties
  • stateGroups
  • blendTracks
string 쿼리를 형성하는 점으로 구분된 접근자 하나 또는 여러 개를 지정하고 값이나 오브젝트 레퍼런스를 산출합니다. 단일 @를 지정하면 연관된 오브젝트의 속성 값을 반환합니다. 두 개의 @를 지정하면 오버라이드 소스의 속성 값을 반환합니다. Wwise 오브젝트 레퍼런스 를 참고하세요.
platform any of: 플랫폼의 이름이나 ID (GUID). 이 인자는 선택 사항입니다. 특별히 지정돼있지 않은 경우, 현재 플랫폼을 사용합니다.
string 플랫폼의 이름.
string 플랫폼의 ID.
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.
language any of: 언어 이름이나 ID (GUID).
string 언어의 이름.
string 언어의 ID.
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.

옵션 스키마

Result

이름 타입 설명
id string 오브젝트의 ID (GUID).
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.
name string 오브젝트의 이름을 말합니다.
notes string 오브젝트의 노트.
type string 오브젝트의 타입. 사용 가능한 타입에 대한 더 자세한 정보는 Wwise 오브젝트 레퍼런스 를 참고하세요.
pluginName string Source, Effect, Mixer, Device 및 Metadata 플러그인의 이름.
path string 프로젝트 루트로부터의 오브젝트 경로. 예: '\Actor-Mixer Hierarchy\Default Work Unit\Sound1'
parent object 계층 구조 내에서 해당 오브젝트의 부모 객체.
parent.id string 오브젝트의 ID (GUID).
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.
parent.name string 오브젝트의 이름을 말합니다.
owner object 오브젝트의 소유자. 커스텀 효과, 커스텀 감쇠, 등과 같이 다른 오브젝트가 지역적으로 소유하고 있는 오브젝트에 해당됩니다.
owner.id string 오브젝트의 ID (GUID).
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.
owner.name string 오브젝트의 이름을 말합니다.
isPlayable boolean 오브젝트가 Transport에서 재생될 수 있으면 true입니다.
shortId integer 오브젝트의 Short ID.
classId integer 오브젝트의 클래스 ID.
Unsigned Integer 32 비트. 범위: [0,4294967295]
category string 오브젝트의 카테고리. 예: 'Actor-Mixer Hierarchy'
filePath string 오브젝트를 포함하고 있는 파일 경로. 해당 경로는 Work Unit 파일이나 프로젝트 파일이 될 수 있습니다. Mac에서 WAAPI를 사용할 경우는 Mac에서 WAAPI 사용하기 를 참고하세요.
workunit object 오브젝트를 포함하고 있는 상위 Work Unit. 'id'와 'name'이 반환됩니다.
workunit.id string 오브젝트의 ID (GUID).
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.
workunit.name string 오브젝트의 이름을 말합니다.
childrenCount number 오브젝트의 자식 객체 개수. 추후 버전에는 사용이 중단됩니다. The same result can be obtained with children.count().
totalSize integer SoundBank 내에서 이 오브젝트와 해당 모든 하위 항목이 차지하는 공간 (단위: 바이트). objectSize는 포함되지 않습니다. 정확한 값을 위해서는 SoundBank가 생성되어야 합니다.
mediaSize integer 이 오브젝트와 해당 모든 하위 항목의 미디어 파일의 총 변환 크기 (단위: 바이트). 정확한 값을 위해서는 SoundBank가 생성되어야 합니다.
objectSize integer SoundBank 내에서 오브젝트의 메타 데이터가 차지하는 공간 (단위: 바이트). 미디어 파일은 포함되지 않습니다. 정확한 값을 위해서는 SoundBank가 생성되어야 합니다.
structureSize integer SoundBank 내에서 오브젝트의 메타 데이터와 해당 모든 하위 항목이 차지하는 공간 (단위: 바이트). 미디어 파일은 포함되지 않습니다. 정확한 값을 위해서는 SoundBank가 생성되어야 합니다.
musicTransitionRoot object (DEPRECATED) The music transition root containing all other music transitions recursively. 추후 버전에는 사용이 중단됩니다. The TransitionRoot reference should be used instead.
musicTransitionRoot.id string 오브젝트의 ID (GUID).
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.
musicPlaylistRoot object (DEPRECATED) The music playlist root containing all other music playlist items recursively. Music Playlist Container에만 적용됩니다. 추후 버전에는 사용이 중단됩니다. The PlaylistRoot reference should be used instead.
musicPlaylistRoot.id string 오브젝트의 ID (GUID).
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.
originalWavFilePath string (추후 버전에는 사용 중단) 원본 WAV 파일의 절대 경로. Sound와 Audio Source 오브젝트에 대해서만 유효합니다. Mac에서 WAAPI를 사용할 경우는 Mac에서 WAAPI 사용하기 를 참고하세요.
originalFilePath string 원본 파일의 절대 경로. Sound와 Audio Source 오브젝트에 대해서만 유효합니다. Mac에서 WAAPI를 사용할 경우는 Mac에서 WAAPI 사용하기 를 참고하세요.
originalRelativeFilePath string Relative (from project's Originals Folder) path to the original file. Sound와 Audio Source 오브젝트에 대해서만 유효합니다. Mac에서 WAAPI를 사용할 경우는 Mac에서 WAAPI 사용하기 를 참고하세요.
activeSource object 사운드 오브젝트의 액티브 소스.
activeSource.id string 오브젝트의 ID (GUID).
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.
activeSource.name string 오브젝트의 이름을 말합니다.
convertedWemFilePath string (추후 버전에는 사용 중단) 변환된 WEM 파일의 절대 경로. 옵션에 플랫폼을 지정함. Sound와 Audio Source 오브젝트에 대해서만 유효합니다. Mac에서 WAAPI를 사용할 경우, Mac에서 WAAPI 사용하기 를 참고하세요.
convertedFilePath string 변환된 파일의 절대 경로. 옵션에 플랫폼을 지정함. Sound와 Audio Source 오브젝트에 대해서만 유효합니다. Mac에서 WAAPI를 사용할 경우, Mac에서 WAAPI 사용하기 를 참고하세요.
soundbankBnkFilePath string SoundBank 오브젝트와 연관되어 생성된 SoundBank 파일의 절대 경로. SoundBank 오브젝트에 대해서만 유효합니다. Mac에서 WAAPI를 사용할 경우, Mac에서 WAAPI 사용하기 를 참고하세요.
playbackDuration object min/max 길이와 길이 타입을 포함하고 있는 길이 루트. 추후 버전에는 사용이 중단됩니다. 대신 길이(duration)가 사용됩니다. 직접적인 소스로서 혹은 간접적인 하위 오브젝트를 통해 Audio Source 오브젝트를 포함할 수 있는 모든 오브젝트에 해당됩니다.
playbackDuration.playbackDurationMin number 최소 재생 시간.
playbackDuration.playbackDurationMax number 최대 재생 시간.
playbackDuration.playbackDurationType string 길이 타입을 말합니다.
duration object min/max 길이와 길이 타입을 포함하고 있는 길이 루트. 직접적인 소스로서 혹은 간접적인 하위 오브젝트를 통해 Audio Source 오브젝트를 포함할 수 있는 모든 오브젝트에 해당됩니다.
duration.min number 최소 재생 시간.
duration.max number 최대 재생 시간.
duration.type string 길이 타입을 말합니다.
maxDurationSource object 길이가 가장 긴 오디오 음원. 직접적인 소스로서 혹은 간접적인 하위 오브젝트를 통해 Audio Source 오브젝트를 포함할 수 있는 모든 오브젝트에 해당됩니다.
maxDurationSource.id string 길이가 가장 긴 오디오 음원 오브젝트의 ID (GUID).
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.
maxDurationSource.trimmedDuration number 길이가 가장 긴 트리밍된 음원의 길이 (단위: 초).
audioSourceTrimValues object 트리밍되는 오디오 음원의 시간 범위.
audioSourceTrimValues.trimBegin number 트리밍 시작의 시간 값 (단위: 초).
audioSourceTrimValues.trimEnd number 트리밍 끝의 시간 값 (단위: 초).
maxRadiusAttenuation object 반경이 가장 큰 감쇠 (attenuation). 직접적인 소스로서 혹은 간접적인 하위 오브젝트를 통해 Audio Source 오브젝트를 포함할 수 있는 모든 오브젝트에 해당됩니다.
maxRadiusAttenuation.id string 반경이 가장 큰 감쇠 오브젝트의 ID (GUID).
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.
maxRadiusAttenuation.radius number 감쇠 오브젝트의 반경.
audioSourceLanguage object 오디오 음원에 연관돼 있는 언어. Audio Source 오브젝트에 직접 적용됩니다.
audioSourceLanguage.id string Audio Source 오브젝트가 연결된 Language 오브젝트의 ID (GUID).
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.
audioSourceLanguage.name string Audio Source 오브젝트가 연결된 Language 오브젝트의 이름.
originalTotalChannelCount number The total number of channels present in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
originalNormalChannelCount number The number of channel in the normal plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
originalHeightChannelCount number The number of channel in the height plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
originalLFEChannelCount number The number of low frequency channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
originalAnonymousChannelCount number The number of anonymous channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
originalChannelConfig string The configuration of the channels in the audio source (Ex : 7.1.4). For anonymous channels, returns Anonymous. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
originalChannelMask number The mask associated with the channel's configuration. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
originalSampleRate number The sample rate for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
originalBitDepth number The sample rate for the audio source. Either 16 or 24. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
originalFileSize number The file size in bytes for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
originalDataSize number The data size for bytes the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
originalSampleCount number The number of samples in the audio file. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
originalDuration number The file duration. Differs from generic Duration field because the original file does not include Trim Begind/End. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
originalCodec string The audio file's codec. For original files, it will always be PCM. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
convertedTotalChannelCount number The total number of channels present in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
convertedNormalChannelCount number The number of channel in the normal plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
convertedHeightChannelCount number The number of channel in the height plane of the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
convertedLFEChannelCount number The number of low frequency channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
convertedAnonymousChannelCount number The number of anonymous channel in the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
convertedChannelConfig string The configuration of the channels in the audio source (Ex : 7.1.4). For anonymous channels, returns Anonymous. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
convertedChannelMask number The mask associated with the channel's configuration. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
convertedSampleRate number The sample rate for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
convertedBitDepth number The sample rate for the audio source. Either 16 or 24. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
convertedFileSize number The file size in bytes for the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
convertedDataSize number The data size for bytes the audio source. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
convertedSampleCount number The number of samples in the audio file. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
convertedDuration number The file duration. Differs from generic Duration field because the original file does not include Trim Begind/End. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
convertedCodec string The audio file's codec. For original files, it will always be PCM. This accessor works for Sounds, Audio File Source, Plugin-Media and Music Clips.
workunitIsDefault boolean Work Unit이 기본 설정일 때 true.
workunitType string Work Unit의 타입. Work Unit과 같이 물리적 폴더는 "WorkUnit" 타입을 갖습니다. 물리적 폴더는 workunitType이 "folder"입니다. 사용 가능한 값:
  • folder
  • rootFile
  • nestedFile
workunitIsDirty boolean Work Unit이나 Project(wproj 파일)가 변경됐을 경우, 즉 수정되었으나 저장하지 않은 경우, true입니다.
switchContainerChildContext object Switch Container의 자식 객체와 연관된 컨텍스트 오브젝트. 이 오브젝트는 컨텍스트에 의존하지 않는 Switch Container 하위 항목과 연관돼있는 속성을 갖고 있습니다 (예: '1st only' 체크 상자의 속성).
switchContainerChildContext.id string 오브젝트의 ID (GUID).
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.
isExplicitMute boolean 오브젝트가 명시적으로 음소거되었는지 여부. 오브젝트를 암묵적으로 명시적 음소거를 하면 하위 오브젝트가 음소거됩니다.
isExplicitSolo boolean Whether or not the object has been soloed explicitly. Soloing an object silences all the other objects in the project except this one.
isImplicitMute boolean Whether or not the object has been muted implicitly. 오브젝트를 암묵적으로 명시적 음소거를 하면 하위 오브젝트가 음소거됩니다.
isImplicitSolo boolean Whether or not the object has been soloed implicitly. Soloing an object silences all the other objects in the project except this one.
isIncluded boolean Whether or not the object is Included. 옵션에 플랫폼을 지정함. This takes into consideration the Inclusion status of the object's ancestors.
points array This only applies to Curve objects.
An array of points defining a curve.
points [...] object 곡선에 있는 지점.
points[...].x * number 곡선 지점의 X 좌표.
points[...].y * number 곡선 지점의 Y 좌표.
points[...].shape * string 이 지점과 다음 지점 사이 곡선분(curve segment)의 형태. 사용 가능한 값:
  • Constant
  • Linear
  • Log3
  • Log2
  • Log1
  • InvertedSCurve
  • SCurve
  • Exp1
  • Exp2
  • Exp3
stateProperties array An array of state properties to set.
stateProperties [...] string The name of the property to set.
stateGroups array The State Group objects associated with this object.
stateGroups [...] object A State Group object.
stateGroups[...].id string The ID (GUID) of the State Group object.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
stateGroups[...].name string The name of the State Group object.
regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) any of: 쿼리를 형성하는 점으로 구분된 접근자를 지정하고 속성 값이나 오브젝트 레퍼런스를 산출합니다. 단일 @는 연관된 오브젝트의 속성 값을 지정합니다. 두 개의 @는 오버라이드 소스의 속성 값을 지정합니다. 모든 타입에 사용 가능한 속성 및 참조에 대한 더 자세한 정보는 Wwise 오브젝트 레퍼런스 를 참조하세요.
string 문자열 값.
array An array of string values.
number 숫자 값.
array An array of numeric values.
boolean boolean 값.
array An array of boolean values.
object 오브젝트 레퍼런스 값.
array 오브젝트 목록 레퍼런스 값.
regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] string 문자열 값.
regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] number 숫자 값.
regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] boolean boolean 값.
regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).id string 오브젝트의 ID (GUID).
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.
regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$).name string 오브젝트의 이름을 말합니다.
regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$) [...] object 오브젝트 레퍼런스 값.
regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].id string 오브젝트의 ID (GUID).
{aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID.
regex(^((@?@?[a-zA-Z0-9:_\(\),]+)|[a-zA-Z\(\),]+\(.+\))(\.@?@?[a-zA-Z0-9:_\(\),]+|[a-zA-Z\(\),]+\(.+\))*$)[...].name string 오브젝트의 이름을 말합니다.

결과 스키마

더 보기

예제

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

이 페이지가 도움이 되었나요?

지원이 필요하신가요?

질문이 있으신가요? 문제를 겪고 계신가요? 더 많은 정보가 필요하신가요? 저희에게 문의해주시면 도와드리겠습니다!

지원 페이지를 방문해 주세요

작업하는 프로젝트에 대해 알려주세요. 언제든지 도와드릴 준비가 되어 있습니다.

프로젝트를 등록하세요. 아무런 조건이나 의무 사항 없이 빠른 시작을 도와드리겠습니다.

Wwise를 시작해 보세요