Trait ObsOutputTrait 

pub trait ObsOutputTrait: ObsOutputTraitSealed + ObsObjectTrait<*mut obs_output_t> {
    // Required methods
    fn signals(&self) -> &Arc<ObsOutputSignals>;
    fn video_encoder(&self) -> &Arc<RwLock<Option<Arc<ObsVideoEncoder>>>>;
    fn audio_encoders(
        &self,
    ) -> &Arc<RwLock<HashMap<usize, Arc<ObsAudioEncoder>>>>;

    // Provided methods
    fn get_current_video_encoder(
        &self,
    ) -> Result<Option<Arc<ObsVideoEncoder>>, ObsError> { ... }
    fn create_and_set_video_encoder(
        &mut self,
        info: VideoEncoderInfo,
    ) -> Result<Arc<ObsVideoEncoder>, ObsError> { ... }
    fn set_video_encoder(
        &mut self,
        encoder: Arc<ObsVideoEncoder>,
    ) -> Result<(), ObsError> { ... }
    fn create_and_set_audio_encoder(
        &mut self,
        info: AudioEncoderInfo,
        mixer_idx: usize,
    ) -> Result<Arc<ObsAudioEncoder>, ObsError> { ... }
    fn set_audio_encoder(
        &mut self,
        encoder: Arc<ObsAudioEncoder>,
        mixer_idx: usize,
    ) -> Result<(), ObsError> { ... }
    fn start(&self) -> Result<(), ObsError> { ... }
    fn set_paused(&self, should_pause: bool) -> Result<(), ObsError> { ... }
    fn pause(&self) -> Result<(), ObsError> { ... }
    fn unpause(&self) -> Result<(), ObsError> { ... }
    fn stop(&mut self) -> Result<(), ObsError> { ... }
    fn is_active(&self) -> Result<bool, ObsError> { ... }
}

Required Methods

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

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

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

Provided Methods

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.

Fails if the output is active.

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

Attaches an existing video encoder to this output.

Fails if the output is active.

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.

Fails if the output is active.

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.

Implementors

impl ObsOutputTrait for ObsOutputRef

impl ObsOutputTrait for ObsReplayBufferOutputRef