输出端口更多...

继承自 CriDisposable .

类
struct	Config
	输出端口创建用配置结构体更多...

Public 类型
enum	Type : System.Int32 { Audio = 0, Vibration = 1 }
	输出端口类型更多...

Public 成员函数
Int32	CalculateWorkSize (CriAtomExOutputPort.Config config)
	计算用于创建输出端口对象的工作区域大小更多...

	CriAtomExOutputPort (Config config)
	创建输出端口对象更多...

override void	Dispose ()
	销毁输出端口对象更多...

void	SetAsrRackId (Int32 rackId)
	指定ASR Rack ID 更多...

void	SetVibrationChannelLevel (Int32 channel, Single level)
	振动类型的输出端口的声道电平的设置更多...

void	SetMonauralMix (Boolean monauralMix)
	振动类型的输出端口是否进行单声道混音的设置更多...

bool	IsDestroyable ()
	确定输出端口对象是否可以销毁更多...

Public 属性
const uint	MaxNameLength = 64
	输出端口名称的最大长度値更多...

属性
bool	isAvailable `[get]`
	输出端口对象是否有效更多...

详细描述

输出端口

说明:: 输出端口是一个可以轻松管理和控制音频输出目标的类。
可以用于需要在主输出以外的设备上播放，或使用特定于平台的播放功能的情况。

成员枚举类型说明

enum Type : System.Int32

strong

输出端口类型

说明:: 显示输出端口的类型的值。

参见: CriWare.CriAtomExOutputPort.Config

枚举值

Audio

声音类型

说明:: 要播放普通音频的输出端口类型。

Vibration

振动类型

说明:: 用于播放基于音频的振动的输出端口类型。

构造及析构函数说明

CriAtomExOutputPort ( Config config )

inline

创建输出端口对象

参数

config 输出端口创建用配置结构体

返回: 输出端口对象

说明:: 创建输出端口对象。
输出端口链接到 ASR Rack，指定输出端口的Voice将在连接到该输出端口的 ASR Rack 中播放。

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;
}

备注:: 使用CriAtomEx.RegisterAcf等注册ACF文件时，ACF中设置的输出端口对象会自动创建，
所以不需要用这个函数创建新的输出端口。
上面生成的输出端口对象可以通过CriWare.CriAtomExAcf.GetOutputPort获得。
此函数应该在应用程序中另外需要新的输出端口对象时使用。
如果成功创建了输出端口对象，该函数将返回所创建的输出端口对象。
如果创建失败，则返回null。

注意:

此函数创建的输出端口对象将以下 ASR Rack ID 设置为初始值，具体取决于 CriWare.CriAtomExOutputPort.Config.type 中指定的类型。

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

在使用输出端口对象之前，请使用 CriWare.CriAtomExOutputPort.SetAsrRackId 设置适当的 ASR Rack。

请注意使用 CriWare.CriAtomExOutputPort.Dispose 销毁使用此 API 创建的对象。

参见: 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 Rack ID

参数

rackId ASR Rack ID

说明:: 指定 ASR Rack 作为输出端口。
指定输出端口的Voice将在为该输出端口指定的 ASR Rack 中播放。

备注:: 在ACF文件注册期间创建的输出端口对象（CriWare.CriAtomExAcf.GetOutputPort）
或使用CriWare.CriAtomExOutputPort.CriAtomExOutputPort创建的输出端口对象，
必须使用此函数指定适当的ASR Rack。

根据输出端口的类型和其他因素，对可以指定的ASR Rack可能有限制。
更多信息请参阅手册。

注意:: 通过本函数更改输出端口的ASR Ｒack ID不会影响已开始播放的音频。

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

void SetVibrationChannelLevel	(	Int32	channel,
		Single	level
	)

inline

振动类型的输出端口的声道电平的设置

参数

channel	声道索引（0=L，1=R）。
level	关卡（Level）(0 ~ 2.0)

说明:: 对于振动类型的输出端口，设置到振动设备的各声道的输出电平。

备注:: 振动型输出端口以 2 声道运行，如果最终输出设备是单声道，则适用 -3dB 下混。
即使在播放声音途中，使用此函数设置的值也会立即反映。

参见: CriWare.CriAtomExOutputPort.SetMonauralMix

void SetMonauralMix ( Boolean monauralMix )

inline

振动类型的输出端口是否进行单声道混音的设置

参数

monauralMix 有无单声道混合（CRI_TRUE=启用，CRI_FALSE=禁用）

说明:: 振动类型输出端口会在2声道上运行，因此如果输入音频有2个或更多声道，
或者设置了3D Panning，输出结果会分别传输到振动设备的左右侧。
如果启用单声道混音，则可以通过在输出到振动设备之前缩混为单声道来消除这些影响。
您还可以使用 CriWare.CriAtomExOutputPort.SetVibrationChannelLevel 在单声道混音后调整发送到振动设备的电平。

备注:: 在此函数设置的值，即使在声音播放时也会即时被反映。

参见: CriWare.CriAtomExOutputPort.SetVibrationChannelLevel

bool IsDestroyable ( )

inline

确定输出端口对象是否可以销毁

返回: 是否可以销毁

说明:

判定输出端口对象是否可以销毁。
返回true时，可以使用 CriWare.CriAtomExOutputPort.Dispose 销毁对象。
而返回false时，则只能在使用以下API将输出端口对象从Player删除后销毁。

参见: CriWare.CriAtomExOutputPort.Dispose

类成员变量说明

const uint MaxNameLength = 64

输出端口名称的最大长度値

说明:: 在 CriWare.CriAtomExOutputPort.Config.name 中可以作为名称指定的字符串的最大长度。

参见: CriWare.CriAtomExOutputPort.Config

属性说明

bool isAvailable

get

输出端口对象是否有效

返回: 对象是否有效

说明:: 获取输出端口对象是否有效。
您可以确定生成的对象中保存的本机句柄是否已被释放。

参见: CriWare.CriAtomExOutputPort.Dispose

该类的文档由以下文件生成:

CriAtomExOutputPort.cs

类

Public 类型

Public 成员函数

Public 属性

属性

详细描述

成员枚举类型说明

构造及析构函数说明

成员函数说明

类成员变量说明

属性说明