Skip to main content

GameCaptureSource

Struct GameCaptureSource 

Source
pub struct GameCaptureSource { /* private fields */ }
Available on Windows only.
Expand description

This struct is essentially a wrapper around an OBS source with additional functionality specific to the custom source.

It provides methods to create an updater and access source-specific signals.

Implementations§

Source§

impl GameCaptureSource

Source

pub fn create_updater<'a>( &'a mut self, ) -> Result<GameCaptureSourceUpdater<'a>, ObsError>

Source§

impl GameCaptureSource

Source

pub fn inner_source(&self) -> &ObsSourceRef

Source

pub fn inner_source_mut(&mut self) -> &mut ObsSourceRef

Source

pub fn into_inner_source(self) -> ObsSourceRef

Consumes self and returns the inner ObsSourceRef

You can still update this source (if created by libobs-simple) and create an updater like so:

let updater = my_custom_source.create_updater()?;

let source = my_custom_source.into_inner_source();
let updater = source.create_updater::<MyCustomSourceUpdater>()?;

Trait Implementations§

Source§

impl Clone for GameCaptureSource

Source§

fn clone(&self) -> GameCaptureSource

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GameCaptureSource

Source§

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

Formats the value using the given formatter. Read more
Source§

impl ObsHookableSourceTrait for GameCaptureSource

Source§

impl ObsObjectTrait<*mut obs_source> for GameCaptureSource

Source§

fn name(&self) -> ObsString

Source§

fn id(&self) -> ObsString

Source§

fn runtime(&self) -> &ObsRuntime

Source§

fn settings(&self) -> Result<ImmutableObsData, ObsError>

Source§

fn hotkey_data(&self) -> Result<ImmutableObsData, ObsError>

Source§

fn update_settings(&self, settings: ObsData) -> Result<(), ObsError>

Updates the settings of this output. Fails if active.
Source§

fn as_ptr(&self) -> SmartPointerSendable<*mut obs_source>

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 create_updater<'a, T>(&'a mut self) -> Result<T, ObsError>
where T: ObsObjectUpdater<'a, K, ToUpdate = Self> + Send + Sync, Self: Sized + Send + Sync,

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

impl ObsSourceTrait for GameCaptureSource

Source§

fn signals(&self) -> &Arc<ObsSourceSignals>

Source§

fn get_active_filters(&self) -> Result<Vec<ObsFilterGuardPair>, ObsError>

Source§

fn apply_filter(&self, filter: &ObsFilterRef) -> Result<(), ObsError>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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.

§

impl<T, K> ObsObjectClone<K> for T
where K: Clone, T: ObsObjectTrait<K> + Clone + 'static,

§

fn clone_box(&self) -> Box<dyn ObsObjectTrait<K>>

§

impl<K> ObsPropertyObject for K
where K: ObsSourceTrait,

§

fn get_properties(&self) -> Result<HashMap<String, ObsProperty>, ObsError>

Returns the properties of the object
§

fn get_properties_by_source_id<T>( id: T, runtime: &ObsRuntime, ) -> Result<HashMap<String, ObsProperty>, ObsError>
where T: Into<ObsString> + Sync + Send,

§

impl<K> ObsPropertyObjectPrivate for K
where K: ObsSourceTrait,

§

fn get_properties_raw( &self, ) -> Result<SmartPointerSendable<*mut obs_properties>, ObsError>

§

fn get_properties_by_id_raw<T>( id: T, runtime: ObsRuntime, ) -> Result<SmartPointerSendable<*mut obs_properties>, ObsError>
where T: Into<ObsString> + Sync + Send,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.