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