Developer Documentation

OdinCustomEffectUnityComponentBase<U>

public abstract class OdinCustomEffectUnityComponentBase<U> : MonoBehaviour, IOdinEffect where U : struct

Custom base component for Media

This convenient class provides effect template with a passthrough of custom userdata on a callback. The abstract representation of a base custom effect is to simplify implementation of Audio as a Unity component. (see other predefined custom effects)

Properties

NameDescription
MediaGet Media
EffectGet base effect
IsCreatedFlag if the effect was added to the pipeline
IsEnabledFlag if the component is active or use isActiveAndEnabled
DestroyOnError

Public Methods

NameDescription
GetEffectUserDataGet userdata used for the OdinCustomEffectUnityComponentBase%601
CustomEffectCallbackCallback delegate for the effect
ResetEffectRemoves an effect from the pipeline and add a new effect with callbacks
GetMediaGet Media
GetEffectGet custom effect