Struct ObsSceneRef 

pub struct ObsSceneRef { /* private fields */ }

This struct holds every ObsSourceRef that is attached to the scene by using add_source.

Implementations

impl ObsSceneRef

pub fn add_discovered_source( &mut self, source_type: &SourceTypeInfo, name: impl Into<ObsString>, settings: Option<ObsData>, ) -> Result<ObsSceneItemRef<ObsSourceRef>, ObsError>

Creates a source from a discovered descriptor and adds it directly to this scene.

impl ObsSceneRef

pub fn create_group( &mut self, name: impl Into<ObsString>, ) -> Result<ObsSceneGroupRef, ObsError>

Creates an empty managed group at the top of this scene.

pub fn groups(&self) -> Result<Vec<ObsSceneGroupRef>, ObsError>

Returns all currently managed groups owned by this scene.

pub fn items_in_order(&self) -> Result<Vec<Arc<dyn SceneItemTrait>>, ObsError>

Returns top-level scene items in libobs’s actual bottom-to-top native order. Items inside a group are enumerated by ObsSceneGroupRef::items_in_order instead.

impl ObsSceneRef

pub fn add_and_set(&self, channel: u32) -> Result<(), ObsError>

👎Deprecated:

Use ObsSceneRef::set_to_channel instead

pub fn set_to_channel(&self, channel: u32) -> Result<(), ObsError>

Sets this scene to a given output channel. There are 64 channels that you can assign scenes to, which will draw on top of each other in ascending index order.

pub fn remove_from_channel(&self, channel: u32) -> Result<(), ObsError>

Removes a scene from a given output channel, for more info about channels see set_to_channel.

pub fn object_id(&self) -> NativeObjectId

pub fn name(&self) -> ObsString

pub fn runtime(&self) -> &ObsRuntime

pub fn signals(&self) -> Arc<ObsSceneSignals>

pub fn add<T>(&mut self, source: T) -> Result<ObsSceneItemRef<T>, ObsError>

where T: ObsSourceTrait + Clone + 'static,

Adds an existing typed source and returns its managed scene-item handle.

pub fn add_new_source( &mut self, info: SourceInfo, ) -> Result<ObsSceneItemRef<ObsSourceRef>, ObsError>

Creates a source from SourceInfo, adds it, and returns the typed scene-item handle.

pub fn remove_item<T: SceneItemTrait + ?Sized>( &mut self, item: &T, ) -> Result<(), ObsError>

Removes a managed item immediately without consuming handles held by the caller.

pub fn items_for_source<T>( &self, source: &T, ) -> Result<Vec<Arc<dyn SceneItemTrait>>, ObsError>

where T: ObsSourceTrait + Clone,

Returns all managed scene items for a source.

pub fn clear(&mut self) -> Result<(), ObsError>

Removes every managed item from this scene.

Trait Implementations

impl Clone for ObsSceneRef

fn clone(&self) -> ObsSceneRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObsSceneRef

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

Formats the value using the given formatter.

impl Eq for ObsSceneRef

impl Hash for ObsSceneRef

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl ObsSceneExtFilter for ObsSceneRef

fn add_scene_filter(&self, filter_ref: &ObsFilterRef) -> Result<(), ObsError>

Adds a filter to the given source in this scene.

fn remove_scene_filter(&self, filter_ref: &ObsFilterRef) -> Result<(), ObsError>

Removes a filter from the this scene (internally removes the filter to the scene’s source).

impl PartialEq for ObsSceneRef

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl SceneItemExtSceneTrait for ObsSceneRef

fn add_source<T: ObsSourceTrait + Clone + 'static>( &mut self, source: T, ) -> Result<ObsSceneItemRef<T>, ObsError>

Adds the specified source to this scene. Returns a reference to the created scene item. You can use that SceneItemPtr to manipulate the source within this scene (position, scale, rotation, etc).

fn add_and_create_source( &mut self, info: SourceInfo, ) -> Result<ObsSceneItemRef<ObsSourceRef>, ObsError>

Creates and adds a source to this scene based on the given SourceInfo. Returns a reference to the created scene item, which internally holds the created source.

fn get_source( &self, name: &str, ) -> Result<Option<Arc<dyn ObsSourceTrait>>, ObsError>

Gets a source by name from this scene. Returns None if no source with the given name exists in this scene.

fn remove_every_item_of_source<T: ObsSourceTrait>( &mut self, source: T, ) -> Result<(), ObsError>

Removes the given source from this scene. Removes the corresponding scene item as well. It may be possible that this source is still added to another scene.

fn remove_item<K: SceneItemTrait + ?Sized>( &mut self, scene_item: &K, ) -> Result<(), ObsError>

Removes a specific scene item from this scene immediately.

fn remove_all_sources(&mut self) -> Result<(), ObsError>

Removes all sources from this scene.

fn items_for_source<T: ObsSourceTrait + Clone>( &self, source: &T, ) -> Result<Vec<Arc<dyn SceneItemTrait>>, ObsError>

Gets the underlying scene item pointers for the given source in this scene.

fn get_source_mut( &self, name: &str, ) -> Result<Option<Arc<dyn ObsSourceTrait>>, ObsError>

👎Deprecated:

Use get_source; the returned shared handle was never a mutable reference

fn remove_scene_item<K: SceneItemTrait>( &mut self, scene_item: K, ) -> Result<(), ObsError>

👎Deprecated:

Use remove_item; it removes the native scene item immediately without consuming the handle

fn get_scene_item_ptr<T: ObsSourceTrait + Clone>( &self, source: &T, ) -> Result<Vec<Arc<dyn SceneItemTrait>>, ObsError>

👎Deprecated:

Use items_for_source; scene item handles are managed objects, not raw pointers