getMovieStatus#

hvpy.getMovieStatus(id, format, verbose=False, callback=None, token=None)[source]#

Get the status of a movie.

Parameters:

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

  • format (str) – Movie format.

  • verbose (bool) – Include extra metadata in the response. Defaults to False, optional.

  • callback (Optional[str]) – Wrap the response object in a function call of your choosing. Default is None (no wrapping), optional.

  • token (Optional[str]) – API token. Defaults to None, optional.

Return type:

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

References

Examples

>>> from hvpy import getMovieStatus
>>> getMovieStatus(id="h2n6n", format="mp4")  
{'frameRate': ..., 'numFrames': ..., 'startDate': '...', 'status': ..., 'endDate': '...', 'width': ..., 'height': ..., 'title': '...', 'thumbnails': {'icon': '...', 'small': '...', 'medium': '...', 'large': '...', 'full': '...'}, 'url': '...', 'statusLabel': 'Completed'}