Variantes

Una variante es una receta reutilizable que define una salida a generar a partir de cada subida—una transcodificación, preview, forma de onda o análisis—y cada resultado se almacena como un track file en la pista. Las variantes de toda la organización (aplicadas a cada subida) se crean en el sitio web. También puedes añadir una variante específica de pista a una sola pista ya procesada vía la API—útil para generar un formato extra o un clip de preview bajo demanda.

GET /v1/variant

Devuelve una lista de variantes de una organización

Parámetros

Nombre	Tipo	Obligatorio	Descripción
`limit`	number	Opcional	Número máximo de variantes a devolver
`offset`	number	Opcional	Número de variantes a omitir

Ejemplo de solicitud

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>;
}

Respuesta

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

GET /v1/variant/:variant_id

Devuelve detalles de una variante concreta

Parámetros

Nombre	Tipo	Obligatorio	Descripción
`variant_id`	uuid	Obligatorio	El ID de la variante a recuperar (parámetro de ruta)

Ejemplo de solicitud

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>;
}

Respuesta

{
"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

Añade una variante específica de pista a una pista ya procesada y encola su procesamiento

Añade un nuevo track file a una pista existente. La pista pasa a processing mientras se genera el nuevo archivo, y luego vuelve automáticamente a ready. Solo se admiten transcode y preview a través de este endpoint, y solo se permiten códecs de salida con pérdida (aac, mp3, ogg, opus). Los ajustes de códec son opcionales y por defecto son aac a 128 kbps.

Parámetros comunes

Nombre	Tipo	Obligatorio	Descripción
`track_id`	uuid	Obligatorio	La pista a la que añadir la variante (parámetro de ruta)
`variant_type_id`	string	Obligatorio	'transcode' (archivo de duración completa) o 'preview' (clip corto). Determina qué conjunto de parámetros de abajo se aplica
`index`	string	Obligatorio	Nombre de entrega de la variante (2–64 caracteres, letras/números/_/-). No debe coincidir con una variante existente de organización o pista

Cuando `variant_type_id` es `“transcode”`

Formato alternativo de duración completa. Ejemplo: { "variant_type_id": "transcode", "index": "mp3", "codec": "mp3", "bitrate": 192 }.

Parámetros de transcode

Nombre	Tipo	Obligatorio	Descripción
`codec`	string	Opcional	Códec de salida: aac (predeterminado), mp3, ogg u opus. Los códecs sin pérdida (flac, alac) no están permitidos
`bitrate`	number	Opcional	Bitrate de salida en kbps, 12–320 (predeterminado 128). Solo aplica a códecs que usan bitrate
`is_stereo`	boolean	Opcional	Mantener salida estéreo (predeterminado true). Cuando es false, la salida se mezcla a mono
`is_strip_tags`	boolean	Opcional	Eliminar etiquetas de metadatos de la salida (predeterminado true)
`is_strip_cover`	boolean	Opcional	Eliminar arte de portada incrustado de la salida (predeterminado true)

Cuando `variant_type_id` es `“preview”`

Clip corto recortado de la pista. También acepta los parámetros de transcode anteriores para el audio de salida (el códec por defecto es aac / 128). El inicio del clip es siempre un porcentaje de la duración de la pista (preview_start_percent).

Parámetros de preview

Nombre	Tipo	Obligatorio	Descripción
`preview_type`	string	Opcional	'seconds' (predeterminado) o 'percent' — cómo se mide la longitud del clip
`preview_seconds`	number	Opcional	Cuando preview_type es 'seconds': longitud del clip en segundos (predeterminado 60)
`preview_min_percent`	number	Opcional	Cuando preview_type es 'seconds': longitud mínima del clip como porcentaje de la duración, 0–100 (predeterminado 0)
`preview_max_percent`	number	Opcional	Cuando preview_type es 'seconds': longitud máxima del clip como porcentaje de la duración, 0–100 (predeterminado 50)
`preview_percent`	number	Opcional	Cuando preview_type es 'percent': longitud del clip como porcentaje de la duración, 0–100 (predeterminado 25)
`preview_min_seconds`	number	Opcional	Cuando preview_type es 'percent': longitud mínima del clip en segundos (predeterminado 0)
`preview_max_seconds`	number	Opcional	Cuando preview_type es 'percent': longitud máxima del clip en segundos (predeterminado 90)
`preview_start_percent`	number	Opcional	Dónde empieza el clip, como porcentaje de la duración total, 0–100 (predeterminado 25). Siempre se usa independientemente de preview_type

Ejemplo de solicitud

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>;
}

Respuesta

{
"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
  }
}
}

Variantes

Parámetros

Ejemplo de solicitud

Respuesta

Parámetros

Ejemplo de solicitud

Respuesta

Parámetros comunes

Cuando variant_type_id es “transcode”

Parámetros de transcode

Cuando variant_type_id es “preview”

Parámetros de preview

Ejemplo de solicitud

Respuesta

Cuando `variant_type_id` es `“transcode”`

Cuando `variant_type_id` es `“preview”`