Struct ObsContext

pub struct ObsContext { /* private fields */ }

Interface to the OBS context. Only one context can exist across all threads and any attempt to create a new context while there is an existing one will error.

Note that the order of the struct values is important! OBS is super specific about how it does everything. Things are freed early to latest from top to bottom.

Implementations

impl ObsContext

pub fn startup_info(&self) -> &Arc<RwLock<StartupInfo>>

pub fn displays( &self, ) -> &Arc<RwLock<HashMap<usize, Arc<Pin<Box<ObsDisplayRef>>>>>>

pub fn outputs(&self) -> &Arc<RwLock<Vec<ObsOutputRef>>>

pub fn scenes(&self) -> &Arc<RwLock<Vec<ObsSceneRef>>>

pub fn runtime(&self) -> &ObsRuntime

pub fn displays_mut( &mut self, ) -> &mut Arc<RwLock<HashMap<usize, Arc<Pin<Box<ObsDisplayRef>>>>>>

pub fn outputs_mut(&mut self) -> &mut Arc<RwLock<Vec<ObsOutputRef>>>

pub fn scenes_mut(&mut self) -> &mut Arc<RwLock<Vec<ObsSceneRef>>>

impl ObsContext

pub fn builder() -> StartupInfo

pub async fn new(info: StartupInfo) -> Result<ObsContextReturn, ObsError>

Initializes libobs on the current thread.

Note that there can be only one ObsContext initialized at a time. This is because libobs is not completely thread-safe.

Also note that this might leak a very tiny amount of memory. As a result, it is probably a good idea not to restart the OBS context repeatedly over a very long period of time. Unfortunately the memory leak is caused by a bug in libobs itself.

If the bootstrapper feature is enabled, and ObsContextReturn::Restart is returned, the application must be restarted to apply the updates and initialization can not continue.

pub async fn get_version(&self) -> Result<String, ObsError>

pub fn log(&self, level: ObsLogLevel, msg: &str)

pub async fn reset_video(&mut self, ovi: ObsVideoInfo) -> Result<(), ObsError>

Resets the OBS video context. This is often called when one wants to change a setting related to the OBS video info sent on startup.

It is important to register your video encoders to a video handle after you reset the video context if you are using a video handle other than the main video handle. For convenience, this function sets all video encoder back to the main video handler by default.

Note that you cannot reset the graphics module without destroying the entire OBS context. Trying so will result in an error.

pub async fn get_video_ptr( &self, ) -> Result<Sendable<*mut video_output>, ObsError>

pub async fn get_audio_ptr( &self, ) -> Result<Sendable<*mut audio_output>, ObsError>

pub async fn data(&self) -> Result<ObsData, ObsError>

pub async fn output( &mut self, info: OutputInfo, ) -> Result<ObsOutputRef, ObsError>

pub async fn display( &mut self, data: ObsDisplayCreationData, ) -> Result<Pin<Box<ObsDisplayRef>>, ObsError>

Creates a new display and returns its ID.

pub async fn remove_display(&mut self, display: &ObsDisplayRef)

pub async fn remove_display_by_id(&mut self, id: usize)

pub async fn get_display_by_id( &self, id: usize, ) -> Option<Arc<Pin<Box<ObsDisplayRef>>>>

pub async fn get_output(&mut self, name: &str) -> Option<ObsOutputRef>

pub async fn update_output( &mut self, name: &str, settings: ObsData, ) -> Result<(), ObsError>

pub async fn scene<T: Into<ObsString> + Send + Sync>( &mut self, name: T, ) -> Result<ObsSceneRef, ObsError>

pub async fn get_scene(&mut self, name: &str) -> Option<ObsSceneRef>

pub async fn source_builder<T: ObsSourceBuilder, K: Into<ObsString> + Send + Sync>( &self, name: K, ) -> Result<T, ObsError>

Trait Implementations

impl Clone for ObsContext

fn clone(&self) -> ObsContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObsContext

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

Formats the value using the given formatter.

impl ObsBootstrap for ObsContext

fn is_valid_installation() -> Result<bool>

fn is_update_available() -> Result<bool>

impl ObsContextEncoders for ObsContext

fn get_best_video_encoder<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ObsVideoEncoderType, ObsError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn get_best_audio_encoder<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ObsAudioEncoderType, ObsError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn get_available_audio_encoders<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<ObsAudioEncoderType>, ObsError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn get_available_video_encoders<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<ObsVideoEncoderType>, ObsError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,