Varianten

Eine Variante ist ein wiederverwendbares Rezept, das eine Ausgabe definiert, die aus jedem Upload erzeugt werden soll — ein Transcode, Preview, Wellenform oder Analyse — und jedes Ergebnis wird als Track-Datei am Track gespeichert. Organisationsweite Varianten (auf jeden Upload angewendet) werden auf der Website erstellt. Sie können auch eine track-spezifische Variante zu einem einzelnen, bereits verarbeiteten Track über die API hinzufügen — praktisch, um ein zusätzliches Format oder einen Preview-Clip bei Bedarf zu erzeugen.

GET /v1/variant

Gibt eine Liste von Varianten für eine Organisation zurück

Parameter

Name	Typ	Erforderlich	Beschreibung
`limit`	number	Optional	Maximale Anzahl zurückzugebender Varianten
`offset`	number	Optional	Anzahl zu überspringender Varianten

Beispielanfrage

curl -X GET "https://api.audiodelivery.net/v1/variant" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch('https://api.audiodelivery.net/v1/variant', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
  }
});

const data = await response.json();

import Foundation

func performRequest() async throws {
    var request = URLRequest(url: URL(string: "https://api.audiodelivery.net/v1/variant")!)
    request.httpMethod = "GET"
    request.setValue("Bearer YOUR_API_KEY", forHTTPHeaderField: "Authorization")
    let (data, _) = try await URLSession.shared.data(for: request)
    let json = try JSONSerialization.jsonObject(with: data) as! [String: Any]
    // use json
}

import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.withContext
import okhttp3.*

val client = OkHttpClient()

suspend fun performRequest(): String = withContext(Dispatchers.IO) {
    val request = Request.Builder()
        .url("https://api.audiodelivery.net/v1/variant")
        .addHeader("Authorization", "Bearer YOUR_API_KEY")
        .build()
    val response = client.newCall(request).execute()
    response.body?.string() ?: error("Empty response body")
}

import 'dart:convert';
import 'package:http/http.dart' as http;

Future<Map<String, dynamic>> performRequest() async {
  final response = await http.get(
    Uri.parse("https://api.audiodelivery.net/v1/variant"),
    headers: {
      "Authorization": "Bearer YOUR_API_KEY",
    },
  );
  if (response.statusCode < 200 || response.statusCode >= 300) {
    throw Exception('Request failed: ${response.statusCode}');
  }
  return jsonDecode(response.body) as Map<String, dynamic>;
}

Antwort

{
"ok": true,
"api_request_id": "uuid",
"count": 0,
"variants": [
  {
    "id": "uuid",
    "organization_id": "uuid",
    "variant_type_id": "string",
    "props": {}
  }
]
}

GET /v1/variant/:variant_id

Gibt Details zu einer bestimmten Variante zurück

Parameter

Name	Typ	Erforderlich	Beschreibung
`variant_id`	uuid	Erforderlich	Die ID der abzurufenden Variante (Pfadparameter)

Beispielanfrage

curl -X GET "https://api.audiodelivery.net/v1/variant/VARIANT_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch('https://api.audiodelivery.net/v1/variant/VARIANT_ID', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
  }
});

const data = await response.json();

import Foundation

func performRequest() async throws {
    var request = URLRequest(url: URL(string: "https://api.audiodelivery.net/v1/variant/VARIANT_ID")!)
    request.httpMethod = "GET"
    request.setValue("Bearer YOUR_API_KEY", forHTTPHeaderField: "Authorization")
    let (data, _) = try await URLSession.shared.data(for: request)
    let json = try JSONSerialization.jsonObject(with: data) as! [String: Any]
    // use json
}

import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.withContext
import okhttp3.*

val client = OkHttpClient()

suspend fun performRequest(): String = withContext(Dispatchers.IO) {
    val request = Request.Builder()
        .url("https://api.audiodelivery.net/v1/variant/VARIANT_ID")
        .addHeader("Authorization", "Bearer YOUR_API_KEY")
        .build()
    val response = client.newCall(request).execute()
    response.body?.string() ?: error("Empty response body")
}

import 'dart:convert';
import 'package:http/http.dart' as http;

Future<Map<String, dynamic>> performRequest() async {
  final response = await http.get(
    Uri.parse("https://api.audiodelivery.net/v1/variant/VARIANT_ID"),
    headers: {
      "Authorization": "Bearer YOUR_API_KEY",
    },
  );
  if (response.statusCode < 200 || response.statusCode >= 300) {
    throw Exception('Request failed: ${response.statusCode}');
  }
  return jsonDecode(response.body) as Map<String, dynamic>;
}

Antwort

{
"ok": true,
"api_request_id": "uuid",
"variant_id": "uuid",
"variant": {
  "id": "uuid",
  "organization_id": "uuid",
  "variant_type_id": "string",
  "props": {}
}
}

POST /v1/track/:track_id/variant

Fügt eine track-spezifische Variante zu einem bereits verarbeiteten Track hinzu und stellt die Verarbeitung in die Warteschlange

Hängt eine neue Track-Datei an einen bestehenden Track an. Der Track wechselt zu processing, während die neue Datei erzeugt wird, und kehrt danach automatisch zu ready zurück. Über diesen Endpunkt werden nur transcode und preview unterstützt, und nur verlustbehaftete Ausgabe-Codecs sind erlaubt (aac, mp3, ogg, opus). Codec-Einstellungen sind optional und standardmäßig aac bei 128 kbps.

Gemeinsame Parameter

Name	Typ	Erforderlich	Beschreibung
`track_id`	uuid	Erforderlich	Der Track, an den die Variante angehängt wird (Pfadparameter)
`variant_type_id`	string	Erforderlich	'transcode' (Datei in voller Länge) oder 'preview' (kurzer Clip). Bestimmt, welcher Parametersatz unten gilt
`index`	string	Erforderlich	Delivery-Name für die Variante (2–64 Zeichen, Buchstaben/Ziffern/_/-). Darf nicht mit einer bestehenden Organisations- oder Track-Variante kollidieren

Wenn `variant_type_id` `“transcode”` ist

Alternativformat in voller Länge. Beispiel: { "variant_type_id": "transcode", "index": "mp3", "codec": "mp3", "bitrate": 192 }.

Transcode-Parameter

Name	Typ	Erforderlich	Beschreibung
`codec`	string	Optional	Ausgabe-Codec: aac (Standard), mp3, ogg oder opus. Verlustfreie Codecs (flac, alac) sind nicht erlaubt
`bitrate`	number	Optional	Ausgabe-Bitrate in kbps, 12–320 (Standard 128). Gilt nur für Codecs, die Bitrate verwenden
`is_stereo`	boolean	Optional	Stereo-Ausgabe beibehalten (Standard true). Bei false wird die Ausgabe auf Mono heruntergemischt
`is_strip_tags`	boolean	Optional	Metadaten-Tags aus der Ausgabe entfernen (Standard true)
`is_strip_cover`	boolean	Optional	Eingebettetes Cover-Artwork aus der Ausgabe entfernen (Standard true)

Wenn `variant_type_id` `“preview”` ist

Kurzer Clip aus dem Track. Akzeptiert auch die Transcode-Parameter oben für das Ausgabe-Audio (Codec-Standard ist aac / 128). Der Clip-Start ist immer ein Prozentsatz der Track-Dauer (preview_start_percent).

Preview-Parameter

Name	Typ	Erforderlich	Beschreibung
`preview_type`	string	Optional	'seconds' (Standard) oder 'percent' — wie die Clip-Länge gemessen wird
`preview_seconds`	number	Optional	Wenn preview_type 'seconds' ist: Clip-Länge in Sekunden (Standard 60)
`preview_min_percent`	number	Optional	Wenn preview_type 'seconds' ist: minimale Clip-Länge als Prozent der Dauer, 0–100 (Standard 0)
`preview_max_percent`	number	Optional	Wenn preview_type 'seconds' ist: maximale Clip-Länge als Prozent der Dauer, 0–100 (Standard 50)
`preview_percent`	number	Optional	Wenn preview_type 'percent' ist: Clip-Länge als Prozent der Dauer, 0–100 (Standard 25)
`preview_min_seconds`	number	Optional	Wenn preview_type 'percent' ist: minimale Clip-Länge in Sekunden (Standard 0)
`preview_max_seconds`	number	Optional	Wenn preview_type 'percent' ist: maximale Clip-Länge in Sekunden (Standard 90)
`preview_start_percent`	number	Optional	Wo der Clip beginnt, als Prozent der Gesamtdauer, 0–100 (Standard 25). Wird immer verwendet, unabhängig von preview_type

Beispielanfrage

curl -X POST "https://api.audiodelivery.net/v1/track/TRACK_ID/variant" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "variant_type_id": "preview",
  "index": "preview",
  "preview_type": "seconds",
  "preview_seconds": 3,
  "preview_min_percent": 0,
  "preview_max_percent": 100,
  "preview_start_percent": 25
}'

const payload = {
  "variant_type_id": "preview",
  "index": "preview",
  "preview_type": "seconds",
  "preview_seconds": 3,
  "preview_min_percent": 0,
  "preview_max_percent": 100,
  "preview_start_percent": 25
};

const response = await fetch('https://api.audiodelivery.net/v1/track/TRACK_ID/variant', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(payload)
});

const data = await response.json();

import Foundation

func performRequest() async throws {
    var request = URLRequest(url: URL(string: "https://api.audiodelivery.net/v1/track/TRACK_ID/variant")!)
    request.httpMethod = "POST"
    request.setValue("Bearer YOUR_API_KEY", forHTTPHeaderField: "Authorization")
    request.setValue("application/json", forHTTPHeaderField: "Content-Type")
    let bodyJSON = """
{
  "variant_type_id": "preview",
  "index": "preview",
  "preview_type": "seconds",
  "preview_seconds": 3,
  "preview_min_percent": 0,
  "preview_max_percent": 100,
  "preview_start_percent": 25
}
"""
    request.httpBody = bodyJSON.data(using: .utf8)
    let (data, _) = try await URLSession.shared.data(for: request)
    let json = try JSONSerialization.jsonObject(with: data) as! [String: Any]
    // use json
}

import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.withContext
import okhttp3.*
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.RequestBody.Companion.toRequestBody

val client = OkHttpClient()

suspend fun performRequest(): String = withContext(Dispatchers.IO) {
    val body = """{
  "variant_type_id": "preview",
  "index": "preview",
  "preview_type": "seconds",
  "preview_seconds": 3,
  "preview_min_percent": 0,
  "preview_max_percent": 100,
  "preview_start_percent": 25
}""".toRequestBody("application/json".toMediaType())
    val request = Request.Builder()
        .url("https://api.audiodelivery.net/v1/track/TRACK_ID/variant")
        .post(body)
        .addHeader("Authorization", "Bearer YOUR_API_KEY")
        .addHeader("Content-Type", "application/json")
        .build()
    val response = client.newCall(request).execute()
    response.body?.string() ?: error("Empty response body")
}

import 'dart:convert';
import 'package:http/http.dart' as http;

Future<Map<String, dynamic>> performRequest() async {
  final response = await http.post(
    Uri.parse("https://api.audiodelivery.net/v1/track/TRACK_ID/variant"),
    headers: {
      "Authorization": "Bearer YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: jsonEncode({
  "variant_type_id": "preview",
  "index": "preview",
  "preview_type": "seconds",
  "preview_seconds": 3,
  "preview_min_percent": 0,
  "preview_max_percent": 100,
  "preview_start_percent": 25
}),
  );
  if (response.statusCode < 200 || response.statusCode >= 300) {
    throw Exception('Request failed: ${response.statusCode}');
  }
  return jsonDecode(response.body) as Map<String, dynamic>;
}

Antwort

{
"ok": true,
"api_request_id": "uuid",
"track_id": "uuid",
"variant_id": "uuid",
"job_id": "uuid",
"variant": {
  "id": "uuid",
  "organization_id": "uuid",
  "track_id": "uuid",
  "variant_type_id": "preview",
  "index": "preview",
  "props": {
    "preview_type": "seconds",
    "preview_seconds": 3,
    "preview_min_percent": 0,
    "preview_max_percent": 100,
    "preview_start_percent": 25,
    "codec": "aac",
    "bitrate": 128,
    "is_stereo": true,
    "is_strip_tags": true,
    "is_strip_cover": true
  }
}
}

Varianten

Parameter

Beispielanfrage

Antwort

Parameter

Beispielanfrage

Antwort

Gemeinsame Parameter

Wenn variant_type_id “transcode” ist

Transcode-Parameter

Wenn variant_type_id “preview” ist

Preview-Parameter

Beispielanfrage

Antwort

Wenn `variant_type_id` `“transcode”` ist

Wenn `variant_type_id` `“preview”` ist