A config structure for creating an AuxIn
More...
A config structure for creating an AuxIn
- Description:
- A structure for specifying the behavior for creating an AuxIn handle for capturing sound.
Specify it as an argument at the time of creation.
The created AuxIn handle reserves as many internal resources as necessary, depending on the settings specified in this structure when the handle is created.
The size of the work area required for the player varies according to the parameters specified in this structure.
Maximum number of output channels
- Description:
- Specifies the number of sound channels to be played by the AtomIn player.
The created AuxIn can play sound data that is "equal to or less than" the number of channels specified with max_channels.
The relationship between the value specified as the maximum number of output channels and the data that can be played back by the created AuxIn is as follows:
| Maximum number of output channels (specified value) | Data that can be played by the created AuxIn |
| 1 | Mono |
| 2 | Mono, stereo |
| 6 | Mono, stereo, 5.1ch |
| 8 | Mono, stereo, 5.1ch, 7.1ch |
- Note:
- For platforms that use hardware resources when outputting sound, it is possible to reduce the consumption of hardware resources by reducing the number of output channels.
- Note:
- Data exceeding the specified maximum number of output channels cannot be played.
For example, if the maximum number of output channels is set to 1, the created AuxIn cannot play stereo sound.
(It will not be downmixed to monaural and output.)
Maximum sampling rate
- Description:
- Specifies the sampling rate of the sound played by the AuxIn.
The created AuxIn can play sound data that is "equal to or less than" the sampling rate specified with max_sampling_rate.
- Note:
- By lowering the maximum sampling rate, it is possible to reduce the size of the work memory required when creating AuxIn.
- Note:
- Data that exceeds the specified maximum sampling rate cannot be played.
For example, if the maximum sampling rate is set to 24000, the created AuxIn cannot play sound with 48000Hz.
(It is not down-sampled and output.)
Sound renderer type
- Description:
- Specifies the type of the sound renderer to be used by AuxIn.
When set to CriAtomEx.SoundRendererType.Native, the sound data is sent to the sound output of each platform.
When set to CriAtomEx.SoundRendererType.Asr, the sound data is sent to ASR (Atom Sound Renderer).
(The destination of ASR is specified separately when ASR is initialized.)
The documentation for this struct was generated from the following file:
