Class OdinRmsComponent

Custom RMS dBFS component for OdinNative.Wrapper.Media.CustomEffect

This class is an effect in the odin audio pipeline to calculate Root Mean Square (RMS) averaging with the decibels relative to full scale (dBFS).

Declaration

[HelpURL("https://docs.4players.io/voice/unity/next/api/OdinNative.Unity.Audio/OdinRmsComponent/")]
[AddComponentMenu("Odin/Audio/Effect/RMS dBFS")]
public class OdinRmsComponent : OdinCustomEffectUnityComponentBase<nint>, IOdinEffect

Inheritance: System.Object -> UnityEngine.Object -> UnityEngine.Component -> UnityEngine.Behaviour -> UnityEngine.MonoBehaviour -> OdinNative.Unity.Audio.OdinCustomEffectUnityComponentBase<U>

Implements:
OdinNative.Unity.Audio.IOdinEffect

Fields

RmsDbfs

Declaration

[Tooltip("Root Mean Square (RMS) averaging with the decibels relative to full scale (dBFS)")]
public float RmsDbfs

Methods

GetEffectUserData()

Get userdata used for the OdinNative.Unity.Audio.OdinCustomEffectUnityComponentBase

Declaration

public override nint GetEffectUserData()

Returns

System.IntPtr: effect userdata

CustomEffectCallback(OdinTArray<float>, ref bool, nint)

Callback delegate for the effect

Declaration

public override void CustomEffectCallback(NativeBindings.OdinTArray<float> audio, ref bool isSilent, nint _)

Parameters

Type	Name	Description
OdinNative.Core.Imports.NativeBindings.OdinTArray<T>	audio	audio data wrapper for copy buffer to native
System.Boolean	isSilent	flag whether the buffer contains silence, can be set to mute the frame
System.IntPtr	_	effect userdata, see OdinNative.Unity.Audio.OdinCustomEffectUnityComponentBase

Implements

• OdinNative.Unity.Audio.IOdinEffect