upsies.uis.tui.commands.screenshots

Create screenshots from video file and optionally upload them

Classes

class upsies.uis.tui.commands.screenshots.screenshots(args, config)[source]

Bases: CommandBase

Create screenshots from video file and optionally upload them

names = ('screenshots', 'ss')

Sequence of command names

The first name is the full name and the rest are short aliases.

cli_arguments = {'--tonemap': {'default': None, 'help': 'Apply tonemap filter to HDR screenshots', 'metavar': 'BOOL', 'type': <function bool_or_none>}, 'CONTENT': {'help': 'Path to release content', 'type': <function content>}, ('--exclude-files', '--ef'): {'action': 'extend', 'default': [], 'help': 'Glob pattern to exclude from CONTENT (matched case-insensitively against path relative to CONTENT)', 'metavar': 'PATTERN', 'nargs': '+'}, ('--exclude-files-regex', '--efr'): {'action': 'extend', 'default': [], 'help': 'Regular expression to exclude from CONTENT (matched case-sensitively against path relative to CONTENT)', 'metavar': 'PATTERN', 'nargs': '+', 'type': <function regex>}, ('--format', '-f'): {'default': None, 'help': 'Format string for each uploaded image\nUse {url} for the full-size image URL and {thumbnail} for the thumbnail URL\nExample: "[url={url}][img]{thumbnail}[/img][/url]"'}, ('--from-all-videos', '-a'): {'action': 'store_true', 'help': 'Make NUMBER screenshots from each video file beneath CONTENT'}, ('--number', '-n'): {'default': 0, 'help': 'How many screenshots to make in total', 'type': <function integer>}, ('--optimize', '--opt'): {'default': None, 'help': 'File size optimization level: low, medium, high, placebo, none, default', 'metavar': 'LEVEL', 'type': <function one_of.<locals>.one_of_values>}, ('--output-directory', '-o'): {'default': '', 'help': 'Directory where screenshots are put (created on demand)', 'metavar': 'PATH'}, ('--precreated', '-p'): {'action': 'extend', 'default': [], 'help': 'Existing screenshot file path', 'metavar': 'SCREENSHOT', 'nargs': '+'}, ('--thumb-width', '--tw'): {'default': None, 'help': 'Thumbnail width in pixels or 0 for no thumbnail', 'metavar': 'WIDTH', 'type': <function integer>}, ('--timestamps', '-t'): {'action': 'extend', 'default': [], 'help': 'Space-separated list of [[HH:]MM:]SS strings', 'metavar': 'TIMESTAMP', 'nargs': '+', 'type': <function timestamp>}, ('--upload-to', '-u'): {'help': 'Comma-separated list of case-insensitive image hosting service names\nSupported services: freeimage, imgbb, imgbox, pixhost, ptpimg, ra, rfximg', 'metavar': 'IMAGE_HOSTS', 'type': <function imagehosts>}}

CLI argument definitions for this command

This is a dict in which keys are option names or flags (e.g. "PATH" or ("--path", "-p") and each value is a dict with keyword arguments for argparse.ArgumentParser.add_argument().

Additionally, you may specify a group in each keyword argument dictionary. Arguments with the same group value are mutually exclusive, meaning the user can only specify one of them.

property jobs

Iterable of JobBase instances

Each JobBase instance may also be None for inactive jobs.