ゲームやその他のプロジェクトを Unreal Engineでデバッグする際は、実行中のゲームやエディタにコマンドを直接送信すると便利です。これはオーディオの場合に特に当てはまります。限定された状況や未知の条件でのみ発生するバグを追跡する場合、コンソール コマンドによって、特定の機能を有効化/無効化したり、重要なパラメータをリアルタイムで変更したりできます。
コンソールの使い方
コマンド コンソール はデフォルトで、ボタン ツールバーに含まれています。Unreal Editor ウィンドウの下にあります。キーボードの チルダ キー ( ~ ) を押してコマンド コンソールを直接開くことができます。英国の英語キーボードの場合は 重アクセント記号 キー ( ` ) を使用してください。
チルダ キーでコンソールが開かない場合や、別のキーを使用する場合は、 [Project Settings (プロジェクト設定)] > [Engine (エンジン)] > [Input (インプット)] > [Console Keys (コンソール キー)] に移動してキーボードの割り当てを変更できます。
コンソール コマンドを使用する際は アウトプットログ も開けるようにしておくと便利です。コマンド コンソールの左にあるショートカットをクリックします。チルダ キー ( ~ ) を 2 回押すと、出力ログ ドロワーも開きます。[Window (ウィンドウ)] > [Output Log (アウトプットログ)] でも設定できます。
ほとんどのオーディオ コンソール コマンドでは、「[CVar Name] [Value]」構文を使って特定の コンソール変数 (CVar) を目的の値に設定します。
例えば、サウンド ミックスのデバッグでは、コンソール コマンド au.Debug.SoundMixes
を使用して、CVar au.Debug.SoundMixes 1
を true に設定します (1=true です)。
また、コマンド [CVar name ?] を入力すると、指定した CVar の使用法について詳細情報を確認できます。
コンソールに入力するコマンドは、リアルタイムでエディタに影響を及ぼします。コンソール コマンドはゲーム内またはエディタ内から実行できるほか、ゲームが開始済みの場合は -server スイッチを使用してサーバーのコンソールから実行できます。
全般的なオーディオ CVar と使用方法
いくつかの古い関数を除き、オーディオ固有のコンソール コマンドと CVar には プレフィックスの au.
が付きます。コンソールは自動提案機能をサポートしているため、コンソールに「au.
」と入力して一覧のコマンドをスクロールすることで、使用できるコマンド一覧を表示できます。
au.Debug.SoundMixes
—この変数を「1」に設定すると、現在アクティブなサウンド クラス ミックスに関する情報を取得できます。サウンド ミックスは、レベル内の多くのサウンドに同時に影響を与える可能性のあるオブジェクトであるため、それらのグリッチの追跡は困難です。サウンド ミックスの関連情報を表示することで、予期しないサウンド ミックスがトリガーされているかどうか、サウンド ミックスがプッシュされてサウンド ミックス モディファイアのリストから予期どおりに外れるかどうか、同じミックスで複数のインスタンスが同時にアクティブになっているかどうかを判断しやすくなります。多くの場合、これはサウンドの単一のクラスが突然再生されなくなるといった状況をデバッグする際の最初のステップとして最適です。au.DumpActiveSounds
—1 に設定すると、現在再生しているすべてのサウンドのリストを取得します。これを使用して、人間の耳では同じように聞こえたとしても原因が異なる問題について、考えられるエラーの原因を絞り込むことができます。例えば、サウンドが聞こえなくなった場合、アクティブなサウンドをダンプすることで、問題がサウンドが再生されないことなのか、またはサウンドのレベルが低すぎて聞こえないのかを判別できます。同様に、ボリューム モディファイアを不適切なボリュームに設定したことによる大きな音と、同じ音の複数のインスタンスが同時に再生されて非常に大きな一つの音として認識される場合を区別するのに役立ちます。AudioMemReport
—値を指定せずに AudioMemReport コマンドを入力すると (値は必須ではありません)、アクティブなサウンド オブジェクトのメモリ使用量について詳細なドキュメントが生成されます。これは、オーディオ システムが想定以上に大量のメモリを使用する原因の究明に役立ちます。また、全般的なオーディオの最適化にも便利です。
オーディオ コンソール コマンド
Unreal Audio Engine のデバッグには以下のコマンドを使用します。新しいコマンドに置き換えられた非推奨のコマンドも、該当する場合はこの表に示します。
ほとんどの場合、有効化/無効化は 1 / 0、on / off、true / false (on/off と true/false は大文字小文字を区別する) で設定できます。
0 = false (無効化) と 1 = true (有効化) の場合、コマンドのアクションを無効化する [au.DisableDeviceSwap] コマンドなどを使用する際は、true を設定することで無効化のアクションが有効化されることに注意してください。つまり、この機能をオン (有効) にするには、「au.DisableDeviceSwap 1」と入力します。
コマンド |
説明/コメント |
引数 |
---|---|---|
|
アクティブなサウンドのビジュアリゼーション モード。 |
0:無効、1:ボリューム (Lin)、2:ボリューム (dB)、3:距離、4:ランダム カラー |
|
オーディオ ビジュアリゼーションを適用するサウンド タイプ。 |
0:すべて表示、1:コンポーネントのみ、2:非コンポーネントのみ |
|
オーディオ ビジュアリゼーション |
0:無効、1:有効 |
|
3D ビジュアリゼーションが有効なときにリスナーを表示するかどうか。 |
0:無効、1:有効 |
|
3D ビジュアリゼーションが有効なときに、オーディオ空間化のソースを表示するかどうか。 |
0:無効、1:有効 |
|
3D ビジュアリゼーションが有効なときに、仮想化したループを表示するかどうか。 |
0:無効、1:有効 |
|
音声波形を完全に停止する前に試行する ADPCM デコードの試行回数を設定します。 |
Value: 値:試行回数 |
|
ADPCM でのシークを無効にします。 |
1:シークを無効化 |
|
オーディオの空間化を許可します。通常、これは有効です。無効化すると、すべてのオーディオが空間化されなくなり、減衰が発生します。 |
0:無効、>0:有効 |
|
有効化すると、オーディオ レンダリング スレッドでサブミックスを初期化します。 |
0:無効、1:有効 |
|
チャンネル数が 2 を超えるソースに対してリバーブ処理を許可します。 |
0:無効、>0:有効 |
|
ベイク済み解析再生のタイムラインをシフトします。 |
値:タイムラインをシフトする秒数 |
|
オーディオ コンポーネントからのベイクされた解析へのクエリを有効または無効にします。 |
0:無効、1:有効 |
|
オーディオのプラグイン処理をバイパスします。 |
0:有効、1:オーディオのプラグイン処理を無効化します。 |
|
1 に設定すると、非プロシージャル ソースの Play When Silent フラグを無視します。 |
0:Play When Silent フラグに従う、1:サイレントな非プロシージャル ソースをすべて停止します |
|
ソロやミュートしたサウンドをクリアします。 |
0:無効、1:有効 |
|
コマンド バッファのフラッシュが完了するまで待機する時間。 |
値:ミリ秒単位の数値 |
|
ビューポートにデバッグ テキストをレンダリングする際の、最初の X 位置を設定します。 |
デフォルト = 100 |
|
ビューポートにデバッグ テキストをレンダリングする際の、最初の Y 位置を設定します。 |
デフォルト:-1 |
|
SoundCue 情報をビューポートにポストします。非推奨のコマンド |
0:無効、1:有効、オプション:-AllViews (現在のワールドに関連付けられたビューポートだけでなく、すべてのビューポートに対して有効化/無効化する) |
|
有効化すると、サウンド キュー デバッグのコンパクト ビューを使用します。 |
0:無効、1:有効 |
|
有効化すると、サウンド キューのフル パスを表示します。 |
0:無効、1:有効 |
|
コンパクト ビューでの文字のサイズ (ピクセル単位)。 |
デフォルト:7 |
|
コンパクト ビューでのタブのサイズ (文字単位)。 |
デフォルト:5 |
|
SoundMix の情報をビューポートにポストします。非推奨のコマンド |
0:無効、1:有効、オプション:-AllViews (現在のワールドに関連付けられたビューポートだけでなく、すべてのビューポートに対して有効化/無効化する) |
|
SoundModulation の情報をビューポートにポストします。非推奨のコマンド |
0:無効、1:有効、オプション:-AllViews (現在のワールドに関連付けられたビューポートだけでなく、すべてのビューポートに対して有効化/無効化する) |
|
SoundReverb の情報をビューポートにポストします。非推奨のコマンド |
0:無効、1:有効、オプション:-AllViews (現在のワールドに関連付けられたビューポートだけでなく、すべてのビューポートに対して有効化/無効化する) |
|
SoundWave の情報をビューポートにポストします。非推奨のコマンド |
0:無効、1:有効、オプション:-AllViews (現在のワールドに関連付けられたビューポートだけでなく、すべてのビューポートに対して有効化/無効化する) |
|
フル サウンド デバッガー ビューに表示するサウンドの最大数。 |
デフォルト:32 |
|
サウンド デバッガー リストで有効化すると、サウンドのフル パスを表示します。 |
0:無効、1:有効 |
|
サウンド統計がアクティブなときにソートおよび表示する値。 |
値:クラス、距離、名前 (デフォルト)、優先度 (サウンドごとの波形インスタンスの最高値)、時間、波、ボリューム |
|
オーディオ デバッグ ビューの本文テキストの色。 |
値:白色、赤色、オレンジ色、黄色、青色、赤紫色 (マゼンタ)、紫色、黒色 |
|
SoundWave 情報をビューポートにポストします。非推奨のコマンド |
0:無効、1:有効、オプション:-AllViews (現在のワールドに関連付けられたビューポートだけでなく、すべてのビューポートに対して有効化/無効化する) |
|
0 以外の場合、サウンド グループまたはプラットフォームのランタイム設定で設定された圧縮解除しきい値をオーバーライドします。 |
値:完全に圧縮解除する最大時間 (秒単位) |
|
ロードして使用するデフォルトのモジュレーション プラグインの名前 (コンフィグ内のプラットフォーム固有の実装名によってオーバーライドされます)。 |
N/A |
|
1 に設定すると、外部ボリュームの変更コマンドを無視します。 |
0:アプリ ボリュームの復元、1:アプリ ボリュームを無効化 |
|
1 に設定すると、ロードや起動の際にプリキャッシュを無効化し、再生時のみに同期的に事前キャッシュします。 |
0:通常の事前キャッシュ ロジックを使用、 1:同期呼び出しを除く、すべてのプリキャッシュを無効化 |
|
バイノーラル空間化を無効にします。 |
0:無効、1:有効 |
|
Windows のオーディオ ミキサーのデバイス スワップ処理コードを無効化します。 |
0:無効、1:有効 |
|
距離減衰の使用を無効にします。 |
0:無効、1:有効 |
|
ソース エンベロープ トラッキングでのエンベロープ フォロワーの使用を無効にします。 |
0:無効、1:有効 |
|
ソースごとのローパスおよびハイパス フィルタの使用を無効にします。 |
0:無効、1:有効 |
|
ソースごとのハイパス フィルタの使用を無効にします。 |
0:無効、1:有効 |
|
レガシー オーディオ バックエンドでリバーブを無効にします。 |
0:無効、1:有効 |
|
ソース エフェクトの使用を無効にします。 |
0:無効、1:有効 |
|
サラウンドのクワッド リバーブを無効にします。 |
0:無効、1:有効 |
|
サラウンドのクワッド リバーブを無効にします。 |
0:無効、1:有効 |
|
リバーブ サブミックスを無効にします。 |
0:無効、1:有効 |
|
リバーブ サブミックスを無効にします。 |
0:無効、1:有効 |
|
ソース エフェクトの使用を無効にします。 |
0:無効、1:有効 |
|
有効化すると、減衰設定の 3D Stereo Spread プロパティを無視し、代わりに特異点からオーディオをレンダリングします。 |
0:無効、1:有効 |
|
音声停止機能を無効化します。 |
0:無効、1:有効 |
|
EQ サブミックスを無効化します。 |
0:無効、1:有効 |
|
反復型の FFT 方式と DFT 方式のどちらを使用するか決定します。 |
0:反復型 FFT を使用、1:DFT を使用 |
|
現在アクティブなすべてのサウンドに関するデータをログに出力します。 |
N/A |
|
プロジェクト設定のクック オーバーライドを変更してから、新しいオーディオ ソースに適用するまでの最大レイテンシーを設定します。 |
値:キャッシュの間隔を表す時間 (秒単位) |
|
バイノーラル レンダリングが利用可能な場合、すべての空間サウンドのバイノーラル オーディオ レンダリングを切り替えます。 |
0:無効、1:有効 |
|
Windows デバイスの詳細ログを有効化します。 |
0:無効、1:有効 |
|
オクルージョンを 0.25f でスケーリングして、オーディオ ミキサーでフィルタ カットオフ周波数の変化を補正します。 |
0:無効、1:有効 |
|
サラウンド時にクワッド リバーブのステレオ フリップを有効化します。 |
0:無効、1:有効 |
|
サラウンド時にクワッド リバーブのステレオ フリップを有効化します。 |
0:無効、1:有効 |
|
FadeOut イベント実行までの待機時間。 |
値:時間 (ミリ秒単位)。 |
|
1 に設定すると、保留中のすべてのコマンドを、アプリの一時停止時にオーディオ スレッドとオーディオ レンダリング スレッドに送信します。 |
0:有効、1:無効にする |
|
1 に設定すると、GC を実行するたびに保留中のすべてのオーディオ レンダリング スレッド コマンドをフラッシュします。 |
1:有効 |
|
1 に設定すると、フェンスのタイムアウト時にオーディオ レンダリング スレッドを同期的にフラッシュします。 |
1:有効 |
|
1 に設定すると、すべてのオーディオ アセットをロード時に完全に圧縮解除せず、再生時に徐々に圧縮解除します。 |
0:ロード時の完全な圧縮解除を許可、1:リアルタイムの圧縮解除を強制 |
|
ソース処理に対する非同期タスクの使用を無効化します。 |
0:同期タスクの使用停止、1:オーディオのデコードを強制的に同期 |
|
オーディオ ミキサーを使用するかどうか決定します。これは |
0:オーディオミキサーを使用しない、1:オーディオミキサーを使用する |
|
線形ゲイン スカラーを最終フロート バッファに適用し、ホットフィックス可能なクリッピングの緩和を許可します。 |
デフォルト:1.0f |
|
オーディオ レンダリング時間をログに記録します。 |
0:ログ記録なし、1:ログ |
|
最大同時ストリーム数をオーバーライドします。 |
0:オーバーライドしない、「0」以外:オーバーライドする |
|
1 に設定すると、エンジンがティックごとに RenderAudio を呼び出します。 |
0 = ティックごとにレンダリングしない、1 = ティックごとにレンダリングする |
|
単一のコールバックでレンダリングするフレームの数を選択します。 |
値:レンダリングするフレームの数。 |
|
0 より大きい値に設定すると、その値によってオーディオ バッファが事前キャッシュするフレーム数を決定します。 |
0:事前キャッシュ フレームにデフォルト値を使用、>0:事前キャッシュするフレームの数。 |
|
Null デバイスにスワップする前の、レンダリング スレッドがタイムアウトするまで待機する時間。 |
値:時間 (ミリ秒単位)。 |
|
1 に設定すると、すべてのオーディオ アセットが完全にロードされるのではなく、再生時に計画的に圧縮解除されます。 |
0:ロード時の完全な圧縮解除を許可、1:リアルタイムの圧縮解除を強制 |
|
1 に設定すると、レコーディング中にゲームがシャットダウンした場合に、.wav ファイルへのレコーディングのバウンスを試みます。 |
0:無効、1:有効 |
|
オーディオ レンダリング スレッドの優先度を設定します。デフォルト値は 3 です。 |
0:通常、1:通常より上、2:通常より下、3:最高、4:最低、5:通常より少し低い、6:タイム クリティカル |
|
その時点で有効かつアクティブなオーディオ デバイス (オーディオ エンジンのインスタンス) をログに記録します。 |
N/A |
|
オーディオ チャンネル数を変更します。最大値を、オーディオ エンジンの初期化に使用した MaxChannelCount に固定します。 |
0:無効、>0:入力した数値が新しいチャンネル数になります |
|
オーディオ チャンネル数をパーセンテージで変更します。 |
システムで使用できるチャンネルによってデフォルトが異なります。別の値を追加することでこれを変更できます。 |
|
一度限りの距離の最適化のため、カリング候補となるにはサウンドの最大持続時間を設定する必要があります。 |
デフォルト値は「1.0」です (秒単位) |
|
受信するストリーム チャンクをロードの失敗として処理するようにエンジンを強制します。 |
0:無効、1:有効 |
|
0 以外の値に設定すると、すべてのキャッシュミスを |
0: |
|
これはストリーム キャッシュが有効な場合に、保持していないオーディオをキャッシュからフラッシュします。 |
N/A |
|
0 以外の値に設定すると、ディスクの読み取りが完了するまで |
0:無効、1:強制的にロードをブロック |
|
1 に設定すると、 |
1:セッション全体のキャッシュミスを、すべて AudioMemReport に表示します。0:セッション全体のキャッシュミスを、すべて AudioMemReport に表示します。0: |
|
画面に表示するストリーム チャンクの最大量を設定します。 |
値:画面に表示する要素の数。 |
|
この値が、当社でサポート可能なストリーム キャッシュの潜在的な最小使用量です。例えば、これを 0.25 に設定すると、チャンクの排除を開始する際に、潜在的に少なくともキャッシュ サイズの 25% を使用することになります。 |
0.0:チャンク数を (キャッシュ サイズ / 最大チャンク サイズ) に制限する、[0.01 ~ 0.99]:小さな音をたくさん再生する際に、チャンク数を増やしてディスク IO を制限します。 |
|
再生する準備の整った、キャッシュされていないオーディオ チャンクに対して、デフォルトの要求優先度を設定します。 |
0:高、1:通常、2:通常より下、3:低、4:最小値 |
|
1 に設定すると、そのサウンドで |
0:無効、1:有効 |
|
ストリーム キャッシュが有効な場合に、オーディオ チャンクのデフォルト要求優先度を設定します。 |
0:高、1:通常、2:通常より下、3:低、4:最小値 |
|
オーディオ ストリーム キャッシュを新しいサイズに縮小するために、必要に応じて十分なオーディオ チャンクをカリングし、キャッシュをそのサイズに維持するよう試行します。 |
値:サイズ (メガバイト単位) |
|
1 に設定すると、キャッシュのオーバーフロー時に audiomemreport を出力します。 |
0:無効、1:有効 |
|
このストリーミング マネージャーに対して、パフォーマンス重視のプロファイル モードを開始します。プロファイル統計は audiomemreport で出力できます。 |
N/A |
|
au.streamcaching.StartProfiling コマンドを停止します。 |
N/A |
|
この CVar を設定してキャッシュ サイズをオーバーライドできます。0:プロジェクト設定のキャッシュ サイズを使用します。 |
値:新しいキャッシュ サイズ (メガバイト単位)。 |
|
0 以外の値に設定すると、割り当てを超過しないように |
0:無効、>0:有効 ( 0 以外の値はすべて 1 と同等) |
|
修正すると、子でなくなった子サブミックスをリストするサブミックスが存在しないことを確認し、以前の子が以前の親を誤ってリストすることを防ぎます。 |
N/A |
|
バッファ アンダーランを送信する前に、レンダリング スレッドが次のバッファを生成するために待機する時間。 |
値:ミリ秒単位の数値 |
|
ステレオ パンニングに対するゼロ減衰のオーバーライド距離。 |
0:実際の距離を使用、1:リスナー オーバーライドを使用 |
|
オーディオ ループの仮想化サポートを有効化/無効化します。 |
0:無効、1:有効 |
|
仮想化したサウンドを強制的に更新して、リスナーが 1 フレーム内で指定した距離を移動するかどうかを確認するために必要な距離のしきい値を設定します。測定単位はアンリアル単位 (UU:Unreal Unit) です。 |
0:無効、1:有効、デフォルト値:2500 UU |
|
サウンドの最大可聴距離を超えて、最小と最大の間の更新レートをスケーリングするように仮想ループ距離を設定します。 |
0:無効、1:有効、デフォルト値:15000.0 |
|
サウンドが再び聞こえるかどうかを確認する最大レートを設定します (サウンドの最大可聴距離 + パフォーマンス スケーリング距離を超えた場合)。 |
0:無効、1:有効、デフォルト値:3.0f |
|
サウンドの最大可聴距離で再びサウンドが聞こえるかどうかを確認する最小レートを設定します。 |
0:無効、1:有効、デフォルト値:.1f |
|
1 に設定すると、 |
0:再生を試みる、1:ロードを待機する |
古いオーディオ コンソール コマンド
以下に示すコマンドは依然として機能しており、一部のユーザーによって使用されている可能性があります。
ただし、これらのコマンドは入力引数を受け取らず、新しいオーディオ コンソール コマンドのように自動補完されないことに注意してください。
コマンド |
説明/コメント |
---|---|
|
3D サウンドの 3D ビジュアリゼーションに対してオン/オフを切り替えます |
|
サウンド名を追加の入力として受け取り、そのサウンドのデバッグ情報を提供します |
|
動的なサウンド ボリューム名を追加の入力として受け取り、そのボリュームのデバッグ情報を提供します |
|
オーディオ オブジェクトのメモリ レポートを作成します |
|
サウンド名を追加の入力として受け取り、そのサウンドのデバッグ情報を提供します |
|
すべての動的なサウンド ボリュームをリセットします |
|
動的なサウンドのボリューム名を追加の入力として受け取り、その特定のボリュームをリセットします |
|
動的なサウンドのボリューム名を追加の入力として受け取り、その特定のボリュームを設定します |
|
サウンドのクラス名を追加の入力として受け取り、そのサウンド クラスがソロ (可聴音のみ) かどうかを切り替えます |
|
サウンドのキュー名を追加の入力として受け取り、そのサウンド キューがソロ (可聴音のみ) かどうかを切り替えます |
|
サウンド ウェーブ名を追加の入力として受け取り、そのサウンド ウェーブがソロ (可聴音のみ) かどうかを切り替えます |
|
現在ソロであるオーディオ デバイスのソロ コマンドをクリアします |
|
すべてのソースのハイパス フィルタ機能を無効にします |
|
すべてのソースのローパス フィルタ機能を無効にします |
|
ラジオ エフェクトを無効にします |
|
現在アクティブなサウンド オブジェクトに関する詳細情報を出力します |
|
ラジオ エフェクトを有効にします |
|
現在再生しているサウンドのドライ信号を分離します (まだエフェクト処理を経ていないサウンド部分など) |
|
リバーブ処理によって生成されたオーディオを分離します |
|
アクティブなサウンド コンポーネントと関連データのリストをすべてダンプします |
|
アクティブなサウンド クラスのボリュームと関連データのリストをすべてダンプします |
|
アクティブなサウンド クラスと関連データのリストをすべてダンプします |
|
各サウンド ウェーブ オブジェクトのリストを、対応する継続時間とともにダンプします |
|
ロードされたサウンドに関するデバッグ情報を表示します。追加のパラメータ:ALPHASORT:true に設定するとサウンドを名前で並べ替えます。それ以外の場合は、メモリ使用量の大きい順に並べ替えます。LONGNAMES:true に設定すると、リストされた各サウンドのフル パスを出力します。それ以外の場合はオブジェクト名のみを出力します。 |
|
次のフィールドを使用して、現在アクティブな Wave インスタンスの情報を表示します。Instance Index Source ?TEXT("Yes") :、再生時間、ボリューム、パス名、サウンド名 |
|
フォーカスのある PIE ウィンドウにかかわらず、すべてのデバイスのオーディオを可聴にするかどうかを切り替えます |
|
サウンドのキュー名を追加の入力として受け取り、そのサウンド キューを再生します |
|
サウンド ウェーブ名を追加入力として受け取り、そのサウンド ウェーブを再生します |
|
すべてのボリュームをデフォルトにリセットして、テスト フィルタをすべて削除します |
|
サウンド ミックス名を追加パラメータとして受け取り、そのサウンド ミックスを基本ミックスとして設定します |
|
サウンド クラスの階層を表示します |
|
他すべてのデバイスをミュートして、単一のデバイスをソロ デバイスに設定します。 |
|
潜在的なサウンド クラスの破損やパスのコリジョンを処理します |
|
すべてのソースに対してロー パス フィルタを最大に設定し、潜在的な LFE ブリードの問題をテストします |
|
すべてのソースに対してロー パス フィルタを最大に設定します |
|
呼び出すと、すべてに対して HRTF が有効かどうかを変更します。例えば、bHRTFEnabledForAll が現在「false」に設定されている場合は、「true」に設定されます。 |