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
impl GameCaptureSource
pub fn create_updater<'a>( &'a mut self, ) -> Result<GameCaptureSourceUpdater<'a>, ObsError>
Source§impl GameCaptureSource
impl GameCaptureSource
pub fn inner_source(&self) -> &ObsSourceRef
pub fn inner_source_mut(&mut self) -> &mut ObsSourceRef
Sourcepub fn into_inner_source(self) -> ObsSourceRef
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()?;
// Or consume the custom wrapper and work with the generic source directly.
let source = my_custom_source.into_inner_source();
let updater = source.create_updater::<MyCustomSourceUpdater>()?;Trait Implementations§
Source§impl Clone for GameCaptureSource
impl Clone for GameCaptureSource
Source§impl Debug for GameCaptureSource
impl Debug for GameCaptureSource
Source§impl ObsHookableSourceTrait for GameCaptureSource
impl ObsHookableSourceTrait for GameCaptureSource
fn source_specific_signals(&self) -> Arc<ObsHookableSourceSignals> ⓘ
Source§impl ObsObjectTrait for GameCaptureSource
impl ObsObjectTrait for GameCaptureSource
fn name(&self) -> ObsString
fn id(&self) -> ObsString
fn runtime(&self) -> &ObsRuntime
fn settings(&self) -> Result<ImmutableObsData, ObsError>
fn hotkey_data(&self) -> Result<ImmutableObsData, ObsError>
Source§fn update_settings(&self, settings: ObsData) -> Result<(), ObsError>
fn update_settings(&self, settings: ObsData) -> Result<(), ObsError>
Updates the settings of this output. Fails if active.
Source§fn create_updater<'a, T>(&'a mut self) -> Result<T, ObsError>
fn create_updater<'a, T>(&'a mut self) -> Result<T, ObsError>
Updates the object with the current settings.
For examples please take a look at the Github repository.
Source§impl ObsSourceTrait for GameCaptureSource
impl ObsSourceTrait for GameCaptureSource
fn signals(&self) -> &Arc<ObsSourceSignals> ⓘ
fn get_active_filters(&self) -> Result<Vec<ObsFilterGuardPair>, ObsError>
fn apply_filter(&self, filter: &ObsFilterRef) -> Result<(), ObsError>
Auto Trait Implementations§
impl !RefUnwindSafe for GameCaptureSource
impl !UnwindSafe for GameCaptureSource
impl Forget for GameCaptureSource
impl Freeze for GameCaptureSource
impl Move for GameCaptureSource
impl Send for GameCaptureSource
impl Sync for GameCaptureSource
impl Unpin for GameCaptureSource
impl UnsafeUnpin for GameCaptureSource
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> ObsMediaSourceExt for Twhere
T: ObsSourceTrait + ?Sized,
impl<T> ObsMediaSourceExt for Twhere
T: ObsSourceTrait + ?Sized,
fn media_play(&self) -> Result<(), ObsError>
fn media_pause(&self) -> Result<(), ObsError>
fn media_set_paused(&self, paused: bool) -> Result<(), ObsError>
fn media_restart(&self) -> Result<(), ObsError>
fn media_stop(&self) -> Result<(), ObsError>
fn media_next(&self) -> Result<(), ObsError>
fn media_previous(&self) -> Result<(), ObsError>
Source§fn media_seek(&self, position: Duration) -> Result<(), ObsError>
fn media_seek(&self, position: Duration) -> Result<(), ObsError>
Requests a media seek to
position. Read morefn media_position(&self) -> Result<Option<Duration>, ObsError>
fn media_duration(&self) -> Result<Option<Duration>, ObsError>
fn media_state(&self) -> Result<MediaState, ObsError>
Source§impl<K> ObsPropertyObject for Kwhere
K: ObsSourceTrait,
impl<K> ObsPropertyObject for Kwhere
K: ObsSourceTrait,
Source§fn get_properties(&self) -> Result<HashMap<String, ObsProperty>, ObsError>
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>
Source§impl<T> ObsSourceAudioExt for Twhere
T: ObsSourceTrait + ?Sized,
impl<T> ObsSourceAudioExt for Twhere
T: ObsSourceTrait + ?Sized,
fn set_volume(&self, volume: LinearVolume) -> Result<(), ObsError>
fn volume(&self) -> Result<LinearVolume, ObsError>
fn set_muted(&self, muted: bool) -> Result<(), ObsError>
fn muted(&self) -> Result<bool, ObsError>
fn set_sync_offset(&self, offset: AudioSyncOffset) -> Result<(), ObsError>
fn sync_offset(&self) -> Result<AudioSyncOffset, ObsError>
Source§fn set_audio_mixes(&self, mixes: AudioMixMask) -> Result<(), ObsError>
fn set_audio_mixes(&self, mixes: AudioMixMask) -> Result<(), ObsError>
Routes this source to the selected native audio mixes/tracks.