OctoPrintClient.timelapse

OctoPrintClient.timelapse.get(unrendered, opts)

Get a list of all timelapses and the current timelapse config.

If unrendered is true, also retrieve the list of unrendered timelapses.

Arguments:

  • opts (object()) – Additional options for the request

Returns Promise:

A jQuery Promise for the request’s response

OctoPrintClient.timelapse.list(opts)

Get the lists of rendered and unrendered timelapses. The returned promise will be resolved with an object containing the properties rendered which will have the list of rendered timelapses, and unrendered which will have the list of unrendered timelapses.

Arguments:

  • opts (object()) – Additional options for the request

Returns Promise:

A jQuery Promise for the request’s response

OctoPrintClient.timelapse.listRendered(opts)

Get the list of rendered timelapses.

Arguments:

  • opts (object()) – Additional options for the request

Returns Promise:

A jQuery Promise for the request’s response

OctoPrintClient.timelapse.listUnrendered(opts)

Get the list of unrendered timelapses.

Arguments:

  • opts (object()) – Additional options for the request

Returns Promise:

A jQuery Promise for the request’s response

OctoPrintClient.timelapse.download(filename, opts)

Download the rendered timelapse filename.

Arguments:

  • filename (string()) – The name of the rendered timelapse to download

  • opts (object()) – Additional options for the request

Returns Promise:

A jQuery Promise for the request’s response

OctoPrintClient.timelapse.delete(filename, opts)

Delete the rendered timelapse filename.

Arguments:

  • filename (string()) – The name of the rendered timelapse to delete

  • opts (object()) – Additional options for the request

Returns Promise:

A jQuery Promise for the request’s response

OctoPrintClient.timelapse.deleteUnrendered(name, opts)

Delete the unrendered timelapse name.

Arguments:

  • name (string()) – The name of the unrendered timelapse to delete

  • opts (object()) – Additional options for the request

Returns Promise:

A jQuery Promise for the request’s response

OctoPrintClient.timelapse.renderUnrendered(name, opts)

Render the unrendered timelapse name.

Arguments:

  • name (string()) – The name of the unrendered timelapse to render

  • opts (object()) – Additional options for the request

Returns Promise:

A jQuery Promise for the request’s response

OctoPrintClient.timelapse.getConfig(opts)

Get the current timelapse configuration.

Arguments:

  • opts (object()) – Additional options for the request

Returns Promise:

A jQuery Promise for the request’s response

OctoPrintClient.timelapse.saveConfig(config, opts)

Save the timelapse configuration.

Arguments:

  • config (object()) – The config to save

  • opts (object()) – Additional options for the request

Returns Promise:

A jQuery Promise for the request’s response

See also

Timelapse API

The documentation of the underlying timelapse API.