GstRTSPMediaFactory: GStreamer RTSP Server Reference Manual

## GstRTSPMediaFactory GstRTSPMediaFactory |

## Functions

GstRTSPMediaFactory * | gst_rtsp_media_factory_new ()
gchar * | gst_rtsp_media_factory_get_launch ()
void | gst_rtsp_media_factory_set_launch ()
GstRTSPPermissions * | gst_rtsp_media_factory_get_permissions ()
void | gst_rtsp_media_factory_set_permissions ()
void | gst_rtsp_media_factory_add_role ()
void | gst_rtsp_media_factory_set_shared ()
gboolean | gst_rtsp_media_factory_is_shared ()
gboolean | gst_rtsp_media_factory_is_eos_shutdown ()
void | gst_rtsp_media_factory_set_eos_shutdown ()
GstRTSPLowerTrans | gst_rtsp_media_factory_get_protocols ()
void | gst_rtsp_media_factory_set_protocols ()
void | gst_rtsp_media_factory_set_profiles ()
GstRTSPProfile | gst_rtsp_media_factory_get_profiles ()
GstRTSPAddressPool * | gst_rtsp_media_factory_get_address_pool ()
void | gst_rtsp_media_factory_set_address_pool ()
guint | gst_rtsp_media_factory_get_buffer_size ()
void | gst_rtsp_media_factory_set_buffer_size ()
GstRTSPSuspendMode | gst_rtsp_media_factory_get_suspend_mode ()
void | gst_rtsp_media_factory_set_suspend_mode ()
void | gst_rtsp_media_factory_set_retransmission_time ()
GstClockTime | gst_rtsp_media_factory_get_retransmission_time ()
void | gst_rtsp_media_factory_set_latency ()
guint | gst_rtsp_media_factory_get_latency ()
void | gst_rtsp_media_factory_set_media_gtype ()
GType | gst_rtsp_media_factory_get_media_gtype ()
GstRTSPMedia * | gst_rtsp_media_factory_construct ()
GstElement * | gst_rtsp_media_factory_create_element ()

## Properties

guint | buffer-size | Read / Write
GstClock * | clock | Read / Write
gboolean | eos-shutdown | Read / Write
guint | latency | Read / Write
gchar * | launch | Read / Write
GstRTSPProfile | profiles | Read / Write
GstRTSPLowerTrans | protocols | Read / Write
gboolean | shared | Read / Write
gboolean | stop-on-disconnect | Read / Write
GstRTSPSuspendMode | suspend-mode | Read / Write
GstRTSPTransportMode | transport-mode | Read / Write

## Signals

void | media-configure | Run Last
void | media-constructed | Run Last

## Types and Values

struct | GstRTSPMediaFactory
struct | GstRTSPMediaFactoryClass

## Object Hierarchy

        GObject
        ╰── GstRTSPMediaFactory
            ╰── GstRTSPMediaFactoryURI

## Description

## Functions

### gst_rtsp_media_factory_new ()

    GstRTSPMediaFactory *
    gst_rtsp_media_factory_new (void);

### gst_rtsp_media_factory_get_launch ()

    gchar *
    gst_rtsp_media_factory_get_launch (GstRTSPMediaFactory *factory);

### gst_rtsp_media_factory_set_launch ()

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

### gst_rtsp_media_factory_get_permissions ()

    GstRTSPPermissions *
    gst_rtsp_media_factory_get_permissions
                                   (GstRTSPMediaFactory *factory);

### gst_rtsp_media_factory_set_permissions ()

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

### gst_rtsp_media_factory_add_role ()

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

### gst_rtsp_media_factory_set_shared ()

    void
    gst_rtsp_media_factory_set_shared (GstRTSPMediaFactory *factory,
                                       gboolean shared);

### gst_rtsp_media_factory_is_shared ()

    gboolean
    gst_rtsp_media_factory_is_shared (GstRTSPMediaFactory *factory);

### gst_rtsp_media_factory_is_eos_shutdown ()

    gboolean
    gst_rtsp_media_factory_is_eos_shutdown
                                   (GstRTSPMediaFactory *factory);

### gst_rtsp_media_factory_set_eos_shutdown ()

    void
    gst_rtsp_media_factory_set_eos_shutdown
                                   (GstRTSPMediaFactory *factory,
                                    gboolean eos_shutdown);

### gst_rtsp_media_factory_get_protocols ()

    GstRTSPLowerTrans
    gst_rtsp_media_factory_get_protocols (GstRTSPMediaFactory *factory);

### gst_rtsp_media_factory_set_protocols ()

    void
    gst_rtsp_media_factory_set_protocols (GstRTSPMediaFactory *factory,
                                          GstRTSPLowerTrans protocols);

### gst_rtsp_media_factory_set_profiles ()

    void
    gst_rtsp_media_factory_set_profiles (GstRTSPMediaFactory *factory,
                                         GstRTSPProfile profiles);

### gst_rtsp_media_factory_get_profiles ()

    GstRTSPProfile
    gst_rtsp_media_factory_get_profiles (GstRTSPMediaFactory *factory);

### gst_rtsp_media_factory_get_address_pool ()

    GstRTSPAddressPool *
    gst_rtsp_media_factory_get_address_pool
                                   (GstRTSPMediaFactory *factory);

### gst_rtsp_media_factory_set_address_pool ()

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

### gst_rtsp_media_factory_get_buffer_size ()

    guint
    gst_rtsp_media_factory_get_buffer_size
                                   (GstRTSPMediaFactory *factory);

### gst_rtsp_media_factory_set_buffer_size ()

    void
    gst_rtsp_media_factory_set_buffer_size
                                   (GstRTSPMediaFactory *factory,
                                    guint size);

### gst_rtsp_media_factory_get_suspend_mode ()

    GstRTSPSuspendMode
    gst_rtsp_media_factory_get_suspend_mode
                                   (GstRTSPMediaFactory *factory);

### gst_rtsp_media_factory_set_suspend_mode ()

    void
    gst_rtsp_media_factory_set_suspend_mode
                                   (GstRTSPMediaFactory *factory,
                                    GstRTSPSuspendMode mode);

### gst_rtsp_media_factory_set_retransmission_time ()

    void
    gst_rtsp_media_factory_set_retransmission_time
                                   (GstRTSPMediaFactory *factory,
                                    GstClockTime time);

### gst_rtsp_media_factory_get_retransmission_time ()

    GstClockTime
    gst_rtsp_media_factory_get_retransmission_time
                                   (GstRTSPMediaFactory *factory);

### gst_rtsp_media_factory_set_latency ()

    void
    gst_rtsp_media_factory_set_latency (GstRTSPMediaFactory *factory,
                                        guint latency);

### gst_rtsp_media_factory_get_latency ()

    guint
    gst_rtsp_media_factory_get_latency (GstRTSPMediaFactory *factory);

### gst_rtsp_media_factory_set_media_gtype ()

    void
    gst_rtsp_media_factory_set_media_gtype
                                   (GstRTSPMediaFactory *factory,
                                    GType media_gtype);

### gst_rtsp_media_factory_get_media_gtype ()

    GType
    gst_rtsp_media_factory_get_media_gtype
                                   (GstRTSPMediaFactory *factory);

### gst_rtsp_media_factory_construct ()

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

### gst_rtsp_media_factory_create_element ()

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

## Types and Values

### struct GstRTSPMediaFactory

    struct GstRTSPMediaFactory;

### 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);
    };

## Property Details

### The `“buffer-size”` property

      “buffer-size”              guint

The kernel UDP buffer size to use.

Flags: Read / Write

Default value: 524288

### The `“clock”` property

      “clock”                    GstClock *

Clock to be used by the pipelines created for all medias of this factory.

Flags: Read / Write

### The `“eos-shutdown”` property

      “eos-shutdown”             gboolean

Send EOS down the pipeline before shutting down.

Flags: Read / Write

Default value: FALSE

### The `“latency”` property

      “latency”                  guint

Latency used for receiving media in milliseconds.

Flags: Read / Write

Default value: 200

### The `“launch”` property

      “launch”                   gchar *

A launch description of the pipeline.

Flags: Read / Write

Default value: NULL

### The `“profiles”` property

      “profiles”                 GstRTSPProfile

Allowed transfer profiles.

Flags: Read / Write

Default value: GST_RTSP_PROFILE_AVP

### The `“protocols”` property

      “protocols”                GstRTSPLowerTrans

Allowed lower transport protocols.

Flags: Read / Write

Default value: GST_RTSP_LOWER_TRANS_UDP | GST_RTSP_LOWER_TRANS_UDP_MCAST | GST_RTSP_LOWER_TRANS_TCP

### The `“shared”` property

      “shared”                   gboolean

If media from this factory is shared.

Flags: Read / Write

Default value: FALSE

### The `“stop-on-disconnect”` property

      “stop-on-disconnect”       gboolean

If media from this factory should be stopped when a client disconnects without TEARDOWN.

Flags: Read / Write

Default value: TRUE

### The `“suspend-mode”` property

      “suspend-mode”             GstRTSPSuspendMode

Control how media will be suspended.

Flags: Read / Write

Default value: GST_RTSP_SUSPEND_MODE_NONE

### The `“transport-mode”` property

      “transport-mode”           GstRTSPTransportMode

If media from this factory is for PLAY or RECORD.

Flags: Read / Write

Default value: GST_RTSP_TRANSPORT_MODE_PLAY

## Signal Details

### The `“media-configure”` signal

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

Flags: Run Last

### The `“media-constructed”` signal

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

Flags: Run Last