Struct ObsReplayBufferOutputRef 

pub struct ObsReplayBufferOutputRef { /* private fields */ }

A reference to an OBS output.

This struct is used specifically for the replay buffer to manage saving the buffer to a file and configuring special settings, which are specific to the replay buffer

The output is associated with video and audio encoders that convert raw media to the required format before sending/storing.

Implementations

impl ObsReplayBufferOutputRef

pub fn inner_output(&self) -> &ObsOutputRef

pub fn inner_output_mut(&mut self) -> &mut ObsOutputRef

pub fn into_inner_output(self) -> ObsOutputRef

impl ObsReplayBufferOutputRef

pub fn replay_signals(&self) -> &Arc<ObsReplayOutputSignals>

pub fn save_buffer(&self) -> Result<Box<Path>, ObsError>

Saves the current replay buffer content to disk.

Implementation Details

This method:

1. Accesses the OBS procedure handler for the output
2. Calls the “save” procedure to trigger saving the replay
3. Calls the “get_last_replay” procedure to retrieve the saved file path
4. Extracts the path string from the calldata and returns it

Returns

• Ok(Box<Path>) - The path to the saved replay file
• Err(ObsError) - Various errors that might occur during the saving process:
  • Failure to get procedure handler
  • Failure to call “save” procedure
  • Failure to call “get_last_replay” procedure
  • Failure to extract the path from calldata

Trait Implementations

impl Clone for ObsReplayBufferOutputRef

fn clone(&self) -> ObsReplayBufferOutputRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObsReplayBufferOutputRef

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

Formats the value using the given formatter.

impl ObsObjectTrait<*mut obs_output> for ObsReplayBufferOutputRef

fn name(&self) -> ObsString

fn id(&self) -> ObsString

fn runtime(&self) -> &ObsRuntime

fn settings(&self) -> Result<ImmutableObsData, ObsError>

fn hotkey_data(&self) -> Result<ImmutableObsData, ObsError>

fn update_settings(&self, settings: ObsData) -> Result<(), ObsError>

Updates the settings of this output. Fails if active.

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

Creates a new reference to the drop guard. This is useful if you are using the underlying raw pointer, make sure to store it along the drop guard

fn create_updater<'a, T: ObsObjectUpdater<'a, K, ToUpdate = Self> + Send + Sync>( &'a mut self, ) -> Result<T, ObsError>

where Self: Sized + Send + Sync,

Updates the object with the current settings. For examples please take a look at the Github repository.

impl ObsOutputTrait for ObsReplayBufferOutputRef

fn signals(&self) -> &Arc<ObsOutputSignals>

fn video_encoder(&self) -> &Arc<RwLock<Option<Arc<ObsVideoEncoder>>>>

fn audio_encoders(&self) -> &Arc<RwLock<HashMap<usize, Arc<ObsAudioEncoder>>>>

fn get_current_video_encoder( &self, ) -> Result<Option<Arc<ObsVideoEncoder>>, ObsError>

Returns the current video encoder attached to this output, if any.

fn create_and_set_video_encoder( &mut self, info: VideoEncoderInfo, ) -> Result<Arc<ObsVideoEncoder>, ObsError>

Creates and attaches a new video encoder to this output.

fn set_video_encoder( &mut self, encoder: Arc<ObsVideoEncoder>, ) -> Result<(), ObsError>

Attaches an existing video encoder to this output.

fn create_and_set_audio_encoder( &mut self, info: AudioEncoderInfo, mixer_idx: usize, ) -> Result<Arc<ObsAudioEncoder>, ObsError>

Creates and attaches a new audio encoder for the given mixer index. Fails if output active.

fn set_audio_encoder( &mut self, encoder: Arc<ObsAudioEncoder>, mixer_idx: usize, ) -> Result<(), ObsError>

Attaches an existing audio encoder to this output at the mixer index.

fn start(&self) -> Result<(), ObsError>

Starts the output, wiring encoders to global contexts and invoking obs_output_start. Returns an error with last OBS message when start fails.

fn set_paused(&self, should_pause: bool) -> Result<(), ObsError>

fn pause(&self) -> Result<(), ObsError>

Pauses or resumes the output and waits for the pause/unpause signal.

fn unpause(&self) -> Result<(), ObsError>

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

Stops the output and waits for stop and deactivate signals.

fn is_active(&self) -> Result<bool, ObsError>

Returns whether the output is currently active.