libobs-wrapper 9.0.4+32.0.2

A safe wrapper around libobs
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

use std::fmt::Debug;

use crate::{
    data::{ImmutableObsData, ObsData, ObsObjectUpdater},
    macros::trait_with_optional_send_sync,
    runtime::ObsRuntime,
    unsafe_send::SmartPointerSendable,
    utils::{ObsError, ObsString},
};

mod macros;
pub(crate) use macros::*;

/// Helper trait to enable cloning boxed outputs.
pub trait ObsObjectClone<K: Clone> {
    fn clone_box(&self) -> Box<dyn ObsObjectTrait<K>>;
}

impl<T, K: Clone> ObsObjectClone<K> for T
where
    T: ObsObjectTrait<K> + Clone + 'static,
{
    fn clone_box(&self) -> Box<dyn ObsObjectTrait<K>> {
        Box::new(self.clone())
    }
}

impl<K: Clone> Clone for Box<dyn ObsObjectTrait<K>> {
    fn clone(&self) -> Self {
        self.clone_box()
    }
}

trait_with_optional_send_sync! {
    #[doc(hidden)]
    pub trait ObsObjectTraitPrivate: Debug {
        /// Replaces the settings data of the object. This should only be called if the actual OBS object has been updated.
        ///
        /// DO NOT USE THIS METHOD UNLESS YOU KNOW WHAT YOU ARE DOING.
        fn __internal_replace_settings(&self, settings: ImmutableObsData) -> Result<(), ObsError>;
        /// Replaces the hotkey data of the object. This should only be called if the actual OBS object has been updated.
        ///
        /// DO NOT USE THIS METHOD UNLESS YOU KNOW WHAT YOU ARE DOING.
        fn __internal_replace_hotkey_data(&self, hotkey_data: ImmutableObsData)
            -> Result<(), ObsError>;
    }
}

#[allow(private_bounds)]
/// Trait representing an OBS object.
/// A OBs object has an id, a name, `settings` and `hotkey_data`.
pub trait ObsObjectTrait<K: Clone>: ObsObjectClone<K> + ObsObjectTraitPrivate {
    fn runtime(&self) -> &ObsRuntime;
    fn settings(&self) -> Result<ImmutableObsData, ObsError>;
    fn hotkey_data(&self) -> Result<ImmutableObsData, ObsError>;

    fn id(&self) -> ObsString;
    fn name(&self) -> ObsString;

    /// Updates the settings of this output. Fails if active.
    fn update_settings(&self, settings: ObsData) -> Result<(), ObsError>;

    /// Updates the object with the current settings.
    /// For examples please take a look at the [Github repository](https://github.com/libobs-rs/libobs-rs/blob/main/examples).
    fn create_updater<'a, T: ObsObjectUpdater<'a, K, ToUpdate = Self> + Send + Sync>(
        &'a mut self,
    ) -> Result<T, ObsError>
    where
        Self: Sized + Send + Sync,
    {
        let runtime = self.runtime().clone();
        T::create_update(runtime, self)
    }

    /// Creates a new reference to the drop guard.
    /// This is useful if you are using the underlying raw pointer, make sure to store it along the drop guard
    fn as_ptr(&self) -> SmartPointerSendable<K>;
}