Struct vcsr::args::Args

pub struct Args {
    pub num_groups: Option<u32>,
    pub num_selected: Option<u32>,
    pub accurate: bool,
    pub accurate_delay_seconds: f32,
    pub actual_size: bool,
    pub background_colour: String,
    pub capture_alpha: u8,
    pub delay_percent: Option<f32>,
    pub end_delay_percent: f32,
    pub exclude_extensions: Vec<String>,
    pub fast: bool,
    pub frame_type: Option<String>,
    pub filenames: Vec<String>,
    pub grid: Grid,
    pub grid_spacing: Option<u32>,
    pub grid_horizontal_spacing: u32,
    pub grid_vertical_spacing: u32,
    pub image_format: String,
    pub ignore_errors: bool,
    pub interval: Option<Duration>,
    pub manual_timestamps: Vec<String>,
    pub metadata_background_colour: String,
    pub metadata_font: Option<String>,
    pub metadata_font_colour: String,
    pub metadata_font_size: f32,
    pub metadata_horizontal_margin: u32,
    pub metadata_margin: u32,
    pub metadata_position: MetadataPosition,
    pub metadata_vertical_margin: u32,
    pub no_overwrite: bool,
    pub output_path: Option<String>,
    pub recursive: bool,
    pub num_samples: Option<u32>,
    pub no_shadow: bool,
    pub start_delay_percent: f32,
    pub show_timestamp: bool,
    pub thumbnail_output_path: Option<String>,
    pub timestamp_background_colour: String,
    pub timestamp_border_colour: String,
    pub timestamp_border_mode: bool,
    pub timestamp_border_radius: f32,
    pub timestamp_border_size: u32,
    pub timestamp_font: Option<String>,
    pub timestamp_font_colour: String,
    pub timestamp_font_size: f32,
    pub timestamp_position: TimestampPosition,
    pub timestamp_horizontal_margin: u32,
    pub timestamp_horizontal_padding: u32,
    pub timestamp_vertical_margin: u32,
    pub timestamp_vertical_padding: u32,
    pub vcs_width: u32,
    pub verbose: bool,
}

Fields

num_groups: Option<u32>

num_selected: Option<u32>

accurate: bool

Make accurate captures. This capture mode is way slower than the default one but it helps when capturing frames from HEVC videos.

accurate_delay_seconds: f32

Fast skip to N seconds before capture time, then do accurate capture (decodes N seconds of video before each capture). This is used with accurate capture mode only.

actual_size: bool

Make thumbnails of actual size. In other words, thumbnails will have the actual 1:1 size of the video resolution.

background_colour: String

Color of the timestamp background rectangle in hexadecimal, for example AABBCC

capture_alpha: u8

Alpha channel value for the captures (transparency in range [0, 255]). Defaults to 255 (opaque)

delay_percent: Option<f32>

do not capture frames in the first and last n percent of total time

end_delay_percent: f32

do not capture frames in the last n percent of total time

exclude_extensions: Vec<String>

Do not process files that end with the given extensions.

fast: bool

Fast mode. Just make a contact sheet as fast as possible, regardless of output image quality. May mess up the terminal.

frame_type: Option<String>

Frame type passed to ffmpeg 'select=eq(pict_type,FRAME_TYPE)' filter. Should be one of ('I', 'B', 'P') or the special type 'key' which will use the 'select=key' filter instead.

filenames: Vec<String>

grid: Grid

display frames on a mxn grid (for example 4x5). The special value zero (as in 2x0 or 0x5 or 0x0) is only allowed when combined with --interval or with --manual. Zero means that the component should be automatically deduced based on other arguments passed.

grid_spacing: Option<u32>

number of pixels spacing captures both vertically and horizontally

grid_horizontal_spacing: u32

number of pixels spacing captures horizontally

grid_vertical_spacing: u32

number of pixels spacing captures vertically

image_format: String

Output image format. Can be any format supported by image-rs. For example 'png' or 'jpg'.

ignore_errors: bool

Ignore any error encountered while processing files recursively and continue to the next file.

interval: Option<Duration>

Capture frames at specified interval. Interval format is any string supported by humantime. For example '5m', '3 minutes 5 seconds', '1 hour 15 min and 20 sec' etc.

manual_timestamps: Vec<String>

Space-separated list of frame timestamps to use, for example 1:11:11.111 2:22:22.222

metadata_background_colour: String

Color of the metadata background in hexadecimal, for example AABBCC

metadata_font: Option<String>

Path to TTF font used for metadata

metadata_font_colour: String

Color of the metadata font in hexadecimal, for example AABBCC

metadata_font_size: f32

size of the font used for metadata

metadata_horizontal_margin: u32

Horizontal margin (in pixels) in the metadata header.

metadata_margin: u32

Margin (in pixels) in the metadata header.

metadata_position: MetadataPosition

Position of the metadata header.

metadata_vertical_margin: u32

Vertical margin (in pixels) in the metadata header.

no_overwrite: bool

Do not overwrite output file if it already exists, simply ignore this file and continue processing other unprocessed files.

output_path: Option<String>

save to output file

recursive: bool

Process every file in the specified directory recursively

num_samples: Option<u32>

number of samples

no_shadow: bool

show dropshadow on frames

start_delay_percent: f32

do not capture frames in the first n percent of total time

show_timestamp: bool

display timestamp for each frame

thumbnail_output_path: Option<String>

Save thumbnail files to the specified output directory. If set, the thumbnail files will not be deleted after successful creation of the contact sheet.

timestamp_background_colour: String

Color of the timestamp background rectangle in hexadecimal, for example AABBCC

timestamp_border_colour: String

Color of the timestamp border in hexadecimal, for example AABBCC

timestamp_border_mode: bool

Draw timestamp text with a border instead of the default rectangle.

timestamp_border_radius: f32

Draw timestamp text with a border instead of the default rectangle.

timestamp_border_size: u32

Size of the timestamp border in pixels (used only with --timestamp-border-mode).

timestamp_font: Option<String>

Path to TTF font used for timestamps

timestamp_font_colour: String

Color of the timestamp font in hexadecimal, for example AABBCC

timestamp_font_size: f32

size of the font used for timestamps

timestamp_position: TimestampPosition

Timestamp position.

timestamp_horizontal_margin: u32

timestamp_horizontal_padding: u32

Horizontal padding (in pixels) for timestamps.

timestamp_vertical_margin: u32

Vertical margin (in pixels) for timestamps.

timestamp_vertical_padding: u32

V ertical padding (in pixels) for timestamps.

vcs_width: u32

width of the generated contact sheet

verbose: bool

log to stdout as well as to the log file.

Trait Implementations

impl Clone for Args

fn clone(&self) -> Args

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Args

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

Formats the value using the given formatter.

impl Default for Args

fn default() -> Self

Returns the "default value" for a type.

impl StructOpt for Args

fn clap<'a, 'b>() -> App<'a, 'b>

Returns the corresponding clap::App.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Creates the struct from clap::ArgMatches. It cannot fail with a parameter generated by clap by construction.

fn from_args() -> Self

Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.