voicemeeter 0.3.0

Voicemeeter Remote bindings and abstractions
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

use crate::types::ZIndex;

pub(crate) static STRIP: &str = "Strip";
pub(crate) static BUS: &str = "Bus";
pub(crate) static VOICEMEETER_OPTION: &str = "Option";

/// Parameter is out of range for current program
#[derive(thiserror::Error, Debug, Clone)]
#[error("out of range: {name}({index}) is not supported on `{program}`")]
pub struct OutOfRangeError {
    /// Name of the parameter `base` i.e "Strip" or "Bus"
    pub name: &'static str,
    /// Index that was out of range
    pub index: ZIndex,
    /// Current program
    pub program: super::VoicemeeterApplication,
}

/// Device is invalid for the current program and parameter
#[derive(thiserror::Error, Debug, Clone)]
#[error("invalid device: {device:?} is not supported on `{program}`")]
pub struct DeviceError {
    /// Current program
    pub program: super::VoicemeeterApplication,
    /// Device that was invalid
    pub device: crate::types::Device,
}

/// Invalid strip/bus type for a specific parameter
#[derive(thiserror::Error, Debug, Clone)]
#[non_exhaustive]
pub enum InvalidTypeError {
    /// Expected Physical
    #[error(
        "{name}[{strip_index}] needs to be a physical {name} for access to parameter `{parameter}`"
    )]
    ExpectedPhysical {
        /// Name of the parameter `base` i.e "Strip" or "Bus"
        name: &'static str,
        /// Index that was used
        strip_index: ZIndex,
        /// Parameter that expected a physical strip/bus
        parameter: String,
    },
    /// Expected Virtual
    #[error(
        "{name}[{strip_index}] needs to be a virtual {name} for access to parameter `{parameter}`"
    )]
    ExpectedVirtual {
        /// Name of the parameter `base` i.e "Strip" or "Bus"
        name: &'static str,
        /// Index that was used
        strip_index: ZIndex,
        /// Parameter that expected a physical strip/bus
        parameter: String,
    },
}

/// Invalid Voicemeeter program
#[derive(thiserror::Error, Debug, Clone)]
#[error("{parameter} requires programs {expected:?} to be accessed, program is {found}")]
pub struct InvalidVoicemeeterVersion {
    /// Expected programs
    pub expected: &'static [super::VoicemeeterApplication],
    /// Found program
    pub found: super::VoicemeeterApplication,
    /// Parameter that expected a physical strip/bus
    pub parameter: String,
}

/// Invalid Parameter
#[derive(thiserror::Error, Debug, Clone)]
pub enum ParameterError {
    /// Version is not compatible with parameter
    #[error(transparent)]
    Version(#[from] InvalidVoicemeeterVersion),
    /// Strip/bus is not compatible with parameter
    #[error(transparent)]
    Type(#[from] InvalidTypeError),
    /// Parameter index is out of range
    #[error(transparent)]
    OutOfRange(#[from] OutOfRangeError),
    /// Device is invalid for parameter
    #[error(transparent)]
    Device(#[from] DeviceError),
}