downloadMovie

hvpy.downloadMovie(id, format, hq=False)

Download a custom movie that was generated using the queueMovie API endpoint.

Parameters:

• id (Union[int, DataSource]) – Unique movie identifier, returned as a response by the queueMovie endpoint request.

• format (str) – Movie Format (“mp4”, “webm”, or “flv”).

• hq (bool) – Download a higher-quality movie file (valid for “mp4” movies only, ignored otherwise). Defaults to False, optional.

Return type:

Union[bytes, str, Dict[str, Any]]

References

• https://api.helioviewer.org/docs/v2/api/api_groups/movies.html#id9

Examples

>>> from hvpy import downloadMovie
>>> downloadMovie(id="h2n6n", format="mp4")
b'...'