CRIWARE Unity Plugin Manual  Last Updated: 2024-07-12
CriAtomExMic.Config Struct Reference

A config structure for creating an AtomEx microphone More...

Public Attributes

string deviceId
 Device ID More...
 
uint flags
 Creation flag More...
 
int numChannels
 The number of channels More...
 
int samplingRate
 Sampling rate More...
 
uint frameSize
 Frame size (number of samples) More...
 
uint bufferingTime
 Buffer size (ms) More...
 
IntPtr context
 Platform context More...
 

Properties

static Config Default [get]
 Default setting More...
 

Detailed Description

A config structure for creating an AtomEx microphone

Description:
A structure for specifying the behavior for creating an AtomEx microphone.
It is specified as an argument of the CriWare.CriAtomExMic::Create function.
See also
CriAtomExMic::Create

Member Data Documentation

string deviceId

Device ID

Description:
A string which indicates the identifier of the platform audio input device.
Specify CRIATOMMIC_DEFAULT_DEVICE_ID if you don't want to specify one.
See also
CriAtomExMic::Create, CriAtomExMic::GetDevices
uint flags

Creation flag

Description:
A flag that is referenced when creating an audio input device.
int numChannels

The number of channels

Description:
The number of channels required for audio input. The default is 1.
The creation fails if you specify an unsupported number of channels.
See also
CriAtomExMic::IsFormatSupported
int samplingRate

Sampling rate

Description:
The sampling frequency required for audio input. The default is 44100.
The creation fails if you specify a non-supported sampling frequency.
See also
CriAtomExMic::IsFormatSupported
uint frameSize

Frame size (number of samples)

Description:
The number of samples indicating the size of 1 frame. The default is 256.
This is the processing unit of the effect for which CriWare.CriAtomExMic::AttachEffect was called.
uint bufferingTime

Buffer size (ms)

Description:
The size of the buffer maintained internally. The default is 50msec.
This is the processing unit of the effect for which CriWare.CriAtomExMic::AttachEffect was called.
IntPtr context

Platform context

Description:
It is not used at this time.

Property Documentation

Config Default
staticget

Default setting

Description:
The default setting for the config structure.

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