Note: Scale VideoPlayback is now Scale VideoAnnotation V2. For backwards compatability, V2 tasks will use the same endpoint as videoplayback and be treated as such. V2 is currently only activated for a select number of customers. Please contact Scale for any questions regarding V2.
This endpoint creates a videoplaybackannotation task. In this task, we will view the given video file and draw annotation on the images extracted from the video.
You are required to provide a URL to the video file as the attachment. It can be in mp4, webm, or ogg format.
[V2 Only] You have the option to provide either a URL to the video file as the attachment or a list of images as the attachments or both. If the request is successful, regardless of what you pass in, the task will contain images that will be annotated with a video file as reference.
You can optionally provide additional markdown-enabled or Google Doc-based instructions via the instruction parameter.
You may optionally specify a frame_rate, which will determine how many frames per second will be used to annotate the given video. The default value is 1.
[V2 Only] You may optionally specify a annotation_frame_rate which replaces the function of frame_rate. If you intend for the video to have a different frame rate than the frames being annotated, please specify a video_frame_rate. In the instances where either one are missing, the task will use the legacy frame_rate parameters or interpret from the video itself.
You may also optionally specify events_to_annotate, a list of strings describing events section to annotate in the video.
If the request is successful, Scale will return the generated task object, at which point you should store the task_id to have a permanent reference to the task.