Commit ccceb1de authored by Wim Taymans's avatar Wim Taymans

docs: update docs

parent 2fdc6ef8
......@@ -14,18 +14,20 @@
</bookinfo>
<chapter>
<xi:include href="xml/rtsp-server.xml"/>
<xi:include href="xml/rtsp-client.xml"/>
<xi:include href="xml/rtsp-mount-points.xml"/>
<xi:include href="xml/rtsp-media-factory.xml"/>
<xi:include href="xml/rtsp-media-factory-uri.xml"/>
<xi:include href="xml/rtsp-mount-points.xml"/>
<xi:include href="xml/rtsp-media.xml"/>
<xi:include href="xml/rtsp-auth.xml"/>
<xi:include href="xml/rtsp-params.xml"/>
<xi:include href="xml/rtsp-sdp.xml"/>
<xi:include href="xml/rtsp-server.xml"/>
<xi:include href="xml/rtsp-session-pool.xml"/>
<xi:include href="xml/rtsp-session.xml"/>
<xi:include href="xml/rtsp-media.xml"/>
<xi:include href="xml/rtsp-sdp.xml"/>
<xi:include href="xml/rtsp-address-pool.xml"/>
<xi:include href="xml/rtsp-auth.xml"/>
<xi:include href="xml/rtsp-token.xml"/>
<xi:include href="xml/rtsp-permissions.xml"/>
<xi:include href="xml/rtsp-params.xml"/>
</chapter>
<!-- <chapter> -->
......
This diff is collapsed.
......@@ -22,6 +22,14 @@
#include "rtsp-address-pool.h"
/**
* gst_rtsp_address_copy:
* @addr: a #GstRTSPAddress
*
* Make a copy of @addr.
*
* Returns: a copy of @addr.
*/
GstRTSPAddress *
gst_rtsp_address_copy (GstRTSPAddress * addr)
{
......@@ -41,6 +49,13 @@ gst_rtsp_address_copy (GstRTSPAddress * addr)
static void gst_rtsp_address_pool_release_address (GstRTSPAddressPool * pool,
GstRTSPAddress * addr);
/**
* gst_rtsp_address_free:
* @addr: a #GstRTSPAddress
*
* Free @addr and releasing it back into the pool when owned by a
* pool.
*/
void
gst_rtsp_address_free (GstRTSPAddress * addr)
{
......@@ -54,7 +69,6 @@ gst_rtsp_address_free (GstRTSPAddress * addr)
g_slice_free (GstRTSPAddress, addr);
}
G_DEFINE_BOXED_TYPE (GstRTSPAddress, gst_rtsp_address,
(GBoxedCopyFunc) gst_rtsp_address_copy,
(GBoxedFreeFunc) gst_rtsp_address_free);
......
......@@ -34,12 +34,21 @@ G_BEGIN_DECLS
#define GST_RTSP_ADDRESS_POOL_CLASS_CAST(klass) ((GstRTSPAddressPoolClass*)(klass))
typedef struct _GstRTSPAddress GstRTSPAddress;
typedef struct _GstRTSPAddressClass GstRTSPAddressClass;
typedef struct _GstRTSPAddressPool GstRTSPAddressPool;
typedef struct _GstRTSPAddressPoolClass GstRTSPAddressPoolClass;
typedef struct _GstRTSPAddressPoolPrivate GstRTSPAddressPoolPrivate;
/**
* GstRTSPAddress:
* @pool: the #GstRTSPAddressPool owner of this address
* @address: the address
* @port: the port number
* @n_ports: number of ports
* @ttl: TTL or 0 for unicast addresses
*
* An address
*/
struct _GstRTSPAddress {
GstRTSPAddressPool *pool;
......@@ -48,6 +57,7 @@ struct _GstRTSPAddress {
gint n_ports;
guint8 ttl;
/*<private >*/
gpointer priv;
};
......@@ -56,6 +66,17 @@ GType gst_rtsp_address_get_type (void);
GstRTSPAddress * gst_rtsp_address_copy (GstRTSPAddress *addr);
void gst_rtsp_address_free (GstRTSPAddress *addr);
/**
* GstRTSPAddressFlags:
* @GST_RTSP_ADDRESS_FLAG_NONE: no flags
* @GST_RTSP_ADDRESS_FLAG_IPV4: an IPv4 address
* @GST_RTSP_ADDRESS_FLAG_IPV6: and IPv6 address
* @GST_RTSP_ADDRESS_FLAG_EVEN_PORT: address with an even port
* @GST_RTSP_ADDRESS_FLAG_MULTICAST: a multicast address
* @GST_RTSP_ADDRESS_FLAG_UNICAST: a unicast address
*
* Flags used to control allocation of addresses
*/
typedef enum {
GST_RTSP_ADDRESS_FLAG_NONE = 0,
GST_RTSP_ADDRESS_FLAG_IPV4 = (1 << 0),
......@@ -71,6 +92,7 @@ typedef enum {
* Used with gst_rtsp_address_pool_add_range_unicast() to bind to all
* IPv4 addresses
*/
#define GST_RTSP_ADDRESS_POOL_ANY_IPV4 "0.0.0.0"
/**
* GST_RTSP_ADDRESS_POOL_ANY_IPV6:
......@@ -78,22 +100,26 @@ typedef enum {
* Used with gst_rtsp_address_pool_add_range_unicast() to bind to all
* IPv6 addresses
*/
#define GST_RTSP_ADDRESS_POOL_ANY_IPV4 "0.0.0.0"
#define GST_RTSP_ADDRESS_POOL_ANY_IPV6 "::"
/**
* GstRTSPAddressPool:
* @parent: the parent GObject
*
* An address pool, all member are prive
* An address pool, all member are private
*/
struct _GstRTSPAddressPool {
GObject parent;
/*< private >*/
GstRTSPAddressPoolPrivate *priv;
};
/**
* GstRTSPAddressPoolClass:
*
* Opaque Address pool class.
*/
struct _GstRTSPAddressPoolClass {
GObjectClass parent_class;
};
......
......@@ -149,10 +149,10 @@ gst_rtsp_auth_new (void)
* gst_rtsp_auth_add_basic:
* @auth: a #GstRTSPAuth
* @basic: the basic token
* @authgroup: authorisation group
* @token: authorisation token
*
* Add a basic token for the default authentication algorithm that
* enables the client qith privileges from @authgroup.
* enables the client with privileges listed in @token.
*/
void
gst_rtsp_auth_add_basic (GstRTSPAuth * auth, const gchar * basic,
......
......@@ -105,7 +105,7 @@ typedef gboolean (*GstRTSPClientSendFunc) (GstRTSPClient *client,
/**
* GstRTSPClient:
*
* The client structure.
* The client object represents the connection and its state with a client.
*/
struct _GstRTSPClient {
GObject parent;
......@@ -115,10 +115,13 @@ struct _GstRTSPClient {
/**
* GstRTSPClientClass:
* @create_sdp: called when the SDP needs to be created for media.
* @configure_client_transport: called when the client transport needs to be
* configured.
* @params_set: set parameters. This function should also initialize the
* RTSP response(state->response) via a call to gst_rtsp_message_init_response()
* RTSP response(state->response) via a call to gst_rtsp_message_init_response()
* @params_get: get parameters. This function should also initialize the
* RTSP response(state->response) via a call to gst_rtsp_message_init_response()
* RTSP response(state->response) via a call to gst_rtsp_message_init_response()
*
* The client class structure.
*/
......
......@@ -53,6 +53,7 @@ typedef struct _GstRTSPMediaFactoryPrivate GstRTSPMediaFactoryPrivate;
struct _GstRTSPMediaFactory {
GObject parent;
/*< private >*/
GstRTSPMediaFactoryPrivate *priv;
};
......
......@@ -774,8 +774,9 @@ gst_rtsp_media_get_buffer_size (GstRTSPMedia * media)
/**
* gst_rtsp_media_use_time_provider:
* @media: a #GstRTSPMedia
* @time_provider: if a #GstNetTimeProvider should be used
*
* Set @media to provide a GstNetTimeProvider.
* Set @media to provide a #GstNetTimeProvider.
*/
void
gst_rtsp_media_use_time_provider (GstRTSPMedia * media, gboolean time_provider)
......
......@@ -76,6 +76,7 @@ typedef enum {
struct _GstRTSPMedia {
GObject parent;
/*< private >*/
GstRTSPMediaPrivate *priv;
};
......
......@@ -110,6 +110,8 @@ gst_rtsp_permissions_new (void)
/**
* gst_rtsp_permissions_add_role:
* @permissions: a #GstRTSPPermissions
* @role: a role
* @structure: the permissions structure
*
* Add the configuration in @structure to @permissions for @role.
*/
......@@ -151,7 +153,9 @@ gst_rtsp_permissions_add_role (GstRTSPPermissions * permissions,
/**
* gst_rtsp_permissions_remove_role:
* @permissions: a #GstRTSPPermissions
* @role: a role
*
* Remove all permissions for @role in @permissions.
*/
void
gst_rtsp_permissions_remove_role (GstRTSPPermissions * permissions,
......@@ -165,7 +169,11 @@ gst_rtsp_permissions_remove_role (GstRTSPPermissions * permissions,
/**
* gst_rtsp_permissions_get_role:
* @permissions: a #GstRTSPPermissions
* @role: a role
*
* Get all permissions for @role in @permissions.
*
* Returns: the structure with permissions for @role.
*/
const GstStructure *
gst_rtsp_permissions_get_role (GstRTSPPermissions * permissions,
......@@ -187,6 +195,16 @@ gst_rtsp_permissions_get_role (GstRTSPPermissions * permissions,
return NULL;
}
/**
* gst_rtsp_permissions_is_allowed:
* @permissions: a #GstRTSPPermissions
* @role: a role
* @permission: a permission
*
* Check if @role in @permissions is given permission for @permission.
*
* Returns: %TRUE if @role is allowed @permission.
*/
gboolean
gst_rtsp_permissions_is_allowed (GstRTSPPermissions * permissions,
const gchar * role, const gchar * permission)
......
......@@ -33,7 +33,6 @@ GType gst_rtsp_permissions_get_type (void);
#define GST_RTSP_PERMISSIONS_CAST(obj) ((GstRTSPPermissions*)(obj))
#define GST_RTSP_PERMISSIONS(obj) (GST_RTSP_PERMISSIONS_CAST(obj))
/**
* GstRTSPPermissions:
*
......
......@@ -61,6 +61,7 @@ struct _GstRTSPServer {
* object that handles the new connection on @socket.
* @setup_connection: Setup the new client connection. The default
* implementation will configure the TLS certificate.
* @client_connected: emited when a new client connected.
*
* The RTSP server class structure
*/
......
......@@ -356,7 +356,7 @@ gst_rtsp_session_media_set_rtsp_state (GstRTSPSessionMedia * media,
}
/**
* gst_rtsp_session_media_set_rtsp_state:
* gst_rtsp_session_media_get_rtsp_state:
* @media: a #GstRTSPSessionMedia
*
* Get the current RTSP state of @media.
......
......@@ -48,6 +48,7 @@ struct _GstRTSPSessionMedia
{
GObject parent;
/*< private >*/
GstRTSPSessionMediaPrivate *priv;
};
......
......@@ -52,6 +52,7 @@ typedef struct _GstRTSPSessionPoolPrivate GstRTSPSessionPoolPrivate;
struct _GstRTSPSessionPool {
GObject parent;
/*< private >*/
GstRTSPSessionPoolPrivate *priv;
};
......
......@@ -67,6 +67,7 @@ typedef enum
struct _GstRTSPSession {
GObject parent;
/*< private >*/
GstRTSPSessionPrivate *priv;
};
......
......@@ -42,7 +42,25 @@ typedef struct _GstRTSPStreamTransportPrivate GstRTSPStreamTransportPrivate;
#include "rtsp-stream.h"
/**
* GstRTSPSendFunc:
* @buffer: a #GstBuffer
* @channel: a channel
* @user_data: user data
*
* Function registered with gst_rtsp_stream_transport_set_callbacks() and
* called when @buffer must be sent on @channel.
*
* Returns: %TRUE on success
*/
typedef gboolean (*GstRTSPSendFunc) (GstBuffer *buffer, guint8 channel, gpointer user_data);
/**
* GstRTSPKeepAliveFunc:
* @user_data: user data
*
* Function registered with gst_rtsp_stream_transport_set_keepalive() and called
* when the stream is active.
*/
typedef void (*GstRTSPKeepAliveFunc) (gpointer user_data);
/**
......@@ -54,6 +72,7 @@ typedef void (*GstRTSPKeepAliveFunc) (gpointer user_data);
struct _GstRTSPStreamTransport {
GObject parent;
/*< private >*/
GstRTSPStreamTransportPrivate *priv;
};
......
......@@ -951,6 +951,7 @@ alloc_ports (GstRTSPStream * stream)
* gst_rtsp_stream_get_server_port:
* @stream: a #GstRTSPStream
* @server_port: (out): result server port
* @family: the port family to get
*
* Fill @server_port with the port pair used by the server. This function can
* only be called when @stream has been joined.
......
......@@ -62,6 +62,10 @@ typedef enum
/**
* GstRTSPThread:
* @mini_object: parent #GstMiniObject
* @type: the thread type
* @context: a #GMainContext
* @loop: a #GMainLoop
*
* Structure holding info about a mainloop running in a thread
*/
......@@ -121,11 +125,13 @@ gst_rtsp_thread_unref (GstRTSPThread * thread)
struct _GstRTSPThreadPool {
GObject parent;
/*< private >*/
GstRTSPThreadPoolPrivate *priv;
};
/**
* GstRTSPThreadPoolClass:
* @pool: a #GThreadPool used internally
* @get_thread: get or reuse a thread object
* @configure_thread: configure a thread object
* @thread_enter: called from the thread when it is entered
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment