menu
バージョン
2021.1.14.8108
2024.1.6.8842
2023.1.14.8770
2022.1.19.8584
2021.1.14.8108
2019.2.15.7667
2019.1.11.7296
2018.1.11.6987
2017.2.10.6745
2017.1.9.6501
2016.2.6.6153
2015.1.9.5624
2024.1.6.8842
2023.1.14.8770
2022.1.19.8584
2021.1.14.8108
2019.2.15.7667
2019.1.11.7296
2018.1.11.6987
2017.2.10.6745
2017.1.9.6501
2016.2.6.6153
2015.1.9.5624
|
Wwise SDK 2021.1.14
|
Wwise Authoring APIの詳細は、 Wwise Authoring API (WAAPI)を使用する を参照してください。
ak.soundengine.executeActionOnEvent
Playアクションで指定されたイベントが参照する全ノードに対し、アクションを実行します。 AK::SoundEngine::ExecuteActionOnEvent を参照してください。
ak.soundengine.postEvent
サウンドエンジンに対し、非同期でEventをポストします（イベントIDで）。 AK::SoundEngine::PostEvent を参照してください。
ak.soundengine.postMsgMonitor
ProfilerのCapture Logビューに、メッセージを表示します。
ak.soundengine.postTrigger
指定したTriggerをポストします。 AK::SoundEngine::PostTrigger を参照してください。
ak.soundengine.registerGameObj
ゲームオブジェクトを登録します。ゲームオブジェクトを2回登録しても、何も変わりません。登録を1回解除すると、何回登録したかに関わらず、登録が解除されます。 AK::SoundEngine::RegisterGameObj を参照してください。
ak.soundengine.resetRTPCValue
リアルタイムのパラメータコントロール値を、Wwiseプロジェクトで指定したデフォルト値にリセットします。 AK::SoundEngine::ResetRTPCValue を参照してください。
ak.soundengine.seekOnEvent
指定したEventのPlay Actionsが参照する、全ての再生中のオブジェクトの中を、シークします。 AK::SoundEngine::SeekOnEvent を参照してください。
ak.soundengine.setDefaultListeners
後続の、登録済みの全てのゲームオブジェクトの、デフォルトのアクティブリスナーを設定します。 AK::SoundEngine::SetDefaultListeners を参照してください。
ak.soundengine.setGameObjectAuxSendValues
指定したゲームオブジェクトをルーティングするための、Auxiliary Busを設定します。 AK::SoundEngine::SetGameObjectAuxSendValues を参照してください。
ak.soundengine.setGameObjectOutputBusVolume
指定したゲームオブジェクトに適用するoutput bus volume (direct) を設定します。 AK::SoundEngine::SetGameObjectOutputBusVolume を参照してください。
ak.soundengine.setListeners
1つのゲームオブジェクトの、アクティブなリスナーを設定します。デフォルトで、新しいゲームオブジェクトにアクティブなリスナーはありませんが、この動作を SetDefaultListeners() でオーバーライドできます。アクティブでないリスナーは計算されません。 AK::SoundEngine::SetListeners を参照してください。
ak.soundengine.setListenerSpatialization
リスナーのスペーシャリゼーションのパラメータを設定します。各オーディオチャンネルに対し、このリスナー専用のボリュームオフセットを定義することができます。 AK::SoundEngine::SetListenerSpatialization を参照してください。
ak.soundengine.setMultiplePositions
1つのゲームオブジェクトに、複数のポジションを設定します。複数のポジションを1つのゲームオブジェクトに対して設定すると、1つのボイスのリソースだけで、複数の発信ソースをシミュレーションできます。例えば、壁の開口部分、エリアサウンド、同じエリアで同じ音を出す複数のオブジェクトなどをシミュレーションするのに使えます。 AK::SoundEngine::SetMultiplePositions を参照してください。
ak.soundengine.setObjectObstructionAndOcclusion
ゲームオブジェクトのオブストラクションとオクルージョンのレベルを設定します。この関数は、特定のリスナーにとってのオブジェクトの聞こえ方を変えるために使います。 AK::SoundEngine::SetObjectObstructionAndOcclusion を参照してください。
ak.soundengine.setPosition
ゲームオブジェクトのポジションを設定します。 AK::SoundEngine::SetPosition を参照してください。
ak.soundengine.setRTPCValue
RTPCの値を設定します。 AK::SoundEngine::SetRTPCValue を参照してください。
ak.soundengine.setScalingFactor
ゲームオブジェクトの拡大縮小の倍率を設定します。このゲームオブジェクトの減衰計算を調整し、影響を与える範囲がより大きいサウンドや、より小さいサウンドを、シミュレーションできます。 AK::SoundEngine::SetScalingFactor を参照してください。
ak.soundengine.setState
State GroupのStateを設定します。 AK::SoundEngine::SetState を参照してください。
ak.soundengine.setSwitch
Switch GroupのStateを設定します。 AK::SoundEngine::SetSwitch を参照してください。
ak.soundengine.stopAll
指定のゲームオブジェクトIDに関連する現在のコンテンツの再生を、停止します。ゲームオブジェクトの指定がなければ、全てのサウンドを停止します。 AK::SoundEngine::StopAll を参照してください。
ak.soundengine.stopPlayingID
指定の再生中のIDに関連する現在のコンテンツの再生を、停止します。 AK::SoundEngine::StopPlayingID を参照してください。
ak.soundengine.unregisterGameObj
ゲームオブジェクトの登録を解除します。ゲームオブジェクトを2回登録しても、何も変わりません。登録を1回解除すると、何回登録したかに関わらず、登録が解除されます。使用中のゲームオブジェクトの登録を解除することは許可されますが、このゲームオブジェクトのパラメータを制御することは、できなくなります。例えば、このゲームオブジェクトに関連するサウンドが、移動中の3Dサウンドであるとします。このゲームオブジェクトの登録を解除すると、動きは止まり、このゲームオブジェクトを再び制御する方法はありません。 AK::SoundEngine::UnregisterGameObj を参照してください。
ak.wwise.core.audio.import
Wwiseオブジェクトを作成し、オーディオファイルをインポートします。この関数は、Audio File ImporterのTab Delimitedインポートで提供されるものと同じインポートプロセッサを使います。この関数は、作成、置き換え、または再利用された全てのオブジェクトのアレイを返します。オプションを使い、オブジェクトの返し方を指定します。詳細は、 オーディオファイルのインポートとストラクチャーの作成 を参照してください。
ak.wwise.core.audio.importTabDelimited
タブ区切りファイルから、スクリプトによるオブジェクト作成とオーディオファイルインポート。
ak.wwise.core.audioSourcePeaks.getMinMaxPeaksInRegion
オーディオソースの指定された範囲の最小・最大（min/max）のピークのペアを、バイナリ文字列の集合体として取得します（1チャンネルにつき、1文字列）。文字列は、base-64でエンコードした16-bit符号付きintのアレイで、min値とmax値がインターリーブしています。getCrossChannelPeaksがtrueの場合、全チャンネルのピークを1つのバイナリ文字列がグローバルに表しています。
ak.wwise.core.audioSourcePeaks.getMinMaxPeaksInTrimmedRegion
オーディオソースのトリムした範囲全体の最小・最大（min/max）のピークのペアを、チャンネルごとに、バイナリ文字列のアレイとして取得します（1チャンネルにつき、1文字列）。文字列は、base-64でエンコードした16-bit符号付きintのアレイで、min値とmax値がインターリーブしています。getCrossChannelPeaksがtrueの場合、全チャンネルのピークをグローバルに表すバイナリ文字列が、1つだけあります。
ak.wwise.core.getInfo
グローバルなWwise情報を取得します。
ak.wwise.core.log.get
特定のチャンネルの、最後のログを取得します。ログに項目が追加されたときに通知を受け取るには、 ak.wwise.core.log.itemAdded を参照してください。
ak.wwise.core.object.copy
オブジェクトを、特定の親にコピーします。
ak.wwise.core.object.create
'parent'の子として、タイプが'type'のオブジェクトを作成します。オブジェクトの作成の詳細については、 オーディオファイルのインポートとストラクチャーの作成 を参照してください。また、Wwiseへのオーディオファイルのインポートについては、 ak.wwise.core.audio.import も参照してください。
ak.wwise.core.object.delete
指定のオブジェクトを削除します。
ak.wwise.core.object.get
クエリの結果にある各オブジェクトに対して、オプションで指定した通りにクエリを実行し、データを返します。クエリに、'waql'引数、または'from'引数を指定し、オプションとして'transform'引数も指定できます。詳細は、 Wwise Authoring Query Language (WAQL) を使用する または Wwise Project のクエリ を参照してください。オプションについて詳しく知るには、 Returnオプション を参照してください。
ak.wwise.core.object.getAttenuationCurve
特定の減衰オブジェクトの、指定の減衰カーブを取得します。
ak.wwise.core.object.getPropertyAndReferenceNames
オブジェクトの、プロパティとリファレンス名のリストを取得します。
ak.wwise.core.object.getPropertyInfo
オブジェクトのプロパティに関する情報を取得します。なお、この関数はプロパティの値を返しません。プロパティの値を取得するには、 ak.wwise.core.object.get and Returnオプション を参照してください。
ak.wwise.core.object.getPropertyNames
ak.wwise.core.object.getTypes
Wwiseのオブジェクトモデルに登録された、全てのオブジェクトタイプを取得します。この関数は、 Wwiseオブジェクトリファレンス に相当するものを返します。
ak.wwise.core.object.isPropertyEnabled
プロパティが依存する値によって、プロパティが有効になった場合は、trueを返します。
ak.wwise.core.object.move
オブジェクトを、特定の親へと移動します。移動したオブジェクトを戻します。
ak.wwise.core.object.setAttenuationCurve
ある減衰オブジェクトの、指定の減衰カーブを設定します。
ak.wwise.core.object.setName
オブジェクトの名前を変更します。
ak.wwise.core.object.setNotes
オブジェクトのnotes（備考）を設定します。
ak.wwise.core.object.setProperty
特定のプラットフォームの、あるオブジェクトのプロパティ値を設定します。各オブジェクトタイプで設定できるプロパティの詳細については、 Wwiseオブジェクトリファレンス を参照してください。オブジェクトのリファレンスを設定するには、 ak.wwise.core.object.setReference を参照してください。オブジェクトのプロパティ値を取得するには、 ak.wwise.core.object.get を参照してください。
ak.wwise.core.object.setRandomizer
特定のプラットフォームの、あるオブジェクトのプロパティのrandomizer値を設定します。各オブジェクトタイプで設定できるプロパティの詳細については、 Wwiseオブジェクトリファレンス を参照してください。
ak.wwise.core.object.setReference
オブジェクトのリファレンス値を設定します。各オブジェクトタイプで提供されるリファレンスの詳細については、 Wwiseオブジェクトリファレンス を参照してください。
ak.wwise.core.plugin.getList
ak.wwise.core.plugin.getProperties
ak.wwise.core.plugin.getProperty
ak.wwise.core.profiler.enableProfilerData
キャプチャするデータのタイプを指定します。ユーザーのプロファイラ設定をオーバーライドします。
ak.wwise.core.profiler.getAudioObjects
プロファイラの特定のキャプチャ時間における、Audio Objectを取得します。
ak.wwise.core.profiler.getBusses
プロファイラの特定のキャプチャ時間における、バスを取得します。
ak.wwise.core.profiler.getCursorTime
指定のプロファイラカーソルの、現在の時間を、ミリ秒単位で返します。
ak.wwise.core.profiler.getRTPCs
プロファイラの特定のキャプチャ時間における、アクティブなRTPCを取得します。
ak.wwise.core.profiler.getVoiceContributions
ボイスパスで、ボイスボリューム、ハイパス、そしてローパスに影響する全てのパラメータを、パイプラインIDから得て、取得します。
ak.wwise.core.profiler.getVoices
プロファイラの特定のキャプチャ時間における、ボイスを取得します。
ak.wwise.core.profiler.startCapture
プロファイラのキャプチャを開始し、キャプチャ開始の時間を、ミリ秒単位で返します。
ak.wwise.core.profiler.stopCapture
プロファイラのキャプチャを停止し、キャプチャ終了の時間を、ミリ秒単位で返します。
ak.wwise.core.project.save
現在のプロジェクトを保存します。
ak.wwise.core.remote.connect
Wwise Authoringアプリケーションを、Wwise Sound Engineの稼働中の実行ファイルに接続します。ホストが、コミュニケーションを有効にして、コードを実行中の状態である必要があります。"host"だけが提供されていれば、Wwiseは、最初に見つけたSound Engineインスタンスに接続します。異なるインスタンスを区別できるように、接続するアプリケーションの名前を指示することもできます。
ak.wwise.core.remote.disconnect
Wwise Authoringアプリケーションと、Wwise Sound Engineの稼働中の実行ファイルの接続を、切断します。
ak.wwise.core.remote.getAvailableConsoles
Wwise Authoringを、Sound Engineインスタンスに接続するために使用可能な、全てのコンソールを取得します。
ak.wwise.core.remote.getConnectionStatus
接続ステータスを取得します。
ak.wwise.core.soundbank.generate
WAAPIリクエストで定義したインポート定義で、SoundBankのリストを生成します。SoundBankをディスクに書き込まない場合は、 ak.wwise.core.soundbank.generated にサブスクライブして、SoundBankの構成の情報や、バンクデータを、base64として取得します。
ak.wwise.core.soundbank.getInclusions
SoundBankのinclusionリストを取得します。
ak.wwise.core.soundbank.setInclusions
SoundBankのinclusionリストを修正します。SoundBankのinclusionリストを、'inclusions'引数が修正する方法を、'operation'引数が定義し、SoundBankのinclusionリストで、'inclusions'を追加したり、削除したり、置き換えたりすることができます。
ak.wwise.core.switchContainer.addAssignment
Switch Containerの子を、Switchにアサインします。これは、子をAssigned Objectsビューのステートに、ドラッグ＆ドロップすることに相当します。子は、必ず各ステートの最後に追加されます。
ak.wwise.core.switchContainer.getAssignments
Switch Containerの子とステートの間の、アサインメントのリストを返します。
ak.wwise.core.switchContainer.removeAssignment
Switch Containerの子とStateの間のアサインを、削除します。
ak.wwise.core.transport.create
特定のWwiseオブジェクトの、トランスポートオブジェクトを作成します。返されるトランスポートオブジェクトを使い、ほかのトランスポート関数を通して、Wwiseオブジェクトの再生、停止、一時停止、再開ができます。
ak.wwise.core.transport.destroy
与えられたトランスポートオブジェクトを、破棄します。
ak.wwise.core.transport.executeAction
提供されたTransportオブジェクト、または指定がない場合は、すべてのTransportオブジェクトに対し、アクションを実行します。
ak.wwise.core.transport.getList
トランスポートオブジェクトのリストを返します。
ak.wwise.core.transport.getState
特定のトランスポートオブジェクトのステートを取得します。
ak.wwise.core.undo.beginGroup
undoグループを開始します。 ak.wwise.core.beginUndoGroup を1回コールしたら、必ず、 ak.wwise.core.undo.endGroup を1回コールします。 ak.wwise.core.undo.beginGroup へのコールは、ネスト化できます。WAMPセッションを閉じる時にすべてのundoグループが閉じていることを確認するチェックを行います。閉じていないグループがある場合は、開いている各グループに対してそれぞれcancelGroupをコールします。
ak.wwise.core.undo.cancelGroup
最後のundoグループを取り消します。これは、最後の ak.wwise.core.undo.beginGroup コールのあとに行われた操作を、元に戻すものではないので、注意してください。
ak.wwise.core.undo.endGroup
最後のundoグループを終了します。
ak.wwise.debug.enableAsserts
デバグのアサートを有効にします。'false'でenableAssertsをコールするたびに、refカウントが増加します。trueでコールすると、refカウントが減少します。これがあるのは、Debugビルドだけです。
ak.wwise.debug.enableAutomationMode
Wwiseのオートメーションモードを有効、または無効にします。メッセージボックスやダイアログに起因する、中断の可能性を減らします。例えば、オートメーションモードを有効にすると、プロジェクトマイグレーション、プロジェクトロードログ、EULAアクセプタンス、プロジェクトライセンス表示、そして一般的なメッセージボックスを、そのまま受け入れることになります。
ak.wwise.debug.testAssert
プライベートな使用に限ります。
ak.wwise.debug.testCrash
プライベートな使用に限ります。
ak.wwise.ui.bringToForeground
Wwiseのメインウィンドウを、最前面に表示します。制限事項の詳細については、MSDNの SetForegroundWindow と、 AllowSetForegroundWindow を参照してください。AllowSetForegroundWindow のためのWwiseプロセスIDを入手するには、 ak.wwise.core.getInfo を参照してください。
ak.wwise.ui.captureScreen
ビューに対して、Wwise UIの一部をキャプチャします。
ak.wwise.ui.commands.execute
コマンドを実行します。一部のコマンドは、オブジェクトのリストをパラメータとして受け取ることができます。使用可能なコマンドについては、 Wwise Authoring Commandの識別子 を参照してください。
ak.wwise.ui.commands.getCommands
コマンドのリストを取得します。
ak.wwise.ui.commands.register
アドオンのコマンドのアレイを、登録します。登録したコマンドは、Wwiseプロセスを終了するまで、残ります。コマンド登録の詳細は、 コマンドアドオンの定義 を参照してください。また、 ak.wwise.ui.commands.executed も参照してください。
ak.wwise.ui.commands.unregister
アドオンUIコマンドのアレイを、登録解除します。
ak.wwise.ui.getSelectedObjects
ユーザーが現在、アクティブなビューで選択しているオブジェクトのリストを、取得します。
ak.wwise.ui.project.close
現在のプロジェクトを閉じます。
ak.wwise.ui.project.open
パスで指定したプロジェクトを開きます。操作が完了したときに通知を受け取る方法について、詳しくは ak.wwise.core.project.loaded を参照してください。
ak.wwise.waapi.getFunctions
関数のリストを取得します。
ak.wwise.waapi.getSchema
Waapi URIのJSONスキーマを取得します。
ak.wwise.waapi.getTopics
クライアントがサブスクライブできるトピックのリストを、取得します。