Inworld Audio Module

Overview > Inworld Audio Module Class: InworldAudioModule | Inherits from: MonoBehaviour Abstract base class for all audio processing modules in the Inworld framework. Provides common functionality for audio modules including coroutine management and audio manager access. All audio modules should inherit from this class to integrate with the audio processing pipeline.

​

Properties

• Priority
• Audio

​

Methods

• StartModule
• StopModule

---

​

Audio Processing Pipeline

The InworldAudioModule interfaces are called in a specific order during audio processing:

1. Pre-Processing: OnPreProcessAudio() is called first
2. Collection: OnCollectAudio() gathers audio data from the input buffer
3. Post-Processing: OnPostProcessAudio() processes the collected data
4. Voice Detection: Voice detection runs continuously when enabled
5. Audio Sending: Audio data is sent when the player is speaking

This pipeline runs continuously in the audio coroutine managed by the InworldAudioManager.

​

Constants

The base class defines several audio processing constants:

• k_InputSampleRate (16000) - Standard sample rate for audio input
• k_InputChannels (1) - Number of audio channels (mono)
• k_InputBufferSecond (1) - Buffer duration in seconds
• k_SizeofInt16 (2) - Size of 16-bit integer in bytes

---

​

Interfaces

The InworldAudioModule system uses several interfaces that define different aspects of audio processing. These interfaces are implemented by child classes and called by the InworldAudioManager at specific times:

​

IMicrophoneHandler

Handles microphone recording functionality. Methods:

• ListMicDevices() - Lists available microphone devices
• StartMicrophone() - Called by InworldAudioManager.StartMicrophone()
• StopMicrophone() - Called by InworldAudioManager.StopMicrophone()
• ChangeInputDevice(string deviceName) - Changes the input device
• IsMicRecording (property) - Accessed by InworldAudioManager.IsMicRecording

​

ICollectAudioHandler

Handles audio data collection from the input buffer. Methods:

• OnCollectAudio() - Called by InworldAudioManager.CollectAudio() during the audio coroutine
• ResetPointer() - Called by InworldAudioManager.ResetPointer()

​

IPlayerAudioEventHandler

Handles voice detection and player audio events. Methods:

• OnPlayerUpdate() - Coroutine for continuous player audio updates
• StartVoiceDetecting() - Called by InworldAudioManager.StartVoiceDetecting()
• StopVoiceDetecting() - Called by InworldAudioManager.StopVoiceDetecting()

​

ICalibrateAudioHandler

Handles audio calibration functionality. Methods:

• OnStartCalibration() - Called by InworldAudioManager.StartCalibrate()
• OnStopCalibration() - Called by InworldAudioManager.StopCalibrate()
• OnCalibrate() - Performs the actual calibration process

​

IProcessAudioHandler

Handles audio pre-processing and post-processing. Methods:

• OnPreProcessAudio() - Called by InworldAudioManager.PreProcess() during the audio coroutine
• OnPostProcessAudio() - Called by InworldAudioManager.PostProcess() during the audio coroutine
• ProcessedBuffer (property) - Buffer containing processed audio data

​

ISendAudioHandler

Handles sending audio data to external services. Methods:

• OnStartSendAudio() - Called when InworldAudioManager.IsPlayerSpeaking is set to true
• OnStopSendAudio() - Called when InworldAudioManager.IsPlayerSpeaking is set to false
• Samples (property) - Accessed by InworldAudioManager.OnSendAudio() and InworldAudioManager.PushAudio()

​

Reference

​

Priority

Gets or sets the execution priority of this audio module. Lower values indicate higher priority and will be processed first.

​

Returns

Type: int

---

​

Audio

Gets the InworldAudioManager instance that coordinates audio processing. Automatically finds and caches the audio manager in the scene if not already set.

​

Returns

Type: InworldAudioManager

---

​

StartModule

Starts the module’s processing coroutine. Only one coroutine can be active per module at a time.

​

Parameters

​

Returns

Type: void

---

​

StopModule

Stops the currently running module coroutine and cleans up resources. Safe to call even if no coroutine is currently running.

​

Returns

Type: void

---