mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-09-29 23:32:33 +00:00
Code Issues 1 Projects Releases Wiki Activity

All around: add annotations and API guards

Browse source
This commit is contained in:
Mathieu Duponchelle 2018-02-10 00:07:25 +01:00
parent 2bb00ebfaa
commit c725ef01a4
12 changed files with 91 additions and 79 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
gst/rtsp-server/rtsp-auth.c
View file

@ -290,7 +290,7 @@ gst_rtsp_auth_set_tls_certificate (GstRTSPAuth * auth, GTlsCertificate * cert)
* *
* Get the #GTlsCertificate used for negotiating TLS @auth. * Get the #GTlsCertificate used for negotiating TLS @auth.
* *
* Returns: (transfer full): the #GTlsCertificate of @auth. g_object_unref() after * Returns: (transfer full) (nullable): the #GTlsCertificate of @auth. g_object_unref() after
* usage. * usage.
*/ */
GTlsCertificate * GTlsCertificate *
@ -350,7 +350,7 @@ gst_rtsp_auth_set_tls_database (GstRTSPAuth * auth, GTlsDatabase * database)
* *
* Get the #GTlsDatabase used for verifying client certificate. * Get the #GTlsDatabase used for verifying client certificate.
* *
* Returns: (transfer full): the #GTlsDatabase of @auth. g_object_unref() after * Returns: (transfer full) (nullable): the #GTlsDatabase of @auth. g_object_unref() after
* usage. * usage.
* Since: 1.6 * Since: 1.6
*/ */
@ -460,7 +460,7 @@ gst_rtsp_auth_set_default_token (GstRTSPAuth * auth, GstRTSPToken * token)
* Get the default token for @auth. This token will be used for unauthenticated * Get the default token for @auth. This token will be used for unauthenticated
* users. * users.
* *
* Returns: (transfer full): the #GstRTSPToken of @auth. gst_rtsp_token_unref() after * Returns: (transfer full) (nullable): the #GstRTSPToken of @auth. gst_rtsp_token_unref() after
* usage. * usage.
*/ */
GstRTSPToken * GstRTSPToken *

20
gst/rtsp-server/rtsp-client.c
View file

@ -3806,7 +3806,7 @@ invalid_length:
/** /**
* gst_rtsp_client_set_session_pool: * gst_rtsp_client_set_session_pool:
* @client: a #GstRTSPClient * @client: a #GstRTSPClient
* @pool: (transfer none): a #GstRTSPSessionPool * @pool: (transfer none) (nullable): a #GstRTSPSessionPool
* *
* Set @pool as the sessionpool for @client which it will use to find * Set @pool as the sessionpool for @client which it will use to find
* or allocate sessions. the sessionpool is usually inherited from the server * or allocate sessions. the sessionpool is usually inherited from the server
@ -3847,7 +3847,7 @@ gst_rtsp_client_set_session_pool (GstRTSPClient * client,
* *
* Get the #GstRTSPSessionPool object that @client uses to manage its sessions. * Get the #GstRTSPSessionPool object that @client uses to manage its sessions.
* *
* Returns: (transfer full): a #GstRTSPSessionPool, unref after usage. * Returns: (transfer full) (nullable): a #GstRTSPSessionPool, unref after usage.
*/ */
GstRTSPSessionPool * GstRTSPSessionPool *
gst_rtsp_client_get_session_pool (GstRTSPClient * client) gst_rtsp_client_get_session_pool (GstRTSPClient * client)
@ -3870,7 +3870,7 @@ gst_rtsp_client_get_session_pool (GstRTSPClient * client)
/** /**
* gst_rtsp_client_set_mount_points: * gst_rtsp_client_set_mount_points:
* @client: a #GstRTSPClient * @client: a #GstRTSPClient
* @mounts: (transfer none): a #GstRTSPMountPoints * @mounts: (transfer none) (nullable): a #GstRTSPMountPoints
* *
* Set @mounts as the mount points for @client which it will use to map urls * 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 * to media streams. These mount points are usually inherited from the server that
@ -3905,7 +3905,7 @@ gst_rtsp_client_set_mount_points (GstRTSPClient * client,
* *
* Get the #GstRTSPMountPoints object that @client uses to manage its sessions. * Get the #GstRTSPMountPoints object that @client uses to manage its sessions.
* *
* Returns: (transfer full): a #GstRTSPMountPoints, unref after usage. * Returns: (transfer full) (nullable): a #GstRTSPMountPoints, unref after usage.
*/ */
GstRTSPMountPoints * GstRTSPMountPoints *
gst_rtsp_client_get_mount_points (GstRTSPClient * client) gst_rtsp_client_get_mount_points (GstRTSPClient * client)
@ -3928,7 +3928,7 @@ gst_rtsp_client_get_mount_points (GstRTSPClient * client)
/** /**
* gst_rtsp_client_set_auth: * gst_rtsp_client_set_auth:
* @client: a #GstRTSPClient * @client: a #GstRTSPClient
* @auth: (transfer none): a #GstRTSPAuth * @auth: (transfer none) (nullable): a #GstRTSPAuth
* *
* configure @auth to be used as the authentication manager of @client. * configure @auth to be used as the authentication manager of @client.
*/ */
@ -3961,8 +3961,8 @@ gst_rtsp_client_set_auth (GstRTSPClient * client, GstRTSPAuth * auth)
* *
* Get the #GstRTSPAuth used as the authentication manager of @client. * Get the #GstRTSPAuth used as the authentication manager of @client.
* *
* Returns: (transfer full): the #GstRTSPAuth of @client. g_object_unref() after * Returns: (transfer full) (nullable): the #GstRTSPAuth of @client.
* usage. * g_object_unref() after usage.
*/ */
GstRTSPAuth * GstRTSPAuth *
gst_rtsp_client_get_auth (GstRTSPClient * client) gst_rtsp_client_get_auth (GstRTSPClient * client)
@ -3985,7 +3985,7 @@ gst_rtsp_client_get_auth (GstRTSPClient * client)
/** /**
* gst_rtsp_client_set_thread_pool: * gst_rtsp_client_set_thread_pool:
* @client: a #GstRTSPClient * @client: a #GstRTSPClient
* @pool: (transfer none): a #GstRTSPThreadPool * @pool: (transfer none) (nullable): a #GstRTSPThreadPool
* *
* configure @pool to be used as the thread pool of @client. * configure @pool to be used as the thread pool of @client.
*/ */
@ -4018,7 +4018,7 @@ gst_rtsp_client_set_thread_pool (GstRTSPClient * client,
* *
* Get the #GstRTSPThreadPool used as the thread pool of @client. * Get the #GstRTSPThreadPool used as the thread pool of @client.
* *
* Returns: (transfer full): the #GstRTSPThreadPool of @client. g_object_unref() after * Returns: (transfer full) (nullable): the #GstRTSPThreadPool of @client. g_object_unref() after
* usage. * usage.
*/ */
GstRTSPThreadPool * GstRTSPThreadPool *
@ -4110,7 +4110,7 @@ no_address:
* *
* Get the #GstRTSPConnection of @client. * Get the #GstRTSPConnection of @client.
* *
* Returns: (transfer none): the #GstRTSPConnection of @client. * Returns: (transfer none) (nullable): the #GstRTSPConnection of @client.
* The connection object returned remains valid until the client is freed. * The connection object returned remains valid until the client is freed.
*/ */
GstRTSPConnection * GstRTSPConnection *

14
gst/rtsp-server/rtsp-media-factory.c
View file

@ -411,7 +411,7 @@ gst_rtsp_media_factory_new (void)
/** /**
* gst_rtsp_media_factory_set_permissions: * gst_rtsp_media_factory_set_permissions:
* @factory: a #GstRTSPMediaFactory * @factory: a #GstRTSPMediaFactory
* @permissions: (transfer none): a #GstRTSPPermissions * @permissions: (transfer none) (nullable): a #GstRTSPPermissions
* *
* Set @permissions on @factory. * Set @permissions on @factory.
*/ */
@ -439,7 +439,7 @@ gst_rtsp_media_factory_set_permissions (GstRTSPMediaFactory * factory,
* *
* Get the permissions object from @factory. * Get the permissions object from @factory.
* *
* Returns: (transfer full): a #GstRTSPPermissions object, unref after usage. * Returns: (transfer full) (nullable): a #GstRTSPPermissions object, unref after usage.
*/ */
GstRTSPPermissions * GstRTSPPermissions *
gst_rtsp_media_factory_get_permissions (GstRTSPMediaFactory * factory) gst_rtsp_media_factory_get_permissions (GstRTSPMediaFactory * factory)
@ -534,7 +534,7 @@ gst_rtsp_media_factory_set_launch (GstRTSPMediaFactory * factory,
* Get the gst_parse_launch() pipeline description that will be used in the * Get the gst_parse_launch() pipeline description that will be used in the
* default prepare vmethod. * default prepare vmethod.
* *
* Returns: (transfer full): the configured launch description. g_free() after * Returns: (transfer full) (nullable): the configured launch description. g_free() after
* usage. * usage.
*/ */
gchar * gchar *
@ -748,7 +748,7 @@ gst_rtsp_media_factory_get_buffer_size (GstRTSPMediaFactory * factory)
/** /**
* gst_rtsp_media_factory_set_address_pool: * gst_rtsp_media_factory_set_address_pool:
* @factory: a #GstRTSPMediaFactory * @factory: a #GstRTSPMediaFactory
* @pool: (transfer none): a #GstRTSPAddressPool * @pool: (transfer none) (nullable): a #GstRTSPAddressPool
* *
* configure @pool to be used as the address pool of @factory. * configure @pool to be used as the address pool of @factory.
*/ */
@ -780,7 +780,7 @@ gst_rtsp_media_factory_set_address_pool (GstRTSPMediaFactory * factory,
* *
* Get the #GstRTSPAddressPool used as the address pool of @factory. * Get the #GstRTSPAddressPool used as the address pool of @factory.
* *
* Returns: (transfer full): the #GstRTSPAddressPool of @factory. g_object_unref() after * Returns: (transfer full) (nullable): the #GstRTSPAddressPool of @factory. g_object_unref() after
* usage. * usage.
*/ */
GstRTSPAddressPool * GstRTSPAddressPool *
@ -804,7 +804,7 @@ gst_rtsp_media_factory_get_address_pool (GstRTSPMediaFactory * factory)
/** /**
* gst_rtsp_media_factory_set_multicast_iface: * gst_rtsp_media_factory_set_multicast_iface:
* @factory: a #GstRTSPMediaFactory * @factory: a #GstRTSPMediaFactory
* @multicast_iface: (transfer none): a multicast interface name * @multicast_iface: (transfer none) (nullable): a multicast interface name
* *
* configure @multicast_iface to be used for @factory. * configure @multicast_iface to be used for @factory.
*/ */
@ -838,7 +838,7 @@ gst_rtsp_media_factory_set_multicast_iface (GstRTSPMediaFactory * media_factory,
* *
* Get the multicast interface used for @factory. * Get the multicast interface used for @factory.
* *
* Returns: (transfer full): the multicast interface for @factory. g_free() after * Returns: (transfer full) (nullable): the multicast interface for @factory. g_free() after
* usage. * usage.
*/ */
gchar * gchar *

20
gst/rtsp-server/rtsp-media.c
View file

@ -892,7 +892,7 @@ gst_rtsp_media_take_pipeline (GstRTSPMedia * media, GstPipeline * pipeline)
/** /**
* gst_rtsp_media_set_permissions: * gst_rtsp_media_set_permissions:
* @media: a #GstRTSPMedia * @media: a #GstRTSPMedia
* @permissions: (transfer none): a #GstRTSPPermissions * @permissions: (transfer none) (nullable): a #GstRTSPPermissions
* *
* Set @permissions on @media. * Set @permissions on @media.
*/ */
@ -920,7 +920,7 @@ gst_rtsp_media_set_permissions (GstRTSPMedia * media,
* *
* Get the permissions object from @media. * Get the permissions object from @media.
* *
* Returns: (transfer full): a #GstRTSPPermissions object, unref after usage. * Returns: (transfer full) (nullable): a #GstRTSPPermissions object, unref after usage.
*/ */
GstRTSPPermissions * GstRTSPPermissions *
gst_rtsp_media_get_permissions (GstRTSPMedia * media) gst_rtsp_media_get_permissions (GstRTSPMedia * media)
@ -1598,7 +1598,7 @@ gst_rtsp_media_get_publish_clock_mode (GstRTSPMedia * media)
/** /**
* gst_rtsp_media_set_address_pool: * gst_rtsp_media_set_address_pool:
* @media: a #GstRTSPMedia * @media: a #GstRTSPMedia
* @pool: (transfer none): a #GstRTSPAddressPool * @pool: (transfer none) (nullable): a #GstRTSPAddressPool
* *
* configure @pool to be used as the address pool of @media. * configure @pool to be used as the address pool of @media.
*/ */
@ -1634,8 +1634,8 @@ gst_rtsp_media_set_address_pool (GstRTSPMedia * media,
* *
* Get the #GstRTSPAddressPool used as the address pool of @media. * Get the #GstRTSPAddressPool used as the address pool of @media.
* *
* Returns: (transfer full): the #GstRTSPAddressPool of @media. g_object_unref() after * Returns: (transfer full) (nullable): the #GstRTSPAddressPool of @media.
* usage. * g_object_unref() after usage.
*/ */
GstRTSPAddressPool * GstRTSPAddressPool *
gst_rtsp_media_get_address_pool (GstRTSPMedia * media) gst_rtsp_media_get_address_pool (GstRTSPMedia * media)
@ -1658,7 +1658,7 @@ gst_rtsp_media_get_address_pool (GstRTSPMedia * media)
/** /**
* gst_rtsp_media_set_multicast_iface: * gst_rtsp_media_set_multicast_iface:
* @media: a #GstRTSPMedia * @media: a #GstRTSPMedia
* @multicast_iface: (transfer none): a multicast interface name * @multicast_iface: (transfer none) (nullable): a multicast interface name
* *
* configure @multicast_iface to be used for @media. * configure @multicast_iface to be used for @media.
*/ */
@ -1694,8 +1694,8 @@ gst_rtsp_media_set_multicast_iface (GstRTSPMedia * media,
* *
* Get the multicast interface used for @media. * Get the multicast interface used for @media.
* *
* Returns: (transfer full): the multicast interface for @media. g_free() after * Returns: (transfer full) (nullable): the multicast interface for @media.
* usage. * g_free() after usage.
*/ */
gchar * gchar *
gst_rtsp_media_get_multicast_iface (GstRTSPMedia * media) gst_rtsp_media_get_multicast_iface (GstRTSPMedia * media)
@ -2074,7 +2074,7 @@ default_convert_range (GstRTSPMedia * media, GstRTSPTimeRange * range,
* Get the current range as a string. @media must be prepared with * Get the current range as a string. @media must be prepared with
* gst_rtsp_media_prepare (). * gst_rtsp_media_prepare ().
* *
* Returns: (transfer full): The range as a string, g_free() after usage. * Returns: (transfer full) (nullable): The range as a string, g_free() after usage.
*/ */
gchar * gchar *
gst_rtsp_media_get_range_string (GstRTSPMedia * media, gboolean play, gst_rtsp_media_get_range_string (GstRTSPMedia * media, gboolean play,
@ -3289,7 +3289,7 @@ get_clock_unlocked (GstRTSPMedia * media)
* *
* @media must be prepared before this method returns a valid clock object. * @media must be prepared before this method returns a valid clock object.
* *
* Returns: (transfer full): the #GstClock used by @media. unref after usage. * Returns: (transfer full) (nullable): the #GstClock used by @media. unref after usage.
*/ */
GstClock * GstClock *
gst_rtsp_media_get_clock (GstRTSPMedia * media) gst_rtsp_media_get_clock (GstRTSPMedia * media)

2
gst/rtsp-server/rtsp-mount-points.c
View file

@ -181,7 +181,7 @@ default_make_path (GstRTSPMountPoints * mounts, const GstRTSPUrl * url)
* *
* Make a path string from @url. * Make a path string from @url.
* *
* Returns: (transfer full): a path string for @url, g_free() after usage. * Returns: (transfer full) (nullable): a path string for @url, g_free() after usage.
*/ */
gchar * gchar *
gst_rtsp_mount_points_make_path (GstRTSPMountPoints * mounts, gst_rtsp_mount_points_make_path (GstRTSPMountPoints * mounts,

22
gst/rtsp-server/rtsp-server.c
View file

@ -328,7 +328,7 @@ gst_rtsp_server_set_address (GstRTSPServer * server, const gchar * address)
* *
* Get the address on which the server will accept connections. * Get the address on which the server will accept connections.
* *
* Returns: (transfer full): the server address. g_free() after usage. * Returns: (transfer full) (nullable): the server address. g_free() after usage.
*/ */
gchar * gchar *
gst_rtsp_server_get_address (GstRTSPServer * server) gst_rtsp_server_get_address (GstRTSPServer * server)
@ -417,7 +417,7 @@ gst_rtsp_server_set_service (GstRTSPServer * server, const gchar * service)
* *
* Get the service on which the server will accept connections. * Get the service on which the server will accept connections.
* *
* Returns: (transfer full): the service. use g_free() after usage. * Returns: (transfer full) (nullable): the service. use g_free() after usage.
*/ */
gchar * gchar *
gst_rtsp_server_get_service (GstRTSPServer * server) gst_rtsp_server_get_service (GstRTSPServer * server)
@ -488,7 +488,7 @@ gst_rtsp_server_get_backlog (GstRTSPServer * server)
/** /**
* gst_rtsp_server_set_session_pool: * gst_rtsp_server_set_session_pool:
* @server: a #GstRTSPServer * @server: a #GstRTSPServer
* @pool: (transfer none): a #GstRTSPSessionPool * @pool: (transfer none) (nullable): a #GstRTSPSessionPool
* *
* configure @pool to be used as the session pool of @server. * configure @pool to be used as the session pool of @server.
*/ */
@ -521,7 +521,7 @@ gst_rtsp_server_set_session_pool (GstRTSPServer * server,
* *
* Get the #GstRTSPSessionPool used as the session pool of @server. * Get the #GstRTSPSessionPool used as the session pool of @server.
* *
* Returns: (transfer full): the #GstRTSPSessionPool used for sessions. g_object_unref() after * Returns: (transfer full) (nullable): the #GstRTSPSessionPool used for sessions. g_object_unref() after
* usage. * usage.
*/ */
GstRTSPSessionPool * GstRTSPSessionPool *
@ -545,7 +545,7 @@ gst_rtsp_server_get_session_pool (GstRTSPServer * server)
/** /**
* gst_rtsp_server_set_mount_points: * gst_rtsp_server_set_mount_points:
* @server: a #GstRTSPServer * @server: a #GstRTSPServer
* @mounts: (transfer none): a #GstRTSPMountPoints * @mounts: (transfer none) (nullable): a #GstRTSPMountPoints
* *
* configure @mounts to be used as the mount points of @server. * configure @mounts to be used as the mount points of @server.
*/ */
@ -579,7 +579,7 @@ gst_rtsp_server_set_mount_points (GstRTSPServer * server,
* *
* Get the #GstRTSPMountPoints used as the mount points of @server. * Get the #GstRTSPMountPoints used as the mount points of @server.
* *
* Returns: (transfer full): the #GstRTSPMountPoints of @server. g_object_unref() after * Returns: (transfer full) (nullable): the #GstRTSPMountPoints of @server. g_object_unref() after
* usage. * usage.
*/ */
GstRTSPMountPoints * GstRTSPMountPoints *
@ -603,7 +603,7 @@ gst_rtsp_server_get_mount_points (GstRTSPServer * server)
/** /**
* gst_rtsp_server_set_auth: * gst_rtsp_server_set_auth:
* @server: a #GstRTSPServer * @server: a #GstRTSPServer
* @auth: (transfer none): a #GstRTSPAuth * @auth: (transfer none) (nullable): a #GstRTSPAuth
* *
* configure @auth to be used as the authentication manager of @server. * configure @auth to be used as the authentication manager of @server.
*/ */
@ -636,7 +636,7 @@ gst_rtsp_server_set_auth (GstRTSPServer * server, GstRTSPAuth * auth)
* *
* Get the #GstRTSPAuth used as the authentication manager of @server. * Get the #GstRTSPAuth used as the authentication manager of @server.
* *
* Returns: (transfer full): the #GstRTSPAuth of @server. g_object_unref() after * Returns: (transfer full) (nullable): the #GstRTSPAuth of @server. g_object_unref() after
* usage. * usage.
*/ */
GstRTSPAuth * GstRTSPAuth *
@ -660,7 +660,7 @@ gst_rtsp_server_get_auth (GstRTSPServer * server)
/** /**
* gst_rtsp_server_set_thread_pool: * gst_rtsp_server_set_thread_pool:
* @server: a #GstRTSPServer * @server: a #GstRTSPServer
* @pool: (transfer none): a #GstRTSPThreadPool * @pool: (transfer none) (nullable): a #GstRTSPThreadPool
* *
* configure @pool to be used as the thread pool of @server. * configure @pool to be used as the thread pool of @server.
*/ */
@ -693,7 +693,7 @@ gst_rtsp_server_set_thread_pool (GstRTSPServer * server,
* *
* Get the #GstRTSPThreadPool used as the thread pool of @server. * Get the #GstRTSPThreadPool used as the thread pool of @server.
* *
* Returns: (transfer full): the #GstRTSPThreadPool of @server. g_object_unref() after * Returns: (transfer full) (nullable): the #GstRTSPThreadPool of @server. g_object_unref() after
* usage. * usage.
*/ */
GstRTSPThreadPool * GstRTSPThreadPool *
@ -1088,7 +1088,7 @@ default_create_client (GstRTSPServer * server)
* @socket: (transfer full): a network socket * @socket: (transfer full): a network socket
* @ip: the IP address of the remote client * @ip: the IP address of the remote client
* @port: the port used by the other end * @port: the port used by the other end
* @initial_buffer: any initial data that was already read from the socket * @initial_buffer: (nullable): any initial data that was already read from the socket
* *
* Take an existing network socket and use it for an RTSP connection. This * Take an existing network socket and use it for an RTSP connection. This
* is used when transferring a socket from an HTTP server which should be used * is used when transferring a socket from an HTTP server which should be used

8
gst/rtsp-server/rtsp-session-media.c
View file

@ -210,8 +210,8 @@ gst_rtsp_session_media_matches (GstRTSPSessionMedia * media,
* *
* Get the #GstRTSPMedia that was used when constructing @media * Get the #GstRTSPMedia that was used when constructing @media
* *
* Returns: (transfer none): the #GstRTSPMedia of @media. Remains valid as long * Returns: (transfer none) (nullable): the #GstRTSPMedia of @media.
* as @media is valid. * Remains valid as long as @media is valid.
*/ */
GstRTSPMedia * GstRTSPMedia *
gst_rtsp_session_media_get_media (GstRTSPSessionMedia * media) gst_rtsp_session_media_get_media (GstRTSPSessionMedia * media)
@ -387,8 +387,8 @@ gst_rtsp_session_media_set_transport (GstRTSPSessionMedia * media,
* *
* Get a previously created #GstRTSPStreamTransport for the stream at @idx. * Get a previously created #GstRTSPStreamTransport for the stream at @idx.
* *
* Returns: (transfer none): a #GstRTSPStreamTransport that is valid until the * Returns: (transfer none) (nullable): a #GstRTSPStreamTransport that is
* session of @media is unreffed. * valid until the session of @media is unreffed.
*/ */
GstRTSPStreamTransport * GstRTSPStreamTransport *
gst_rtsp_session_media_get_transport (GstRTSPSessionMedia * media, guint idx) gst_rtsp_session_media_get_transport (GstRTSPSessionMedia * media, guint idx)

4
gst/rtsp-server/rtsp-session-pool.c
View file

@ -341,7 +341,7 @@ create_session (GstRTSPSessionPool * pool, const gchar * id)
* *
* Create a new #GstRTSPSession object in @pool. * Create a new #GstRTSPSession object in @pool.
* *
* Returns: (transfer full): a new #GstRTSPSession. * Returns: (transfer full) (nullable): a new #GstRTSPSession.
*/ */
GstRTSPSession * GstRTSPSession *
gst_rtsp_session_pool_create (GstRTSPSessionPool * pool) gst_rtsp_session_pool_create (GstRTSPSessionPool * pool)
@ -751,7 +751,7 @@ static GSourceFuncs gst_pool_source_funcs = {
* Create a #GSource that will be dispatched when the session should be cleaned * Create a #GSource that will be dispatched when the session should be cleaned
* up. * up.
* *
* Returns: (transfer full): a #GSource * Returns: (transfer full) (nullable): a #GSource
*/ */
GSource * GSource *
gst_rtsp_session_pool_create_watch (GstRTSPSessionPool * pool) gst_rtsp_session_pool_create_watch (GstRTSPSessionPool * pool)

9
gst/rtsp-server/rtsp-session.c
View file

@ -320,7 +320,7 @@ gst_rtsp_session_release_media (GstRTSPSession * sess,
* Get the session media for @path. @matched will contain the number of matched * Get the session media for @path. @matched will contain the number of matched
* characters of @path. * characters of @path.
* *
* Returns: (transfer none): the configuration for @path in @sess. * Returns: (transfer none) (nullable): the configuration for @path in @sess.
*/ */
GstRTSPSessionMedia * GstRTSPSessionMedia *
gst_rtsp_session_get_media (GstRTSPSession * sess, const gchar * path, gst_rtsp_session_get_media (GstRTSPSession * sess, const gchar * path,
@ -480,8 +480,8 @@ gst_rtsp_session_new (const gchar * sessionid)
* *
* Get the sessionid of @session. * Get the sessionid of @session.
* *
* Returns: (transfer none): the sessionid of @session. The value remains valid * Returns: (transfer none) (nullable): the sessionid of @session.
* as long as @session is alive. * The value remains valid as long as @session is alive.
*/ */
const gchar * const gchar *
gst_rtsp_session_get_sessionid (GstRTSPSession * session) gst_rtsp_session_get_sessionid (GstRTSPSession * session)
@ -497,7 +497,8 @@ gst_rtsp_session_get_sessionid (GstRTSPSession * session)
* *
* Get the string that can be placed in the Session header field. * Get the string that can be placed in the Session header field.
* *
* Returns: (transfer full): the Session header of @session. g_free() after usage. * Returns: (transfer full) (nullable): the Session header of @session.
* g_free() after usage.
*/ */
gchar * gchar *
gst_rtsp_session_get_header (GstRTSPSession * session) gst_rtsp_session_get_header (GstRTSPSession * session)

16
gst/rtsp-server/rtsp-stream-transport.c
View file

@ -164,7 +164,7 @@ gst_rtsp_stream_transport_new (GstRTSPStream * stream, GstRTSPTransport * tr)
* *
* Get the #GstRTSPStream used when constructing @trans. * Get the #GstRTSPStream used when constructing @trans.
* *
* Returns: (transfer none): the stream used when constructing @trans. * Returns: (transfer none) (nullable): the stream used when constructing @trans.
*/ */
GstRTSPStream * GstRTSPStream *
gst_rtsp_stream_transport_get_stream (GstRTSPStreamTransport * trans) gst_rtsp_stream_transport_get_stream (GstRTSPStreamTransport * trans)
@ -263,7 +263,7 @@ gst_rtsp_stream_transport_set_transport (GstRTSPStreamTransport * trans,
* *
* Get the transport configured in @trans. * Get the transport configured in @trans.
* *
* Returns: (transfer none): the transport configured in @trans. It remains * Returns: (transfer none) (nullable): the transport configured in @trans. It remains
* valid for as long as @trans is valid. * valid for as long as @trans is valid.
*/ */
const GstRTSPTransport * const GstRTSPTransport *
@ -277,7 +277,7 @@ gst_rtsp_stream_transport_get_transport (GstRTSPStreamTransport * trans)
/** /**
* gst_rtsp_stream_transport_set_url: * gst_rtsp_stream_transport_set_url:
* @trans: a #GstRTSPStreamTransport * @trans: a #GstRTSPStreamTransport
* @url: (transfer none): a client #GstRTSPUrl * @url: (transfer none) (nullable): a client #GstRTSPUrl
* *
* Set @url as the client url. * Set @url as the client url.
*/ */
@ -303,8 +303,8 @@ gst_rtsp_stream_transport_set_url (GstRTSPStreamTransport * trans,
* *
* Get the url configured in @trans. * Get the url configured in @trans.
* *
* Returns: (transfer none): the url configured in @trans. It remains * Returns: (transfer none) (nullable): the url configured in @trans.
* valid for as long as @trans is valid. * It remains valid for as long as @trans is valid.
*/ */
const GstRTSPUrl * const GstRTSPUrl *
gst_rtsp_stream_transport_get_url (GstRTSPStreamTransport * trans) gst_rtsp_stream_transport_get_url (GstRTSPStreamTransport * trans)
@ -453,6 +453,8 @@ gst_rtsp_stream_transport_send_rtp (GstRTSPStreamTransport * trans,
GstRTSPStreamTransportPrivate *priv; GstRTSPStreamTransportPrivate *priv;
gboolean res = FALSE; gboolean res = FALSE;
g_return_val_if_fail (GST_IS_BUFFER (buffer), FALSE);
priv = trans->priv; priv = trans->priv;
if (priv->send_rtp) if (priv->send_rtp)
@ -482,6 +484,8 @@ gst_rtsp_stream_transport_send_rtcp (GstRTSPStreamTransport * trans,
GstRTSPStreamTransportPrivate *priv; GstRTSPStreamTransportPrivate *priv;
gboolean res = FALSE; gboolean res = FALSE;
g_return_val_if_fail (GST_IS_BUFFER (buffer), FALSE);
priv = trans->priv; priv = trans->priv;
if (priv->send_rtcp) if (priv->send_rtcp)
@ -531,6 +535,8 @@ gst_rtsp_stream_transport_recv_data (GstRTSPStreamTransport * trans,
const GstRTSPTransport *tr; const GstRTSPTransport *tr;
GstFlowReturn res; GstFlowReturn res;
g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
priv = trans->priv; priv = trans->priv;
tr = priv->transport; tr = priv->transport;

46
gst/rtsp-server/rtsp-stream.c
View file

@ -446,7 +446,7 @@ gst_rtsp_stream_get_pt (GstRTSPStream * stream)
* *
* Get the srcpad associated with @stream. * Get the srcpad associated with @stream.
* *
* Returns: (transfer full): the srcpad. Unref after usage. * Returns: (transfer full) (nullable): the srcpad. Unref after usage.
*/ */
GstPad * GstPad *
gst_rtsp_stream_get_srcpad (GstRTSPStream * stream) gst_rtsp_stream_get_srcpad (GstRTSPStream * stream)
@ -465,7 +465,7 @@ gst_rtsp_stream_get_srcpad (GstRTSPStream * stream)
* *
* Get the sinkpad associated with @stream. * Get the sinkpad associated with @stream.
* *
* Returns: (transfer full): the sinkpad. Unref after usage. * Returns: (transfer full) (nullable): the sinkpad. Unref after usage.
*/ */
GstPad * GstPad *
gst_rtsp_stream_get_sinkpad (GstRTSPStream * stream) gst_rtsp_stream_get_sinkpad (GstRTSPStream * stream)
@ -484,7 +484,7 @@ gst_rtsp_stream_get_sinkpad (GstRTSPStream * stream)
* *
* Get the control string to identify this stream. * Get the control string to identify this stream.
* *
* Returns: (transfer full): the control string. g_free() after usage. * Returns: (transfer full) (nullable): the control string. g_free() after usage.
*/ */
gchar * gchar *
gst_rtsp_stream_get_control (GstRTSPStream * stream) gst_rtsp_stream_get_control (GstRTSPStream * stream)
@ -507,7 +507,7 @@ gst_rtsp_stream_get_control (GstRTSPStream * stream)
/** /**
* gst_rtsp_stream_set_control: * gst_rtsp_stream_set_control:
* @stream: a #GstRTSPStream * @stream: a #GstRTSPStream
* @control: a control string * @control: (nullable): a control string
* *
* Set the control string in @stream. * Set the control string in @stream.
*/ */
@ -529,7 +529,7 @@ gst_rtsp_stream_set_control (GstRTSPStream * stream, const gchar * control)
/** /**
* gst_rtsp_stream_has_control: * gst_rtsp_stream_has_control:
* @stream: a #GstRTSPStream * @stream: a #GstRTSPStream
* @control: a control string * @control: (nullable): a control string
* *
* Check if @stream has the control string @control. * Check if @stream has the control string @control.
* *
@ -682,6 +682,7 @@ gst_rtsp_stream_is_transport_supported (GstRTSPStream * stream,
GstRTSPStreamPrivate *priv; GstRTSPStreamPrivate *priv;
g_return_val_if_fail (GST_IS_RTSP_STREAM (stream), FALSE); g_return_val_if_fail (GST_IS_RTSP_STREAM (stream), FALSE);
g_return_val_if_fail (transport != NULL, FALSE);
priv = stream->priv; priv = stream->priv;
@ -817,7 +818,7 @@ gst_rtsp_stream_get_protocols (GstRTSPStream * stream)
/** /**
* gst_rtsp_stream_set_address_pool: * gst_rtsp_stream_set_address_pool:
* @stream: a #GstRTSPStream * @stream: a #GstRTSPStream
* @pool: (transfer none): a #GstRTSPAddressPool * @pool: (transfer none) (nullable): a #GstRTSPAddressPool
* *
* configure @pool to be used as the address pool of @stream. * configure @pool to be used as the address pool of @stream.
*/ */
@ -851,8 +852,8 @@ gst_rtsp_stream_set_address_pool (GstRTSPStream * stream,
* *
* Get the #GstRTSPAddressPool used as the address pool of @stream. * Get the #GstRTSPAddressPool used as the address pool of @stream.
* *
* Returns: (transfer full): the #GstRTSPAddressPool of @stream. g_object_unref() after * Returns: (transfer full) (nullable): the #GstRTSPAddressPool of @stream.
* usage. * g_object_unref() after usage.
*/ */
GstRTSPAddressPool * GstRTSPAddressPool *
gst_rtsp_stream_get_address_pool (GstRTSPStream * stream) gst_rtsp_stream_get_address_pool (GstRTSPStream * stream)
@ -875,7 +876,7 @@ gst_rtsp_stream_get_address_pool (GstRTSPStream * stream)
/** /**
* gst_rtsp_stream_set_multicast_iface: * gst_rtsp_stream_set_multicast_iface:
* @stream: a #GstRTSPStream * @stream: a #GstRTSPStream
* @multicast_iface: (transfer none): a multicast interface name * @multicast_iface: (transfer none) (nullable): a multicast interface name
* *
* configure @multicast_iface to be used for @stream. * configure @multicast_iface to be used for @stream.
*/ */
@ -910,8 +911,8 @@ gst_rtsp_stream_set_multicast_iface (GstRTSPStream * stream,
* *
* Get the multicast interface used for @stream. * Get the multicast interface used for @stream.
* *
* Returns: (transfer full): the multicast interface for @stream. g_free() after * Returns: (transfer full) (nullable): the multicast interface for @stream.
* usage. * g_free() after usage.
*/ */
gchar * gchar *
gst_rtsp_stream_get_multicast_iface (GstRTSPStream * stream) gst_rtsp_stream_get_multicast_iface (GstRTSPStream * stream)
@ -2280,7 +2281,7 @@ request_rtp_rtcp_decoder (GstElement * rtpbin, guint session,
* *
* Creating a rtxsend bin * Creating a rtxsend bin
* *
* Returns: (transfer full): a #GstElement. * Returns: (transfer full) (nullable): a #GstElement.
* *
* Since: 1.6 * Since: 1.6
*/ */
@ -2340,6 +2341,9 @@ gst_rtsp_stream_set_pt_map (GstRTSPStream * stream, guint pt, GstCaps * caps)
{ {
GstRTSPStreamPrivate *priv = stream->priv; GstRTSPStreamPrivate *priv = stream->priv;
if (!GST_IS_CAPS (caps))
return;
g_mutex_lock (&priv->lock); g_mutex_lock (&priv->lock);
g_hash_table_insert (priv->ptmap, GINT_TO_POINTER (pt), gst_caps_ref (caps)); g_hash_table_insert (priv->ptmap, GINT_TO_POINTER (pt), gst_caps_ref (caps));
g_mutex_unlock (&priv->lock); g_mutex_unlock (&priv->lock);
@ -3359,7 +3363,7 @@ wrong_bin:
* *
* Get the previous joined bin with gst_rtsp_stream_join_bin() or NULL. * Get the previous joined bin with gst_rtsp_stream_join_bin() or NULL.
* *
* Return: (transfer full): the joined bin or NULL. * Return: (transfer full) (nullable): the joined bin or NULL.
*/ */
GstBin * GstBin *
gst_rtsp_stream_get_joined_bin (GstRTSPStream * stream) gst_rtsp_stream_get_joined_bin (GstRTSPStream * stream)
@ -3381,10 +3385,10 @@ gst_rtsp_stream_get_joined_bin (GstRTSPStream * stream)
/** /**
* gst_rtsp_stream_get_rtpinfo: * gst_rtsp_stream_get_rtpinfo:
* @stream: a #GstRTSPStream * @stream: a #GstRTSPStream
* @rtptime: (allow-none): result RTP timestamp * @rtptime: (allow-none) (out caller-allocates): result RTP timestamp
* @seq: (allow-none): result RTP seqnum * @seq: (allow-none) (out caller-allocates): result RTP seqnum
* @clock_rate: (allow-none): the clock rate * @clock_rate: (allow-none) (out caller-allocates): the clock rate
* @running_time: result running-time * @running_time: (out caller-allocates): result running-time
* *
* Retrieve the current rtptime, seq and running-time. This is used to * Retrieve the current rtptime, seq and running-time. This is used to
* construct a RTPInfo reply header. * construct a RTPInfo reply header.
@ -3534,8 +3538,8 @@ no_stats:
* *
* Retrieve the current caps of @stream. * Retrieve the current caps of @stream.
* *
* Returns: (transfer full): the #GstCaps of @stream. use gst_caps_unref() * Returns: (transfer full) (nullable): the #GstCaps of @stream.
* after usage. * use gst_caps_unref() after usage.
*/ */
GstCaps * GstCaps *
gst_rtsp_stream_get_caps (GstRTSPStream * stream) gst_rtsp_stream_get_caps (GstRTSPStream * stream)
@ -4297,7 +4301,7 @@ gst_rtsp_stream_is_blocking (GstRTSPStream * stream)
/** /**
* gst_rtsp_stream_query_position: * gst_rtsp_stream_query_position:
* @stream: a #GstRTSPStream * @stream: a #GstRTSPStream
* @position: current position of a #GstRTSPStream * @position: (out): current position of a #GstRTSPStream
* *
* Query the position of the stream in %GST_FORMAT_TIME. This only considers * Query the position of the stream in %GST_FORMAT_TIME. This only considers
* the RTP parts of the pipeline and not the RTCP parts. * the RTP parts of the pipeline and not the RTCP parts.
@ -4377,7 +4381,7 @@ gst_rtsp_stream_query_position (GstRTSPStream * stream, gint64 * position)
/** /**
* gst_rtsp_stream_query_stop: * gst_rtsp_stream_query_stop:
* @stream: a #GstRTSPStream * @stream: a #GstRTSPStream
* @stop: current stop of a #GstRTSPStream * @stop: (out): current stop of a #GstRTSPStream
* *
* Query the stop of the stream in %GST_FORMAT_TIME. This only considers * Query the stop of the stream in %GST_FORMAT_TIME. This only considers
* the RTP parts of the pipeline and not the RTCP parts. * the RTP parts of the pipeline and not the RTCP parts.

3
gst/rtsp-server/rtsp-thread-pool.c
View file

@ -512,7 +512,8 @@ thread_error:
* *
* Get a new #GstRTSPThread for @type and @ctx. * Get a new #GstRTSPThread for @type and @ctx.
* *
* Returns: (transfer full): a new #GstRTSPThread, gst_rtsp_thread_stop() after usage * Returns: (transfer full) (nullable): a new #GstRTSPThread,
* gst_rtsp_thread_stop() after usage
*/ */
GstRTSPThread * GstRTSPThread *
gst_rtsp_thread_pool_get_thread (GstRTSPThreadPool * pool, gst_rtsp_thread_pool_get_thread (GstRTSPThreadPool * pool,