getJPXInputParameters#
- class hvpy.parameters.getJPXInputParameters(**data)[source]#
Bases:
HvpyParameters
Handles the input parameters of the
getJPX
API.- startTime#
Datetime for the beginning of the JPX movie data.
- endTime#
Datetime for the end of the JPX movie data.
- sourceId#
Unique image datasource identifier.
- linked#
Generate a linked JPX file containing image pointers instead of data for each individual frame in the series. Default is
True
, optional.
- verbose#
if set to
True
, the JSON response will include timestamps for each frame in the resulting movie and any warning messages associated with the request. In addition to the JPX movie file URI. Default isFalse
, optional.
- jpip#
Return a JPIP URI string instead of the binary data of the movie itself, or instead of an HTTP URI in the JSON response (if
verbose
is set toTrue
). Default isFalse
, optional.
- cadence#
The desired amount of time (in seconds) between each frame in the movie. Default is
None
(maximum cadence), optional.
References