struct GstRTSPSession

struct GstRTSPSession;

Session information kept by the server for a specific client. One client session, identified with a session id, can handle multiple medias identified with the url of a media.

struct GstRTSPSessionClass

struct GstRTSPSessionClass {
  GObjectClass  parent_class;
};

gst_rtsp_session_new ()

GstRTSPSession *    gst_rtsp_session_new                (const gchar *sessionid);

Create a new GstRTSPSession instance with sessionid.

gst_rtsp_session_get_sessionid ()

const gchar *       gst_rtsp_session_get_sessionid      (GstRTSPSession *session);

Get the sessionid of session.

gst_rtsp_session_get_header ()

gchar *             gst_rtsp_session_get_header         (GstRTSPSession *session);

Get the string that can be placed in the Session header field.

gst_rtsp_session_set_timeout ()

void                gst_rtsp_session_set_timeout        (GstRTSPSession *session,
                                                         guint timeout);

Configure session for a timeout of timeout seconds. The session will be cleaned up when there is no activity for timeout seconds.

gst_rtsp_session_get_timeout ()

guint               gst_rtsp_session_get_timeout        (GstRTSPSession *session);

Get the timeout value of session.

gst_rtsp_session_touch ()

void                gst_rtsp_session_touch              (GstRTSPSession *session);

Update the last_access time of the session to the current time.

gst_rtsp_session_prevent_expire ()

void                gst_rtsp_session_prevent_expire     (GstRTSPSession *session);

Prevent session from expiring.

gst_rtsp_session_allow_expire ()

void                gst_rtsp_session_allow_expire       (GstRTSPSession *session);

Allow session to expire. This method must be called an equal amount of time as gst_rtsp_session_prevent_expire().

gst_rtsp_session_next_timeout ()

gint                gst_rtsp_session_next_timeout       (GstRTSPSession *session,
                                                         GTimeVal *now);

Get the amount of milliseconds till the session will expire.

gst_rtsp_session_is_expired ()

gboolean            gst_rtsp_session_is_expired         (GstRTSPSession *session,
                                                         GTimeVal *now);

Check if session timeout out.

gst_rtsp_session_manage_media ()

GstRTSPSessionMedia * gst_rtsp_session_manage_media     (GstRTSPSession *sess,
                                                         const gchar *path,
                                                         GstRTSPMedia *media);

Manage the media object obj in sess. path will be used to retrieve this media from the session with gst_rtsp_session_get_media().

Ownership is taken from media.

gst_rtsp_session_release_media ()

gboolean            gst_rtsp_session_release_media      (GstRTSPSession *sess,
                                                         GstRTSPSessionMedia *media);

Release the managed media in sess, freeing the memory allocated by it.

gst_rtsp_session_get_media ()

GstRTSPSessionMedia * gst_rtsp_session_get_media        (GstRTSPSession *sess,
                                                         const gchar *path,
                                                         gint *matched);

Get the session media for path. matched will contain the number of matched characters of path.

enum GstRTSPFilterResult

typedef enum {
  GST_RTSP_FILTER_REMOVE,
  GST_RTSP_FILTER_KEEP,
  GST_RTSP_FILTER_REF,
} GstRTSPFilterResult;

Possible return values for gst_rtsp_session_pool_filter().

GstRTSPSessionFilterFunc ()

GstRTSPFilterResult (*GstRTSPSessionFilterFunc)         (GstRTSPSession *sess,
                                                         GstRTSPSessionMedia *media,
                                                         gpointer user_data);

This function will be called by the gst_rtsp_session_filter(). An implementation should return a value of GstRTSPFilterResult.

When this function returns GST_RTSP_FILTER_REMOVE, media will be removed from sess.

A return value of GST_RTSP_FILTER_KEEP will leave media untouched in sess.

A value of GST_RTSP_FILTER_REF will add media to the result GList of gst_rtsp_session_filter().

gst_rtsp_session_filter ()

GList *             gst_rtsp_session_filter             (GstRTSPSession *sess,
                                                         GstRTSPSessionFilterFunc func,
                                                         gpointer user_data);

Call func for each media in sess. The result value of func determines what happens to the media. func will be called with sess locked so no further actions on sess can be performed from func.

If func returns GST_RTSP_FILTER_REMOVE, the media will be removed from sess.

If func returns GST_RTSP_FILTER_KEEP, the media will remain in sess.

If func returns GST_RTSP_FILTER_REF, the media will remain in sess but will also be added with an additional ref to the result GList of this function..

When func is NULL, GST_RTSP_FILTER_REF will be assumed for all media.

The "sessionid" property

  "sessionid"                gchar*                : Read / Write / Construct Only

the session id.

Default value: NULL

The "timeout" property

  "timeout"                  guint                 : Read / Write

the timeout of the session (0 = never).

Default value: 60

The "timeout-always-visible" property

  "timeout-always-visible"   gboolean              : Read / Write

timeout always visible in header.

Default value: FALSE