Skip to main content

  • ​
    createVideo

    public CreateVideoResponse createVideo(CreateVideoRequest request) throws GPUdbException
    Creates a job to generate a sequence of raster images that visualize data over a specified time.
    Parameters:
    request - Request object containing the parameters for the operation.
    Returns:
    Response object containing the results of the operation.
    Throws:
    GPUdbException - if an error occurs during the operation.

  • ​
    createVideo

    public CreateVideoResponse createVideo(String attribute, String begin, double durationSeconds, String end, double framesPerSecond, String style, String path, String styleParameters, Map<String,String> options) throws GPUdbException
    Creates a job to generate a sequence of raster images that visualize data over a specified time.
    Parameters:
    attribute - The animated attribute to map to the video’s frames. Must be present in the LAYERS specified for the visualization. This is often a time-related field but may be any numeric type.
    begin - The start point for the video. Accepts an expression evaluable over the attribute.
    durationSeconds - Seconds of video to produce.
    end - The end point for the video. Accepts an expression evaluable over the attribute.
    framesPerSecond - The presentation frame rate of the encoded video in frames per second.
    style - The name of the visualize mode; should correspond to the schema used for the styleParameters field. Supported values:
    path - Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless REPLACE_IF_EXISTS is TRUE.
    styleParameters - A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.
    options - Optional parameters.
    • TTL: Sets the TTL of the video.
    • WINDOW: Specified using the data-type corresponding to the attribute. For a window of size W, a video frame rendered for time t will visualize data in the interval [t-W,t]. The minimum window size is the interval between successive frames. The minimum value is the default. If a value less than the minimum value is specified, it is replaced with the minimum window size. Larger values will make changes throughout the video appear more smooth while smaller values will capture fast variations in the data.
    • NO_ERROR_IF_EXISTS: If TRUE, does not return an error if the video already exists. Ignored if REPLACE_IF_EXISTS is TRUE. Supported values:The default value is FALSE.
    • REPLACE_IF_EXISTS: If TRUE, deletes any existing video with the same path before creating a new video. Supported values:The default value is FALSE.
    The default value is an empty Map.
    Returns:
    Response object containing the results of the operation.
    Throws:
    GPUdbException - if an error occurs during the operation.