struct GstRTSPMediaFactory

struct GstRTSPMediaFactory;

The definition and logic for constructing the pipeline for a media. The media can contain multiple streams like audio and video.

struct GstRTSPMediaFactoryClass

struct GstRTSPMediaFactoryClass {
  GObjectClass  parent_class;

  gchar *         (*gen_key)            (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);

  GstElement *    (*create_element)     (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  GstRTSPMedia *  (*construct)          (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
  GstElement *    (*create_pipeline)    (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
  void            (*configure)          (GstRTSPMediaFactory *factory, GstRTSPMedia *media);

  /* signals */
  void            (*media_constructed)  (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
  void            (*media_configure)    (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
};

The GstRTSPMediaFactory class structure.

gst_rtsp_media_factory_new ()

GstRTSPMediaFactory * gst_rtsp_media_factory_new        (void);

Create a new GstRTSPMediaFactory instance.

gst_rtsp_media_factory_get_launch ()

gchar *             gst_rtsp_media_factory_get_launch   (GstRTSPMediaFactory *factory);

Get the gst_parse_launch() pipeline description that will be used in the default prepare vmethod.

gst_rtsp_media_factory_set_launch ()

void                gst_rtsp_media_factory_set_launch   (GstRTSPMediaFactory *factory,
                                                         const gchar *launch);

The gst_parse_launch() line to use for constructing the pipeline in the default prepare vmethod.

The pipeline description should return a GstBin as the toplevel element which can be accomplished by enclosing the dscription with brackets '(' ')'.

The description should return a pipeline with payloaders named pay0, pay1, etc.. Each of the payloaders will result in a stream.

gst_rtsp_media_factory_get_permissions ()

GstRTSPPermissions * gst_rtsp_media_factory_get_permissions
                                                        (GstRTSPMediaFactory *factory);

Get the permissions object from factory.

gst_rtsp_media_factory_set_permissions ()

void                gst_rtsp_media_factory_set_permissions
                                                        (GstRTSPMediaFactory *factory,
                                                         GstRTSPPermissions *permissions);

Set permissions on factory.

gst_rtsp_media_factory_add_role ()

void                gst_rtsp_media_factory_add_role     (GstRTSPMediaFactory *factory,
                                                         const gchar *role,
                                                         const gchar *fieldname,
                                                         ...);

A convenience method to add role with fieldname and additional arguments to the permissions of factory. If factory had no permissions, new permissions will be created and the role will be added to it.

gst_rtsp_media_factory_set_shared ()

void                gst_rtsp_media_factory_set_shared   (GstRTSPMediaFactory *factory,
                                                         gboolean shared);

Configure if media created from this factory can be shared between clients.

gst_rtsp_media_factory_is_shared ()

gboolean            gst_rtsp_media_factory_is_shared    (GstRTSPMediaFactory *factory);

Get if media created from this factory can be shared between clients.

gst_rtsp_media_factory_is_eos_shutdown ()

gboolean            gst_rtsp_media_factory_is_eos_shutdown
                                                        (GstRTSPMediaFactory *factory);

Get if media created from this factory will have an EOS event sent to the pipeline before shutdown.

gst_rtsp_media_factory_set_eos_shutdown ()

void                gst_rtsp_media_factory_set_eos_shutdown
                                                        (GstRTSPMediaFactory *factory,
                                                         gboolean eos_shutdown);

Configure if media created from this factory will have an EOS sent to the pipeline before shutdown.

gst_rtsp_media_factory_get_protocols ()

GstRTSPLowerTrans   gst_rtsp_media_factory_get_protocols
                                                        (GstRTSPMediaFactory *factory);

Get the allowed protocols of factory.

gst_rtsp_media_factory_set_protocols ()

void                gst_rtsp_media_factory_set_protocols
                                                        (GstRTSPMediaFactory *factory,
                                                         GstRTSPLowerTrans protocols);

Configure the allowed lower transport for factory.

gst_rtsp_media_factory_get_address_pool ()

GstRTSPAddressPool * gst_rtsp_media_factory_get_address_pool
                                                        (GstRTSPMediaFactory *factory);

Get the GstRTSPAddressPool used as the address pool of factory.

gst_rtsp_media_factory_set_address_pool ()

void                gst_rtsp_media_factory_set_address_pool
                                                        (GstRTSPMediaFactory *factory,
                                                         GstRTSPAddressPool *pool);

configure pool to be used as the address pool of factory.

gst_rtsp_media_factory_get_buffer_size ()

guint               gst_rtsp_media_factory_get_buffer_size
                                                        (GstRTSPMediaFactory *factory);

Get the kernel UDP buffer size.

gst_rtsp_media_factory_set_buffer_size ()

void                gst_rtsp_media_factory_set_buffer_size
                                                        (GstRTSPMediaFactory *factory,
                                                         guint size);

Set the kernel UDP buffer size.

gst_rtsp_media_factory_construct ()

GstRTSPMedia *      gst_rtsp_media_factory_construct    (GstRTSPMediaFactory *factory,
                                                         const GstRTSPUrl *url);

Construct the media object and create its streams. Implementations should create the needed gstreamer elements and add them to the result object. No state changes should be performed on them yet.

One or more GstRTSPStream objects should be created from the result with gst_rtsp_media_create_stream().

After the media is constructed, it can be configured and then prepared with gst_rtsp_media_prepare().

gst_rtsp_media_factory_create_element ()

GstElement *        gst_rtsp_media_factory_create_element
                                                        (GstRTSPMediaFactory *factory,
                                                         const GstRTSPUrl *url);

Construct and return a GstElement that is a GstBin containing the elements to use for streaming the media.

The bin should contain payloaders pay%d for each stream. The default implementation of this function returns the bin created from the launch parameter.

The "buffer-size" property

  "buffer-size"              guint                 : Read / Write

The kernel UDP buffer size to use.

Default value: 524288

The "eos-shutdown" property

  "eos-shutdown"             gboolean              : Read / Write

Send EOS down the pipeline before shutting down.

Default value: FALSE

The "launch" property

  "launch"                   gchar*                : Read / Write

A launch description of the pipeline.

Default value: NULL

The "protocols" property

  "protocols"                GstRTSPLowerTrans     : Read / Write

Allowed lower transport protocols.

Default value: GST_RTSP_LOWER_TRANS_UDP|GST_RTSP_LOWER_TRANS_UDP_MCAST|GST_RTSP_LOWER_TRANS_TCP

The "shared" property

  "shared"                   gboolean              : Read / Write

If media from this factory is shared.

Default value: FALSE

The "suspend-mode" property

  "suspend-mode"             GstRTSPSuspendMode    : Read / Write

Control how media will be suspended.

Default value: GST_RTSP_SUSPEND_MODE_NONE

The "media-configure" signal

void                user_function                      (GstRTSPMediaFactory *gstrtspmediafactory,
                                                        GstRTSPMedia        *arg1,
                                                        gpointer             user_data)                : Run Last

The "media-constructed" signal

void                user_function                      (GstRTSPMediaFactory *gstrtspmediafactory,
                                                        GstRTSPMedia        *arg1,
                                                        gpointer             user_data)                : Run Last