Trait PluginBase 

pub trait PluginBase {
    // Provided methods
    fn on_load(&mut self) -> Result<()> { ... }
    fn get_info(&self) -> PluginInfo { ... }
    fn on_parameter(&mut self, id: i32) -> Result<()> { ... }
    fn on_get_parameter_string(&self, id: i32) -> Result<String> { ... }
}

Base plugin trait that all plugin types implement

Provided Methods

fn on_load(&mut self) -> Result<()>

Called when the plugin is loaded

Examples found in repository

examples/simple_dsp.rs (line 89)

fn main() {
    println!("VirtualDJ Rust SDK - Simple Gain Plugin Example");
    println!("This example demonstrates a basic DSP plugin structure.");
    
    let mut plugin = GainPlugin::new();
    if let Ok(()) = plugin.on_load() {
        println!("✓ Plugin loaded successfully");
    }
    
    let info = plugin.get_info();
    println!("\nPlugin Information:");
    println!("  Name: {}", info.name);
    println!("  Author: {}", info.author);
    println!("  Description: {}", info.description);
    println!("  Version: {}", info.version);
    
    println!("\nTo use this plugin in a real project:");
    println!("1. Implement DspPlugin trait methods for your audio processing");
    println!("2. Compile with: cargo build --release");
    println!("3. Deploy the resulting DLL to VirtualDJ's plugin directory");
}

fn get_info(&self) -> PluginInfo

Get plugin information

Examples found in repository

examples/simple_dsp.rs (line 93)

fn main() {
    println!("VirtualDJ Rust SDK - Simple Gain Plugin Example");
    println!("This example demonstrates a basic DSP plugin structure.");
    
    let mut plugin = GainPlugin::new();
    if let Ok(()) = plugin.on_load() {
        println!("✓ Plugin loaded successfully");
    }
    
    let info = plugin.get_info();
    println!("\nPlugin Information:");
    println!("  Name: {}", info.name);
    println!("  Author: {}", info.author);
    println!("  Description: {}", info.description);
    println!("  Version: {}", info.version);
    
    println!("\nTo use this plugin in a real project:");
    println!("1. Implement DspPlugin trait methods for your audio processing");
    println!("2. Compile with: cargo build --release");
    println!("3. Deploy the resulting DLL to VirtualDJ's plugin directory");
}

examples/query_vdj_state.rs (line 113)

fn main() {
    println!("VirtualDJ State Query Example");
    println!("=============================\n");
    println!("This example demonstrates how to use PluginContext to query VirtualDJ state.");
    println!("In a real plugin, you would use this pattern in your plugin callbacks.\n");
    
    println!("Example usage patterns:\n");
    
    println!("1. Query track information:");
    println!("   let title = context.get_info_string(\"deck 1 get_title\")?;");
    println!("   let position = context.get_info_double(\"deck 1 get_position\")?;\n");
    
    println!("2. Query cue information:");
    println!("   let has_cue = context.get_info_string(\"deck 1 has_cue 1\")?;");
    println!("   let cue_pos = context.get_info_double(\"deck 1 cue_pos 1\")?;\n");
    
    println!("3. Send commands:");
    println!("   context.send_command(\"deck 1 play\")?;");
    println!("   context.send_command(\"mixer master volume 50\")?;\n");
    
    println!("Note: This example is a reference. To use PluginContext:");
    println!("- You need a valid VirtualDJ plugin pointer");
    println!("- You need access to the VdjCallbacks struct");
    println!("- Typically this is done within your plugin's on_load() or other callbacks\n");
    
    let plugin = StateQueryPlugin::new();
    let info = plugin.get_info();
    println!("Plugin: {} v{}", info.name, info.version);
}

fn on_parameter(&mut self, id: i32) -> Result<()>

Called when a parameter is changed

fn on_get_parameter_string(&self, id: i32) -> Result<String>

Get string representation of a parameter

Implementors