gstreamer
Loading...
Searching...
No Matches
gstreamer option handling

Types and functions used to define and parse module configuration options. More...

Collaboration diagram for gstreamer option handling:

Files

file  gstreamer_options.h
 Option and configuration helpers for the gstreamer module.
 

Data Structures

struct  GStreamerDefinition
 Lightweight description of one configured gstreamer output. More...
 

Functions

vector< GStreamerDefinitiongstreamer::getGStreamerDefinition (const std::shared_ptr< GOptions > &gopts)
 Parse all configured gstreamer output definitions from the options container.
 
GOptions gstreamer::defineOptions ()
 Define the options contributed by the gstreamer module.
 

Detailed Description

Function Documentation

◆ defineOptions()

GOptions gstreamer::defineOptions ( )

The returned GOptions object contains:

  • gstreamer-specific options such as ebuffer and -gstreamer
  • the option definitions contributed by dependent modules currently aggregated here

This function is typically used by applications and examples as the module entry point for command-line configuration.

Returns
Fully populated option definition object for the module.

Definition at line 41 of file gstreamer_options.cc.

◆ getGStreamerDefinition()

std::vector< GStreamerDefinition > gstreamer::getGStreamerDefinition ( const std::shared_ptr< GOptions > & gopts)

This function reads the "gstreamer" option node and converts each object entry into a GStreamerDefinition value. Each entry is expected to provide:

  • format : plugin format selector
  • filename : base output filename
  • type : semantic output type, defaulting to "event" when omitted

The returned vector preserves the order found in the option node, which is useful when the caller wants output instantiation or reporting to follow user configuration order.

Parameters
goptsParsed options container supplying the "gstreamer" node.
Returns
Vector of configured streamer definitions.

Definition at line 16 of file gstreamer_options.cc.