API-Referenz

Der VidioClient ist der Hauptzugangspunkt zur Interaktion mit der VIDIO API von Python aus. Verwenden Sie ihn, um Dateien hochzuladen, Jobs für Highlight-Reels zu erstellen, den Jobstatus zu überprüfen, Ausgaben zu rendern und auf den Abschluss der Verarbeitung zu warten.

Der API-Zugang ist derzeit für den Studio-Plan und höher verfügbar.

Das Kundenmodell

Der VidioClient bietet eine einfache Schnittstelle für die Arbeit mit der VIDIO API. Nachdem Sie einen Client mit Ihrem API-Schlüssel erstellt haben, können Sie Eingabedateien hochladen, Jobs für Highlight-Reels erstellen, den Status von Jobs abfragen, Ausgaben rendern und auf den Abschluss von Jobs warten.

Eigenschaften

api_keystring

Ihr VIDIO API-Schlüssel, der zur Authentifizierung von Anfragen verwendet wird.

Methoden

KLASSEVidioClient(api_key)

Client initialisieren

Erstellt eine neue Instanz von VidioClient.

Parameters

api_keystring

Ihr VIDIO API-Schlüssel.

Returns

Eine konfigurierte VidioClient-Instanz.

python

from vidio import VidioClient
import os

client = VidioClient(
    api_key=os.getenv("VIDIO_API_KEY")
)

METHODclient.upload(file_path)

Datei hochladen

Lädt eine lokale Datei zu VIDIO hoch und gibt ein Upload-Ergebnis mit dem Eingabeschlüssel zurück.

Parameters

file_pathstring

Der lokale Pfad zur Datei, die Sie hochladen möchten.

Returns

Ein Upload-Ergebnisobjekt, das `input_key` enthält.

python

result = client.upload("/path/to/video.mp4")
print(result.input_key)

METHODclient.create_highlight_reel(input_keys, video_category, output_length, aspect_ratio)

Highlight-Reel erstellen

Erstellt einen Job für ein Highlight-Reel aus einer oder mehreren hochgeladenen Eingabedateien.

Parameters

input_keyslist[string]

Eine Liste von hochgeladenen Datei-Schlüsseln, die von upload() zurückgegeben wurden. Die Reihenfolge der Eingabeschlüssel bestimmt die Reihenfolge der Medien im Ausgabevideo.

video_categorystring

Videokategorie wie ball-sports. Es kann podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others sein. Für die besten Ergebnisse geben Sie die Kategorie an, die Ihrem Inhalt am nächsten kommt. Wenn Ihr Inhalt nicht in eine Kategorie passt, verwenden Sie others.

output_lengthinteger

Gewünschte Ausgabelänge in Sekunden. Die Ausgabelänge sollte kleiner oder gleich der Gesamtlänge aller zusammengefassten Eingabevideos sein.

aspect_ratiostring

Ausgabe-Seitenverhältnis wie landscape, portrait oder square.

Returns

Ein Jobobjekt, das `job_id` und Statusinformationen enthält.

python

job = client.create_highlight_reel(
    input_keys=[result.input_key],
    video_category="ball-sports",
    output_length=30,
    aspect_ratio="landscape",
)

print(job.job_id)
print(job.status)

METHODclient.get_job(job_id)

Job abrufen

Holt den aktuellen Status eines Jobs ab.

Parameters

job_idstring

Die Job-ID, die zurückgegeben wurde, als der Job für das Highlight-Reel erstellt wurde.

Returns

Ein Jobobjekt mit dem neuesten Status.

python

job_status = client.get_job(job.job_id)
print(job_status.status)

METHODclient.wait_for_job(job_id)

Auf Job warten

Fragt die API ab, bis der Job für das Highlight-Reel einen abgeschlossenen Status erreicht.

Parameters

job_idstring

Die Job-ID, auf die gewartet werden soll.

Returns

Das endgültige abgeschlossene Jobobjekt.

python

final_job = client.wait_for_job(job.job_id)
print(final_job.status)

METHODclient.render(job_id)

Ausgabe rendern

Startet das Rendern eines Ausgabevideos für einen abgeschlossenen Job für das Highlight-Reel.

Parameters

job_idstring

Die Job-ID des abgeschlossenen Jobs für das Highlight-Reel.

Returns

Ein Render-Ergebnisobjekt mit dem Renderstatus.

python

render_result = client.render(
    job_id=job.job_id
)

print(render_result.status)

METHODclient.wait_for_render(job_id)

Auf Render warten

Fragt, bis das Rendern abgeschlossen ist und die Ausgabe bereit ist.

Parameters

job_idstring

Die Job-ID, die mit dem Rendern verknüpft ist.

Returns

Das endgültige Render-Ergebnisobjekt.

python

final_render = client.wait_for_render(job.job_id)
print(final_render.output_url)