Skip to main content

PluginContext

Struct PluginContext 

Source
pub struct PluginContext { /* private fields */ }
Expand description

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§

Source§

impl PluginContext

Source

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.

Source

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

Source

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

Source

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.