Skip to main content
show_video(paths=None, options=)[source]

Retrieves information about rendered videos.

Parameters

paths (list of str) –

The fully-qualified KiFS paths for the videos to show. If empty, shows all videos. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

options (dict of str to str) –

Optional parameters. The default value is an empty dict ( ).

Returns

A dict with the following entries–

creation_times (list of str) –

Creation time for each video as an ISO-8601 datetime.

elapsed_render_time_seconds (list of longs) –

The elapsed time spent rendering each video in seconds.

job_ids (list of longs) –

The job id of the rendering process, for each video that is still being rendered.

paths (list of str) –

KIFS path to each video.

rendered_bytes (list of longs) –

The number of bytes emitted by the encoder for each video.

rendered_frames (list of longs) –

The number of frames rendered for each video.

rendered_percents (list of longs) –

Percent completion of each video’s rendering process (0-100).

requests (list of str) –

JSON-string reflecting each video’s creation parameters.

status (list of str) –

The status of the last rendered frame for each video. Either OK or Error with a message indicating the nature of the error.

ttls (list of longs) –

The remaining TTL, in minutes, before the respective video expires (-1 if it will never expire).

info (dict of str to str) –

Additional information.