mirrors/gst-plugins-rs
mirrors/gst-plugins-rs
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs.git synced 2024-12-23 02:26:35 +00:00
Code Issues Projects Releases Wiki Activity

aws: Add plugin docs

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs/-/merge_requests/1337>
This commit is contained in:
Arun Raghavan 2023-12-18 15:38:36 -05:00
parent 6d47045a60
commit 06d96ec5a2
1 changed files with 236 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

236
docs/plugins/gst_plugins_cache.json
View file

@ -181,6 +181,242 @@
},
"rank": "none"
},
"awss3putobjectsink": {
"author": "Arun Raghavan <arun@asymptotic.io>",
"description": "Writes an object to Amazon S3 using PutObject (mostly useful for small files)",
"hierarchy": [
"GstAwsS3PutObjectSink",
"GstBaseSink",
"GstElement",
"GstObject",
"GInitiallyUnowned",
"GObject"
],
"klass": "Source/Network",
"pad-templates": {
"sink": {
"caps": "ANY",
"direction": "sink",
"presence": "always"
}
},
"properties": {
"access-key": {
"blurb": "AWS Access Key",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "NULL",
"mutable": "ready",
"readable": true,
"type": "gchararray",
"writable": true
},
"bucket": {
"blurb": "The bucket of the file to write",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "NULL",
"mutable": "ready",
"readable": true,
"type": "gchararray",
"writable": true
},
"content-disposition": {
"blurb": "Content-Disposition header to set for uploaded object",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "NULL",
"mutable": "null",
"readable": true,
"type": "gchararray",
"writable": true
},
"content-type": {
"blurb": "Content-Type header to set for uploaded object",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "NULL",
"mutable": "null",
"readable": true,
"type": "gchararray",
"writable": true
},
"endpoint-uri": {
"blurb": "The S3 endpoint URI to use",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "NULL",
"mutable": "null",
"readable": true,
"type": "gchararray",
"writable": true
},
"flush-interval-buffers": {
"blurb": "Number of buffers to accumulate before doing a write (0 => disable)",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "1",
"max": "18446744073709551615",
"min": "0",
"mutable": "null",
"readable": true,
"type": "guint64",
"writable": true
},
"flush-interval-bytes": {
"blurb": "Number of bytes to accumulate before doing a write (0 => disable)",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "0",
"max": "18446744073709551615",
"min": "0",
"mutable": "null",
"readable": true,
"type": "guint64",
"writable": true
},
"flush-interval-time": {
"blurb": "Total duration of buffers to accumulate before doing a write (0 => disable)",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "0",
"max": "18446744073709551615",
"min": "0",
"mutable": "null",
"readable": true,
"type": "guint64",
"writable": true
},
"flush-on-error": {
"blurb": "Whether to write out the data on error (like stopping without an EOS)",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "false",
"mutable": "null",
"readable": true,
"type": "gboolean",
"writable": true
},
"key": {
"blurb": "The key of the file to write",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "NULL",
"mutable": "ready",
"readable": true,
"type": "gchararray",
"writable": true
},
"metadata": {
"blurb": "A map of metadata to store with the object in S3; field values need to be convertible to strings.",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"mutable": "ready",
"readable": true,
"type": "GstStructure",
"writable": true
},
"region": {
"blurb": "An AWS region (e.g. eu-west-2).",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "us-west-2",
"mutable": "ready",
"readable": true,
"type": "gchararray",
"writable": true
},
"request-timeout": {
"blurb": "Timeout for general S3 requests (in ms, set to -1 for infinity)",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "15000",
"max": "9223372036854775807",
"min": "-1",
"mutable": "null",
"readable": true,
"type": "gint64",
"writable": true
},
"retry-attempts": {
"blurb": "Number of times AWS SDK attempts a request before abandoning the request",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "5",
"max": "10",
"min": "1",
"mutable": "null",
"readable": true,
"type": "guint",
"writable": true
},
"secret-access-key": {
"blurb": "AWS Secret Access Key",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "NULL",
"mutable": "ready",
"readable": true,
"type": "gchararray",
"writable": true
},
"session-token": {
"blurb": "AWS temporary Session Token from STS",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "NULL",
"mutable": "ready",
"readable": true,
"type": "gchararray",
"writable": true
},
"uri": {
"blurb": "The S3 object URI",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "",
"mutable": "ready",
"readable": true,
"type": "gchararray",
"writable": true
}
},
"rank": "none"
},
"awss3sink": {
"author": "Marcin Kolny <mkolny@amazon.com>",
"description": "Writes an object to Amazon S3",