Referensi parameter elemen GStreamer

Untuk mengirim video ke Amazon Kinesis Video Streams Producer SDK, kvssink Anda tentukan sebagai wastafel, atau tujuan akhir pipeline. Referensi ini memberikan informasi tentang parameter kvssink yang diperlukan dan opsional. Untuk informasi selengkapnya, lihat Contoh: Plugin SDK GStreamer Produser Kinesis Video Streamer.

Topik

• Memberikan kredensi untuk kvssink

• Menyediakan wilayah untuk kvssink

• kvssinkparameter yang diperlukan

• kvssinkparameter opsional

Memberikan kredensi untuk kvssink

Untuk mengizinkan elemen kvssink GStreamer membuat permintaan AWS, berikan AWS kredensialnya untuk digunakan saat memanggil layanan Amazon Kinesis Video Streams. Rantai penyedia kredensi mencari kredensil dengan urutan sebagai berikut:

1. AWS IoT kredensi

Untuk mengatur AWS IoT kredensyal, lihat. Mengontrol akses ke sumber daya Kinesis Video Streams menggunakan AWS IoT

Nilai iot-credentials parameter harus dimulai dengan iot-certificate, dan diikuti oleh daftar dipisahkan koma dari pasangan kunci = nilai berikut.

Kunci	Diperlukan	Deskripsi
ca-path	Ya	Jalur file ke sertifikat CA yang digunakan untuk membangun kepercayaan dengan layanan backend melalui TLS. Contoh: /file/path/to/certificate.pem
cert-path	Ya	Jalur file ke sertifikat X.509. Contoh: /file/path/to/certificateID-certificate.pem.crt
endpoint	Ya	Titik akhir penyedia titik akhir AWS IoT Core kredensi untuk akun Anda. AWS Lihat PanduanAWS IoT Pengembang. Contoh: credential-account-specific-prefix.credentials.iot.aws-region.amazonaws.com
key-path	Ya	File path ke kunci pribadi yang digunakan dalam public/private key pair. Contoh: /file/path/to/certificateID-private.pem.key
role-aliases	Ya	Nama alias peran yang menunjuk ke peran AWS IAM yang akan digunakan saat menghubungkan ke. AWS IoT Core Contoh: KvsCameraIoTRoleAlias
iot-thing-name	Tidak	iot-thing-nameItu opsional. Jika iot-thing-name tidak disediakan, nilai stream-name parameter digunakan. Contoh: kvs_example_camera

Contoh:

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. Variabel-variabel lingkungan

Untuk memiliki kredensi kvssink penggunaan dari lingkungan, atur variabel lingkungan berikut:

Nama Variabel Lingkungan	Diperlukan	Deskripsi
AWS_ACCESS_KEY_ID	Ya	Kunci AWS akses yang digunakan untuk mengakses Amazon Kinesis Video Streams.
AWS_SECRET_ACCESS_KEY	Ya	Kunci AWS rahasia yang terkait dengan kunci akses.
AWS_SESSION_TOKEN	Tidak	Menentukan nilai token sesi yang diperlukan jika Anda menggunakan kredensyal keamanan sementara langsung dari operasi. AWS STS

Menyetel variabel lingkungan mengubah nilai yang digunakan hingga akhir sesi shell Anda, atau sampai Anda menyetel variabel ke nilai yang berbeda. Untuk membuat variabel persisten di seluruh sesi future, atur di skrip startup shell Anda.

3. access-key, secret-key parameter

Untuk menentukan kredensyal secara langsung sebagai kvssink parameter, atur parameter berikut:

kvssinkNama Parameter	Diperlukan	Deskripsi
access-key	Ya	Kunci AWS akses yang digunakan untuk mengakses Amazon Kinesis Video Streams.
secret-key	Ya	Kunci AWS rahasia yang terkait dengan kunci akses.
session-token	Tidak	Menentukan nilai token sesi yang diperlukan jika Anda menggunakan kredensyal keamanan sementara langsung dari operasi. AWS STS

Menggunakan kredensil statis:

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

Menggunakan kredensil sementara:

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

4. File kredensi

penting

Jika Anda telah memilih salah satu metode sebelumnya, Anda tidak dapat menggunakan credential-file kvssink parameter.

kvssinkNama Parameter	Diperlukan	Deskripsi
credential-file	Ya	Path ke file teks yang berisi kredensyal dalam format tertentu.

File teks harus berisi kredensil dalam salah satu format berikut:

• KREDENSIAL YourAccessKeyYourSecretKey

• KEDALUWARSA KREDENSIAL YourAccessKeyYourSecretKeySessionToken

Contoh: credentials.txt File Anda terletak di /home/ubuntu dan berisi yang berikut:

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

Untuk menggunakannyakvssink, ketik:

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

catatan

Waktu kedaluwarsa harus setidaknya 5 + 30 + 3 = 38 detik di masa depan. Masa tenggang didefinisikan sebagai IOT_CREDENTIAL_FETCH_GRACE_PERIOD variabel dalam IotCredentialProvider.h. Jika kredensyal terlalu dekat dengan kedaluwarsa saat Anda mulaikvssink, Anda menerima kode kesalahan. 0x52000049 - STATUS_INVALID_TOKEN_EXPIRATION

penting

kvssinktidak memodifikasi file kredensyal. Jika Anda menggunakan kredensi sementara, file kredensional harus diperbarui oleh sumber luar sebelum waktu kedaluwarsa dikurangi masa tenggang.

Menyediakan wilayah untuk kvssink

Berikut ini adalah urutan pencarian wilayah:

1. AWS_DEFAULT_REGIONvariabel lingkungan ditinjau terlebih dahulu. Jika diatur, wilayah itu digunakan untuk mengkonfigurasi klien.

2. aws-regionparameter ditinjau selanjutnya. Jika diatur, wilayah itu digunakan untuk mengkonfigurasi klien.

3. Jika tidak satu pun dari metode sebelumnya yang digunakan, kvssink defaultnya. us-west-2

kvssinkparameter yang diperlukan

Selain memberikan kredensyal dan wilayah, kvssink elemen memiliki parameter yang diperlukan berikut:

stream-name- Nama streaming video Amazon Kinesis tujuan.

kvssinkparameter opsional

kvssinkElemen memiliki parameter opsional berikut. Untuk informasi selengkapnya tentang parameter ini, lihat Struktur aliran video Kinesis.

Parameter	Deskripsi	Unit/Jenis	Default
absolute-fragment-times	Apakah akan menggunakan waktu fragmen absolut.	Boolean	true
access-key	Kunci AWS akses yang digunakan untuk mengakses Kinesis Video Streams. Anda harus memiliki AWS kredensi yang ditetapkan atau memberikan parameter ini. Untuk memberikan informasi ini, ketikkan berikut ini: $ export AWS_ACCESS_KEY_ID=
avg-bandwidth-bps	Bandwidth rata-rata yang diharapkan untuk aliran.	Byte per detik	4194304
aws-region	Wilayah AWS Untuk digunakan. catatan Anda juga dapat menyediakan wilayah dengan variabel AWS_DEFAULT_REGION lingkungan. Variabel lingkungan diutamakan jika variabel lingkungan dan parameter kvssink disetel. penting Wilayah akan default us-west-2 jika tidak ditentukan lain.	String	us-west-2
buffer-duration	Durasi buffer aliran.	Detik	180
codec-id	ID codec dari aliran.	String	"V_MPEG4/ISO/AVC"
connection-staleness	Waktu setelahnya, di mana panggilan balik staleness aliran dipanggil.	Detik	60
content-type	Jenis konten aliran.	String	"video/h264"
fragment-acks	Apakah akan menggunakan ACK fragmen.	Boolean	true
fragment-duration	Durasi fragmen yang Anda inginkan.	Milidetik	2000
framerate	Frame rate yang diharapkan.	Bingkai per detik	25
frame-timecodes	Apakah akan menggunakan kode waktu bingkai atau membuat stempel waktu menggunakan callback waktu saat ini.	Boolean	true
key-frame-fragmentation	Apakah akan menghasilkan fragmen pada bingkai kunci.	Boolean	true
log-config	Jalur konfigurasi log.	String	"./kvs_log_configuration"
max-latency	Latensi maksimum untuk streaming.	Detik	60
recalculate-metrics	Apakah akan menghitung ulang metrik.	Boolean	true
replay-duration	Durasi untuk memutar pembaca saat ini ke belakang untuk memutar ulang selama kesalahan jika restart diaktifkan.	Detik	40
restart-on-error	Apakah akan memulai ulang ketika terjadi kesalahan.	Boolean	true
retention-period	Lamanya waktu aliran dipertahankan.	Jam	2
rotation-period	Periode rotasi kunci. Untuk informasi selengkapnya, lihat Memutar Kunci Master Pelanggan.	Detik	2400
secret-key	Kunci AWS rahasia yang digunakan untuk mengakses Kinesis Video Streams. Anda harus memiliki AWS kredensi yang ditetapkan atau memberikan parameter ini. $ export AWS_SECRET_ACCESS_KEY_ID=
session-token	Menentukan nilai token sesi yang diperlukan jika Anda menggunakan kredensyal keamanan sementara langsung dari operasi. AWS STS
storage-size	Ukuran penyimpanan perangkat dalam MegaBytes (MB). Untuk informasi tentang mengonfigurasi penyimpanan perangkat, lihatStorageInfo.	MegaBytes	128
streaming-type	Jenis streaming. Nilai yang valid meliputi: 0: waktu nyata 1: mendekati waktu nyata (saat ini tidak didukung) 2: offline	Enum GstKvsSinkStreamingType	0: waktu nyata
timecode-scale	Skala kode waktu MKV.	Milidetik	1
track-name	Nama trek MKV.	String	"kinesis_video"
iot-certificate	AWS IoT kredensyal yang akan digunakan dalam elemen. kvssink iot-certificatemenerima kunci dan nilai berikut: catatan iot-thing-nameItu opsional. Jika iot-thing-name tidak disediakan, nilai stream-name parameter digunakan. 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	String	Tidak ada