알림: 고객님의 주요 출시 버전( 2023.1.10.8659 )에 해당하는 최신 설명서로 이동했습니다. 특정 버전의 설명서를 보시려면 Audiokinetic 런처에서 오프라인 설명서를 다운로드하고 Wwise Authoring의 Offline Documentation을 확인하세요.
link
Wwise SDK 2023.1.10
ak.soundengine.getSwitch 결과 스키마
스키마
{
"type": "object",
"description": "The Switch Group and any options. Default returns id and name.\\n A Wwise object. 반환 옵션을 사용해 필요한 속성을 지정하세요.",
"description": "오브젝트의 ID (GUID).\\n {aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID."
},
"name": {
"type": "string",
"description": "오브젝트의 이름을 말합니다."
}
}
},
"childrenCount": {
"type": "number",
"description": "오브젝트의 자식 객체 개수. 추후 버전에는 사용이 중단됩니다. The same result can be obtained with children.count()."
},
"totalSize": {
"type": "integer",
"description": "SoundBank 내에서 이 오브젝트와 해당 모든 하위 항목이 차지하는 공간 (단위: 바이트). objectSize는 포함되지 않습니다. 정확한 값을 위해서는 SoundBank가 생성되어야 합니다."
},
"mediaSize": {
"type": "integer",
"description": "이 오브젝트와 해당 모든 하위 항목의 미디어 파일의 총 변환 크기 (단위: 바이트). 정확한 값을 위해서는 SoundBank가 생성되어야 합니다."
},
"objectSize": {
"type": "integer",
"description": "SoundBank 내에서 오브젝트의 메타 데이터가 차지하는 공간 (단위: 바이트). 미디어 파일은 포함되지 않습니다. 정확한 값을 위해서는 SoundBank가 생성되어야 합니다."
},
"structureSize": {
"type": "integer",
"description": "SoundBank 내에서 오브젝트의 메타 데이터와 해당 모든 하위 항목이 차지하는 공간 (단위: 바이트). 미디어 파일은 포함되지 않습니다. 정확한 값을 위해서는 SoundBank가 생성되어야 합니다."
},
"musicTransitionRoot": {
"type": "object",
"description": "(DEPRECATED) The music transition root containing all other music transitions recursively. 추후 버전에는 사용이 중단됩니다. The TransitionRoot reference should be used instead.",
"description": "오브젝트의 ID (GUID).\\n {aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID."
}
}
},
"musicPlaylistRoot": {
"type": "object",
"description": "(DEPRECATED) The music playlist root containing all other music playlist items recursively. Music Playlist Container에만 적용됩니다. 추후 버전에는 사용이 중단됩니다. The PlaylistRoot reference should be used instead.",
"description": "오브젝트의 ID (GUID).\\n {aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID."
}
}
},
"originalWavFilePath": {
"type": "string",
"description": "(추후 버전에는 사용 중단) 원본 WAV 파일의 절대 경로. Sound와 Audio Source 오브젝트에 대해서만 유효합니다. Mac에서 WAAPI를 사용할 경우는 \\ref waapi_path_on_mac 를 참고하세요."
},
"originalFilePath": {
"type": "string",
"description": "원본 파일의 절대 경로. Sound와 Audio Source 오브젝트에 대해서만 유효합니다. Mac에서 WAAPI를 사용할 경우는 \\ref waapi_path_on_mac 를 참고하세요."
},
"originalRelativeFilePath": {
"type": "string",
"description": "Relative (from project's Originals Folder) path to the original file. Sound와 Audio Source 오브젝트에 대해서만 유효합니다. Mac에서 WAAPI를 사용할 경우는 \\ref waapi_path_on_mac 를 참고하세요."
"description": "오브젝트의 ID (GUID).\\n {aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID."
},
"name": {
"type": "string",
"description": "오브젝트의 이름을 말합니다."
}
}
},
"convertedWemFilePath": {
"type": "string",
"description": "(추후 버전에는 사용 중단) 변환된 WEM 파일의 절대 경로. 옵션에 플랫폼을 지정합니다. Sound와 Audio Source 오브젝트에 대해서만 유효합니다. Mac에서 WAAPI를 사용할 경우, \\ref waapi_path_on_mac 를 참고하세요."
},
"convertedFilePath": {
"type": "string",
"description": "변환된 파일의 절대 경로. 옵션에 플랫폼을 지정합니다. Sound와 Audio Source 오브젝트에 대해서만 유효합니다. Mac에서 WAAPI를 사용할 경우, \\ref waapi_path_on_mac 를 참고하세요."
},
"soundbankBnkFilePath": {
"type": "string",
"description": "SoundBank 오브젝트와 연관되어 생성된 SoundBank 파일의 절대 경로. SoundBank 오브젝트에 대해서만 유효합니다. Mac에서 WAAPI를 사용할 경우, \\ref waapi_path_on_mac 를 참고하세요."
},
"playbackDuration": {
"type": "object",
"description": "min\/max 길이와 길이 타입을 포함하고 있는 길이 루트. 추후 버전에는 사용이 중단됩니다. 대신 길이(duration)가 사용됩니다. 직접적인 소스로서 혹은 간접적인 하위 오브젝트를 통해 Audio Source 오브젝트를 포함할 수 있는 모든 오브젝트에 해당됩니다.",
"properties": {
"playbackDurationMin": {
"type": "number",
"description": "최소 재생 시간."
},
"playbackDurationMax": {
"type": "number",
"description": "최대 재생 시간."
},
"playbackDurationType": {
"type": "string",
"description": "길이 타입을 말합니다."
}
}
},
"duration": {
"type": "object",
"description": "min\/max 길이와 길이 타입을 포함하고 있는 길이 루트. 직접적인 소스로서 혹은 간접적인 하위 오브젝트를 통해 Audio Source 오브젝트를 포함할 수 있는 모든 오브젝트에 해당됩니다.",
"properties": {
"min": {
"type": "number",
"description": "최소 재생 시간."
},
"max": {
"type": "number",
"description": "최대 재생 시간."
},
"type": {
"type": "string",
"description": "길이 타입을 말합니다."
}
}
},
"maxDurationSource": {
"type": "object",
"description": "길이가 가장 긴 오디오 음원. 직접적인 소스로서 혹은 간접적인 하위 오브젝트를 통해 Audio Source 오브젝트를 포함할 수 있는 모든 오브젝트에 해당됩니다.",
"description": "오브젝트의 ID (GUID).\\n {aabbcc00-1122-3344-5566-77889900aabb} 형식의 오브젝트 GUID."
}
}
},
"isExplicitMute": {
"type": "boolean",
"description": "오브젝트가 명시적으로 음소거되었는지 여부. 오브젝트를 암묵적으로 명시적 음소거를 하면 하위 오브젝트가 음소거됩니다."
},
"isExplicitSolo": {
"type": "boolean",
"description": "Whether or not the object has been soloed explicitly. Soloing an object silences all the other objects in the project except this one."
},
"isImplicitMute": {
"type": "boolean",
"description": "Whether or not the object has been muted implicitly. 오브젝트를 암묵적으로 명시적 음소거를 하면 하위 오브젝트가 음소거됩니다."
},
"isImplicitSolo": {
"type": "boolean",
"description": "Whether or not the object has been soloed implicitly. Soloing an object silences all the other objects in the project except this one."
},
"isIncluded": {
"type": "boolean",
"description": "Whether or not the object is Included. 옵션에 플랫폼을 지정합니다. This takes into consideration the Inclusion status of the object's ancestors."
},
"points": {
"type": "array",
"description": "This only applies to Curve objects.\\n An array of points defining a curve.",
"items": {
"type": "object",
"description": "곡선에 있는 지점.",
"properties": {
"x": {
"type": "number",
"description": "곡선 지점의 X 좌표."
},
"y": {
"type": "number",
"description": "곡선 지점의 Y 좌표."
},
"shape": {
"type": "string",
"description": "이 지점과 다음 지점 사이 곡선분(curve segment)의 형태.",
"enum": [
"Constant",
"Linear",
"Log3",
"Log2",
"Log1",
"InvertedSCurve",
"SCurve",
"Exp1",
"Exp2",
"Exp3"
]
}
},
"required": [
"x",
"y",
"shape"
],
"additionalProperties": false
}
},
"stateProperties": {
"type": "array",
"description": "An array of state properties to set.",
"items": {
"description": "The name of the property to set.",
"type": "string"
}
},
"stateGroups": {
"type": "array",
"description": "The State Group objects associated with this object.",
"description": "쿼리를 형성하는 점으로 구분된 접근자를 지정하고 속성 값이나 오브젝트 레퍼런스를 산출합니다. 단일 @는 연관된 오브젝트의 속성 값을 지정합니다. 두 개의 @@는 오버라이드 소스의 속성 값을 지정합니다. 모든 타입에 사용 가능한 속성 및 참조에 대한 더 자세한 정보는 \\ref wobjects_index 를 참조하세요.",