Developer Documentation

Audio Capture

Our Unreal Engine Plugin contains these Audio Capture Blueprints:

NameDescription
Construct Local MediaCreates a media object that will be used in the Add Media To Room node input. Connect an Audio Capture or Odin Audio Capture object to it.
Get Capture Devices AvailableReturns all available capture devices with the device id. IMPORTANT! Use the Async version in case you experience stuttering. The Async version runs asynchronously and uses a callback when the result is available.
Get Current Audio Capture DeviceReturns info on the current capture device.
Change Capture Device By IdIMPORTANT! Use the Async version in case you experience stuttering. Updates the capture device and restarts the capture stream of the Audio Capture component. The Async version runs asynchronously and does not block the main thread.
Change Capture Device By NameIMPORTANT! Use the Async version in case you experience stuttering. Updates the capture device and restarts the capture stream of the Audio Capture component. The Async version runs asynchronously and does not block the main thread.
Restart CapturingRestart the stream, using CurrentSelectedDeviceIndex as the new input.
Get and Set Is PausedGet Is Capturing Paused: Returns whether the audio capture is paused. Set Is Capturing Paused: Sets the paused state of the audio capture.
On Capture Device ResetWill be called if ODIN recognizes that the selected capture device does not supply data anymore, i.e., if a microphone was unplugged. ODIN will wait for AllowedTimeWithoutStreamUpdate seconds before trying a stream restart. You can set the AllowedTimeWithoutStreamUpdate parameter on the Odin Audio Capture Object.
On Default Device ChangedWill be called if the Default Device is the currently selected device and if the Default Device was switched by the system.