Struct ObsVideoEncoder 

pub struct ObsVideoEncoder { /* private fields */ }

Represents a VideoEncoder. The VideoEncoder is removed, if there are no references to this struct left. If you attach this video encoder to a ObsOutputRef, it is stored internally so you can safely drop this struct, if attached to the ObsOutputRef. If not attached to the output, it’ll just remove itself again.

Implementations

impl ObsVideoEncoder

pub fn new_from_info( info: VideoEncoderInfo, runtime: ObsRuntime, ) -> Result<Arc<Self>, ObsError>

Info: the handler attribute is no longer needed and kept for compatibility. The handler parameter will be removed in a future release.

pub unsafe fn set_video_context( &mut self, handler: Sendable<*mut video_output>, ) -> Result<(), ObsError>

This is only needed once for global video context

Safety

The handler pointer must be a valid pointer to a video_output that lives as long as this function call.

Trait Implementations

impl Clone for ObsVideoEncoder

fn clone(&self) -> ObsVideoEncoder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObsVideoEncoder

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

Formats the value using the given formatter.

impl ObsEncoderTrait for ObsVideoEncoder

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

impl ObsObjectTrait<*mut obs_encoder> for ObsVideoEncoder

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

Updates the settings of this output. Fails if active.

fn runtime(&self) -> &ObsRuntime

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

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

fn id(&self) -> ObsString

fn name(&self) -> ObsString

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

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.