Effects & Filters
This page centralizes all documentation for audio effects and filters in Yukino, including usage, built-in effects, custom filters, effect chains, utilities, and best practices.
Quick Reference
Basic Usage
Applying Effects
// Apply a single effect
player.effects.apply('bassboost');
// Apply multiple effects
player.effects.applyMany(['nightcore', 'echo']);
// Apply with custom parameters
player.effects.apply('tremolo', {
frequency: 2.0,
depth: 0.5
});
Removing Effects
player.effects.remove('bassboost');
player.effects.removeMany(['nightcore', 'echo']);
player.effects.clear();
Built-in Effects & Filters
Equalizer
// Each band represents a frequency range:
// Band 0: 25Hz ... Band 14: 16000Hz
await player.setEqualizer([
{ band: 0, gain: 0.6 },
{ band: 1, gain: 0.7 },
{ band: 2, gain: 0.8 },
{ band: 3, gain: 0.5 }
]);
// Presets
import { FilterUtil } from 'yukinojs';
const bassBoostEQ = FilterUtil.createBassBoostEQ(0.5);
await player.setEqualizer(bassBoostEQ);
const flatEQ = FilterUtil.createFlatEQ();
await player.setEqualizer(flatEQ);
Karaoke
await player.setKaraoke({
level: 1.0,
monoLevel: 1.0,
filterBand: 220.0,
filterWidth: 100.0
});
await player.clearKaraoke();
Timescale, Nightcore, Vaporwave
await player.setTimescale({ speed: 1.2, pitch: 1.2, rate: 1.0 });
await player.setFilters(FilterUtil.nightcorePreset());
await player.setFilters(FilterUtil.vaporwavePreset());
await player.clearTimescale();
Tremolo, Vibrato, Rotation, 8D
await player.setTremolo({ frequency: 2.0, depth: 0.5 });
await player.setVibrato({ frequency: 2.0, depth: 0.5 });
await player.setRotation({ rotationHz: 0.2 });
await player.setFilters(FilterUtil.eightDimensionalPreset());
Channel Mix, Low Pass
await player.setChannelMix({ leftToLeft: 1.0, leftToRight: 0.0, rightToLeft: 0.0, rightToRight: 1.0 });
await player.setLowPass({ smoothing: 20.0 });
Combining Filters
await player.setFilters({
equalizer: [ { band: 0, gain: 0.6 }, { band: 1, gain: 0.7 } ],
timescale: { speed: 1.2, pitch: 1.2 },
tremolo: { frequency: 2.0, depth: 0.5 }
});
await player.clearFilters();
Effect Chains & Presets
// Chain effects
player.effects.chain()
.add('bassboost', { level: 0.6 })
.add('echo', { delay: 0.3 })
.add('tremolo')
.apply();
// Presets
const preset = { name: 'party', effects: [ ['bassboost', { level: 0.7 }], ['tremolo', { frequency: 3.0 }], ['echo', { delay: 0.2 }] ] };
player.effects.registerPreset(preset);
player.effects.applyPreset('party');
Custom Filters & Utilities
See Custom Filters for:
- FilterUtil class (creation, presets, validation)
- CustomFilterManager (add, update, remove, apply, events)
- Filter interpolation, caching, dynamic generation
- Filter chains and best practices
Real-time Control & Events
player.effects.update('tremolo', { frequency: 5.0, depth: 0.8 });
player.effects.transition('tremolo', { frequency: 6.0, depth: 0.9 }, 2000);
player.effects.on('effectApply', (effect, params) => { ... });
player.effects.on('effectRemove', (effect) => { ... });
player.effects.on('effectUpdate', (effect, params) => { ... });
player.effects.on('error', (error, effect) => { ... });
Best Practices
- Reset filters when changing tracks
- Avoid extreme filter values
- Apply filters gradually for performance
- Save and restore user preferences
- Use filter interpolation for smooth transitions
- Cache complex filter combinations
- Group related filters with tags
- Throttle filter updates for performance
For full details, advanced usage, and code samples, see the Audio Effects & Filters page.