FQLab.PluginContracts.IAudioPlugin Interface Reference

Defines the contract for third party plugins. More...

Inheritance diagram for FQLab.PluginContracts.IAudioPlugin:

Collaboration diagram for FQLab.PluginContracts.IAudioPlugin:

Public Member Functions
void	Process (ref float[] samples, AudioFormat format)
	Passes a reference to the current set of samples for the plugin to modify.

Properties
string	Name [get]
	Gets the display name of the plugin.

Detailed Description

Defines the contract for third party plugins.

Member Function Documentation

Process()

void FQLab.PluginContracts.IAudioPlugin.Process	(	ref float[]	samples,
		AudioFormat	format
	)

Passes a reference to the current set of samples for the plugin to modify.

Parameters

samples	Audio samples to process. To be modified in-place.
format	Exposes the metadata of the stream that is providing samples.

Implemented in HallEcho.HallEcho, and WobbleTremolo.WobbleTremolo.

Property Documentation

Name

string FQLab.PluginContracts.IAudioPlugin.Name

get

Gets the display name of the plugin.

Implemented in HallEcho.HallEcho, and WobbleTremolo.WobbleTremolo.

---

The documentation for this interface was generated from the following file:

• contracts/FQLab.PluginContracts/AudioPluginContracts.cs