GStreamer 要素パラメータリファレンス - Amazon Kinesis Video Streams

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

GStreamer 要素パラメータリファレンス

ビデオを Amazon Kinesis Video Streams プロデューサー SDK に送信するには、kvssinkシンクまたはパイプラインの最終的な送信先として指定します。このリファレンスでは、kvssink の必須およびオプションのパラメータに関する情報を提供します。詳細については、「例: Kinesis Video Streams プロデューサー SDK GStreamer プラグイン」を参照してください。

トピック

認証情報を に提供する kvssink

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

AWS IoT 認証情報を設定するには、「」を参照してくださいを使用して Kinesis Video Streams リソースへのアクセスを制御する AWS IoT

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

キー 必要 説明
ca-path はい

TLS 経由でバックエンドサービスとの信頼を確立するために使用される CA 証明書へのファイルパス。

例: /file/path/to/certificate.pem

cert-path はい

X.509 証明書へのファイルパス。

例: /file/path/to/certificateID-certificate.pem.crt

endpoint はい

AWS アカウントの AWS IoT Core 認証情報エンドポイントプロバイダーエンドポイント。「 AWS IoT デベロッパーガイド」を参照してください。

例: credential-account-specific-prefix.credentials.iot.aws-region.amazonaws.com

key-path はい

パブリック/プライベートキーペアで使用されるプライベートキーへのファイルパス。

例: /file/path/to/certificateID-private.pem.key

role-aliases はい

に接続するときに使用する AWS IAM ロールを指すロールエイリアスの名前 AWS IoT Core。

例: KvsCameraIoTRoleAlias

iot-thing-name いいえ

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

例: kvs_example_camera

例:

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"

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

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

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

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

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

静的認証情報の使用:

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

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

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

前述の方法のいずれかを選択した場合、 credential-filekvssinkパラメータは使用できません。

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

テキストファイルには、次のいずれかの形式の認証情報が含まれている必要があります。

  • 認証情報 YourAccessKey YourSecretKey

  • 認証情報YourAccessKeyの有効期限 YourSecretKey SessionToken

例: 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-file="/home/ubuntu/credentials.txt"
注記

有効期限は、少なくとも 5 + 30 + 3 = 38 秒後である必要があります。猶予期間は、 のIOT_CREDENTIAL_FETCH_GRACE_PERIOD変数として定義されますIotCredentialProvider.h。起動時に認証情報の有効期限に近すぎるとkvssink、エラーコード が表示されます0x52000049 - STATUS_INVALID_TOKEN_EXPIRATION

重要

kvssink は認証情報ファイルを変更しません。一時的な認証情報を使用している場合は、有効期限から猶予期間を差し引いた前に、外部ソースによって認証情報ファイルを更新する必要があります。

にリージョンを指定する kvssink

リージョン検索の順序は次のとおりです。

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

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

  3. 前述の方法のいずれも使用されていない場合、 はkvssinkデフォルトで になりますus-west-2

kvssink 必須パラメータ

kvssink 要素には、認証情報とリージョンの提供に加えて、次の必須パラメータがあります。

stream-name - 送信先の Amazon Kinesis ビデオストリームの名前。

kvssink オプションのパラメータ

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

パラメータ 説明 単位/タイプ デフォルト値
absolute-fragment-times 絶対フラグメントタイムを使用するかどうか。 ブール値 true
access-key

Kinesis Video Streams へのアクセスに使用されるアクセス AWS キー。

AWS 認証情報を設定するか、このパラメータを指定する必要があります。この情報を指定するには、次のように入力します。

$ export AWS_ACCESS_KEY_ID=
avg-bandwidth-bps ストリームの予想される平均帯域幅。 1 秒あたりのバイト 4194304
aws-region

AWS リージョン 使用する 。

注記

リージョンに AWS_DEFAULT_REGION環境変数を指定することもできます。環境変数と kvssink パラメータの両方が設定されている場合、環境変数が優先されます。

重要

特に指定us-west-2されていない場合、リージョンはデフォルトで になります。

文字列 us-west-2
buffer-duration ストリームのバッファ期間。 [秒] 180
codec-id ストリームのコーデック ID。 文字列 "V_MPEG4/ISO/AVC"
connection-staleness ストリームの古さコールバックが呼び出されるまでの時間。 [秒] 60
content-type ストリームのコンテンツタイプ。 文字列 "video/h264"
fragment-acks ACK フラグメントを使用するかどうか。 ブール値 true
fragment-duration フラグメントの有効期間。 ミリ秒 2000
framerate 予想されるフレームレート。 1 秒あたりのフレーム 25
frame-timecodes フレームのタイムコードを使用するか、現在時刻のコールバックを使用してタイムスタンプを生成するかどうかを指定します。 ブール値 true
key-frame-fragmentation キーフレームでフラグメントを生成するかどうかを指定します。 ブール値 true
log-config ログ設定のパス。 文字列 "./kvs_log_configuration"
max-latency ストリームの最大レイテンシー。 [秒] 60
recalculate-metrics メトリクスを再計算するかどうかを指定します。 ブール値 true
replay-duration 再開が有効になっている場合、エラー発生時の再生まで現在のリーダーをロールバックする期間。 [秒] 40
restart-on-error エラーが発生したときに再起動するかどうか。 ブール値 true
retention-period ストリームが保持される期間。 時間 2
rotation-period キーの更新間隔。詳細については、「カスタマーマスターキーのローテーション」を参照してください。 [秒] 2400
secret-key

Kinesis Video Streams へのアクセスに使用される AWS シークレットキー。

AWS 認証情報を設定するか、このパラメータを指定する必要があります。

$ export AWS_SECRET_ACCESS_KEY_ID=
session-token オペレーションから直接 AWS STS 一時的なセキュリティ認証情報を使用する場合に必要なセッショントークン値を指定します。
storage-size デバイスのストレージサイズ MegaBytes (MB)。デバイスストレージの構成の詳細については、「StorageInfo」を参照してください。 MegaBytes 128
streaming-type ストリーミングタイプ。有効な値を次に示します。
  • 0: リアルタイム

  • 1: ほぼリアルタイム (現在サポートされていません)

  • 2: オフライン

列挙型 GstKvsSinkStreamingType 0: リアルタイム
timecode-scale MKV のタイムコードスケール。 ミリ秒 1
track-name MKV トラック名。 文字列 "kinesis_video"
iot-certificate

AWS IoT kvssink要素で使用される 認証情報。

iot-certificate は、次のキーと値を受け入れます。

注記

iot-thing-nameオプションの です。が指定されていない場合iot-thing-nameは、 stream-nameパラメータ値が使用されます。

  • 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

文字列 なし