Get detected scenes for videos

curl --request POST \
  --url http://localhost:6699/api/v1/media/scenes \
  --header 'Content-Type: application/json' \
  --header 'X-License-Key: <api-key>' \
  --data '
{
  "cache_dir": "<string>",
  "media_paths": [
    "<string>"
  ]
}
'

import requests

url = "http://localhost:6699/api/v1/media/scenes"

payload = {
    "cache_dir": "<string>",
    "media_paths": ["<string>"]
}
headers = {
    "X-License-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-License-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cache_dir: '<string>', media_paths: ['<string>']})
};

fetch('http://localhost:6699/api/v1/media/scenes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "6699",
  CURLOPT_URL => "http://localhost:6699/api/v1/media/scenes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cache_dir' => '<string>',
    'media_paths' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-License-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:6699/api/v1/media/scenes"

	payload := strings.NewReader("{\n  \"cache_dir\": \"<string>\",\n  \"media_paths\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-License-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:6699/api/v1/media/scenes")
  .header("X-License-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cache_dir\": \"<string>\",\n  \"media_paths\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:6699/api/v1/media/scenes")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["X-License-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cache_dir\": \"<string>\",\n  \"media_paths\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "media_scenes": {},
  "missing_visual_analysis": [
    "<string>"
  ]
}

Media

Get detected scenes for videos

Returns the scenes Jumper detected during visual analysis with the current visual model, in source seconds and source timecode. Scenes are contiguous: each one starts where the previous one ends.

Scene times are on the 1 FPS visual analysis grid, so they have 1-second resolution. end_seconds and end_timecode are exclusive: a scene ends just before them, where the next scene starts.
The last scene ends at frame_count / fps instead of at the next whole second, rounded to milliseconds.
fps is the nominal (rounded) frame rate, and seconds count timecode seconds: for 29.97 fps media, second N starts at frame N × 30. A file with 4522 frames at 29.97 fps ends its last scene at 150.733 timecode seconds, while it plays for 150.88 seconds.
Timecodes add the seconds to the file’s start_timecode at fps. They are null when the frame rate is unknown.
Videos without visual analysis for the current visual model are listed in missing_visual_analysis. Images, audio-only files, and files Jumper can’t read are left out of both.

POST

media

scenes

Get detected scenes for videos

curl --request POST \
  --url http://localhost:6699/api/v1/media/scenes \
  --header 'Content-Type: application/json' \
  --header 'X-License-Key: <api-key>' \
  --data '
{
  "cache_dir": "<string>",
  "media_paths": [
    "<string>"
  ]
}
'

import requests

url = "http://localhost:6699/api/v1/media/scenes"

payload = {
    "cache_dir": "<string>",
    "media_paths": ["<string>"]
}
headers = {
    "X-License-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-License-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cache_dir: '<string>', media_paths: ['<string>']})
};

fetch('http://localhost:6699/api/v1/media/scenes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "6699",
  CURLOPT_URL => "http://localhost:6699/api/v1/media/scenes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cache_dir' => '<string>',
    'media_paths' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-License-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:6699/api/v1/media/scenes"

	payload := strings.NewReader("{\n  \"cache_dir\": \"<string>\",\n  \"media_paths\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-License-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:6699/api/v1/media/scenes")
  .header("X-License-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cache_dir\": \"<string>\",\n  \"media_paths\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:6699/api/v1/media/scenes")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["X-License-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cache_dir\": \"<string>\",\n  \"media_paths\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "media_scenes": {},
  "missing_visual_analysis": [
    "<string>"
  ]
}

Authorizations

X-License-Key

string

header

required

Raw Jumper Pro license key on every authenticated request, without a Bearer prefix

Body

application/json

cache_dir

string

required

Analysis folder to read visual analysis from

media_paths

string[]

required

Video files to read scenes for

Response

Scenes keyed by each path exactly as sent

media_scenes

object

required

Keyed by each path exactly as sent.

Show child attributes

missing_visual_analysis

string[]

required

Requested videos, as sent, without visual analysis for the current visual model

Overview

Endpoints

Get detected scenes for videos

Authorizations

Body

Response