バージョン

menu_open
警告:あなたのメジャーリリース ( 2023.1.10.8659 ) に該当する最新ドキュメンテーションが表示されています。特定バージョンのドキュメンテーションにアクセスするには、Audiokinetic Launcherでオフラインドキュメンテーションをダウンロードし、Wwise AuthoringのOffline Documentationオプションにチェックを入れてください。
Wwise SDK 2023.1.10
ak.soundengine.getSwitch 結果スキーマ

スキーマ

{
"type": "object",
"description": "The Switch Group and any options. デフォルトで、IDと名前を返します。\\n Wwiseオブジェクト。必須のプロパティを指定するには、returnオプションを使います。",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "オブジェクトのID(GUID)。\\n オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。"
},
"name": {
"type": "string",
"description": "オブジェクト名。"
},
"notes": {
"type": "string",
"description": "オブジェクトのnotes。"
},
"type": {
"type": "string",
"description": "オブジェクトのタイプ。使用可能なタイプの詳細については、 \\ref wobjects_index を参照してください。"
},
"pluginName": {
"type": "string",
"description": "Source、Effect、Mixer、Device、Metadataプラグインの、プラグイン名。"
},
"path": {
"type": "string",
"description": "プロジェクトルートからオブジェクトへのパス。例: '\\\\Actor-Mixer Hierarchy\\\\Default Work Unit\\\\Sound1'"
},
"parent": {
"type": "object",
"description": "階層におけるオブジェクトの親。",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "オブジェクトのID(GUID)。\\n オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。"
},
"name": {
"type": "string",
"description": "オブジェクト名。"
}
}
},
"owner": {
"type": "object",
"description": "オブジェクトのオーナー。カスタムエフェクトやカスタム減衰など、ほかのオブジェクトにローカルで所有されているオブジェクトが、該当します。",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "オブジェクトのID(GUID)。\\n オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。"
},
"name": {
"type": "string",
"description": "オブジェクト名。"
}
}
},
"isPlayable": {
"type": "boolean",
"description": "オブジェクトをTransportで再生できる場合は、trueです。"
},
"shortId": {
"type": "integer",
"description": "オブジェクトのShort ID。"
},
"classId": {
"type": "integer",
"description": "オブジェクトのクラスID。\\n 符号なし整数32-bit。",
"minimum": 0,
"maximum": 4294967295
},
"category": {
"type": "string",
"description": "オブジェクトのカテゴリ。例: 'Actor-Mixer Hierarchy'"
},
"filePath": {
"type": "string",
"description": "オブジェクトを含むファイルへのパス。パスは、Work Unitファイルまたはプロジェクトファイルとします。WAAPIをMacで使う場合は、 \\ref waapi_path_on_mac を参照してください。"
},
"workunit": {
"type": "object",
"description": "オブジェクトを含む、親Work Unit。'id'と'name'を返します。",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "オブジェクトのID(GUID)。\\n オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。"
},
"name": {
"type": "string",
"description": "オブジェクト名。"
}
}
},
"childrenCount": {
"type": "number",
"description": "このオブジェクトの子の数。注:これは非推奨です。The same result can be obtained with children.count()."
},
"totalSize": {
"type": "integer",
"description": "このオブジェクトと、その全ての子が、SoundBankに占めるスペース(単位byte)。objectSizeは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。"
},
"mediaSize": {
"type": "integer",
"description": "このオブジェクトとその全ての子のメディアファイルの、変換後の合計サイズ(単位bytes)。なお、正確な値を得るには、SoundBankを生成する必要があります。"
},
"objectSize": {
"type": "integer",
"description": "このオブジェクトのメタデータがSoundBankに占めるスペース(単位byte)。メディアファイルは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。"
},
"structureSize": {
"type": "integer",
"description": "このオブジェクトとその全ての子のメタデータが、SoundBankに占めるスペース(単位byte)。メディアファイルは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。"
},
"musicTransitionRoot": {
"type": "object",
"description": "(DEPRECATED) The music transition root containing all other music transitions recursively. 注:これは非推奨です。The TransitionRoot reference should be used instead.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "オブジェクトのID(GUID)。\\n オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。"
}
}
},
"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.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "オブジェクトのID(GUID)。\\n オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。"
}
}
},
"originalWavFilePath": {
"type": "string",
"description": "(DEPRECATED) Absolute path to the original wav file. これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 \\ref waapi_path_on_mac を参照してください。"
},
"originalFilePath": {
"type": "string",
"description": "Absolute path to the original file. これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 \\ref waapi_path_on_mac を参照してください。"
},
"originalRelativeFilePath": {
"type": "string",
"description": "Relative (from project's Originals Folder) path to the original file. これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 \\ref waapi_path_on_mac を参照してください。"
},
"activeSource": {
"type": "object",
"description": "The active source of the sound object.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "オブジェクトのID(GUID)。\\n オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。"
},
"name": {
"type": "string",
"description": "オブジェクト名。"
}
}
},
"convertedWemFilePath": {
"type": "string",
"description": "(DEPRECATED) Absolute path to the converted wem file. 選択肢からプラットフォームを指定。これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 \\ref waapi_path_on_mac を参照してください。"
},
"convertedFilePath": {
"type": "string",
"description": "Absolute path to the converted file. 選択肢からプラットフォームを指定。これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 \\ref waapi_path_on_mac を参照してください。"
},
"soundbankBnkFilePath": {
"type": "string",
"description": "SoundBankオブジェクトに関連する、生成後のSoundBankファイルへの絶対パス。これは、SoundBankオブジェクトだけで有効です。WAAPIをMacで使う場合は、 \\ref waapi_path_on_mac を参照してください。"
},
"playbackDuration": {
"type": "object",
"description": "最小と最大のdurationと、durationタイプを含む、durationルート。注:これは非推奨です。The duration should be used instead. これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。",
"properties": {
"playbackDurationMin": {
"type": "number",
"description": "再生にかかる最短時間。"
},
"playbackDurationMax": {
"type": "number",
"description": "再生にかかる最長時間。"
},
"playbackDurationType": {
"type": "string",
"description": "durationタイプ。"
}
}
},
"duration": {
"type": "object",
"description": "最小と最大のdurationと、durationタイプを含む、durationルート。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。",
"properties": {
"min": {
"type": "number",
"description": "再生にかかる最短時間。"
},
"max": {
"type": "number",
"description": "再生にかかる最長時間。"
},
"type": {
"type": "string",
"description": "durationタイプ。"
}
}
},
"maxDurationSource": {
"type": "object",
"description": "最長のdurationのオーディオソース。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "最長の長さのオーディオソースオブジェクトの、ID(GUID)。\\n オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。"
},
"trimmedDuration": {
"type": "number",
"description": "トリムした最長のソースの、durationを秒単位で示します。"
}
}
},
"audioSourceTrimValues": {
"type": "object",
"description": "オーディオソースをトリムした時間の範囲。",
"properties": {
"trimBegin": {
"type": "number",
"description": "トリム開始の時間値を、秒単位で示します。"
},
"trimEnd": {
"type": "number",
"description": "トリム終了の時間値を、秒単位で示します。"
}
}
},
"maxRadiusAttenuation": {
"type": "object",
"description": "半径が最大の減衰。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "半径が最大の減衰オブジェクトの、ID(GUID)。\\n オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。"
},
"radius": {
"type": "number",
"description": "減衰オブジェクトの半径。"
}
}
},
"audioSourceLanguage": {
"type": "object",
"description": "オーディオソースに関連付けられたランゲージ。これは、Audio Sourceオブジェクトに、直接適用されるだけです。",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "Audio Sourceオブジェクトに関連するLanguageオブジェクトのID(GUID)。\\n オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。"
},
"name": {
"type": "string",
"description": "Audio Sourcオブジェクトか関連付けられているLanguageオブジェクトの名前。"
}
}
},
"workunitIsDefault": {
"type": "boolean",
"description": "ワークユニットがデフォルトであれば、true。"
},
"workunitType": {
"type": "string",
"description": "Work Unitのタイプ。なお、Work Unitsと同様に、物理フォルダにも\"WorkUnit\"というタイプがあります。物理フォルダには、workunitType \"folder\"があります。",
"enum": [
"folder",
"rootFile",
"nestedFile"
]
},
"workunitIsDirty": {
"type": "boolean",
"description": "Work UnitまたはProject(wprojファイル)がダーティである場合、つまり変更したあとに保存していない場合は、true。"
},
"switchContainerChildContext": {
"type": "object",
"description": "Switch Containerの子に関連付けられた、コンテキストオブジェクト。子に関連する、Switch Containerのコンテキストに依存するプロパティを、このオブジェクトが保持します(例えば、'1st only'チェックボックスのプロパティなど)。",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "オブジェクトのID(GUID)。\\n オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。"
}
}
},
"isExplicitMute": {
"type": "boolean",
"description": "Whether or not the object has been muted explicitly. Explicitly muting an object implicitly mutes the descendant objects."
},
"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. Explicitly muting an object implicitly mutes the descendant objects."
},
"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": "この点から、次の点までの、カーブセグメントの形状。",
"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.",
"items": {
"type": "object",
"description": "A State Group object.",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "The ID (GUID) of the State Group object.\\n An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
"name": {
"type": "string",
"description": "The name of the State Group object."
}
}
}
}
},
"patternProperties": {
"^((@?@?[a-zA-Z0-9:_\\‍(\\‍),]+)|[a-zA-Z\\‍(\\‍),]+\\‍(.+\\‍))(\\.@?@?[a-zA-Z0-9:_\\‍(\\‍),]+|[a-zA-Z\\‍(\\‍),]+\\‍(.+\\‍))*$": {
"description": "クエリを構成し、プロパティ値またはオブジェクトリファレンスを出す、ドット区切りのアクセサを指定します。1つの@マークは、関連するオブジェクトのプロパティ値を示します。2つの@@マークは、ソースがオーバーライドするプロパティ値を示します。使用可能なすべてのタイプの、プロパティやリファレンスの詳細については、 \\ref wobjects_index を参照してください。",
"anyOf": [
{
"type": "string",
"description": "文字列値。"
},
{
"type": "array",
"description": "An array of string values.",
"items": {
"type": "string",
"description": "文字列値。"
}
},
{
"type": "number",
"description": "数値。"
},
{
"type": "array",
"description": "An array of numeric values.",
"items": {
"type": "number",
"description": "数値。"
}
},
{
"type": "boolean",
"description": "ブール値。"
},
{
"type": "array",
"description": "An array of boolean values.",
"items": {
"type": "boolean",
"description": "ブール値。"
}
},
{
"type": "object",
"description": "オブジェクトのリファレンス値。",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "オブジェクトのID(GUID)。\\n オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。"
},
"name": {
"type": "string",
"description": "オブジェクト名。"
}
},
"additionalProperties": true
},
{
"type": "array",
"description": "オブジェクトリストのリファレンス値。",
"items": {
"type": "object",
"description": "オブジェクトのリファレンス値。",
"properties": {
"id": {
"type": "string",
"pattern": "^\\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\\}$",
"description": "オブジェクトのID(GUID)。\\n オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。"
},
"name": {
"type": "string",
"description": "オブジェクト名。"
}
},
"additionalProperties": true
}
}
]
}
},
"additionalProperties": true
}

このページはお役に立ちましたか?

サポートは必要ですか?

ご質問や問題、ご不明点はございますか?お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう