Struct ObsAudioEncoder 

pub struct ObsAudioEncoder { /* private fields */ }

Represents a audio encoder. If this struct is not referenced anywhere anymore, this Audio Encoder will get removed. Note: The output internally stores the ObsAudioEncoder, once it was added to the output

Implementations

impl ObsAudioEncoder

pub fn new_from_info( info: AudioEncoderInfo, mixer_idx: usize, 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_audio_context( &mut self, handler: Sendable<*mut audio_output>, ) -> Result<(), ObsError>

This is only needed once for global audio context

Safety

You must ensure that the handler pointer is valid and lives as long as this function call.

Trait Implementations

impl Clone for ObsAudioEncoder

fn clone(&self) -> ObsAudioEncoder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObsAudioEncoder

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

Formats the value using the given formatter.

impl ObsEncoderTrait for ObsAudioEncoder

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

impl ObsObjectTrait<*mut obs_encoder> for ObsAudioEncoder

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 update_settings(&self, settings: ObsData) -> Result<(), ObsError>

Updates the settings of this output. Fails if active.

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.