

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# Référence des paramètres de l'élément GStreamer
<a name="examples-gstreamer-plugin-parameters"></a>

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](examples-gstreamer-plugin.md).

**Rubriques**
+ [Fournissez des informations d'identification à `kvssink`](#credentials-to-kvssink)
+ [Fournissez une région à `kvssink`](#kvssink-region)
+ [`paramètres facultatifs kvssink`](#kvssink-optional-parameters)

## Fournissez des informations d'identification à `kvssink`
<a name="credentials-to-kvssink"></a>

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 :

### 1. AWS IoT informations d’identification
<a name="collapsible-section-1"></a>

Pour configurer les AWS IoT informations d'identification, consultez[Contrôler l'accès aux ressources de Kinesis Video Streams à l'aide de AWS IoT](how-iot.md).

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** : ` /{{file}}/{{path}}/{{to}}/certificate.pem` | 
| cert-path | Oui | Chemin du fichier vers le X.509 certificat. **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](https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html).**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** : `/{{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** : `{{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** : `{{kvs_example_camera}}` | 

**Example**  
**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}}"
```

### 2. Variables d’environnement
<a name="collapsible-section-2"></a>

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.

### 3. `paramètres de clé d'accès et de clé` secrète ``
<a name="collapsible-section-3"></a>

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. | 

**Example**  
**À 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}}"
```

**Example**  
**À 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}}"
```

### 4. Fichier d'identification
<a name="collapsible-section-4"></a>

**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}}

**Example**  
**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 dans`kvssink`, tapez :   

```
gst-launch-1.0 -v ... ! kvssink stream-name="{{YourStream}}" aws-region="{{YourRegion}}" credential-path="/home/ubuntu/{{credentials}}.txt" 
```
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`](https://github.com/awslabs/amazon-kinesis-video-streams-producer-c/blob/master/src/source/Common/IotCredentialProvider.h). Si les informations d'identification sont trop proches de leur date d'expiration lorsque vous démarrez`kvssink`, vous recevez le code d'erreur`0x52000049 - STATUS_INVALID_TOKEN_EXPIRATION`.
`kvssink`ne 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`
<a name="kvssink-region"></a>

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

1. `AWS_DEFAULT_REGION`la variable d'environnement est d'abord examinée. Si elle est définie, cette région est utilisée pour configurer le client.

1. `aws-region`le paramètre est passé en revue ensuite. Si elle est définie, cette région est utilisée pour configurer le client.

1. 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`
<a name="kvssink-optional-parameters"></a>

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](producer-reference-structures-stream.md).



| Paramètre | Description | Unité / Type | Par défaut | 
| --- | --- | --- | --- | 
| stream-name  | Nom du flux vidéo Amazon Kinesis de destination.  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. <br />Vous devez définir les AWS informations d'identification ou fournir ce paramètre. Pour fournir ces informations, saisissez ce qui suit :<pre>export AWS_ACCESS_KEY_ID=</pre> |  |  | 
| avg-bandwidth-bps | Bande passante moyenne attendue pour le flux.  | Bits par seconde | 4194304 | 
| aws-region | Le Région AWS à utiliser. 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.  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](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html). | Secondes | 3600 | 
| secret-key | La clé AWS secrète utilisée pour accéder à Kinesis Video Streams.<br />Vous devez définir les AWS informations d'identification ou fournir ce paramètre.<pre>export AWS_SECRET_ACCESS_KEY=</pre> |  |  | 
| 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](producer-reference-structures-producer.md#producer-reference-structures-producer-storageinfo). | Mébioctet (MiB) | 128 | 
| streaming-type | Le type de streaming. Les valeurs valides sont les suivantes : +  0 : temps réel <br />+  1 : temps quasi réel (non pris en charge actuellement) <br />+  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. <br />`iot-certificate`accepte les clés et valeurs suivantes :  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` <br />+  `cert-path`=`/localdirectorypath /to/certificate` <br />+  `key-path`=`/localdirectorypath /to/private/key` <br />+  `ca-path`=`/localdirectorypath/to/ca-cert` <br />+  `role-aliases`=`role-aliases` <br />+  `iot-thing-name`=`YourIotThingName`  | Chaîne | Aucune | 