Struct PluginContext 

pub struct PluginContext { /* private fields */ }

Plugin context that provides access to VirtualDJ API functions

This struct holds the plugin pointer and callbacks, allowing safe access to VirtualDJ state information like track metadata, position, BPM, etc.

Example

let context = PluginContext::new(plugin_ptr, &callbacks);
let title = context.get_info_string("deck 1 get_title")?;
let position = context.get_info_double("deck 1 get_position")?;

Implementations

impl PluginContext

pub fn new(plugin: *mut VdjPlugin, callbacks: &VdjCallbacks) -> Self

Create a new plugin context

Arguments

• plugin - Pointer to the VdjPlugin struct
• callbacks - Reference to the VdjCallbacks struct

Safety

The plugin pointer must be valid and the callbacks must remain valid for the lifetime of this context.

pub fn get_info_double(&self, command: &str) -> Result<f64>

Query VirtualDJ for a double/numeric value

Arguments

• command - The VDJ script command (e.g., “deck 1 get_position”)

Returns

A Result containing the numeric value, or an error if the command fails

Examples found in repository

examples/query_vdj_state.rs (line 28)

    pub fn query_deck_info(&self, context: &PluginContext, deck: i32) -> Result<()> {
        // Get track title (like GetInfoText("deck 1 get_title") in C++)
        let title = context.get_info_string(&format!("deck {} get_title", deck))?;
        println!("Deck {} title: {}", deck, title);

        // Get position as a double (like GetInfoDouble("deck 1 get_position") in C++)
        let position = context.get_info_double(&format!("deck {} get_position", deck))?;
        println!("Deck {} position: {}", deck, position);

        // Check if deck is audible
        let audible = context.get_info_string(&format!("deck {} is_audible", deck))?;
        println!("Deck {} is audible: {}", deck, audible);

        Ok(())
    }

    /// Example showing how to iterate through cues and query their properties
    pub fn query_deck_cues(&self, context: &PluginContext, deck: i32) -> Result<()> {
        // Get track title
        let title = context.get_info_string(&format!("deck {} get_title", deck))?;
        
        // Get current position
        let cursor_percent = context.get_info_double(&format!("deck {} get_position", deck))?;
        
        println!("\nQuerying cues for deck {} ({})", deck, title);
        println!("Current position: {:.2}%", cursor_percent * 100.0);

        // Check cues 1-8 (you can extend to 128 like in the C++ version)
        for cue in 1..=8 {
            // Check if cue exists
            let has_cue = context.get_info_string(&format!("deck {} has_cue {}", deck, cue))?;
            
            if has_cue.to_lowercase() != "on" {
                continue;
            }

            // Get cue name
            let cue_name = context.get_info_string(&format!("deck {} cue_name {}", deck, cue))?;
            
            // Get cue position
            let cue_pos = context.get_info_double(&format!("deck {} cue_pos {}", deck, cue))?;
            
            if cue_pos >= 0.0 {
                println!("  Cue {}: {} (position: {:.2}%)", cue, cue_name, cue_pos * 100.0);
            }
        }

        Ok(())
    }

pub fn get_info_string(&self, command: &str) -> Result<String>

Query VirtualDJ for a string value

Arguments

• command - The VDJ script command (e.g., “deck 1 get_title”)

Returns

A Result containing the string value, or an error if the command fails

Examples found in repository

examples/query_vdj_state.rs (line 24)

    pub fn query_deck_info(&self, context: &PluginContext, deck: i32) -> Result<()> {
        // Get track title (like GetInfoText("deck 1 get_title") in C++)
        let title = context.get_info_string(&format!("deck {} get_title", deck))?;
        println!("Deck {} title: {}", deck, title);

        // Get position as a double (like GetInfoDouble("deck 1 get_position") in C++)
        let position = context.get_info_double(&format!("deck {} get_position", deck))?;
        println!("Deck {} position: {}", deck, position);

        // Check if deck is audible
        let audible = context.get_info_string(&format!("deck {} is_audible", deck))?;
        println!("Deck {} is audible: {}", deck, audible);

        Ok(())
    }

    /// Example showing how to iterate through cues and query their properties
    pub fn query_deck_cues(&self, context: &PluginContext, deck: i32) -> Result<()> {
        // Get track title
        let title = context.get_info_string(&format!("deck {} get_title", deck))?;
        
        // Get current position
        let cursor_percent = context.get_info_double(&format!("deck {} get_position", deck))?;
        
        println!("\nQuerying cues for deck {} ({})", deck, title);
        println!("Current position: {:.2}%", cursor_percent * 100.0);

        // Check cues 1-8 (you can extend to 128 like in the C++ version)
        for cue in 1..=8 {
            // Check if cue exists
            let has_cue = context.get_info_string(&format!("deck {} has_cue {}", deck, cue))?;
            
            if has_cue.to_lowercase() != "on" {
                continue;
            }

            // Get cue name
            let cue_name = context.get_info_string(&format!("deck {} cue_name {}", deck, cue))?;
            
            // Get cue position
            let cue_pos = context.get_info_double(&format!("deck {} cue_pos {}", deck, cue))?;
            
            if cue_pos >= 0.0 {
                println!("  Cue {}: {} (position: {:.2}%)", cue, cue_name, cue_pos * 100.0);
            }
        }

        Ok(())
    }

    /// Example showing how to send commands (like SendCommand in C++)
    pub fn send_example_command(&self, context: &PluginContext) -> Result<()> {
        // Play deck 1
        context.send_command("deck 1 play")?;
        println!("Sent: deck 1 play");

        // You can also use the parsed information to make decisions
        let active_deck_str = context.get_info_string("get_activedeck")?;
        let active_deck: i32 = active_deck_str.parse().unwrap_or(1);
        println!("Active deck: {}", active_deck);

        Ok(())
    }

pub fn send_command(&self, command: &str) -> Result<()>

Send a command to VirtualDJ

Arguments

• command - The VDJ script command (e.g., “deck 1 play”)

Returns

Ok(()) if successful, or an error if the command fails

Examples found in repository

examples/query_vdj_state.rs (line 75)

    pub fn send_example_command(&self, context: &PluginContext) -> Result<()> {
        // Play deck 1
        context.send_command("deck 1 play")?;
        println!("Sent: deck 1 play");

        // You can also use the parsed information to make decisions
        let active_deck_str = context.get_info_string("get_activedeck")?;
        let active_deck: i32 = active_deck_str.parse().unwrap_or(1);
        println!("Active deck: {}", active_deck);

        Ok(())
    }