Struct SCRecordingOutputConfiguration 

pub struct SCRecordingOutputConfiguration { /* private fields */ }

Configuration for recording output

Implementations

impl SCRecordingOutputConfiguration

pub fn new() -> Result<Self, SCError>

Create a new recording output configuration

Errors

Returns SCError::FeatureNotAvailable when run on macOS older than 15.0.

pub fn with_output_url(self, path: &Path) -> Result<Self, InvalidOutputPath>

Set the output file URL.

Errors

Returns an InvalidOutputPath when path is not valid UTF-8 or contains an interior NUL byte.

pub fn output_url(&self) -> Option<PathBuf>

Get the configured output file URL.

pub fn with_video_codec(self, codec: SCRecordingOutputCodec) -> Self

Set the video codec

pub fn video_codec(&self) -> SCRecordingOutputCodec

Get the video codec

pub fn with_output_file_type(self, file_type: SCRecordingOutputFileType) -> Self

Set the output file type

pub fn output_file_type(&self) -> SCRecordingOutputFileType

Get the output file type

pub fn available_video_codecs_count(&self) -> usize

Get the number of available video codecs

pub fn available_video_codecs(&self) -> Vec<SCRecordingOutputCodec>

Get all available video codecs

Returns a vector of all video codecs that can be used for recording. The length always matches available_video_codecs_count: a codec this crate has no constant for is preserved by identifier.

pub fn available_output_file_types_count(&self) -> usize

Get the number of available output file types

pub fn available_output_file_types(&self) -> Vec<SCRecordingOutputFileType>

Get all available output file types

Returns a vector of all file types that can be used for recording output. The length always matches available_output_file_types_count.

pub fn as_ptr(&self) -> *const c_void

Trait Implementations

impl Clone for SCRecordingOutputConfiguration

fn clone(&self) -> Self

Deep-copies the underlying SCRecordingOutputConfiguration.

The native object is a mutable class. Retaining it would make every clone an alias — reconfiguring one handle would silently reconfigure the others, and two threads configuring “their own” clone would race on the same non-atomic properties, which Send/Sync on this type promises cannot happen.

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

Performs copy-assignment from source.

impl Debug for SCRecordingOutputConfiguration

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

Formats the value using the given formatter.

impl Drop for SCRecordingOutputConfiguration

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for SCRecordingOutputConfiguration

impl Sync for SCRecordingOutputConfiguration