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

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

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

pub fn filters(&self) -> &Arc<RwLock<Vec<ObsFilterRef>>>

pub fn runtime(&self) -> &ObsRuntime

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

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

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

pub fn filters_mut(&mut self) -> &mut Arc<RwLock<Vec<ObsFilterRef>>>

impl ObsContext

pub fn check_version_compatibility() -> bool

Checks if the installed OBS version matches the expected version. Returns true if the major version matches, false otherwise.

pub fn builder() -> StartupInfo

pub fn new(info: StartupInfo) -> Result<ObsContext, 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.

On Linux, make sure to call ObsContext::check_version_compatibility before initializing the context. If that method returns false, it may be possible for the binary to crash.

If initialization fails, an ObsError is returned.

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

pub fn get_version_global() -> Result<String, ObsError>

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

pub 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 unsafe fn get_video_ptr( &self, ) -> Result<Sendable<*mut video_output>, ObsError>

Returns a pointer to the video output.

Safety

This function is unsafe because it returns a raw pointer that must be handled carefully. Only use this pointer if you REALLY know what you are doing.

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

Returns a pointer to the audio output.

Safety

This function is unsafe because it returns a raw pointer that must be handled carefully. Only use this pointer if you REALLY know what you are doing.

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

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

pub fn obs_filter(&mut self, info: FilterInfo) -> Result<ObsFilterRef, ObsError>

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

Creates a new display and returns its ID.

You must call update_color_space on the display when the window is moved, resized or the display settings change.

Note: When calling set_size or set_pos, update_color_space is called automatically.

Another note: On Linux, this method is unsafe because you must ensure that every display reference is dropped before your window exits.

pub fn remove_display( &mut self, display: &ObsDisplayRef, ) -> Result<(), ObsError>

pub fn remove_display_by_id(&mut self, id: usize) -> Result<(), ObsError>

pub fn get_display_by_id( &self, id: usize, ) -> Result<Option<ObsDisplayRef>, ObsError>

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

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

pub fn get_filter( &mut self, name: &str, ) -> Result<Option<ObsFilterRef>, ObsError>

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

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

pub 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 duplicate 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 ObsContextEncoders for ObsContext

fn best_video_encoder(&self) -> Result<ObsVideoEncoderBuilder, ObsError>

fn best_audio_encoder(&self) -> Result<ObsAudioEncoderBuilder, ObsError>

fn available_audio_encoders( &self, ) -> Result<Vec<ObsAudioEncoderBuilder>, ObsError>

fn available_video_encoders( &self, ) -> Result<Vec<ObsVideoEncoderBuilder>, ObsError>