ASR Rack More...

Inherits CriDisposable.

Classes
struct	Config
	A config structure for creating an ASR Rack More...

interface	IPlatformConfig
	Platform-specific configuration structure used to create an ASR Rack More...

struct	PerformanceInfo
	Performance information More...

struct	PlatformConfig
	A platform-specific config structure for creating an ASR Rack More...

Public Member Functions
	CriAtomExAsrRack (Config config, IPlatformConfig platformConfig)
	Creating an ASR Rack More...

	CriAtomExAsrRack (Config config, PlatformConfig platformConfig)
	Creating an ASR Rack More...

void	AttachDspBusSetting (string settingName)
	Attaching the DSP bus settings More...

void	DetachDspBusSetting ()
	Detaches the DSP bus settings More...

void	ApplyDspBusSnapshot (string snapshotName, int timeMs)
	Applies the DSP bus snapshot More...

string	GetAppliedDspBusSnapshotName ()
	Gets the snapshot's name More...

PerformanceInfo	GetPerformanceInfo ()
	Gets the performance information for the ASR rack More...

void	ResetPerformanceMonitor ()
	Resets the performance measurements for the ASR rack More...

override void	Dispose ()
	Discards an ASR Rack More...

Static Public Member Functions
static string	GetAppliedDspBusSnapshotName (CriAtomExAsrRackId rackId)
	Gets the snapshot's name More...

static PerformanceInfo	GetPerformanceInfoByRackId (CriAtomExAsrRackId rackId=CriAtomExAsrRack.defaultRackId)
	Gets the performance information for the ASR rack More...

static void	ResetPerformanceMonitorByRackId (CriAtomExAsrRackId rackId=CriAtomExAsrRack.defaultRackId)
	Resets the performance measurements for the ASR rack More...

static void	SetAisacControl (CriAtomExAsrRackId rackId, string controlName, float value)
	Setting the AISAC control value by name More...

static void	SetAisacControl (CriAtomExAsrRackId rackId, int controlId, float value)
	Setting AISAC control value by specifying an ID More...

static void	SetDefaultConfig (ref Config config)
	Set the default parameters More...

static void	GetNumRenderedSamples (CriAtomExAsrRackId rackId, out Int64 numSamples, out Int32 samplingRate)
	Get the total number of samples rendered by the ASR rack More...

static CriAtomExAsrRackId	GetAmbisonicRackId ()
	Get the ASR rack ID for Ambisonics playback More...

static CriAtomExAsrRackId	GetChannelBasedAudioRackId ()
	Get the ASR Rack ID for channel-based playback More...

static CriAtomExAsrRackId	GetObjectBasedAudioRackId ()
	Get the ASR rack ID for ObjectBasedAudio playback More...

static CriAtomExAsrRackId	GetPassThroughRackId ()
	Get the ASR rack ID for pass-through playback More...

static void	SetDeviceId_WASAPI (CriAtomExAsrRackId rackId, string busName, string deviceId)
	Setting the device ID More...

static void	SetDeviceId_WASAPI (CriAtomExAsrRackId rackId, string busName, int index)
	Setting the device ID More...

static void	SetHapticDeviceId_PC (CriAtomExAsrRackId rackId, string busName, int index, CriAtom.HapticDeviceType_WASAPI deviceType)
	Setting the device ID More...

Public Attributes
const CriAtomExAsrRackId	defaultRackId = 0
	Default ASR Rack ID More...

const CriAtomExAsrRackId	IllegalRackId = -1
	Invalid Rack ID More...

Properties
CriAtomExAsrRackId	rackId `[get]`
	Get the ASR Rack ID More...

static CriAtomExAsrRack	Default `[get]`
	Default ASR Rack More...

static Config	defaultConfig = new CriAtomExAsrRack(defaultRackId) `[get]`
	Default configuration More...

Detailed Description

ASR Rack

Constructor & Destructor Documentation

CriAtomExAsrRack	(	Config	config,
		IPlatformConfig	platformConfig
	)

inline

Creating an ASR Rack

Parameters

config	Config structure
platformConfig	Platform-specific parameter structure

Returns: ASR Rack

Description:: Create an ASR Rack.
Be sure to destroy the ASR Rack created by this function with the Dispose function.
If platform-specific parameters are not needed, specify null for platformConfig.

CriAtomExAsrRack	(	Config	config,
		PlatformConfig	platformConfig
	)

inline

Creating an ASR Rack

Deprecated:: 削除予定の非推奨APIです。 CriWare.CriAtomExAsrRack.CriAtomExAsrRack(Config, IPlatformConfig) の使用を検討してください。

Parameters

config	Config structure
platformConfig	Platform-specific parameter structure

Returns: ASR Rack

Description:: Creates an ASR Rack.
Be sure to discard the ASR Rack created by this function using the Dispose function.

Member Function Documentation

void AttachDspBusSetting ( string settingName )

inline

Attaching the DSP bus settings

Parameters

settingName Name of the DSP bus setting

Description:: Build DSP buses from the DSP bus settings and attach them to the ASR Rack.
To execute this function, it is necessary to register the ACF information with the CriAtomEx::RegisterAcf function in advance.

Note:: This function is a return-on-complete function.
Calling this function blocks the server processing of the Atom library for a while.
If this function is called during sound playback, problems such as sound interruption may occur, so call this function at a timing when load fluctuations is accepted such as when switching scenes.

See also: CriAtomExAsrRack::DetachDspBusSetting, CriAtomEx::RegisterAcf

void DetachDspBusSetting ( )

inline

Detaches the DSP bus settings

Description:: Detaches the DSP bus settings.

Note:: This function is a return-on-complete function.
Calling this function blocks the server processing of the Atom library for a while.
If this function is called during sound playback, problems such as sound interruption may occur, so call this function at a timing when load fluctuations is accepted such as when switching scenes.

See also: CriAtomExAsrRack::AttachDspBusSetting

void ApplyDspBusSnapshot	(	string	snapshotName,
		int	timeMs
	)

inline

Applies the DSP bus snapshot

Parameters

snapshotName	DSP bus snapshot name
timeMs	The time (in milliseconds) until the snapshot is fully reflected

Description:: Applies the DSP bus snapshot to the ASR Rack.
When this function is called, the parameter values progressively change to the values saved in the snapshot. It takes timeMs milliseconds to complete the change.

static string GetAppliedDspBusSnapshotName ( CriAtomExAsrRackId rackId )

inlinestatic

Gets the snapshot's name

Parameters

rackId Rack ID

Returns: Snapshot name

Description:: Gets the current snapshot name. Returns null if none was set.

string GetAppliedDspBusSnapshotName ( )

inline

Gets the snapshot's name

Returns: Snapshot name

Description:: Gets the current snapshot name. Returns null if none was set.

PerformanceInfo GetPerformanceInfo ( )

inline

Gets the performance information for the ASR rack

Returns: ASR Rack performance information

Description:: Gets performance information from the current ASR Rack instance.

See also: CriAtomExAsrRack::ResetPerformanceMonitor, CriAtomExAsrRack::GetPerformanceInfoByRackId

static PerformanceInfo GetPerformanceInfoByRackId ( CriAtomExAsrRackId rackId = CriAtomExAsrRack.defaultRackId )

inlinestatic

Gets the performance information for the ASR rack

Parameters

rackId Rack ID

Returns: ASR Rack performance information

Description:: Gets performance information for the ASR Rack with the specified ID.
If no Rack ID is specified, performance information for the default ASR Rack (created during the initialization of the library) will be returned.
If an invalid Rack ID is specified, all the members of the structure returned will be set to 0.

See also: CriAtomExAsrRack::ResetPerformanceMonitorByRackId, CriAtomExAsrRack::GetPerformanceInfo

void ResetPerformanceMonitor ( )

inline

Resets the performance measurements for the ASR rack

Description:: Resets the performance measurement of the current ASR Rack instance.

See also: CriAtomExAsrRack::GetPerformanceInfo, CriAtomExAsrRack::ResetPerformanceMonitorByRackId

static void ResetPerformanceMonitorByRackId ( CriAtomExAsrRackId rackId = CriAtomExAsrRack.defaultRackId )

inlinestatic

Resets the performance measurements for the ASR rack

Parameters

rackId Rack ID

Description:: Resets the performance measurement of the ASR Rack with the specified ID.
If no Rack ID is specified, the performance information of the default ASR Rack (created during the initialization of the library) will be reset.

See also: CriAtomExAsrRack::GetPerformanceInfoByRackId, CriAtomExAsrRack::ResetPerformanceMonitor

static void SetAisacControl	(	CriAtomExAsrRackId	rackId,
		string	controlName,
		float	value
	)

inlinestatic

Setting the AISAC control value by name

Parameters

rackId	Rack ID
controlName	AISAC control name
value	AISAC control value

Description:: Sets the AISAC control value by name.

static void SetAisacControl	(	CriAtomExAsrRackId	rackId,
		int	controlId,
		float	value
	)

inlinestatic

Setting AISAC control value by specifying an ID

Parameters

rackId	Rack ID
controlId	AISAC control ID
value	AISAC control value

Description:: Sets the AISAC control value by specifying an ID.

static void SetDefaultConfig ( ref Config config )

inlinestatic

Set the default parameters

Parameters

config Initialization config

Description:: Assign the default parameters to the initialization configuration structure used by CriWare.CriAtomExAsrRack.CriAtomExAsrRack.

override void Dispose ( )

inline

Discards an ASR Rack

Description:: Discards an ASR Rack.

static void GetNumRenderedSamples	(	CriAtomExAsrRackId	rackId,
		out Int64	numSamples,
		out Int32	samplingRate
	)

inlinestatic

Get the total number of samples rendered by the ASR rack

Parameters

rackId	Rack ID
numSamples	Number of samples rendered
samplingRate	Sampling rate

Description:: Get the number of rendered samples and the sampling rate of the ASR rack.

Note:: The increase in the number of rendered samples resulting from calling this function may vary depending on the target platform and output device.

static CriAtomExAsrRackId GetAmbisonicRackId ( )

inlinestatic

Get the ASR rack ID for Ambisonics playback

Returns: ASR Rack ID

Description:: Get the ID of the ASR Rack used for Ambisonics playback.
The ID returned can be used to access the CriAtomExAsrRack via CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId).

An ASR Rack for Ambisonics playback is automatically created by registering an ACF that has the output port set as "_ambisonics".
The ASR Rack ID returned is only valid while an ACF is registered.
If the ACF is unregistered, the ASR Rack for Ambisonics playback will be deleted, and the ASR Rack ID will become invalid.
If an ASR Rack for Ambisonics playback has not been created yet, CriAtomExAsrRack.IllegalRackId is returned.

See also: CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)

static CriAtomExAsrRackId GetChannelBasedAudioRackId ( )

inlinestatic

Get the ASR Rack ID for channel-based playback

Returns: ASR Rack ID

Description:: Get the ID of the ASR Rack used for channel-based playback.
The ID returned can be used to access the CriAtomExAsrRack object via CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId).

The ASR Rack for channel-based playback is automatically created by registering an ACF for which "Use dedicated mixer" is set to Ttue and the output port is set as "_7_1_4".
The ASR Rack ID returned is only valid while the ACF is registered.
If the ACF is unregistered, the ASR Rack for channel-based playback will be deleted, and the ASR Rack ID will become invalid.
If an ASR Rack for channel-based playback has not been created yet, CriAtomExAsrRack.IllegalRackId is returned.

See also: CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)

static CriAtomExAsrRackId GetObjectBasedAudioRackId ( )

inlinestatic

Get the ASR rack ID for ObjectBasedAudio playback

Returns: ASR Rack ID

Description:: Get the ID of the ASR Rack used for ObjectBasedAudio playback.
The ID returned can be used to access the CriAtomExAsrRack object via CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId).

An ASR Rack for ObjectBasedAudio playback is automatically created by registering an ACF that has the output port set as "_object_based_audio".
The ASR Rack ID returned is only valid while an ACF is registered.
If the ACF is unregistered, the ASR Rack for ObjectBasedAudio will be deleted, and the ASR Rack ID will become invalid.
If an ASR Rack for ObjectBasedAudio playback has not been created yet, CriAtomExAsrRack.IllegalRackId is returned.

See also: CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)

static CriAtomExAsrRackId GetPassThroughRackId ( )

inlinestatic

Get the ASR rack ID for pass-through playback

Returns: ASR Rack ID

Description:: Get the ID of the ASR Rack used for pass-through playback.
The ID returned can be used to access the CriAtomExAsrRack object via CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId).
The ASR Rack for pass-through playback is automatically created by registering an ACF that has the output port set as "_pass_through".
The ASR Rack ID returned is only valid while the ACF is registered.
If the ACF is unregistered, the ASR Rack for pass-through playback will be deleted, and the ASR Rack ID will become invalid.
If an ASR Rack for pass-through playback has not been created yet, CriAtomExAsrRack.IllegalRackId is returned.

See also: CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)

static void SetDeviceId_WASAPI	(	CriAtomExAsrRackId	rackId,
		string	busName,
		string	deviceId
	)

inlinestatic

Setting the device ID

Parameters

rackId	ASR Rack ID
busName	Name of the bus to be set
deviceId	Device ID

Description:: Sets the device ID to which audio is output from the ASR rack.

static void SetDeviceId_WASAPI	(	CriAtomExAsrRackId	rackId,
		string	busName,
		int	index
	)

inlinestatic

Setting the device ID

Parameters

rackId	ASR Rack ID
busName	Name of the bus to be set
index	Device index

Description:: Sets the device ID to which audio is output from the ASR rack.
Before calling this function, call CriAtomEx::LoadAudioDeviceList_PC to initialize the device list within the plugin.

static void SetHapticDeviceId_PC	(	CriAtomExAsrRackId	rackId,
		string	busName,
		int	index,
		CriAtom.HapticDeviceType_WASAPI	deviceType
	)

inlinestatic

Setting the device ID

Parameters

rackId	ASR Rack ID
busName	Name of the bus to be set
index	Device index
deviceType	Haptics device type

Description:: Specifies the haptics device ID and its type for the ASR rack.
Before calling this function, call CriAtomEx::LoadAudioDeviceList_PC to initialize the device list within the plugin.

Member Data Documentation

const CriAtomExAsrRackId defaultRackId = 0

Default ASR Rack ID

Description:: Default ASR Rack ID. When returning to normal output or discarding the generated ASR Rack, use this constant for each player to specify the ASR Rack ID.

See also: CriAtomExPlayer::SetAsrRackId, CriMana::Player::SetAsrRackId

const CriAtomExAsrRackId IllegalRackId = -1

Invalid Rack ID

Description:: The default ASR Rack ID. This is the value returned when the creation of an ASR Rack fails.

Property Documentation

CriAtomExAsrRackId rackId

get

Get the ASR Rack ID

Description:: Get the ID of the ASR Rack object.

CriAtomExAsrRack Default

staticget

Default ASR Rack

Description:: This is the ASR rack that is automatically created during initialization.

Config defaultConfig = new CriAtomExAsrRack(defaultRackId)

staticget

Default configuration

Deprecated:: 削除予定の非推奨APIです。 CriWare.CriAtomExAsrRack.Config.Default の使用を検討してください。

Description:: Default config.

Note:: Change the default configuration obtained using this property

See also: CriAtomExAsrRack::CriAtomExAsrRack

The documentation for this class was generated from the following file:

CriAtomExAsrRack.cs

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation