label: string

Default value: "Upload with Clipchamp!"

L’etichetta nel pulsante incorporato. Questo è il testo che viene mostrato sul pulsante, che viene posizionato nel wrapper.

size: string

Default value: "medium"
Allowed values:
tiny small medium large

La dimensione del pulsante Clipchamp. Scegli tra 4 dimensioni.

title: string

Default value: "Ye' olde video-upload shoppe"

Il titolo dell’UI che appare dopo che l’utente clicca sul pulsante incorporato. Il titolo viene mostrato sul popup in alto iframe.

logo: string

Default value: "https://api.clipchamp.com/static/button/images/logo.svg"

L’URL dell’immagine del logo per l’Interfaccia Utente. Questa è un’immagine che viene mostrata nell’angolo in alto a sinistra del iframe.

color: string

Default value: "#303030"

Determina il colore del pulsante Clipchamp, lo sfondo della barra del titolo del popup, e altri elementi grafici. Può essere un nome di un colore (come blue, un codice colore esadecimale (come #3300cc), o un colore RGB codificato (come rgba(78,24,212,0.5)).

style: object

Default value: undefined

Permette la personalizzazione dettagliata dell’aspetto visuale dell’API di Clipchamp utilizzando CSS. Un foglio di stile CSS personalizzato può essere fornito come un URL (style.url property) o come una stringa di dichiarazione CSS (style.text). In entrambi i casi, le dichiarazioni CSS personalizzate aumentano ma non rimpiazzano lo stile dell’interfaccia utente predefinita, che si basa sullo stile predefinito di Bootstrap 3. Vale a dire, lo stile CSS personalizzato è posto sopra lo stile CSS già esistente laddove le classi CSS esistenti possono essere aumentate, le proprietà CSS aggiunte o rimpiazzate. Piano Enterprise.

inline: object

Default value: undefined

Consente un posizionamento inline del widget dell’API in cui il <iframe> che contiene il widget Clipchamp viene inserito all’interno di un elemento wrapper nominato nella pagina di incorporamento. Piano Enterprise.

inputs: Array<string>

Default value: ["file", "camera"]
Allowed values:
file camera direct

Fonti da cui l’utente può scegliere un video in entrata: camera per la sua webcam e file per il sistema di file del suo computer. L’opzionedirect istruisce l’API Clipchamp a ricevere il/i file video in entrata senza alcune azione finale dell’utente direttamente tramite il parametro direct.files. Di conseguenza, l’opzione di ingresso direct non dovrebbe essere usata in combinazione con nessuna delle altre due opzioni (file, camera). Se entrambe direct e file o camera sono date nell’array degli input, allora le opzioni file e camera verranno ignorate e il parametro direct.files dovrebbe essere un array della/e istanza/eBlob.

output: string

Default value: "dummy"
Allowed values:
dummy blob azure s3 youtube gdrive dropbox

Le destinazioni in cui renderemo disponibile o caricato il video in uscita. Se si sceglie “blob”, forniamo il video in uscita come Blob al codice Java Script del tuo cliente. Se selezioni “youtube”, “azure” o “s3”, è necessario autorizzarci a caricare il video nell’account appropriato dalla pagina di configurazione . L’output “dummy” non produce nulla ma simula un upload utilizzando un semplice timer e può essere utilizzata per un’integrazione iniziale e per fare dei test iniziali senza avere un backend configurato.

upload: object

Default value: undefined

Impostazioni che configurano il processo di upload tramite tutte le destinazioni di upload supportate.

camera: object

Default value: undefined

Elementi di configurazione per personalizzare la registrazione con la fotocamera.

direct: object

Default value: undefined

Parametri extra che si applicano all’opzione direct all’interno del parametro di input.

enable: Array<string>

Default value: []
Allowed values:
batch fixup-webcam-webm mobile-webcam-format-fallback no-branding no-error-bypass no-hidden-run no-popout no-probe-reject no-thank-you no-user-retry

Abilita l’azione speciale dell’API Clipchamp:

  • batch – fai in modo che file multipli vengano processati e caricati in sequenza senza ulteriore interazione dell’utente.
  • fixup-webcam-webm – “fixes” Registrazioni WebM webcam che possono avere metadati di durata non corretta o mancanti. Utilizza questo flag se vuoi assicurarti che i passaggi successivi nella pipeline di elaborazione video ricevano i file WebM in cui i metadati video incorporati sono corretti e completi. Questo flag non si applica al momento su dispositivi mobili (ad esempio, telefoni Android con il mobile-webcam-format-fallback flag set). BETA
  • mobile-webcam-format-fallback – abilita la compressione delle registrazioni webcam su dispositivi mobili anche quando il formato target non è disponibile (sperimentale). Questa caratteristica al momento è limitata a Chrome su Android in cui con questo flag, l’API Clipchamp produce file WebM files utilizzando il codec video VP8 o VP9.
  • no-branding – rimuovi il marchio Clipchamp dall’Interfaccia Utente, se disponibile nel tuo piano. Questo non si applica nel pulsante inserito. Utilizza l’opzione pulsante API personalizzato per creare il pulsante incorporato (se disponibile nel tuo piano).
  • no-error-bypass – se la transcodifica fallisce per qualsiasi motivo, normalmente Clipchamp caricherebbe semplicemente il file di ingresso così per com’è. Questo flag sopprime questa azione. La causa più comune per i fallimenti di transcodifica sono i codec di input non supportati.
  • no-hidden-run – disabilita l’opzione per continuare a elaborare e caricare nello sfondo se l’utente chiude la finestra dopo aver cliccato su “invia”.
  • no-popout – alcuni browser bloccano l’uso di certe caratteristiche per il codice di terze parti. Quando questo viene rilevato, Clipchamp aprirà una nuova finestra per poter accedere a queste caratteristiche. L’impostazione di no-popout sopprime questa azione e obbliga Clipchamp a cercare di farlo con ciò che è disponibile. Ciò potrebbe portare ad un aumento delle esigenze di memoria, tra le altre cose.
  • no-probe-reject – nel caso in cui non siamo in grado di determinare che un file di input sia un video, verrà normalmente rifiutato. Questa opzione accetta tutti i file di input e salta direttamente all’upload per file non-video
  • no-thank-you – disabilita la schermata di ringraziamento e chiude immediatamente la finestra. Se ci fossero degli errori durante il processo l’ultima schermata rimarrebbe sempre mostrata.
  • no-user-retry – disabilita la conferma dell’utente e ritira l’opzione dopo che viene completata la registrazione webcam e prima che il file venga caricato. Aggiungendo questo flag inizierà immediatamente l’upload dopo che è terminata la registrazione webcam. Gli utenti non avranno possibilità di ripetere la loro registrazione webcam.

experimental: Array<string>

Default value: []
Allowed values:
force-popout overlong-recording h264-hardware-acceleration

Abilita l’azione sperimentale dell’API Clipchamp

  • force-popout – lancia sempre l’interfaccia utente dell’API Clipchamp in una finestra browser “popout” separata, anche se funzionerebbe all’interno di un iframe dentro il DOM incorporato del sito. Non deve essere utilizzato insieme al parametro no-popout (enable) del flag.
  • overlong-recording – permette registrazioni della telecamera webcam/mobile senza limitazioni di tempo della durata della registrazione (altrimenti forzata dall’API Clipchamp). La durata della registrazione può ancora essere deliberatamente limitata impostando un valore numerico (numero di secondi) nel parametro camera.limit. I clienti devono assicurarsi di impostare solo il flag overlong-recording nei browser supportati (al momento: Chrome, Opera e Firefox).
  • h264-hardware-acceleration – abilita la codifica dell’hardware-accelerata a H.264 sulle piattaforme supportate (al momento: dispositivi basati su ChromeOS/Chromebook x86). Il flag si applica solo al formatoweb (default) preset ed mp4 (default). A seconda dell’hardware sottostante, è possibile ottenere tempi di accelerazione multipli quando si imposta il flag h264-hardware-acceleration. I clienti sperimenteranno un diverso rapporto di compressione per la stessa qualità di output percepita (soggettivo) e sono quindi incoraggiati a regolare il parametro compression per ottenere un compromesso accettabile di qualità/compressione.

dropbox: object

Default value: undefined

Elementi di configurazione quando si utilizza il target di upload di Dropbox.

youtube: object

Default value: undefined

Elementi di configurazione quando si utilizza il target di upload di YouTube.

onWebcamStatusChange(status): function

Questa funzione di callback viene richiamata per un numero di eventi che interessano la registrazione dei video e la webcam o la fotocamera del telefono come tali, dove lo status è una String che riflette il nuovo status della webcam o della registrazione:

  • capture_started – la webcam o la fotocamera del telefono è stata accesa correttamente e sta catturando (ma non ancora registrando) un flusso video
  • capture_ended – la webcam o la fotocamera del telefono è stata spenta e non sta catturando più un flusso video
  • capture_failed – l’accesso alla webcam o alla fotocamera del telefono è fallito
  • recording_running – la registrazione webcam è iniziata o è stata ripresa dopo che era stata messa in pausa
  • recording_paused – la registrazione webcam è stata messa in pausa e può essere successivamente ripresa o terminata
  • recording_finished – la registrazione webcam è terminata ma potrebbe ancora essere elaborata prima che venga caricata o resa disponibile nel callback di onVideoCreated
  • recording_cancelled – la registrazione webcam è stata cancellata

Il monitoraggio dello status della webcam o della fotocamera del telefono è supportato nei browser desktop (ed in Chrome su Android quando il flag mobile-webcam-format-fallback è impostato nell’array del parametro enable).

onMetadataAvailable(metadata): function

Questa funzione di callback viene richiamata per ogni registrazione webcam e file di video in entrata quando la registrazione webcam o il file di video in entrata è stato analizzato con successo. Il parametro del metadata è un oggetto con le seguenti proprietà:

  • raw – il metadata del video raw è un oggetto con le seguenti proprietà:
    • formato – informazioni del formato del container del video
    • streams – flussi array del video, audio, sottotitoli, dati, ecc. contenuti nel video

Tieni presente che quando l’utente sceglie di scartare e ripetere una registrazione webcam, questo callback verrà richiamato svariate volte con i metadati delle diverse registrazioni. onMetadataAvailable verrà anche richiamata svariate volte quando si utilizza il flag batch, laddove l’utente può selezionare vari video in entrata. BETA

onPreviewAvailable(imageBlob): function

onPreviewAvailable si utilizza con l’immagine in anteprima quando essa è disponibile. Tieni presente che il parametro è un’istanza Blob e non un URL, l’immagine non è caricata alla destinazione di upload nominata accanto al video in uscita. Tieni anche presente che non in tutti i casi verranno prodotte immagini di anteprima, in particolar modo se il video in entrata è corrotto o contiene metadati invalidi/incompleti. BETA

onUploadComplete(data): function

Questa funzione callback viene richiamata una volta sola quando il video in uscita ha completato l’upload laddove un singolo oggetto data contiene meta informazioni sul file caricato. Ci sono due proprietà comuni:

  • filename – il nome del file del video originale
  • duration – la durata del video. Questo campo può essere assente in certe situazioni

Ci sono anche un numero di output-proprietà specifiche:

  • Se si utilizza l’output “youtube”
    • kind – “youtube”
    • id – l’ID del video
    • url – l’URL
    • embedHtml – il frammento di codice HTML fornito da YouTube per l’incorporazione del video (se previsto).
  • Se si utilizza l’output “azure”
    • kind – “azure”
    • blob – il corrente nome del blob Azure utilizzato per ultimo quando si memorizza l’upload.
  • Se si utilizza l’output “s3”
    • kind – “s3”
    • key – la chiave di oggetto corrente di Amazon S3 utilizzata per ultimo quando si memorizza l’upload.
  • Se si utilizza l’output “gdrive”
    • kind – “gdrive”
    • id – il file ID di Google
    • name – il nome del file così come archiviato in Google Drive.
    • url – l’URL nel file
    • folder – il file presente nella cartella ID di Google, o “root” se al livello superiore.
  • Se si utilizza l’output “dropbox”
    • kind – “dropbox”
    • id – l’ID del file Dropbox
    • name – il nome del file così come archiviato su Dropbox
    • path – il percorso del file su Dropbox
    • link – il link condiviso del file su Dropbox (richiede che l’opzione corrispondente venga commutata nelle impostazioni API di Clipchamp)
  • Se si utilizza l’output “blob”
    • kind – “blob”
    • data – array di qualsiasi onVideoCreated risultato in

onVideoCreated(blob [,done [,fail [,notify]]]): function

onVideoCreated viene utilizzato se l’output è impostato sul blob e il blob del video in uscita passerà come primo parametro. Il blob è valido fino a che questa funzione finisce il processo determinato dall’utilizzo di 1 dei 3 casi:

  1. Se l’indicazione della funzione contiene almeno un parametro completato e utilizza un callback sia completato che fallito.
  2. Se una promessa (o then) viene ritornata, aspetta che venga risolta o rifiutata.
  3. Se la funzione restituisce qualcosa di diverso rispetto a una promessa e non specifica almeno un parametro callback completato, il processo sarà considerato completato immediatamente al ritorno.

Fino a che la funzione non completa l’elaborazione, il file di output viene considerato come “being uploaded”. Se viene restituita una promessa capace di creare rapporti di avanzamento (cioè quando la funzione then accetta un terzo callback), o se il callback di notifica viene utilizzato, un progresso numerico verrà interpretato come percentuale di completamento del caricamento e verrà visualizzato sullo schermo come tale. Una volta completata l’elaborazione(come stabilito in precedenza) il blob non può più essere utilizzato in modo affidabile poiché l’archivio di supporto può essere stato rimosso.

onErrorOccurred(error): function

onErrorOccurred appare quando è stato rilevato un errore durante la registrazione, l’elaborazione o il caricamento di un video o la registrazione webcam/fotocamera. Il parametero error è un oggetto con una proprietà obbligatoria type, che può essere una delle seguenti:

  • webcam_processing, quando l’errore accade durante una registrazione webcam (o con la fotocamera del telefono);
  • video_processing, quando l’errore accade mentre un video in entrata o una registrazione webcam/fotocamera è stato processato (transcodificato/compresso) prima di caricare il video;
  • video_uploading, quando l’errore accade quando il video in uscita elaborato è stato caricato nella sua posizione di archiviazione selezionata;
  • other_unknown, quando la causa dell’errore è qualcos’altro o addirittura qualcosa di sconosciuto;

Una seconda proprietà(opzionale) message rappresenta una spiegazione di errore leggibile dall’uomo. È possibile utilizzare il valore stringa della proprietà message per mostrare un messaggio di errore ai tuoi utenti. Una proprietà opzionale details è un array che contiene ulteriori informazioni tecniche riguardo l’errore, come eccezioni, eventi di errore e simili. Utilizza il valore della proprietà details per comunicare eventuali problemi al supporto Clipchamp. Il callback onErrorOccurred può occasionalmente apparire varie volte per la stessa causa principale. Tieni presente che l’API di Clipchamp ha le disposizioni per compensare alcuni incidenti che vengono segnalati al callback onErrorOccurred. Ad esempio, il flag no-probe-reject (vedi il parametro abilita) assicurerà che un file video venga trasmesso al motore di transcodifica video anche se non è possibile estrarre metadati tecnici da quel file.

localization: object

Default value: undefined

Una tabella di stringhe disponibili per la localizzazione. Utilizzala per regolare tutti gli elementi rivolti all’utente dell’API affinché appaia nella lingua del tuo sito se non è in Inglese. Puoi anche utilizzare queste stringhe per eliminare i frammenti di testo che non desideri mostrare ai tuoi utenti.