Struct obws::client::Transitions

pub struct Transitions<'a> { /* private fields */ }

API functions related to transitions.

Implementations

impl<'a> Transitions<'a>

pub async fn list_kinds(&self) -> Result<Vec<String>>

Gets an array of all available transition kinds.

pub async fn list(&self) -> Result<SceneTransitionList>

Gets an array of all scene transitions in OBS.

pub async fn current(&self) -> Result<CurrentSceneTransition>

Gets information about the current scene transition.

pub async fn set_current(&self, name: &str) -> Result<()>

Sets the current scene transition.

Small note: While the namespace of scene transitions is generally unique, that uniqueness is not a guarantee as it is with other resources like inputs.

pub async fn set_current_duration(&self, duration: Duration) -> Result<()>

Sets the duration of the current scene transition, if it is not fixed.

pub async fn set_current_settings<T>( &self, settings: T, overlay: Option<bool> ) -> Result<()>

where T: Serialize,

Sets the settings of the current scene transition.

pub async fn current_cursor(&self) -> Result<f32>

Gets the cursor position of the current scene transition.

Note: transitionCursor will return 1.0 when the transition is inactive.

pub async fn trigger(&self) -> Result<()>

Triggers the current scene transition. Same functionality as the Transition button in studio mode.

pub async fn set_tbar_position( &self, position: f32, release: Option<bool> ) -> Result<()>

Sets the position of the T-Bar.

Very important note: This will be deprecated and replaced in a future version of obs-websocket.