GstRTMPMetadata FAQ
Frequently Asked Questions
1. What is GstRTMPMetadata?
GstRTMPMetadata is not a standalone plugin but a set of patches to GStreamer’s existing flvmux and flvdemux elements. These patches extend FLV support to allow insertion and extraction of arbitrary metadata within RTMP streams by leveraging FLV Script Data tags.
2. Which elements are modified by the patches?
The following GStreamer elements are extended:
- flvmux: gains new properties (meta-string, meta-binary) and support for inserting metadata through GstMeta.
- flvdemux: gains properties (attach-flvmeta, flv-meta-signal) and a new flv-meta signal to notify applications when metadata is extracted.
3. How is metadata inserted into the stream?
Metadata can be inserted in three ways:
- As a string using the meta-string property.
- As a binary payload using the meta-binary property (accepts a GBytes).
- By attaching a custom GstFlvMeta to a buffer upstream, which flvmux will serialize into the FLV stream.
4. How is metadata extracted on the receiver side?
When flvdemux detects Script Data tags carrying metadata:
- It can attach a GstFlvMeta to the first audio and video buffers if attach-flvmeta=true.
- It can emit the flv-meta signal with the payload as GBytes if flv-meta-signal=true is enabled.
5. Which GStreamer versions are supported?
Patches are provided for:
- GStreamer 1.16.x
- GStreamer 1.20.x
- GStreamer 1.24.x
6. Can metadata be updated during a live stream?
Yes. Both meta-string and meta-binary can be set multiple times while the pipeline is PLAYING. Each update results in a new Script Data tag being injected into the RTMP stream.
7. Is there an evaluation mode?
Yes. RidgeRun provides an Evaluation mode so that developers can test the product before full integration.
8. What are typical applications of GstRTMPMetadata?
- Live telemetry synchronized with video (robotics, drones, industrial inspection).
- Embedding timestamps, sensor fusion data, or analytics metadata into live RTMP feeds.
- Integrations where metadata must travel alongside video in a single RTMP stream.
9. I am interested in RidgeRun services.
Please consider the following:
- We usually follow the hiring process described here: RidgeRun Hiring Process
- You can find more information about our professional services here: RidgeRun Professional Services
FAQ
- What is GstRTMPMetadata?
- GstRTMPMetadata is not a standalone plugin but a set of patches for GStreamer’s existing flvmux and flvdemux elements. These patches extend FLV support to allow insertion and extraction of arbitrary metadata within RTMP streams by using FLV Script Data tags.
- Which elements are modified by the patches?
- The patches extend two GStreamer elements: flvmux, which gains the meta-string and meta-binary properties plus support for metadata injection through GstMeta; and flvdemux, which gains the attach-flvmeta and flv-meta-signal properties and the flv-meta signal for metadata extraction and notification.
- How is metadata inserted into the stream?
- Metadata can be inserted in three ways: as a string using the meta-string property, as a binary payload using the meta-binary property with GBytes, or by attaching a custom GstFlvMeta to an upstream buffer so that flvmux serializes it into the FLV stream.
- How is metadata extracted on the receiver side?
- When flvdemux detects Script Data tags carrying metadata, it can attach a GstFlvMeta to the first audio and video buffers if attach-flvmeta=true, and it can emit the flv-meta signal with the payload as GBytes if flv-meta-signal=true is enabled.
- Which GStreamer versions are supported?
- GstRTMPMetadata patches are provided for GStreamer 1.16.x, 1.20.x, and 1.24.x.
- Can metadata be updated during a live stream?
- Yes. Both meta-string and meta-binary can be updated multiple times while the pipeline is in the PLAYING state. Each update injects a new Script Data tag into the RTMP stream.
- Is there an evaluation mode?
- Yes. RidgeRun provides an evaluation mode so developers can validate GstRTMPMetadata before full integration into a commercial system.
- What are typical applications of GstRTMPMetadata?
- Typical applications include live telemetry synchronized with video in robotics, drones, and industrial inspection; embedding timestamps, sensor fusion data, or analytics metadata into live RTMP feeds; and custom integrations where metadata must travel alongside video in a single RTMP stream.
- How can I contact RidgeRun for services or support?
- For evaluation access, integration support, or professional services, please contact RidgeRun through the appropriate contact page. You can also refer to RidgeRun Hiring Process and RidgeRun Professional Services for more information.