Αναφορά API

Ο VidioClient είναι το κύριο σημείο εισόδου για την αλληλεπίδραση με το VIDIO API από την Python. Χρησιμοποιήστε το για να ανεβάσετε αρχεία, να δημιουργήσετε εργασίες βίντεο, να ελέγξετε την κατάσταση εργασίας, να αποδώσετε αποτελέσματα και να περιμένετε να ολοκληρωθεί η επεξεργασία.

Η πρόσβαση API είναι αυτή τη στιγμή διαθέσιμη για το σχέδιο Studio και άνω.

Το μοντέλο πελάτη

Ο VidioClient παρέχει μια απλή διεπαφή για εργασία με το VIDIO API. Αφού δημιουργήσετε έναν πελάτη με το κλειδί API σας, μπορείτε να ανεβάσετε αρχεία εισόδου, να δημιουργήσετε εργασίες βίντεο, να ελέγξετε την κατάσταση εργασίας, να αποδώσετε αποτελέσματα και να περιμένετε να ολοκληρωθούν οι εργασίες.

Ιδιότητες

api_keystring

Το κλειδί API VIDIO που χρησιμοποιείτε για την αυθεντικοποίηση αιτήσεων.

Μέθοδοι

CLASSVidioClient(api_key)

Αρχικοποίηση πελάτη

Δημιουργεί μια νέα εμφάνιση VidioClient.

Parameters

api_keystring

Το κλειδί API VIDIO σας.

Returns

Μια ρυθμισμένη εμφάνιση VidioClient.

python

from vidio import VidioClient
import os

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

METHODclient.upload(file_path)

Ανέβασμα αρχείου

Ανεβάζει ένα τοπικό αρχείο στο VIDIO και επιστρέφει ένα αποτέλεσμα ανέβασματος που περιέχει το κλειδί εισόδου.

Parameters

file_pathstring

Η τοπική διαδρομή προς το αρχείο που θέλετε να ανεβάσετε.

Returns

Ένα αντικείμενο αποτελέσματος ανέβασματος που περιέχει `input_key`.

python

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

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

Δημιουργία βίντεο

Δημιουργεί μια εργασία βίντεο από ένα ή περισσότερα αν uploaded input files.

Parameters

input_keyslist[string]

Μια λίστα με τα κλειδιά των ανεβασμένων αρχείων που επιστράφηκαν από το upload(). Η σειρά των κλειδιών εισόδου καθορίζει τη σειρά των μέσων στο βίντεο εξόδου.

video_categorystring

Κατηγορία βίντεο όπως ball-sports. Μπορεί να είναι podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others. Για καλύτερα αποτελέσματα, καθορίστε την κατηγορία που ταιριάζει καλύτερα με το περιεχόμενό σας. Αν το περιεχόμενό σας δεν ταιριάζει σε καμία κατηγορία, χρησιμοποιήστε others.

output_lengthinteger

Επιθυμητό μήκος εξόδου σε δευτερόλεπτα. Το μήκος εξόδου πρέπει να είναι μικρότερο ή ίσο με το συνολικό μήκος όλων των βίντεο εισόδου που έχει συνδυαστεί.

aspect_ratiostring

Αναλογία διαστάσεων εξόδου όπως landscape, portrait ή square.

κατηγορία μουσικήςstring, optional

Προεπιλεγμένη κατηγορία μουσικής που θα εφαρμοστεί στην έξοδο. Οι υποστηριζόμενες τιμές είναι corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary, και trending_vlogs. Εάν η διάρκεια της εξόδου είναι μικρότερη από τη διάρκεια της μουσικής, το επιλεγμένο κομμάτι θα επαναλαμβάνεται για να ταιριάξει με την έξοδο.

music_volumeinteger, optional

Ένταση της μουσικής φόντου από 0 έως 100. Εάν δεν δοθεί, η προεπιλογή είναι 100.

αρχικός_όγκος_ήχου_πηγήςinteger, optional

Αρχικός όγκος ήχου πηγής από 0 έως 100. Εάν δεν παρέχεται, η προεπιλογή είναι 100.

Returns

Ένα αντικείμενο εργασίας που περιέχει `job_id` και πληροφορίες κατάστασης.

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)

Λήψη εργασίας

Ανακτά την τρέχουσα κατάσταση μιας εργασίας.

Parameters

job_idstring

Το ID της εργασίας που επιστράφηκε όταν δημιουργήθηκε η εργασία βίντεο.

Returns

Ένα αντικείμενο εργασίας με την τελευταία κατάσταση.

Response fields

job_idstring

Το αναγνωριστικό εργασίας.

statusstring

Η τρέχουσα κατάσταση της εργασίας, όπως submitted, queued, processing, processed, rendering ή rendered.

outputslist[OutputResult]

Επιστρέφεται όταν η εργασία έχει αποδοθεί πλήρως και τα δεδομένα εξόδου είναι διαθέσιμα από την τελευταία υπο-εργασία.

startfloat | null

Χρόνος έναρξης του τμήματος εξόδου, εάν είναι διαθέσιμος.

endfloat | null

Χρόνος λήξης του τμήματος εξόδου, εάν είναι διαθέσιμος.

thumbnailstring | null

Διαδρομή μικρογραφίας ή URL για την έξοδο.

durationfloat | null

Διάρκεια της εξόδου σε δευτερόλεπτα.

fpsfloat | null

Καρέ ανά δευτερόλεπτο της εξόδου.

overlayslist[OverlayResult]

Καθαρισμένες επικάλυψεις που περιλαμβάνονται στην έξοδο.

idinteger | null

Αναγνωριστικό επικάλυψης.

fileIDstring | null

Συνδεδεμένο αναγνωριστικό αρχείου, όταν είναι διαθέσιμο.

originalFileNamestring | null

Όνομα του αρχικού αρχείου εισόδου που σχετίζεται με την επικάλυψη, όταν είναι διαθέσιμο.

from_integer | float | null

Απόκλιση καρέ όπου ξεκινά η επικάλυψη.

contentstring | null

Τιμή περιεχομένου επικάλυψης, όπως διαδρομή μικρογραφίας ή αναγνωριστικό ήχου.

durationInFramesinteger | null

Διάρκεια επικάλυψης σε καρέ.

typestring | null

Τύπος επικάλυψης, όπως video ή sound.

srcstring | null

URL πηγής για τα μέσα της επικάλυψης.

videoStartTimeinteger | float | null

Χρόνος έναρξης του βίντεο προέλευσης, όταν εφαρμόζεται.

python

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

json

{
  "job_id": "abc123",
  "status": "επεξεργασμένο",
  "outputs": [
    {
      "start": null,
      "end": null,
      "thumbnail": "out/...jpg",
      "duration": 15.22,
      "overlays": [
        {
          "id": 0,
          "fileID": "file_123",
          "from": 0,
          "content": "https://...",
          "durationInFrames": 284,
          "type": "video",
          "src": "https://...",
          "videoStartTime": 5425
        },
        {
          "id": 876361,
          "from": 0,
          "content": "τρέξιμο-νύχτα-393139",
          "durationInFrames": 912,
          "type": "sound",
          "src": "https://..."
        }
      ],
      "fps": 59.94
     }
  ]
}

METHODclient.wait_for_job(job_id)

Αναμονή για εργασία

Ελέγχει το API μέχρι η εργασία βίντεο να φτάσει σε κατάσταση ολοκλήρωσης.

Parameters

job_idstring

Το ID της εργασίας για την οποία περιμένετε.

Returns

Το τελικό αντικείμενο ολοκληρωμένης εργασίας.

python

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

METHODclient.render(job_id)

Απόδοση εξόδου

Ξεκινά την απόδοση ενός βίντεο εξόδου για μια ολοκληρωμένη εργασία βίντεο.

Parameters

job_idstring

Το ID της ολοκληρωμένης εργασίας βίντεο.

output_indexinteger, optional

Ο δείκτης της λίστας OutputResult που θα αποδοθεί. Η προεπιλεγμένη τιμή είναι 0. Γενικά, το πρώτο αποτέλεσμα είναι το καλύτερο.

Returns

Ένα αντικείμενο αποτελέσματος απόδοσης με την κατάσταση απόδοσης.

python

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

print(render_result.status)

METHODclient.wait_for_render(job_id)

Αναμονή για απόδοση

Ελέγχει μέχρι να ολοκληρωθεί η απόδοση και η έξοδος να είναι έτοιμη.

Parameters

job_idstring

Το ID της εργασίας που σχετίζεται με την απόδοση.

Returns

Το τελικό αντικείμενο αποτελέσματος απόδοσης.

python

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