Riferimento ai parametri dell'elemento GStreamer

Per inviare video all'SDK Amazon Kinesis Video Streams Producer, kvssink devi specificare come sink o destinazione finale della pipeline. La documentazione di riferimento fornisce informazioni sui parametri kvssink obbligatori e facoltativi. Per ulteriori informazioni, consulta Esempio: plugin Kinesis Video Streams Producer SDK GStreamer.

Argomenti

• Fornisci le credenziali a kvssink

• Fornisci una regione a kvssink

• kvssinkparametri obbligatori

• kvssinkparametri opzionali

Fornisci le credenziali a kvssink

Per consentire all'elemento kvssink GStreamer di effettuare richieste AWS, fornisci AWS le credenziali da utilizzare quando chiama il servizio Amazon Kinesis Video Streams. La catena di fornitori di credenziali cerca le credenziali nel seguente ordine:

1. AWS IoT credenziali

Per impostare AWS IoT le credenziali, vedere. Controllo dell'accesso alle risorse Kinesis Video Streams tramite AWS IoT

Il valore del iot-credentials parametro deve iniziare con iot-certificate, ed essere seguito da un elenco separato da virgole delle seguenti coppie chiave=valore.

Chiave	Richiesto	Descrizione
ca-path	Sì	Percorso del file del certificato CA utilizzato per stabilire la fiducia con il servizio di backend tramite TLS. Esempio: /file/path/to/certificate.pem
cert-path	Sì	Percorso del file del certificato X.509. Esempio: /file/path/to/certificateID-certificate.pem.crt
endpoint	Sì	L'endpoint del provider di AWS IoT Core credenziali per il tuo account. AWS Consulta la Guida per gli sviluppatori.AWS IoT Esempio: credential-account-specific-prefix.credentials.iot.aws-region.amazonaws.com
key-path	Sì	Percorso del file della chiave privata utilizzata nella coppia di chiavi pubblica/privata. Esempio: /file/path/to/certificateID-private.pem.key
role-aliases	Sì	Il nome dell'alias del ruolo che punta al ruolo AWS IAM da utilizzare durante la connessione a. AWS IoT Core Esempio: KvsCameraIoTRoleAlias
iot-thing-name	No	iot-thing-nameÈ facoltativo. Se non iot-thing-name viene fornito, viene utilizzato il valore del stream-name parametro. Esempio: kvs_example_camera

Esempio:

gst-launch-1.0 -v ... ! kvssink stream-name="YourStream" aws-region="YourRegion" iot-certificate="iot-certificate,endpoint=credential-account-specific-prefix.credentials.iot.aws-region.amazonaws.com,cert-path=certificateID-certificate.pem.crt,key-path=certificateID-private.pem.key,ca-path=certificate.pem,role-aliases=YourRoleAlias,iot-thing-name=YourThingName"

2. Variabili di ambiente

Per kvssink utilizzare le credenziali dell'ambiente, impostate le seguenti variabili di ambiente:

Nome della variabile di ambiente	Richiesto	Descrizione
AWS_ACCESS_KEY_ID	Sì	La chiave di AWS accesso utilizzata per accedere ad Amazon Kinesis Video Streams.
AWS_SECRET_ACCESS_KEY	Sì	La chiave AWS segreta associata alla chiave di accesso.
AWS_SESSION_TOKEN	No	Specifica il valore del token di sessione richiesto se si utilizzano credenziali di sicurezza temporanee direttamente dalle AWS STS operazioni.

L'impostazione della variabile di ambiente modifica il valore utilizzato fino al termine della sessione della shell o finché non imposti la variabile su un valore diverso. Per rendere le variabili persistenti nelle sessioni future, impostale nello script di avvio della shell.

3. access-key, secret-key parametri

Per specificare le credenziali direttamente come kvssink parametro, impostate i seguenti parametri:

kvssinkNome del parametro	Richiesto	Descrizione
access-key	Sì	La chiave di AWS accesso utilizzata per accedere ad Amazon Kinesis Video Streams.
secret-key	Sì	La chiave AWS segreta associata alla chiave di accesso.
session-token	No	Specifica il valore del token di sessione richiesto se si utilizzano credenziali di sicurezza temporanee direttamente dalle AWS STS operazioni.

Utilizzo di credenziali statiche:

gst-launch-1.0 -v ... ! kvssink stream-name="YourStream" aws-region="YourRegion" access-key="AKIDEXAMPLE" secret-key="SKEXAMPLE"

Utilizzo di credenziali temporanee:

gst-launch-1.0 -v ... ! kvssink stream-name="YourStream" aws-region="YourRegion" access-key="AKIDEXAMPLE" secret-key="SKEXAMPLE" session-token="STEXAMPLE"

4. File di credenziali

Importante

Se hai selezionato uno dei metodi precedenti, non puoi utilizzare il credential-file kvssink parametro.

kvssinkNome del parametro	Richiesto	Descrizione
credential-file	Sì	Percorso del file di testo contenente le credenziali in un formato specifico.

Il file di testo deve contenere credenziali in uno dei seguenti formati:

• CREDENZIALI YourAccessKeyYourSecretKey

• Scadenza delle credenziali YourAccessKeyYourSecretKeySessionToken

Esempio: il credentials.txt file si trova in /home/ubuntu e contiene quanto segue:

CREDENTIALS AKIDEXAMPLE 2023-08-10T22:43:00Z SKEXAMPLE STEXAMPLE

Per utilizzarlo inkvssink, digita:

gst-launch-1.0 -v ... ! kvssink stream-name="YourStream" aws-region="YourRegion" credential-file="/home/ubuntu/credentials.txt" 

Nota

Il tempo di scadenza dovrebbe essere di almeno 5 + 30 + 3 = 38 secondi nelle future. Il periodo di grazia è definito come la IOT_CREDENTIAL_FETCH_GRACE_PERIOD variabile in IotCredentialProvider.h. Se all'avvio le credenziali sono troppo vicine alla scadenzakvssink, viene visualizzato il codice di errore. 0x52000049 - STATUS_INVALID_TOKEN_EXPIRATION

Importante

kvssinknon modifica il file delle credenziali. Se utilizzi credenziali temporanee, il file delle credenziali deve essere aggiornato da una fonte esterna prima della scadenza meno il periodo di prova.

Fornisci una regione a kvssink

Di seguito è riportato l'ordine di ricerca della regione:

1. AWS_DEFAULT_REGIONla variabile di ambiente viene esaminata per prima. Se è impostata, quella regione viene utilizzata per configurare il client.

2. aws-regionil parametro viene esaminato successivamente. Se è impostato, quella regione viene utilizzata per configurare il client.

3. Se non è stato utilizzato nessuno dei metodi precedenti, il kvssink valore predefinito è. us-west-2

kvssinkparametri obbligatori

Oltre a fornire credenziali e una regione, l'kvssinkelemento ha il seguente parametro obbligatorio:

stream-name- Il nome dello stream video Amazon Kinesis di destinazione.

kvssinkparametri opzionali

L'elemento kvssink ha i seguenti parametri opzionali. Per ulteriori informazioni su questi parametri, consultare Strutture dei flussi video Kinesis.

Parametro	Descrizione	Unità/Tipo	Predefinita
absolute-fragment-times	Per scegliere se usare i tempi assoluti del frammento.	Booleano	true
access-key	La chiave di AWS accesso utilizzata per accedere a Kinesis Video Streams. Devi avere AWS le credenziali impostate o fornire questo parametro. Per fornire queste informazioni, digitare quanto segue: $ export AWS_ACCESS_KEY_ID=
avg-bandwidth-bps	La larghezza di banda media prevista del flusso.	Byte al secondo	4194304
aws-region	Quello Regione AWS da usare. Nota È inoltre possibile fornire alla regione la variabile di AWS_DEFAULT_REGION ambiente. Le variabili di ambiente hanno la precedenza se sono impostati sia la variabile di ambiente che i parametri kvssink. Importante La regione verrà impostata di default us-west-2 se non diversamente specificato.	Stringa	us-west-2
buffer-duration	Durata del buffer del flusso.	Secondi	180
codec-id	L'ID del codec del flusso.	Stringa	"V_MPEG4/ISO/AVC"
connection-staleness	L'ora dopo la quale viene chiamato lo stream staleness callback.	Secondi	60
content-type	Il tipo di contenuto del flusso.	Stringa	"video/h264"
fragment-acks	Per scegliere se utilizzare il frammento ACK.	Booleano	true
fragment-duration	La durata del frammento desiderata.	Millisecondi	2000
framerate	La frequenza fotogrammi prevista.	Fotogrammi al secondo	25
frame-timecodes	Per scegliere se utilizzare i timecode del fotogramma o generare timestamp tramite il callback dell'ora corrente.	Booleano	true
key-frame-fragmentation	Per scegliere se creare frammenti su un fotogramma chiave.	Booleano	true
log-config	Percorso di configurazione del log.	Stringa	"./kvs_log_configuration"
max-latency	La latenza massima del flusso.	Secondi	60
recalculate-metrics	Per scegliere se calcolare nuovamente i parametri.	Booleano	true
replay-duration	La durata per spostare all'indietro il lettore corrente per la riproduzione quando si verifica un errore se il riavvio è abilitato.	Secondi	40
restart-on-error	Per scegliere se riavviare quando si verifica un errore.	Booleano	true
retention-period	Il periodo di tempo in cui il flusso viene conservato.	Ore	2
rotation-period	Il periodo di rotazione delle chiavi. Per ulteriori informazioni, consulta Rotazione delle chiavi master del cliente.	Secondi	2400
secret-key	La chiave AWS segreta utilizzata per accedere a Kinesis Video Streams. Devi avere AWS le credenziali impostate o fornire questo parametro. $ export AWS_SECRET_ACCESS_KEY_ID=
session-token	Specifica il valore del token di sessione richiesto se si utilizzano credenziali di sicurezza temporanee direttamente dalle operazioni. AWS STS
storage-size	La dimensione di archiviazione del dispositivo in MegaBytes (MB). Per informazioni sulla configurazione dello storage del dispositivo, consulta StorageInfo.	MegaBytes	128
streaming-type	Tipo di streaming. I valori validi includono: 0: tempo reale 1: quasi in tempo reale (non attualmente supportato) 2: offline	Enum GstKvsSinkStreamingType	0: tempo reale
timecode-scale	La dimensione del timecode MKV.	Millisecondi	1
track-name	Il nome della traccia MKV.	Stringa	"kinesis_video"
iot-certificate	AWS IoT credenziali da utilizzare nell'kvssinkelemento. iot-certificateaccetta le seguenti chiavi e valori: Nota iot-thing-nameè facoltativo. Se non iot-thing-name viene fornito, viene utilizzato il valore del stream-name parametro. endpoint=iotcredentialsproviderendpoint cert-path=/localdirectorypath /to/certificate key-path=/localdirectorypath /to/private/key ca-path=/localdirectorypath/to/ca-cert role-aliases=role-aliases iot-thing-name=YourIotThingName	Stringa	Nessuno