Struct FrameCaptureSettings 

#[non_exhaustive]
pub struct FrameCaptureSettings {
    pub framerate_denominator: Option<i32>,
    pub framerate_numerator: Option<i32>,
    pub max_captures: Option<i32>,
    pub quality: Option<i32>,
}

Required when you set Codec to the value FRAME_CAPTURE.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

framerate_denominator: Option<i32>

Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.

framerate_numerator: Option<i32>

Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.

max_captures: Option<i32>

Maximum number of captures (encoded jpg output files).

quality: Option<i32>

JPEG Quality - a higher value equals higher quality.

Implementations

impl FrameCaptureSettings

pub fn framerate_denominator(&self) -> Option<i32>

Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.

pub fn framerate_numerator(&self) -> Option<i32>

Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.

pub fn max_captures(&self) -> Option<i32>

Maximum number of captures (encoded jpg output files).

pub fn quality(&self) -> Option<i32>

JPEG Quality - a higher value equals higher quality.

impl FrameCaptureSettings

pub fn builder() -> FrameCaptureSettingsBuilder

Creates a new builder-style object to manufacture FrameCaptureSettings.

Trait Implementations

impl Clone for FrameCaptureSettings

fn clone(&self) -> FrameCaptureSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameCaptureSettings

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

Formats the value using the given formatter.

impl PartialEq for FrameCaptureSettings

fn eq(&self, other: &FrameCaptureSettings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FrameCaptureSettings