Struct ObsSourceRef

pub struct ObsSourceRef { /* private fields */ }

Implementations

impl ObsSourceRef

pub async fn new<T: Into<ObsString> + Sync + Send, K: Into<ObsString> + Sync + Send>( id: T, name: K, settings: Option<ObsData>, hotkey_data: Option<ObsData>, runtime: ObsRuntime, ) -> Result<Self, ObsError>

pub fn settings(&self) -> &ImmutableObsData

pub fn hotkey_data(&self) -> &ImmutableObsData

pub fn name(&self) -> String

pub fn id(&self) -> String

pub fn signal_manager(&self) -> Arc<ObsSourceSignals>

Trait Implementations

impl Clone for ObsSourceRef

fn clone(&self) -> ObsSourceRef

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ObsSourceRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ObsPropertyObject for ObsSourceRef

fn get_properties<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<ObsProperty>, ObsError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the properties of the object

fn get_properties_by_id<'life0, 'async_trait, T>( id: T, runtime: &'life0 ObsRuntime, ) -> Pin<Box<dyn Future<Output = Result<Vec<ObsProperty>, ObsError>> + Send + 'async_trait>>

where T: 'async_trait + Into<ObsString> + Sync + Send, Self: Send + 'async_trait, 'life0: 'async_trait,

impl ObsPropertyObjectPrivate for ObsSourceRef

fn get_properties_raw<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Sendable<*mut obs_properties_t>, ObsError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn get_properties_by_id_raw<'async_trait, T>( id: T, runtime: ObsRuntime, ) -> Pin<Box<dyn Future<Output = Result<Sendable<*mut obs_properties_t>, ObsError>> + Send + 'async_trait>>

where T: 'async_trait + Into<ObsString> + Sync + Send,

impl ObsUpdatable for ObsSourceRef

fn update_raw<'life0, 'async_trait>( &'life0 mut self, data: ObsData, ) -> Pin<Box<dyn Future<Output = Result<(), ObsError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn reset_and_update_raw<'life0, 'async_trait>( &'life0 mut self, data: ObsData, ) -> Pin<Box<dyn Future<Output = Result<(), ObsError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn runtime(&self) -> ObsRuntime

fn get_settings<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ImmutableObsData, ObsError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn create_updater<'a, 'async_trait, T>( &'a mut self, ) -> Pin<Box<dyn Future<Output = Result<T, ObsError>> + Send + 'async_trait>>

where Self: Sized + Send + Sync + Send + 'async_trait, T: 'async_trait + ObsObjectUpdater<'a, ToUpdate = Self> + Send + Sync, 'a: 'async_trait,

Updates the object with the current settings. For examples please take a look at the Github repository.