バージョン

menu_open
Wwise SDK 2021.1.14
ak.wwise.core.audio.import

Wwiseオブジェクトを作成し、オーディオファイルをインポートします。この関数は、Audio File ImporterのTab Delimitedインポートで提供されるものと同じインポートプロセッサを使います。この関数は、作成、置き換え、または再利用された全てのオブジェクトのアレイを返します。オプションを使い、オブジェクトの返し方を指定します。詳細は、 オーディオファイルのインポートとストラクチャーの作成 を参照してください。

Arguments

Name タイプ 概要
importOperation string インポートオブジェクト作成の実行方法を指定します。作成されたオブジェクトごとに: - createNew: 新しいオブジェクトを作成し、オブジェクト名は可能であれば希望する名前とし、それ以外の場合は新しい固有名を使います。- useExisting: 既存のオブジェクトがあればそれを使い、指定したプロパティを更新します。それ以外の場合は新しいオブジェクトを作成します。これがデフォルト値です。- replaceExisting: 新しいオブジェクトを作成します。同名の既存オブジェクトがある場合、既存オブジェクトを破棄します。可能な値:
  • createNew
  • useExisting
  • replaceExisting
default object "imports"の各アイテムの、デフォルト値。インポートする全ての要素で、共通プロパティを繰り返すのを避けるには、このオブジェクトを使います。
default.importLanguage string オーディオファイルインポート用のランゲージをインポートします(WPROJファイルのLanguageListにある、プロジェクトに定義されたランゲージから入手します)。
default.importLocation any of: ルート相対オブジェクトパスとして使う、Object ID (GUID)、または名前、またはパス。
string type:nameという形式でタイプを認定されたオブジェクトの名前。サポートされるのは、名前がグローバルに固有なオブジェクトタイプのみです。例: Event:Play_Sound_01
string オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
string Wwiseオブジェクトへのプロジェクトパスで、カテゴリと、ワークユニットを含みます。例えば: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
default.audioFile string インポートするメディアファイルへのパス。必ず、Wwiseからアクセスできるパスとします。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
default.audioFileBase64 string Originalsフォルダに対するターゲットファイル相対パスでインポートする、縦線で分けた、Base64でエンコードしたWAVオーディオファイルデータ。例 'MySound.wav|UklGRu...'.
default.originalsSubFolder string インポートしたオーディオファイルを保存する'originals'サブフォルダを指定します。このフォルダは、ファイルを通常インポートする'originals'フォルダと相対関係にあるフォルダです。例: SFXをインポートするる場合は、オーディオファイルはフォルダ Originals\SFX\originalsPath にインポートされます。
default.objectPath string 作成するオブジェクトのパスと名前。パスにはバックスラッシュを使い、絶対パスまたは相対パスとします。名前の前に、オブジェクトタイプを指定することができます。例えば:
\\Actor-Mixer Hierarchy\\Default Work Unit\\<Random Container>MyContainer\\<Sound>MySound. 
使用可能なタイプの詳細は、 Wwiseオブジェクトリファレンス を参照してください。
default.objectType string オーディオファイルをインポートするときに作成するオブジェクトタイプを指定します。タイプを、objectPathで直接指定することもできます。使用可能なタイプについては、 Wwiseオブジェクトリファレンス を参照してください。
default.notes string 作成したオブジェクトの"Notes"フィールド。
default.audioSourceNotes string 作成したオーディオソースオブジェクトの、"Notes"フィールド。
default.switchAssignation string Switch Containerに関連するSwitch GroupまたはState Groupを、Actor-Mixer Hierarchy内に限り、定義します。また、Switch Containerのどの子が、関連するグループのどのSwitchまたはStateにアサインされているのかを、定義します。詳細は、Wwise HelpドキュメンテーションのTab Delimited Importを参照してください。
default.event string インポートしたオブジェクト用に作成するEventの、パスと名前を定義します。詳細は、Wwise HelpドキュメンテーションのTab Delimited Importを参照してください。
default.dialogueEvent string インポートしたオブジェクト用に作成するDialogue Eventの、名前とパスを定義します。詳細は、Wwise HelpドキュメンテーションのTab Delimited Importを参照してください。
default.regex(^@[:_a-zA-Z0-9]+$) any of: Wwiseオブジェクトのプロパティと値を指定します。プロパティ名の前に、@が付きます。使用可能なプロパティについては、 Wwiseオブジェクトリファレンス を参照してください。例: @Volume:3
プロパティの値。
null null値。参照するオブジェクトはありません。
string 文字列値。
number 数値。
boolean ブール値。
imports * array インポートコマンドのアレイ。
imports [...] object インポートコマンド。このオブジェクトのメンバーは、"default "のメンバーと結合され、このオブジェクトのメンバーが優先されます。リストにあるプロパティ以外にも、 @Property を使い、wobjectプロパティやリファレンスを設定することもできます。例えば、 @Volume プロパティを追加してボリュームを設定することができます。Switch ContainerのState/Switchが、State/Switch Groupの子である必要があるように、ほかのリファレンスによって制約されるリファレンスは、必要な順番にリファレンスを確実に設定できないため、設定してはいけません。
imports[...].importLanguage string オーディオファイルインポート用のランゲージをインポートします(WPROJファイルのLanguageListにある、プロジェクトに定義されたランゲージから入手します)。
imports[...].importLocation any of: ルート相対オブジェクトパスとして使う、Object ID (GUID)、または名前、またはパス。
string type:nameという形式でタイプを認定されたオブジェクトの名前。サポートされるのは、名前がグローバルに固有なオブジェクトタイプのみです。例: Event:Play_Sound_01
string オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
string Wwiseオブジェクトへのプロジェクトパスで、カテゴリと、ワークユニットを含みます。例えば: \Actor-Mixer Hierarchy\Default Work Unit\New Sound SFX.
imports[...].audioFile string インポートするメディアファイルへのパス。必ず、Wwiseからアクセスできるパスとします。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
imports[...].audioFileBase64 string Originalsフォルダに対するターゲットファイル相対パスでインポートする、縦線で分けた、Base64でエンコードしたWAVオーディオファイルデータ。例 'MySound.wav|UklGRu...'.
imports[...].originalsSubFolder string インポートしたオーディオファイルを保存する'originals'サブフォルダを指定します。このフォルダは、ファイルを通常インポートする'originals'フォルダと相対関係にあるフォルダです。例: SFXをインポートするる場合は、オーディオファイルはフォルダ Originals\SFX\originalsPath にインポートされます。
imports[...].objectPath * string 作成するオブジェクトのパスと名前。パスにはバックスラッシュを使い、絶対パスまたは相対パスとします。名前の前に、オブジェクトタイプを指定することができます。例えば:
\\Actor-Mixer Hierarchy\\Default Work Unit\\<Random Container>MyContainer\\<Sound>MySound. 
使用可能なタイプの詳細は、 Wwiseオブジェクトリファレンス を参照してください。
imports[...].objectType string オーディオファイルをインポートするときに作成するオブジェクトタイプを指定します。タイプを、objectPathで直接指定することもできます。使用可能なタイプについては、 Wwiseオブジェクトリファレンス を参照してください。
imports[...].notes string 作成したオブジェクトの"Notes"フィールド。
imports[...].audioSourceNotes string 作成したオーディオソースオブジェクトの、"Notes"フィールド。
imports[...].switchAssignation string Switch Containerに関連するSwitch GroupまたはState Groupを、Actor-Mixer Hierarchy内に限り、定義します。また、Switch Containerのどの子が、関連するグループのどのSwitchまたはStateにアサインされているのかを、定義します。詳細は、Wwise HelpドキュメンテーションのTab Delimited Importを参照してください。
imports[...].event string インポートしたオブジェクト用に作成するEventの、パスと名前を定義します。詳細は、Wwise HelpドキュメンテーションのTab Delimited Importを参照してください。
imports[...].dialogueEvent string インポートしたオブジェクト用に作成するDialogue Eventの、名前とパスを定義します。詳細は、Wwise HelpドキュメンテーションのTab Delimited Importを参照してください。
imports[...].regex(^@[:_a-zA-Z0-9]+$) any of: プロパティ値を指定します。使用可能なプロパティについては、 Wwiseオブジェクトリファレンス を参照してください。
プロパティの値。
null null値。参照するオブジェクトはありません。
string 文字列値。
number 数値。
boolean ブール値。
autoAddToSourceControl boolean インポートしたファイルに対し、ソースコントロールでWwiseが自動的にAddまたはCheckoutの操作を実行するのかどうかを、決定します。デフォルトはfalseです。

(必須*)

Arguments Schema

Options

Name タイプ 概要
return array オブジェクトごとに、何が返されるのかを指定します。使用可能なプロパティやリファレンスの詳細については、 Wwiseオブジェクトリファレンス を参照してください。
return式のアレイで、Wwiseオブジェクトのどのエレメントを返すのかを定義します。例えば、名前やIDなどの内蔵アクセサや、VolumeやPitchなどのオブジェクトプロパティが含まれます。
return [...] any of: return式。
string Wwiseオブジェクト用の内蔵アクセサを、1つまたは複数、指定します。可能な値:
  • 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
  • originalWavFilePath
  • soundbankBnkFilePath
  • musicTransitionRoot
  • musicPlaylistRoot
  • playbackDuration
  • maxDurationSource
  • audioSourceTrimValues
  • maxRadiusAttenuation
  • audioSourceLanguage
  • workunitIsDefault
  • workunitType
  • workunitIsDirty
  • switchContainerChildContext
string クエリを構成し、値またはオブジェクトリファレンスを出す、ドット区切りのアクセサを、1つまたは複数、指定します。1つの@マークを指定すると、関連するオブジェクトのプロパティ値を返します。2つの@マークを指定すると、オーバーライドのソースのプロパティ値を返します。 Wwiseオブジェクトリファレンス を参照してください。
platform any of: プラットフォームのID (GUID)または名前。これは任意の引数です。指定がなければ、現在のプラットフォームを使います。
string プラットフォームの名前。
string プラットフォームのID。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
language any of: ランゲージのID (GUID)または名前。
string ランゲージの名前。
string ランゲージのID。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。

Options Schema

Result

Name タイプ 概要
objects array オブジェクトのアレイ。
objects [...] object インポートコマンド。このオブジェクトのメンバーは、"default "のメンバーと結合され、このオブジェクトのメンバーが優先されます。リストにあるプロパティ以外にも、 @Property を使い、wobjectプロパティやリファレンスを設定することもできます。例えば、 @Volume プロパティを追加してボリュームを設定することができます。Switch ContainerのState/Switchが、State/Switch Groupの子である必要があるように、ほかのリファレンスによって制約されるリファレンスは、必要な順番でリファレンスを確実に設定できないため、設定してはいけません。
Wwiseオブジェクト。必須のプロパティを指定するには、returnオプションを使います。
objects[...].id string オブジェクトのID(GUID)。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].name string オブジェクト名。
objects[...].notes string オブジェクトのnotes。
objects[...].type string オブジェクトのタイプ。使用可能なタイプの詳細については、 Wwiseオブジェクトリファレンス を参照してください。
objects[...].pluginName string Source、Effect、Mixer、Device、Metadataプラグインの、プラグイン名。
objects[...].path string プロジェクトルートからオブジェクトへのパス。例: '\Actor-Mixer Hierarchy\Default Work Unit\Sound1'
objects[...].parent object 階層におけるオブジェクトの親。
objects[...].parent.id string オブジェクトのID(GUID)。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].parent.name string オブジェクト名。
objects[...].owner object オブジェクトのオーナー。カスタムエフェクトやカスタム減衰など、ほかのオブジェクトにローカルで所有されているオブジェクトが、該当します。
objects[...].owner.id string オブジェクトのID(GUID)。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].owner.name string オブジェクト名。
objects[...].isPlayable boolean オブジェクトをTransportで再生できる場合は、trueです。
objects[...].shortId integer オブジェクトのShort ID。
objects[...].classId integer オブジェクトのクラスID。
符号なし整数32-bit。Range: [0,4294967295]
objects[...].category string オブジェクトのカテゴリ。例: 'Actor-Mixer Hierarchy'
objects[...].filePath string オブジェクトを含むファイルへのパス。パスは、Work Unitファイルまたはプロジェクトファイルとします。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
objects[...].workunit object オブジェクトを含む、親Work Unit。'id'と'name'を返します。
objects[...].workunit.id string オブジェクトのID(GUID)。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].workunit.name string オブジェクト名。
objects[...].childrenCount number このオブジェクトの子の数。
objects[...].totalSize integer このオブジェクトと、その全ての子が、SoundBankに占めるスペース(単位byte)。objectSizeは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。
objects[...].mediaSize integer このオブジェクトとその全ての子のメディアファイルの、変換後の合計サイズ(単位bytes)。なお、正確な値を得るには、SoundBankを生成する必要があります。
objects[...].objectSize integer このオブジェクトのメタデータがSoundBankに占めるスペース(単位byte)。メディアファイルは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。
objects[...].structureSize integer このオブジェクトとその全ての子のメタデータが、SoundBankに占めるスペース(単位byte)。メディアファイルは含まれません。なお、正確な値を得るには、SoundBankを生成する必要があります。
objects[...].musicTransitionRoot object ミュージックトランジションのルートで、ほかの全てのミュージックトランジションを、再帰的に含みます。
objects[...].musicTransitionRoot.id string オブジェクトのID(GUID)。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].musicPlaylistRoot object ミュージックトランジションのルートで、ほかの全てのミュージックプレイリストアイテムを、再帰的に含みます。これが適用されるのは、Music Playlist Containerだけです。
objects[...].musicPlaylistRoot.id string オブジェクトのID(GUID)。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].originalWavFilePath string 元のwavファイルへの絶対パス。これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
objects[...].convertedWemFilePath string 変換後のwemファイルへの絶対パス。選択肢からプラットフォームを指定。これは、SoundオブジェクトとAudio Sourceオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
objects[...].soundbankBnkFilePath string SoundBankオブジェクトに関連する、生成後のSoundBankファイルへの絶対パス。これは、SoundBankオブジェクトだけで有効です。WAAPIをMacで使う場合は、 MacでWAAPIを使う を参照してください。
objects[...].playbackDuration object 最小と最大のdurationと、durationタイプを含む、durationルート。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。
objects[...].playbackDuration.playbackDurationMin number 再生にかかる最短時間。
objects[...].playbackDuration.playbackDurationMax number 再生にかかる最長時間。
objects[...].playbackDuration.playbackDurationType string durationタイプ。
objects[...].maxDurationSource object 最長のdurationのオーディオソース。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。
objects[...].maxDurationSource.id string 最長の長さのオーディオソースオブジェクトの、ID(GUID)。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].maxDurationSource.trimmedDuration number トリムした最長のソースの、durationを秒単位で示します。
objects[...].audioSourceTrimValues object オーディオソースをトリムした時間の範囲。
objects[...].audioSourceTrimValues.trimBegin number トリム開始の時間値を、秒単位で示します。
objects[...].audioSourceTrimValues.trimEnd number トリム終了の時間値を、秒単位で示します。
objects[...].maxRadiusAttenuation object 半径が最大の減衰。これは、Audio Sourceオブジェクトをソースとして直接含むことができるオブジェクト、または子孫を通して間接的に含むことができるオブジェクト全てに、適用されます。
objects[...].maxRadiusAttenuation.id string 半径が最大の減衰オブジェクトの、ID(GUID)。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].maxRadiusAttenuation.radius number 減衰オブジェクトの半径。
objects[...].audioSourceLanguage object オーディオソースに関連付けられたランゲージ。これは、Audio Sourceオブジェクトに、直接適用されるだけです。
objects[...].audioSourceLanguage.id string Audio Sourceオブジェクトに関連するLanguageオブジェクトのID(GUID)。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].audioSourceLanguage.name string Audio Sourcオブジェクトか関連付けられているLanguageオブジェクトの名前。
objects[...].workunitIsDefault boolean ワークユニットがデフォルトであれば、true。
objects[...].workunitType string Work Unitのタイプ。なお、Work Unitsと同様に、物理フォルダにも"WorkUnit"というタイプがあります。物理フォルダには、workunitType "folder"があります。可能な値:
  • folder
  • rootFile
  • nestedFile
objects[...].workunitIsDirty boolean Work UnitまたはProject(wprojファイル)がダーティである場合、つまり変更したあとに保存していない場合は、true。
objects[...].switchContainerChildContext object Switch Containerの子に関連付けられた、コンテキストオブジェクト。子に関連する、Switch Containerのコンテキストに依存するプロパティを、このオブジェクトが保持します(例えば、'1st only'チェックボックスのプロパティなど)。
objects[...].switchContainerChildContext.id string オブジェクトのID(GUID)。
オブジェクトGUIDで、その形式は: {aabbcc00-1122-3344-5566-77889900aabb}。
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$) any of: クエリを構成し、プロパティ値またはオブジェクトリファレンスを出す、ドット区切りのアクセサを指定します。1つの@マークは、関連するオブジェクトのプロパティ値を示します。2つの@マークは、ソースがオーバーライドするプロパティ値を示します。使用可能なすべてのタイプの、プロパティやリファレンスの詳細については、 Wwiseオブジェクトリファレンス を参照してください。
string 文字列値。
number 数値。
boolean ブール値。
object オブジェクトのリファレンス値。
array オブジェクトリストのリファレンス値。
objects[...].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}。
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$).name string オブジェクト名。
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$) [...] object オブジェクトのリファレンス値。
objects[...].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}。
objects[...].regex(^((@?@?[a-zA-Z0-9:_]+)|[a-zA-Z]+\(.+\))(.@?@?[a-zA-Z0-9:_]+|[a-zA-Z]+\(.+\))*$)[...].name string オブジェクト名。

Result Schema

See Also

Examples

Wwise Authoring APIの詳細は、 Wwise Authoring API (WAAPI)を使用する を参照してください。


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

サポートは必要ですか?

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

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

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

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

Wwiseからはじめよう