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_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 get_scene_source_ptr( &self, ) -> Result<Sendable<*mut obs_source_t>, ObsError>

Gets the underlying source pointer of this scene, which is used internally when setting it to a channel.

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

pub fn name(&self) -> ObsString

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

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 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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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_mut( &self, name: &str, ) -> Result<Option<Arc<Box<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_scene_item<K: SceneItemTrait>( &mut self, scene_item: K, ) -> Result<(), ObsError>

Removes a specific scene item from this scene.

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

Removes all sources from this scene.

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

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

impl Eq for ObsSceneRef