gst_rtsp_client_new ()

GstRTSPClient *
gst_rtsp_client_new (void);

Create a new GstRTSPClient instance.

gst_rtsp_client_close ()

void
gst_rtsp_client_close (GstRTSPClient *client);

Close the connection of client and remove all media it was managing.

Since 1.4

gst_rtsp_client_get_session_pool ()

GstRTSPSessionPool *
gst_rtsp_client_get_session_pool (GstRTSPClient *client);

Get the GstRTSPSessionPool object that client uses to manage its sessions.

gst_rtsp_client_set_session_pool ()

void
gst_rtsp_client_set_session_pool (GstRTSPClient *client,
                                  GstRTSPSessionPool *pool);

Set pool as the sessionpool for client which it will use to find or allocate sessions. the sessionpool is usually inherited from the server that created the client but can be overridden later.

gst_rtsp_client_get_mount_points ()

GstRTSPMountPoints *
gst_rtsp_client_get_mount_points (GstRTSPClient *client);

Get the GstRTSPMountPoints object that client uses to manage its sessions.

gst_rtsp_client_set_mount_points ()

void
gst_rtsp_client_set_mount_points (GstRTSPClient *client,
                                  GstRTSPMountPoints *mounts);

Set mounts as the mount points for client which it will use to map urls to media streams. These mount points are usually inherited from the server that created the client but can be overriden later.

gst_rtsp_client_get_auth ()

GstRTSPAuth *
gst_rtsp_client_get_auth (GstRTSPClient *client);

Get the GstRTSPAuth used as the authentication manager of client .

gst_rtsp_client_set_auth ()

void
gst_rtsp_client_set_auth (GstRTSPClient *client,
                          GstRTSPAuth *auth);

configure auth to be used as the authentication manager of client .

gst_rtsp_client_get_thread_pool ()

GstRTSPThreadPool *
gst_rtsp_client_get_thread_pool (GstRTSPClient *client);

Get the GstRTSPThreadPool used as the thread pool of client .

gst_rtsp_client_set_thread_pool ()

void
gst_rtsp_client_set_thread_pool (GstRTSPClient *client,
                                 GstRTSPThreadPool *pool);

configure pool to be used as the thread pool of client .

gst_rtsp_client_get_connection ()

GstRTSPConnection *
gst_rtsp_client_get_connection (GstRTSPClient *client);

Get the GstRTSPConnection of client .

gst_rtsp_client_set_connection ()

gboolean
gst_rtsp_client_set_connection (GstRTSPClient *client,
                                GstRTSPConnection *conn);

Set the GstRTSPConnection of client . This function takes ownership of conn .

gst_rtsp_client_attach ()

guint
gst_rtsp_client_attach (GstRTSPClient *client,
                        GMainContext *context);

Attaches client to context . When the mainloop for context is run, the client will be dispatched. When context is NULL, the default context will be used).

This function should be called when the client properties and urls are fully configured and the client is ready to start.

GstRTSPClientSendFunc ()

gboolean
(*GstRTSPClientSendFunc) (GstRTSPClient *client,
                          GstRTSPMessage *message,
                          gboolean close,
                          gpointer user_data);

This callback is called when client wants to send message . When close is TRUE, the connection should be closed when the message has been sent.

gst_rtsp_client_set_send_func ()

void
gst_rtsp_client_set_send_func (GstRTSPClient *client,
                               GstRTSPClientSendFunc func,
                               gpointer user_data,
                               GDestroyNotify notify);

Set func as the callback that will be called when a new message needs to be sent to the client. user_data is passed to func and notify is called when user_data is no longer in use.

By default, the client will send the messages on the GstRTSPConnection that was configured with gst_rtsp_client_attach() was called.

gst_rtsp_client_handle_message ()

GstRTSPResult
gst_rtsp_client_handle_message (GstRTSPClient *client,
                                GstRTSPMessage *message);

Let the client handle message .

gst_rtsp_client_send_message ()

GstRTSPResult
gst_rtsp_client_send_message (GstRTSPClient *client,
                              GstRTSPSession *session,
                              GstRTSPMessage *message);

Send a message message to the remote end. message must be a GST_RTSP_MESSAGE_REQUEST or a GST_RTSP_MESSAGE_RESPONSE.

GstRTSPClientSessionFilterFunc ()

GstRTSPFilterResult
(*GstRTSPClientSessionFilterFunc) (GstRTSPClient *client,
                                   GstRTSPSession *sess,
                                   gpointer user_data);

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

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

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

A value of GST_RTSP_FILTER_REF will add sess to the result GList of gst_rtsp_client_session_filter().

gst_rtsp_client_session_filter ()

GList *
gst_rtsp_client_session_filter (GstRTSPClient *client,
                                GstRTSPClientSessionFilterFunc func,
                                gpointer user_data);

Call func for each session managed by client . The result value of func determines what happens to the session. func will be called with client locked so no further actions on client can be performed from func .

If func returns GST_RTSP_FILTER_REMOVE, the session will be removed from client .

If func returns GST_RTSP_FILTER_KEEP, the session will remain in client .

If func returns GST_RTSP_FILTER_REF, the session will remain in client 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 each session.

struct GstRTSPClient

struct GstRTSPClient;

The client object represents the connection and its state with a client.

struct GstRTSPClientClass

struct GstRTSPClientClass {
  GObjectClass  parent_class;

  GstSDPMessage * (*create_sdp) (GstRTSPClient *client, GstRTSPMedia *media);
  gboolean        (*configure_client_media)     (GstRTSPClient * client,
                                                 GstRTSPMedia * media, GstRTSPStream * stream,
                                                 GstRTSPContext * ctx);
  gboolean        (*configure_client_transport) (GstRTSPClient * client,
                                                 GstRTSPContext * ctx,
                                                 GstRTSPTransport * ct);
  GstRTSPResult   (*params_set) (GstRTSPClient *client, GstRTSPContext *ctx);
  GstRTSPResult   (*params_get) (GstRTSPClient *client, GstRTSPContext *ctx);
  gchar *         (*make_path_from_uri) (GstRTSPClient *client, const GstRTSPUrl *uri);

  /* signals */
  void     (*closed)                  (GstRTSPClient *client);
  void     (*new_session)             (GstRTSPClient *client, GstRTSPSession *session);
  void     (*options_request)         (GstRTSPClient *client, GstRTSPContext *ctx);
  void     (*describe_request)        (GstRTSPClient *client, GstRTSPContext *ctx);
  void     (*setup_request)           (GstRTSPClient *client, GstRTSPContext *ctx);
  void     (*play_request)            (GstRTSPClient *client, GstRTSPContext *ctx);
  void     (*pause_request)           (GstRTSPClient *client, GstRTSPContext *ctx);
  void     (*teardown_request)        (GstRTSPClient *client, GstRTSPContext *ctx);
  void     (*set_parameter_request)   (GstRTSPClient *client, GstRTSPContext *ctx);
  void     (*get_parameter_request)   (GstRTSPClient *client, GstRTSPContext *ctx);
  void     (*handle_response)         (GstRTSPClient *client, GstRTSPContext *ctx);

  void     (*tunnel_http_response)    (GstRTSPClient * client, GstRTSPMessage * request,
                                       GstRTSPMessage * response);
};

The client class structure.

The “drop-backlog” property

  “drop-backlog”             gboolean

Drop data when the backlog queue is full.

Flags: Read / Write

Default value: TRUE

The “mount-points” property

  “mount-points”             GstRTSPMountPoints *

The mount points to use for client session.

Flags: Read / Write

The “session-pool” property

  “session-pool”             GstRTSPSessionPool *

The session pool to use for client session.

Flags: Read / Write

The “closed” signal

void
user_function (GstRTSPClient *gstrtspclient,
               gpointer       user_data)

Flags: Run Last

The “describe-request” signal

void
user_function (GstRTSPClient  *gstrtspclient,
               GstRTSPContext *arg1,
               gpointer        user_data)

Flags: Run Last

The “get-parameter-request” signal

void
user_function (GstRTSPClient  *gstrtspclient,
               GstRTSPContext *arg1,
               gpointer        user_data)

Flags: Run Last

The “handle-response” signal

void
user_function (GstRTSPClient  *gstrtspclient,
               GstRTSPContext *arg1,
               gpointer        user_data)

Flags: Run Last

The “new-session” signal

void
user_function (GstRTSPClient  *gstrtspclient,
               GstRTSPSession *arg1,
               gpointer        user_data)

Flags: Run Last

The “options-request” signal

void
user_function (GstRTSPClient  *gstrtspclient,
               GstRTSPContext *arg1,
               gpointer        user_data)

Flags: Run Last

The “pause-request” signal

void
user_function (GstRTSPClient  *gstrtspclient,
               GstRTSPContext *arg1,
               gpointer        user_data)

Flags: Run Last

The “play-request” signal

void
user_function (GstRTSPClient  *gstrtspclient,
               GstRTSPContext *arg1,
               gpointer        user_data)

Flags: Run Last

The “send-message” signal

void
user_function (GstRTSPClient  *client,
               GstRTSPContext *session,
               gpointer        message,
               gpointer        user_data)

Flags: Run Last

The “set-parameter-request” signal

void
user_function (GstRTSPClient  *gstrtspclient,
               GstRTSPContext *arg1,
               gpointer        user_data)

Flags: Run Last

The “setup-request” signal

void
user_function (GstRTSPClient  *gstrtspclient,
               GstRTSPContext *arg1,
               gpointer        user_data)

Flags: Run Last

The “teardown-request” signal

void
user_function (GstRTSPClient  *gstrtspclient,
               GstRTSPContext *arg1,
               gpointer        user_data)

Flags: Run Last