

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# GStreamer referencia de parámetros de elementos
<a name="examples-gstreamer-plugin-parameters"></a>

*Para enviar un vídeo al SDK de C\$1\$1 para productores de Amazon Kinesis Video Streams, debe `kvssink` especificarlo como destino final o destino final de la canalización.* Esta referencia proporciona información sobre parámetros `kvssink` obligatorios y opcionales. Para obtener más información, consulte [Ejemplo: complemento del GStreamer SDK para productores de Kinesis Video Streams: kvssink](examples-gstreamer-plugin.md).

**Temas**
+ [Proporcione las credenciales a `kvssink`](#credentials-to-kvssink)
+ [Proporcione una región a `kvssink`](#kvssink-region)
+ [`kvssink`parámetros opcionales](#kvssink-optional-parameters)

## Proporcione las credenciales a `kvssink`
<a name="credentials-to-kvssink"></a>

Para permitir que el `kvssink` GStreamer elemento realice solicitudes AWS, proporcione AWS las credenciales que utilizará cuando llame al servicio Amazon Kinesis Video Streams. La cadena de proveedores de credenciales busca las credenciales en el siguiente orden:

### 1. AWS IoT credenciales
<a name="collapsible-section-1"></a>

Para configurar AWS IoT las credenciales, consulte[Control del acceso a los recursos de Kinesis Video Streams mediante AWS IoT](how-iot.md).

El valor del `iot-credentials` parámetro debe empezar por `iot-certificate,` e ir seguido de una lista separada por comas de los siguientes pares *key* =*value*.


****  

| Key | Obligatorio | Descripción | 
| --- | --- | --- | 
| ca-path | Sí | Ruta del archivo al certificado de CA utilizado para establecer la confianza con el servicio de backend a través de TLS. 

**Example**  
**Ejemplo**: ` /file/path/to/certificate.pem` | 
| cert-path | Sí | Ruta del archivo al certificado X.509.  

**Example**  
**Ejemplo**: `/file/path/to/certificateID-certificate.pem.crt` | 
| endpoint | Sí | El punto de conexión del proveedor de AWS IoT Core credenciales de su cuenta. AWS Consulte la [guía AWS IoT para desarrolladores](https://docs.aws.amazon.com//iot/latest/developerguide/authorizing-direct-aws.html). 

**Example**  
**Ejemplo**: `credential-account-specific-prefix.credentials.iot.aws-region.amazonaws.com` | 
| key-path | Sí | Ruta del archivo a la clave privada utilizada en el public/private key pair.  

**Example**  
**Ejemplo**: `/file/path/to/certificateID-private.pem.key` | 
| role-aliases | Sí | El nombre del alias del rol que apunta al rol de AWS IAM que se va a usar al conectarse AWS IoT Core.  

**Example**  
**Ejemplo**: `KvsCameraIoTRoleAlias` | 
| iot-thing-name | No | La `iot-thing-name` es opcional. Si no `iot-thing-name` se proporciona, se utiliza el valor del `stream-name` parámetro. 

**Example**  
**Ejemplo**: `kvs_example_camera` | 

**Example**  
**Ejemplo:**  

```
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 de entorno
<a name="collapsible-section-2"></a>

Para poder `kvssink` utilizar las credenciales del entorno, defina las siguientes variables de entorno:


****  

| Nombre de la variable de entorno | Obligatorio | Descripción | 
| --- | --- | --- | 
| AWS\$1ACCESS\$1KEY\$1ID | Sí | La clave de AWS acceso que se utiliza para acceder a Amazon Kinesis Video Streams. | 
| AWS\$1SECRET\$1ACCESS\$1KEY | Sí | La clave AWS secreta asociada a la clave de acceso. | 
| AWS\$1SESSION\$1TOKEN | No | Especifica el valor del token de sesión necesario si utiliza credenciales de seguridad temporales directamente de AWS STS las operaciones. | 

La configuración de la variable de entorno cambia el valor usado hasta el final de su sesión del intérprete de comandos o hasta que otorgue a la variable un valor diferente. Para que las variables sean persistentes en futuras sesiones, configúrelas en el script de inicio de su shell.

### 3. `access-key`, `secret-key` parámetros
<a name="collapsible-section-3"></a>

Para especificar las credenciales directamente como `kvssink` parámetro, defina los siguientes parámetros:


****  

| `kvssink`Nombre del parámetro | Obligatorio | Descripción | 
| --- | --- | --- | 
| access-key | Sí | La clave de AWS acceso que se utiliza para acceder a Amazon Kinesis Video Streams. | 
| secret-key | Sí | La clave AWS secreta asociada a la clave de acceso. | 
| session-token | No | Especifica el valor del token de sesión necesario si utiliza credenciales de seguridad temporales directamente de AWS STS las operaciones. | 

**Example**  
**Uso de credenciales estáticas:**  

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

**Example**  
**Uso de credenciales temporales:**  

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

### 4. Archivo de credenciales
<a name="collapsible-section-4"></a>

**importante**  
Si ha seleccionado uno de los métodos anteriores, no podrá usar el `credential-path` `kvssink` parámetro.


****  

| `kvssink`Nombre del parámetro | Obligatorio | Descripción | 
| --- | --- | --- | 
| credential-path | Sí | Ruta al archivo de texto que contiene las credenciales en un formato específico. | 

El archivo de texto debe contener credenciales en uno de los siguientes formatos:
+ CREDENCIALES *YourAccessKey* *YourSecretKey*
+ CREDENCIALES *YourAccessKey* *Expiration* *YourSecretKey* *SessionToken*

**Example**  
**Ejemplo:** el `credentials.txt` archivo se encuentra en `/home/ubuntu` y contiene lo siguiente:   
`CREDENTIALS AKIDEXAMPLE 2023-08-10T22:43:00Z SKEXAMPLE STEXAMPLE`  
Para usarlo en`kvssink`, escriba:   

```
gst-launch-1.0 -v ... ! kvssink stream-name="YourStream" aws-region="YourRegion" credential-path="/home/ubuntu/credentials.txt" 
```
El tiempo de caducidad debería ser de al menos 5 \$1 30 \$1 3 = **38** segundos en el futuro. El período de gracia se define como la `IOT_CREDENTIAL_FETCH_GRACE_PERIOD` variable en [https://github.com/awslabs/amazon-kinesis-video-streams-producer-c/blob/master/src/source/Common/IotCredentialProvider.h](https://github.com/awslabs/amazon-kinesis-video-streams-producer-c/blob/master/src/source/Common/IotCredentialProvider.h). Si las credenciales están muy cerca de caducar al empezar`kvssink`, recibirá el código de error`0x52000049 - STATUS_INVALID_TOKEN_EXPIRATION`.
`kvssink`no modifica el archivo de credenciales. Si utiliza credenciales temporales, una fuente externa debe actualizar el archivo de credenciales antes de la fecha de caducidad menos el período de gracia. 

## Proporcione una región a `kvssink`
<a name="kvssink-region"></a>

El orden de búsqueda de las regiones es el siguiente:

1. `AWS_DEFAULT_REGION`la variable de entorno se revisa primero. Si está establecida, esa región se usa para configurar el cliente.

1. `aws-region`El parámetro se revisa a continuación. Si está establecido, esa región se usa para configurar el cliente.

1. Si no se ha utilizado ninguno de los métodos anteriores, el `kvssink` valor predeterminado es. `us-west-2` 

## `kvssink`parámetros opcionales
<a name="kvssink-optional-parameters"></a>

El elemento `kvssink` tiene los siguientes parámetros opcionales. Para obtener más información sobre estos parámetros, consulte [Estructuras de transmisión de vídeo de Kinesis](producer-reference-structures-stream.md).


****  

| Parámetro | Description (Descripción) | Unidad/tipo | Predeterminado | 
| --- | --- | --- | --- | 
| stream-name  | El nombre de la transmisión de vídeo de Amazon Kinesis de destino.  Si no se especifica ningún nombre de transmisión, se utilizará el nombre de transmisión predeterminado: «DEFAULT\$1STREAM». Si aún no existe una transmisión con ese nombre predeterminado, se creará.  |  |  | 
| absolute-fragment-times | Si se utilizan tiempos de fragmentos absolutos. | Booleano | true | 
| access-key | La clave de AWS acceso que se utiliza para acceder a Kinesis Video Streams.  Debe tener AWS configuradas las credenciales o proporcionar este parámetro. Para proporcionar esta información, escriba lo siguiente: <pre>export AWS_ACCESS_KEY_ID=</pre> |  |  | 
| avg-bandwidth-bps | El ancho de banda medio previsto para la secuencia.  | Bits por segundo | 4194304 | 
| aws-region | El que Región de AWS se va a usar.  También puede proporcionar la variable de `AWS_DEFAULT_REGION` entorno a la región. Las variables de entorno tienen prioridad si se establecen los parámetros de la variable de entorno y kvssink.   La región se establecerá de forma predeterminada `us-west-2` si no se especifica lo contrario.   | Cadena | "us-west-2" | 
| buffer-duration | La duración del búfer de la secuencia.  | Segundos | 120 | 
| codec-id | El ID del códec de la secuencia. | Cadena | "V\$1MPEG4/ISO/AVC" | 
| connection-staleness | El tiempo transcurrido, al que se denomina devolución de señal por inactividad de la transmisión. | Segundos | 60 | 
| content-type | El tipo de contenido de la secuencia. | Cadena | "video/h264" | 
| fragment-acks | Si se debe usar el fragmento. ACKs | Booleano | true | 
| fragment-duration | La duración del fragmento que desea. | Milisegundos | 2000 | 
| framerate | La velocidad de fotogramas prevista. | Fotogramas por segundo | 25 | 
| frame-timecodes | Si se utilizan códigos de tiempo de fotograma o se generan marcas de tiempo utilizando la devolución de llamada de tiempo actual.  | Booleano | true | 
| key-frame-fragmentation | Si se producen fragmentos en un fotograma clave. | Booleano | true | 
| log-config | La ruta de configuración de registro. | Cadena | "../kvs\$1log\$1configuration" | 
| max-latency | La latencia máxima de la secuencia. | Segundos | 60 | 
| recalculate-metrics | Si se vuelven a calcular las métricas. | Booleano | true | 
| replay-duration | La duración para restaurar el lector actual para reproducir durante un error si está habilitada la reactivación. | Segundos | 40 | 
| restart-on-error | Si se reinicia cuando se produce un error. | Booleano | true | 
| retention-period | El periodo de tiempo que se mantiene la secuencia. | Horas | 2 | 
| rotation-period | El período de rotación de claves. Para obtener más información, consulte [AWS KMS Teclas giratorias](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html). | Segundos | 3600 | 
| secret-key |  La clave AWS secreta que se usa para acceder a Kinesis Video Streams. Debe tener AWS configuradas las credenciales o proporcionar este parámetro. <pre>export AWS_SECRET_ACCESS_KEY=</pre>  |  |  | 
| session-token | Especifica el valor del token de sesión necesario si utiliza credenciales de seguridad temporales directamente de AWS STS las operaciones. |  |  | 
| storage-size | El tamaño de almacenamiento del dispositivo en mebibyte (MiB). Para obtener información acerca de la configuración del almacenamiento de dispositivo, consulte [StorageInfo](producer-reference-structures-producer.md#producer-reference-structures-producer-storageinfo). | Mebibyte (MiB) | 128 | 
| streaming-type | El tipo de streaming. Los valores válidos son: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/kinesisvideostreams/latest/dg/examples-gstreamer-plugin-parameters.html) | Enum GstKvsSinkStreamingType | 0: tiempo real | 
| timecode-scale | La escala de código de tiempo de MKV. | Milisegundos | 1 | 
| track-name | El nombre de la pista MKV. | Cadena | "kinesis\$1video" | 
| iot-certificate | AWS IoT credenciales que se utilizarán en el `kvssink` elemento.  `iot-certificate`acepta las siguientes claves y valores:   El `iot-thing-name` es **opcional**. Si no `iot-thing-name` se proporciona, se utiliza el valor del `stream-name` parámetro.  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/es_es/kinesisvideostreams/latest/dg/examples-gstreamer-plugin-parameters.html) | Cadena | Ninguno | 