CRIWARE Unity Plugin Manual  Last Updated: 2024-04-24
インゲームプレビューの手順

インゲームプレビュー用データの作成

インゲームプレビュー機能を利用するには、インゲームプレビュー用にビルドされたACBファイルとACFファイルを作成する必要があります。

(1) インゲームプレビュー用バイナリのビルド

CRI Atom Craftのプロジェクトツリーのキューシート上で右クリックし、[Atomキューシートバイナリ]を選択してください。
表示された [Atomキューシートバイナリ]ダイアログで、「インゲームプレビュー用バイナリ出力」をチェックし、Atomキューシートバイナリ(ACF、ACB、AWB)をビルドしてください。

adx2u_keys_ingame_process_build.png
[Atomキューシートバイナリのビルド]ダイアログ

[補足事項]
インゲームプレビュー用バイナリは、通常版バイナリと以下の違いがあります。
  • デフォルト値パラメータを含む
  • データ検索用ユニークIDが含まれる
  • データや波形の入れ替えに対応できるよう、リミットサイズが設定される
    (ACBリミットサイズ、ACFリミットサイズ)

(2) インゲームプレビュー用バイナリのコピー

プロジェクトフォルダ下の「inGamePreview」フォルダにインゲームプレビュー用バイナリが作成されます。
UnityプロジェクトのAssetsフォルダへは、「inGamePreview/Assets」フォルダ下のデータをそのままコピーするようにしてください。

CRI Atom Craftのプロジェクトフォルダの構成
  * CriAtomCraft

  \ * Tutorial

    o * Material

    \ * PC

      o * Assets

      \ * inGamePreview

        \ * Assets

 

: プロジェクトルートパス

: マテリアルルートパス

 

:通常用Assetデータ

 

: インゲームプレビュー用Assetデータ

 



インゲームプレビュー対応アプリの準備

インゲームプレビューを使用するためには、Unityプロジェクト側でも専用の設定が必要です。
CRIWARE Library Initializer 」のプロパティで、[Uses In Game Preview] にチェックを入れてください。
adx2le_unity_ingame_initialize.png
サンプル「[CriAtom]インゲームプレビュー(ピンボールデモ) 」がインゲームプレビューに対応していますので、参考にしてください。

インゲームプレビューの実行

(1) 接続先アプリの設定

CRI Atom Craftでインゲームプレビューの接続先アプリのIPアドレスをあらかじめ設定しておきます。
  1. [プロジェクトツリー]->[ターゲットコンフィグ]項目よりPCを選択します。
  2. 右クリックメニューから[プレビュー設定を編集...]を選択します。
  3. [ターゲットコンフィグのプレビュー設定の編集]ウインドウより[編集]ボタンを押下します。
  4. IPアドレス欄にサンプルを動作させるPCのIPアドレスを設定します。

    adx2u_keys_ingame_process_ip.png
    [プレビュー設定]ダイアログ
スマートフォン実機と接続する場合は WiFi接続が必要になります。

インゲームプレビューが可能なネットワーク環境
CRI Atom Craft を起動したWindowsと、接続先のアプリケーションが同じネットワーク内にある必要があります。
特にスマートフォンとの通信の場合、接続にはWiFiネットワークが必要となります。
WiFiの場合、端末相互のアクセスが許可されている必要があります。(プライベートセパレーターがOFFでなければいけません。)
社内環境などで接続がうまくいかない場合はネットワーク管理者にお問い合わせください。
Windowsのセキュリティ警告
インゲームプレビュー対応のアプリケーションを実行すると、Windows警告にひっかかる場合があります。
別アプリケーションとの通信を行おうとするためです。
Windows警告にひっかかった場合は「アクセスを許可する」や「ブロックを解除する」を選択して通信を許可してください。
windows_seculity_warning.png

(2) インゲームプレビューの開始

インゲームプレビューを開始すると、アプリケーションがサーバー、CRI Atom Craftがクライアントとなって通信を行います。
  1. インゲームプレビュー用バイナリを使用するアプリケーションを起動しておきます。
  2. CRI Atom Craftを起動し、インゲームプレビュー用バイナリを作成したプロジェクトファイルを開きます。
  3. [プレビュー]->[インゲームプレビューの開始]メニュー([F10]キー)を選択します。
    通信が確立するとプレビューウィンドウが表示されます。

    adx2u_keys_ingame_process_previewing.png
    プレビュー情報ウィンドウ

データ更新中のエラーコールバックについて
インゲームプレビューに接続した時やプロジェクトに大きな変更を加えた場合、データ更新が発生して全てのサウンドが停止します。
この時、ツール側とUnityプラグイン側両方に次のようなエラーコールバックが大量に発生します。
W2013022700:Cannot access the content of the cuesheet during data transmission by the authoring tool.
このエラーコールバックは通信によるデータ更新中にデータを読もうとして発生するものなので、無視してください。
通信によるデータ更新が完了すれば、エラーコールバックは発生しなくなります。

(3) インゲームプレビュー中のパラメータ変更

インゲームプレビューの接続に成功していれば、CRI Atom Craft 側で変更したパラメータがリアルタイムでプログラム側に反映されます。
音量等のパラメータ変更
プログラム側でキュー music1 を再生した状態で CRI Atom Craft 側でキュー Music1 の音量を変更すると、 プログラム側は何もしないくても音量が下がります。
同様にDSPバス1のセンドレベルをあげればリバーブがかかります。
音量やピッチ等のパラメータを変更するだけの場合はデータ更新は発生しないのでサウンドが停止することもありません。
波形のタイミング変更や差し替え
タイムライン上で波形の位置を変更したり、AISACを追加したりという大きな変更を加えるとデータ更新が発生して、プログラム側の再生が停止します。
データ更新が終わればプログラムからの再生開始は再び有効になりますので、通信が終わるまでお待ちください。
メモリ再生用のデータであれば波形自体を差し替えてプレビューすることも可能です。
タイムライン上で波形を選択して、右クリックメニューの「ウェーブフォームの再割り当て」を選択すると簡単に波形差し替えが可能です。

lepc_sample_prog_ingame_replace.png

インゲームプレビューで出来ないこと
インゲームプレビュー機能では、ストリーム再生の波形を差し替えることは出来ません。
サンプルデータの場合、音楽やボイスの波形はストリーム設定のため別の波形に差し替えてプレビューすることは出来ません。
ストリーム再生のデータでも、ボリューム等のパラメータ変更は可能です。

(4) インゲームプレビューの終了

インゲームプレビューを次のいずれかの方法で終了してください。
  • (a) アプリケーションでインゲームプレビュー機能を終了する。
  • (b) CRI Atom Craftより終了させます。
    • [プレビュー]->[インゲームプレビューの停止]メニュー(Ctrl+[F10]キー)
[補足事項]
Unity Editor 上で、CRIWARE Library Initialzer の[Uses In Game Preview]にチェックを入れると、インゲームプレビュー機能の初期化・終了は自動的に行われます。

[注意事項]
現在、一部のPC環境でインゲームプレビューが動作しない問題が発生しています。
原因の調査と対応方法を検討しています。

インゲームプレビューのトラブルシュート

インゲームプレビュー対応アプリが複数ある場合
インゲームプレビューに対応したアプリケーションが、同一端末で複数起動している状態では正しくインゲームプレビュー接続できません。
特にスマートフォンの場合、ADXのサンプルプログラムや過去に起動した開発中アプリが起動中ではないか確認してください。
接続がうまくいかない場合は、他のアプリケーションプロセスを終了してから試してください。
インゲームプレビュー接続に失敗する場合
le_tool_ingame_failed_no_target.png
ツールからのインゲームプレビュー接続が失敗すると、CRI Atom Craft のログウインドウに接続失敗のメッセージが表示されます。
次のことを確認してください。
  • CRI Atom Craft のツールプロパティで接続先のIPアドレスが正しく指定できているか。
  • WiFi接続の場合、CRI Atom Craftの起動しているWindowsとアプリは同じネットワーク内にあるか。
  • スマートフォン側は意図しないWiFiに接続するなどでIPアドレスが変わってしまっていないか。
  • アプリケーションがインゲームプレビュー用のライブラリ初期化をしているか。
接続は成功するが、インゲームプレビューウインドウに何もファイルが表示されない場合
le_tool_ingame_failed_no_data.png
インゲームプレビューウインドウが「接続中」になっているにも関わらずキューシートリストに何も表示されない場合、次のことを確認してください。
  • アプリケーションが読み込んでいるデータ(ACF, ACB, AWB)はインゲームプレビュー用のバイナリデータを使っているか。
なお、アプリケーションが読み込んでいるインゲームプレビュー用バイナリのみがキューシートリストに表示されます。
複数のACB/AWBを読み込んでいる場合、インゲーム非対応のバイナリはインゲームプレビューウインドウには表示されません。