Fournissez des informations d'identification à kvssink Fournissez une région à kvssink paramètres facultatifs kvssink

Référence des paramètres de l'élément GStreamer

Pour envoyer une vidéo vers le SDK C++ d'Amazon Kinesis Video Streams Producer, vous devez spécifier kvssink le récepteur ou la destination finale du pipeline. Cette référence fournit des informations sur les paramètres obligatoires et facultatifs de l'élément kvssink. Pour de plus amples informations, veuillez consulter Exemple : plug-in GStreamer du SDK pour le producteur de flux vidéo Kinesis - kvssink.

Rubriques

Fournissez des informations d'identification à kvssink
Fournissez une région à kvssink
paramètres facultatifs kvssink

Fournissez des informations d'identification à `kvssink`

Pour autoriser l'élément kvssink GStreamer à adresser des requêtes AWS, fournissez les AWS informations d'identification qu'il utilisera lorsqu'il appelle le service Amazon Kinesis Video Streams. La chaîne de fournisseurs d'informations d'identification recherche les informations d'identification dans l'ordre suivant :

Pour configurer les AWS IoT informations d'identification, consultezContrôler l'accès aux ressources de Kinesis Video Streams à l'aide de AWS IoT.

La valeur du iot-credentials paramètre doit commencer par iot-certificate, et être suivie d'une liste des paires key = value suivantes, séparées par des virgules.

Clé	Obligatoire	Description
`ca-path`	Oui	Chemin du fichier vers le certificat CA utilisé pour établir la confiance avec le service principal via TLS. Exemple Exemple : `/file/path/to/certificate.pem`
`cert-path`	Oui	Chemin du fichier vers le X.509 certificat. Exemple Exemple : `/file/path/to/certificateID-certificate.pem.crt`
`endpoint`	Oui	Le point de terminaison AWS IoT Core du fournisseur d'informations d'identification pour votre AWS compte. Consultez le guide AWS IoT du développeur. Exemple Exemple : `credential-account-specific-prefix.credentials.iot.aws-region.amazonaws.com`
`key-path`	Oui	Chemin du fichier vers la clé privée utilisée dans la paire de public/private clés. Exemple Exemple : `/file/path/to/certificateID-private.pem.key`
`role-aliases`	Oui	Le nom de l'alias de rôle pointant vers le rôle AWS IAM à utiliser lors de la connexion. AWS IoT Core Exemple Exemple : `KvsCameraIoTRoleAlias`
`iot-thing-name`	Non	L’option `iot-thing-name` est facultative. Si elle n'`iot-thing-name`est pas fournie, la valeur du `stream-name` paramètre est utilisée. Exemple Exemple : `kvs_example_camera`

Exemple

Exemple :


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"

Pour kvssink utiliser les informations d'identification de l'environnement, définissez les variables d'environnement suivantes :

Nom de la variable d'environnement	Obligatoire	Description
`AWS_ACCESS_KEY_ID`	Oui	La clé AWS d'accès utilisée pour accéder à Amazon Kinesis Video Streams.
`AWS_SECRET_ACCESS_KEY`	Oui	La clé AWS secrète associée à la clé d'accès.
`AWS_SESSION_TOKEN`	Non	Spécifie la valeur du jeton de session requise si vous utilisez des informations d'identification de sécurité temporaires directement depuis AWS STS les opérations.

La définition de la variable d’environnement permet de modifier la valeur utilisée jusqu’à la fin de votre session shell, ou jusqu’à ce que vous définissiez la variable sur une autre valeur. Pour que les variables persistent lors des sessions futures, définissez-les dans le script de démarrage de votre shell.

Pour spécifier les informations d'identification directement en tant que kvssink paramètre, définissez les paramètres suivants :

`kvssink`Nom du paramètre	Obligatoire	Description
`access-key`	Oui	La clé AWS d'accès utilisée pour accéder à Amazon Kinesis Video Streams.
`secret-key`	Oui	La clé AWS secrète associée à la clé d'accès.
`session-token`	Non	Spécifie la valeur du jeton de session requise si vous utilisez des informations d'identification de sécurité temporaires directement depuis AWS STS les opérations.

Exemple

À l'aide d'informations d'identification statiques :


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

Exemple

À l'aide d'informations d'identification temporaires :


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

Important

Si vous avez sélectionné l'une des méthodes précédentes, vous ne pouvez pas utiliser le credential-path kvssink paramètre.

`kvssink`Nom du paramètre	Obligatoire	Description
`credential-path`	Oui	Chemin d'accès au fichier texte contenant les informations d'identification dans un format spécifique.

Le fichier texte doit contenir des informations d'identification dans l'un des formats suivants :

INFORMATIONS D'IDENTIFICATION YourAccessKey YourSecretKey
INFORMATIONS D'IDENTIFICATION YourAccessKey Expiration YourSecretKey SessionToken

Exemple

Exemple : Votre credentials.txt fichier se trouve dans /home/ubuntu et contient les éléments suivants :

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

Pour l'utiliser danskvssink, tapez :


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

Note

Le délai d'expiration doit être d'au moins 5 + 30 + 3 = 38 secondes dans le futur. Le délai de grâce est défini comme la IOT_CREDENTIAL_FETCH_GRACE_PERIOD variable dans IotCredentialProvider.h. Si les informations d'identification sont trop proches de leur date d'expiration lorsque vous démarrezkvssink, vous recevez le code d'erreur0x52000049 - STATUS_INVALID_TOKEN_EXPIRATION.

Important

kvssinkne modifie pas le fichier d'informations d'identification. Si vous utilisez des informations d'identification temporaires, le fichier d'informations d'identification doit être mis à jour par une source externe avant la date d'expiration moins le délai de grâce.

Fournissez une région à `kvssink`

L'ordre de recherche des régions est le suivant :

AWS_DEFAULT_REGIONla variable d'environnement est d'abord examinée. Si elle est définie, cette région est utilisée pour configurer le client.
aws-regionle paramètre est passé en revue ensuite. Si elle est définie, cette région est utilisée pour configurer le client.
Si aucune des méthodes précédentes n'a été utilisée, la kvssink valeur par défaut est. us-west-2

`paramètres facultatifs kvssink`

Les paramètres facultatifs pour l'élément kvssink sont les suivants. Pour obtenir plus d’informations sur ces paramètres, consultez Structures de flux vidéo Kinesis.

Paramètre	Description	Unité / Type	Par défaut
`stream-name`	Nom du flux vidéo Amazon Kinesis de destination. Important Si aucun nom de flux n'est spécifié, le nom de flux par défaut sera utilisé : « DEFAULT_STREAM ». Si aucun flux portant ce nom par défaut n'existe déjà, il sera créé.
`absolute-fragment-times`	Indique s'il faut utiliser des fragments absolus.	Booléen	true
`access-key`	La clé AWS d'accès utilisée pour accéder à Kinesis Video Streams. Vous devez définir les AWS informations d'identification ou fournir ce paramètre. Pour fournir ces informations, saisissez ce qui suit : `export AWS_ACCESS_KEY_ID=`
`avg-bandwidth-bps`	Bande passante moyenne attendue pour le flux.	Bits par seconde	4194304
`aws-region`	Le Région AWS à utiliser. Note Vous pouvez également fournir la variable d'`AWS_DEFAULT_REGION`environnement à la région. Les variables d'environnement sont prioritaires si la variable d'environnement et les paramètres kvssink sont définis. Important La région sera définie par défaut, sauf indication contraire. `us-west-2`	Chaîne	`"us-west-2"`
`buffer-duration`	Durée de la mémoire tampon du flux.	Secondes	120
`codec-id`	L'ID de codec du flux.	Chaîne	`"V_MPEG4/ISO/AVC"`
`connection-staleness`	Le délai après lequel le rappel d'obsolescence du flux est appelé.	Secondes	60
`content-type`	Le type de contenu du flux.	Chaîne	`"video/h264"`
`fragment-acks`	Indique s'il faut utiliser des ACK de fragment.	Booléen	true
`fragment-duration`	La durée de fragment souhaitée.	Millisecondes	2000
`framerate`	Débit d'images attendu.	Images par seconde	25
`frame-timecodes`	Indique s'il faut utiliser codes horaires d'image ou générer des horodatages à l'aide du rappel actuel.	Booléen	true
`key-frame-fragmentation`	Indique s'il faut générer des fragments sur une image clé.	Booléen	true
`log-config`	Le chemin d'accès de configuration du journal.	Chaîne	`"../kvs_log_configuration"`
`max-latency`	La latence maximum pour le flux.	Secondes	60
`recalculate-metrics`	Indique s'il faut recalculer les métriques.	Booléen	true
`replay-duration`	La durée de restauration du lecteur actuel pour relire en cas d'erreur si le redémarrage est activé.	Secondes	40
`restart-on-error`	Indique s'il faut redémarrer en cas d'erreur.	Booléen	true
`retention-period`	La durée pendant laquelle le flux est conservé.	heures	2
`rotation-period`	La période de rotation des clés d'accès. Pour plus d'informations, consultez la section AWS KMS Touches rotatives.	Secondes	3600
`secret-key`	La clé AWS secrète utilisée pour accéder à Kinesis Video Streams. Vous devez définir les AWS informations d'identification ou fournir ce paramètre. `export AWS_SECRET_ACCESS_KEY=`
`session-token`	Spécifie la valeur du jeton de session requise si vous utilisez des informations d'identification de sécurité temporaires directement depuis AWS STS les opérations.
`storage-size`	Taille de stockage de l'appareil en mébioctet (MiB). Pour plus d'informations sur la configuration du stockage de l'appareil, consultez StorageInfo.	Mébioctet (MiB)	128
`streaming-type`	Le type de streaming. Les valeurs valides sont les suivantes : 0 : temps réel 1 : temps quasi réel (non pris en charge actuellement) 2 : hors ligne	Enum `GstKvsSinkStreamingType`	0 : temps réel
`timecode-scale`	L'échelle de code horaire MKV.	Millisecondes	1
`track-name`	Nom de la piste MKV.	Chaîne	`"kinesis_video"`
`iot-certificate`	AWS IoT informations d'identification à utiliser dans l'`kvssink`élément. `iot-certificate`accepte les clés et valeurs suivantes : Note Le `iot-thing-name` est facultatif. Si elle n'`iot-thing-name`est pas fournie, la valeur du `stream-name` paramètre est utilisée. `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`	Chaîne	Aucune

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Plug-in GStreamer - kvssink

PutMedia API