翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# GStreamer 要素パラメータリファレンス
<a name="examples-gstreamer-plugin-parameters"></a>

Amazon Kinesis Video Streams プロデューサー C\$1\$1 SDK に動画を送信するには、パイプラインの*シンク*または最終送信先`kvssink`として を指定します。このリファレンスでは、`kvssink` の必須およびオプションのパラメータに関する情報を提供します。詳細については、「[例: Kinesis Video Streams プロデューサー SDK GStreamer プラグイン - kvssink](examples-gstreamer-plugin.md)」を参照してください。

**トピック**
+ [認証情報を に提供する `kvssink`](#credentials-to-kvssink)
+ [にリージョンを指定する `kvssink`](#kvssink-region)
+ [`kvssink` オプションのパラメータ](#kvssink-optional-parameters)

## 認証情報を に提供する `kvssink`
<a name="credentials-to-kvssink"></a>

`kvssink` GStreamer 要素がリクエストを実行できるようにするには AWS、Amazon Kinesis Video Streams サービスを呼び出すときに使用する AWS 認証情報を指定します。認証情報プロバイダーチェーンは、次の順序で認証情報を検索します。

### 1. AWS IoT 認証情報
<a name="collapsible-section-1"></a>

 AWS IoT 認証情報を設定するには、「」を参照してください[を使用した Kinesis Video Streams リソースへのアクセスの制御 AWS IoT](how-iot.md)。

`iot-credentials` パラメータ値は で始まり、次の*キー*`iot-certificate,`と*値の*ペアのカンマ区切りリストが続く必要があります。


****  

| Key | 必要 | 説明 | 
| --- | --- | --- | 
| ca-path | はい | TLS を介してバックエンドサービスとの信頼を確立するために使用される CA 証明書へのファイルパス。 

**Example**  
**例**: ` /file/path/to/certificate.pem` | 
| cert-path | はい | X.509 証明書へのファイルパス。 

**Example**  
**例**: `/file/path/to/certificateID-certificate.pem.crt` | 
| endpoint | はい |  AWS アカウントの AWS IoT Core 認証情報エンドポイントプロバイダーエンドポイント。「 [AWS IoT デベロッパーガイド](https://docs.aws.amazon.com//iot/latest/developerguide/authorizing-direct-aws.html)」を参照してください。 

**Example**  
**例**: `credential-account-specific-prefix.credentials.iot.aws-region.amazonaws.com` | 
| key-path | はい | パブリック/プライベートキーペアで使用されるプライベートキーへのファイルパス。 

**Example**  
**例**: `/file/path/to/certificateID-private.pem.key` | 
| role-aliases | はい | への接続時に使用する AWS IAM ロールを指すロールエイリアスの名前 AWS IoT Core。 

**Example**  
**例**: `KvsCameraIoTRoleAlias` | 
| iot-thing-name | いいえ | `iot-thing-name` はオプションです。が指定され`iot-thing-name`ていない場合は、 `stream-name`パラメータ値が使用されます。 

**Example**  
**例**: `kvs_example_camera` | 

**Example**  
**例**:  

```
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. 環境変数
<a name="collapsible-section-2"></a>

で環境の認証情報`kvssink`を使用するには、次の環境変数を設定します。


****  

| 環境変数名 | 必要 | 説明 | 
| --- | --- | --- | 
| AWS\$1ACCESS\$1KEY\$1ID | はい | Amazon Kinesis Video Streams へのアクセスに使用される AWS アクセスキー。 | 
| AWS\$1SECRET\$1ACCESS\$1KEY | はい | アクセスキーに関連付けられた AWS シークレットキー。 | 
| AWS\$1SESSION\$1TOKEN | いいえ | オペレーションから直接 AWS STS 一時的なセキュリティ認証情報を使用する場合は、必要なセッショントークン値を指定します。 | 

環境変数を設定すると使用する値が変更され、その値はシェルセッションが終了するか、または変数に別の値が設定されるまで有効です。変数を今後のセッションで永続化するには、シェルのスタートアップスクリプトで変数を設定します。

### 3. `access-key`、 `secret-key`パラメータ
<a name="collapsible-section-3"></a>

認証情報を`kvssink`パラメータとして直接指定するには、次のパラメータを設定します。


****  

| `kvssink` パラメータ名 | 必要 | 説明 | 
| --- | --- | --- | 
| access-key | はい | Amazon Kinesis Video Streams へのアクセスに使用される AWS アクセスキー。 | 
| secret-key | はい | アクセスキーに関連付けられた AWS シークレットキー。 | 
| session-token | いいえ | オペレーションから直接 AWS STS 一時的なセキュリティ認証情報を使用する場合は、必要なセッショントークン値を指定します。 | 

**Example**  
**静的認証情報の使用:**  

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

**Example**  
**一時的な認証情報の使用:**  

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

### 4. 認証情報ファイル
<a name="collapsible-section-4"></a>

**重要**  
前述の方法のいずれかを選択した場合、 `credential-path``kvssink`パラメータを使用することはできません。


****  

| `kvssink` パラメータ名 | 必要 | 説明 | 
| --- | --- | --- | 
| credential-path | はい | 特定の形式の認証情報を含むテキストファイルへのパス。 | 

テキストファイルには、次のいずれかの形式の認証情報が含まれている必要があります。
+ CREDENTIALS *YourAccessKey* *YourSecretKey*
+ CREDENTIALS *YourAccessKey* *の有効期限* *YourSecretKey* *SessionToken*

**Example**  
**例:** `credentials.txt`ファイルは にあり`/home/ubuntu`、以下が含まれています。  
`CREDENTIALS AKIDEXAMPLE 2023-08-10T22:43:00Z SKEXAMPLE STEXAMPLE`  
で使用するには`kvssink`、次のように入力します。  

```
gst-launch-1.0 -v ... ! kvssink stream-name="YourStream" aws-region="YourRegion" credential-path="/home/ubuntu/credentials.txt" 
```
有効期限は、少なくとも 5 \$1 30 \$1 3 = **38** 秒先である必要があります。猶予期間は、 の `IOT_CREDENTIAL_FETCH_GRACE_PERIOD`変数として定義されます[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)。起動時に認証情報の有効期限に近すぎる場合は`kvssink`、エラーコード が表示されます`0x52000049 - STATUS_INVALID_TOKEN_EXPIRATION`。
`kvssink` は認証情報ファイルを変更しません。一時的な認証情報を使用している場合は、有効期限から猶予期間を引いた時間より前に、外部ソースによって認証情報ファイルを更新する必要があります。

## にリージョンを指定する `kvssink`
<a name="kvssink-region"></a>

リージョンのルックアップ順序は次のとおりです。

1. `AWS_DEFAULT_REGION` 環境変数が最初にレビューされます。設定されている場合、そのリージョンを使用してクライアントを設定します。

1. `aws-region` 次に、 パラメータを確認します。設定されている場合、そのリージョンを使用してクライアントを設定します。

1. 上記のいずれの方法も使用されなかった場合、 は`kvssink`デフォルトで になります`us-west-2`。

## `kvssink` オプションのパラメータ
<a name="kvssink-optional-parameters"></a>

`kvssink` エレメントには以下のオプションパラメータがあります。これらのパラメータの詳細については、「[Kinesis ビデオストリーム構造](producer-reference-structures-stream.md)」を参照してください。


****  

| パラメータ | 説明 | 単位/タイプ | デフォルト | 
| --- | --- | --- | --- | 
| stream-name  | 送信先の Amazon Kinesis ビデオストリームの名前。 stream-name を指定しない場合、デフォルトのストリーム名「DEFAULT\$1STREAM」が使用されます。そのデフォルト名を持つストリームがまだ存在しない場合、ストリームが作成されます。  |  |  | 
| absolute-fragment-times | 絶対フラグメントタイムを使用するかどうか。 | ブール値 | true | 
| access-key | Kinesis Video Streams へのアクセスに使用される AWS アクセスキー。  AWS 認証情報を設定するか、このパラメータを指定する必要があります。この情報を指定するには、次のように入力します。 <pre>export AWS_ACCESS_KEY_ID=</pre> |  |  | 
| avg-bandwidth-bps | ストリームの予想される平均帯域幅。 | 毎秒ビット | 4194304 | 
| aws-region |  AWS リージョン 使用する 。  リージョンに `AWS_DEFAULT_REGION`環境変数を指定することもできます。環境変数と kvssink パラメータの両方が設定されている場合、環境変数が優先されます。   特に指定`us-west-2`しない場合、リージョンはデフォルトで になります。   | String | "us-west-2" | 
| buffer-duration | ストリームのバッファ期間。 | 秒 | 120 | 
| codec-id | ストリームのコーデック ID。 | String | "V\$1MPEG4/ISO/AVC" | 
| connection-staleness | ストリームの古さコールバックが呼び出されるまでの時間。 | 秒 | 60 | 
| content-type | ストリームのコンテンツタイプ。 | String | "video/h264" | 
| fragment-acks | ACK フラグメントを使用するかどうか。 | ブール値 | true | 
| fragment-duration | フラグメントの有効期間。 | ミリ秒 | 2000 | 
| framerate | 予想されるフレームレート。 | 1 秒あたりのフレーム | 25 | 
| frame-timecodes | フレームのタイムコードを使用するか、現在時刻のコールバックを使用してタイムスタンプを生成するかどうかを指定します。 | ブール値 | true | 
| key-frame-fragmentation | キーフレームでフラグメントを生成するかどうかを指定します。 | ブール値 | true | 
| log-config | ログ設定のパス。 | String | "../kvs\$1log\$1configuration" | 
| max-latency | ストリームの最大レイテンシー。 | 秒 | 60 | 
| recalculate-metrics | メトリクスを再計算するかどうかを指定します。 | ブール値 | true | 
| replay-duration | 再開が有効になっている場合、エラー発生時の再生まで現在のリーダーをロールバックする期間。 | 秒 | 40 | 
| restart-on-error | エラーが発生したときに再起動するかどうか。 | ブール値 | true | 
| retention-period | ストリームが保持される期間。 | 時間 | 2 | 
| rotation-period | キーの更新間隔。詳細については、[「キーのローテーション AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html)」を参照してください。 | 秒 | 3600 | 
| secret-key |  Kinesis Video Streams へのアクセスに使用される AWS シークレットキー。  AWS 認証情報を設定するか、このパラメータを指定する必要があります。 <pre>export AWS_SECRET_ACCESS_KEY=</pre>  |  |  | 
| session-token | オペレーションから直接 AWS STS 一時的なセキュリティ認証情報を使用する場合は、必要なセッショントークン値を指定します。 |  |  | 
| storage-size | メビバイト (MiB) 単位のデバイスストレージサイズ。デバイスストレージの構成の詳細については、「[StorageInfo](producer-reference-structures-producer.md#producer-reference-structures-producer-storageinfo)」を参照してください。 | メビバイト (MiB) | 128 | 
| streaming-type | ストリーミングタイプ。有効な値を次に示します。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kinesisvideostreams/latest/dg/examples-gstreamer-plugin-parameters.html) | 列挙型 GstKvsSinkStreamingType | 0: リアルタイム | 
| timecode-scale | MKV のタイムコードスケール。 | ミリ秒 | 1 | 
| track-name | MKV トラック名。 | String | "kinesis\$1video" | 
| iot-certificate | AWS IoT `kvssink`要素で使用される 認証情報。 `iot-certificate` は、次のキーと値を受け入れます。  `iot-thing-name` は**オプション**です。が指定され`iot-thing-name`ていない場合は、 `stream-name`パラメータ値が使用されます。  [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kinesisvideostreams/latest/dg/examples-gstreamer-plugin-parameters.html) | String | なし |