出力ポート [詳解]

CriDisposableを継承しています。

クラス
struct	Config
	出力ポート作成用コンフィグ構造体 [詳解]

公開型
enum	Type : System.Int32 { Audio = 0, Vibration = 1 }
	出力ポートタイプ [詳解]

公開メンバ関数
Int32	CalculateWorkSize (CriAtomExOutputPort.Config config)
	出力ポートオブジェクト作成用ワーク領域サイズの計算 [詳解]

	CriAtomExOutputPort (Config config)
	出力ポートオブジェクトの作成 [詳解]

override void	Dispose ()
	出力ポートオブジェクトの破棄 [詳解]

void	SetAsrRackId (Int32 rackId)
	ASRラックIDの指定 [詳解]

void	SetVibrationChannelLevel (Int32 channel, Single level)
	振動タイプの出力ポートのチャンネルレベルの設定 [詳解]

void	SetMonauralMix (Boolean monauralMix)
	振動タイプの出力ポートのモノラルミックス有無設定 [詳解]

bool	IsDestroyable ()
	出力ポートオブジェクトの破棄可能の判定 [詳解]

公開変数類
const uint	MaxNameLength = 64
	出力ポートの名前の長さの最大値 [詳解]

プロパティ
bool	isAvailable `[get]`
	出力ポートオブジェクトが有効かどうか [詳解]

詳解

出力ポート

説明:: 出力ポートは、音声の出力先の管理や制御を容易にするためのクラスです。
メインの出力先とは別のデバイスでの再生や、プラットフォーム機能を用いた特殊な再生の時に役に立ちます。

列挙型メンバ詳解

enum Type : System.Int32

strong

出力ポートタイプ

説明:: 出力ポートの種別を示す値です。

参照: CriWare.CriAtomExOutputPort.Config

列挙値

Audio

サウンドタイプ

説明:: 通常の音声を再生する出力ポートタイプです。

Vibration

振動タイプ

説明:: オーディオベースの振動を再生する出力ポートタイプです。

構築子と解体子

CriAtomExOutputPort ( Config config )

inline

出力ポートオブジェクトの作成

引数

config 出力ポート作成用コンフィグ構造体

戻り値: 出力ポートオブジェクト

説明:: 出力ポートオブジェクトの作成を行います。
出力ポートはASRラックと紐付けられ、出力ポートが指定されたボイスはその出力ポートに紐付けられた
ASRラックにて再生されるようになります。

CriAtomExOutputPort CreateOutputPort(int rackId) {
    var outputPortConfig = CriAtomExOutputPort.Config.Default();
    outputPortConfig.name = "SampleOutputPort1";
    var outputPort = new CriAtomExOutputPort(outputPortConfig);
    // Set AsrRack ID
    outputPort.SetAsrRackId(rackId);
    return outputPort;
}

備考:: ACFファイルに設定された出力ポートオブジェクトは CriAtomEx.RegisterAcf などを用いて
ACFファイルを登録したとき、ACF内に自動的に作成されるため、本関数で新たに作成する必要はありません。
上記で生成されたの出力ポートオブジェクトは CriWare.CriAtomExAcf.GetOutputPort で取得できます。
そのため、本関数はアプリケーション上で新たに出力ポートオブジェクトが必要になった場合に使用してください。

出力ポートオブジェクトの生成に成功した場合は、本関数は生成した出力ポートオブジェクトを返します。
生成に失敗した場合は null を返します。

注意:

本関数で作成された出力ポートオブジェクトには、 CriWare.CriAtomExOutputPort.Config.type で指定したタイプによって
以下のASRラックIDが初期値としてセットされています。

CriWare.CriAtomExOutputPort.Type.Audio を指定： CriWare.CriAtomExAsrRack.defaultRackId
CriWare.CriAtomExOutputPort.Type.Vibration を指定： CriWare.CriAtomExAsrRack.IllegalRackId

出力ポートオブジェクトを使用する前に、必ず CriWare.CriAtomExOutputPort.SetAsrRackId
で適切なASRラックを設定してください。

本APIで生成したオブジェクトは必ず CriWare.CriAtomExOutputPort.Dispose で破棄してください。

参照: CriWare.CriAtomExOutputPort.Config, CriWare.CriAtomExOutputPort.Dispose, CriWare.CriAtomExAsrRack.rackId, CriWare.CriAtomExAcf.GetOutputPort, CriWare.CriAtomExPlayer.AddOutputPort, CriWare.CriAtomExPlayer.AddPreferredOutputPort

関数詳解

Int32 CalculateWorkSize ( CriAtomExOutputPort.Config config )

inline

出力ポートオブジェクト作成用ワーク領域サイズの計算

引数

config 出力ポート作成用コンフィグ構造体

戻り値: ワーク領域サイズ

説明:: 出力ポートオブジェクトの作成に必要なワーク領域のサイズを計算します。
計算した値は本クラスのコンストラクタを呼び出した際に確保される、アンマネージドメモリのサイズに相当します。

ワーク領域サイズの計算に失敗すると、本関数は -1 を返します。
ワーク領域サイズの計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。

注意:: CriWare.CriAtomExOutputPort.Config.name に指定する出力ポート名の長さは
CriWare.CriAtomExOutputPort.MaxNameLength 以下である必要があります。

参照: CriWare.CriAtomExOutputPort.CriAtomExOutputPort

override void Dispose ( )

inline

出力ポートオブジェクトの破棄

説明:: 出力ポートオブジェクトの破棄を行います。

備考:

以下のAPIを使用してプレーヤーに追加中の出力ポートオブジェクトはそのままでは破棄することができません。

この場合は以下のAPIを使用し、プレーヤーから取り外すことで出力ポートオブジェクトを破棄できます。

参照: CriWare.CriAtomExOutputPort.CriAtomExOutputPort, CriWare.CriAtomExOutputPort.isAvailable, CriWare.CriAtomExOutputPort.IsDestroyable

void SetAsrRackId ( Int32 rackId )

inline

ASRラックIDの指定

引数

rackId ASRラックID

説明:: 出力ポートにASRラック指定します。
出力ポートが指定されたボイスは、その出力ポートに指定されているASRラックで再生されます。

備考:: ACFファイル登録時に作成された出力ポートオブジェクト（CriWare.CriAtomExAcf.GetOutputPort）や
CriWare.CriAtomExOutputPort.CriAtomExOutputPort で作成された
出力ポートオブジェクトには、必ず本関数で適切なASRラックを指定する必要があります。

出力ポートのタイプなどによって、指定できるASRラックに制限がある場合があります。
詳細に関しましてはマニュアルを参照してください。

注意:: 本関数で出力ポートのASRラックIDを変更しても、既に再生されている音声には影響しません。

参照: CriWare.CriAtomExAsrRack.rackId, CriWare.CriAtomExAcf.GetOutputPort

void SetVibrationChannelLevel	(	Int32	channel,
		Single	level
	)

inline

振動タイプの出力ポートのチャンネルレベルの設定

引数

channel	チャンネルインデックス（0 = L, 1 = R）
level	レベル(0 ~ 2.0)

説明:: 振動タイプの出力ポートに対し、振動デバイスの各チャンネルへの出力レベルを設定します。

備考:: 振動タイプの出力ポートは２チャンネルで動作しており、最終出力デバイスがモノラルの場合-3dBのダウンミックスが適用されます。
この関数で設定した値は、音が再生中でも即時反映されます。

参照: CriWare.CriAtomExOutputPort.SetMonauralMix

void SetMonauralMix ( Boolean monauralMix )

inline

振動タイプの出力ポートのモノラルミックス有無設定

引数

monauralMix モノラルミックス有無（CRI_TRUE = 有効, CRI_FALSE = 無効）

説明:: 振動タイプの出力ポートは２チャンネルで動作するため、入力されるボイスがステレオ以上の音声データか、
3Dパンが設定されている場合、その結果が振動デバイスの左右に伝わります。
モノラルミックスを有効にすると、振動デバイスへ出力する前に一度モノラルにダウンミックスを行うことでそれらの影響をなくすことができます。
CriWare.CriAtomExOutputPort.SetVibrationChannelLevel を使用して
モノラルミックス後振動デバイスへ送られるレベルを設定することも可能です。

備考:: この関数で設定した値は、音が再生中でも即時反映されます。

参照: CriWare.CriAtomExOutputPort.SetVibrationChannelLevel

bool IsDestroyable ( )

inline

出力ポートオブジェクトの破棄可能の判定

戻り値: 破棄可能かどうか

説明:

出力ポートオブジェクトの破棄可能かどうか判定します。
true を返した場合、 CriWare.CriAtomExOutputPort.Dispose でオブジェクトを破棄できます。
false を返した場合、以下のAPIで出力ポートオブジェクトをプレーヤーから取り外してからのみ、オブジェクトを破棄できます。

参照: CriWare.CriAtomExOutputPort.Dispose

メンバ詳解

const uint MaxNameLength = 64

出力ポートの名前の長さの最大値

説明:: CriWare.CriAtomExOutputPort.Config.name に名前として指定できる文字列の最大長です。

参照: CriWare.CriAtomExOutputPort.Config

プロパティ詳解

bool isAvailable

get

出力ポートオブジェクトが有効かどうか

戻り値: オブジェクトが有効かどうか

説明:: 出力ポートオブジェクトが有効かどうか取得します。
生成済みオブジェクトの内部で保持しているネイティブハンドルがDispose済みかどうか判定できます。

参照: CriWare.CriAtomExOutputPort.Dispose

このクラス詳解は次のファイルから抽出されました:

CriAtomExOutputPort.cs

クラス

公開型

公開メンバ関数

公開変数類

プロパティ

詳解

列挙型メンバ詳解

構築子と解体子

関数詳解

メンバ詳解

プロパティ詳解