mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-04-26 06:54:49 +00:00
Code Issues 1 Projects Releases Wiki Activity

rtsp-server: Some more doc fixups

Browse source
This commit is contained in:
Edward Hervey 2010-12-11 10:48:25 +01:00
parent d9a36aa1b7
commit b95165fcff
7 changed files with 14 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
gst/rtsp-server/rtsp-media-mapping.h
View file

@ -56,7 +56,7 @@ struct _GstRTSPMediaMapping {
* GstRTSPMediaMappingClass: * GstRTSPMediaMappingClass:
* @find_media: Create or return a previously cached #GstRTSPMediaFactory object * @find_media: Create or return a previously cached #GstRTSPMediaFactory object
* for the given url. the default implementation will use the mappings * for the given url. the default implementation will use the mappings
* added with gst_rtsp_media_mapping_add_factory (). * added with gst_rtsp_media_mapping_add_factory().
* *
* The class for the media mapping object. * The class for the media mapping object.
*/ */

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

@ -547,7 +547,7 @@ gst_rtsp_media_get_stream (GstRTSPMedia * media, guint idx)
/** /**
* gst_rtsp_media_seek: * gst_rtsp_media_seek:
* @stream: a #GstRTSPMediaStream * @media: a #GstRTSPMedia
* @range: a #GstRTSPTimeRange * @range: a #GstRTSPTimeRange
* *
* Seek the pipeline to @range. * Seek the pipeline to @range.
@ -1475,7 +1475,7 @@ no_more_pads_cb (GstElement * element, GstRTSPMedia * media)
/** /**
* gst_rtsp_media_prepare: * gst_rtsp_media_prepare:
* @obj: a #GstRTSPMedia * @media: a #GstRTSPMedia
* *
* Prepare @media for streaming. This function will create the pipeline and * Prepare @media for streaming. This function will create the pipeline and
* other objects to manage the streaming. * other objects to manage the streaming.
@ -1604,7 +1604,7 @@ state_failed:
/** /**
* gst_rtsp_media_unprepare: * gst_rtsp_media_unprepare:
* @obj: a #GstRTSPMedia * @media: a #GstRTSPMedia
* *
* Unprepare @media. After this call, the media should be prepared again before * Unprepare @media. After this call, the media should be prepared again before
* it can be used again. If the media is set to be non-reusable, a new instance * it can be used again. If the media is set to be non-reusable, a new instance
@ -1740,7 +1740,7 @@ remove_udp_destination (GstRTSPMedia *media, GstRTSPMediaStream *stream,
* gst_rtsp_media_set_state: * gst_rtsp_media_set_state:
* @media: a #GstRTSPMedia * @media: a #GstRTSPMedia
* @state: the target state of the media * @state: the target state of the media
* @transports: a GArray of #GstRTSPMediaTrans pointers * @transports: a #GArray of #GstRTSPMediaTrans pointers
* *
* Set the state of @media to @state and for the transports in @transports. * Set the state of @media to @state and for the transports in @transports.
* *

5
gst/rtsp-server/rtsp-media.h
View file

@ -82,7 +82,6 @@ struct _GstRTSPMediaTrans {
/** /**
* GstRTSPMediaStream: * GstRTSPMediaStream:
*
* @srcpad: the srcpad of the stream * @srcpad: the srcpad of the stream
* @payloader: the payloader of the format * @payloader: the payloader of the format
* @prepared: if the stream is prepared for streaming * @prepared: if the stream is prepared for streaming
@ -185,7 +184,7 @@ typedef enum {
* @range: the range of the media being streamed * @range: the range of the media being streamed
* *
* A class that contains the GStreamer element along with a list of * A class that contains the GStreamer element along with a list of
* #GstRTSPediaStream objects that can produce data. * #GstRTSPMediaStream objects that can produce data.
* *
* This object is usually created from a #GstRTSPMediaFactory. * This object is usually created from a #GstRTSPMediaFactory.
*/ */
@ -284,7 +283,7 @@ gboolean gst_rtsp_media_seek (GstRTSPMedia *media, GstR
GstFlowReturn gst_rtsp_media_stream_rtp (GstRTSPMediaStream *stream, GstBuffer *buffer); GstFlowReturn gst_rtsp_media_stream_rtp (GstRTSPMediaStream *stream, GstBuffer *buffer);
GstFlowReturn gst_rtsp_media_stream_rtcp (GstRTSPMediaStream *stream, GstBuffer *buffer); GstFlowReturn gst_rtsp_media_stream_rtcp (GstRTSPMediaStream *stream, GstBuffer *buffer);
gboolean gst_rtsp_media_set_state (GstRTSPMedia *media, GstState state, GArray *trans); gboolean gst_rtsp_media_set_state (GstRTSPMedia *media, GstState state, GArray *transports);
void gst_rtsp_media_remove_elements (GstRTSPMedia *media); void gst_rtsp_media_remove_elements (GstRTSPMedia *media);

2
gst/rtsp-server/rtsp-sdp.c
View file

@ -22,7 +22,7 @@
/** /**
* gst_rtsp_sdp_from_media: * gst_rtsp_sdp_from_media:
* @sdp: a #GstSDPessage * @sdp: a #GstSDPMessage
* @info: info * @info: info
* @media: a #GstRTSPMedia * @media: a #GstRTSPMedia
* *

2
gst/rtsp-server/rtsp-session-pool.h
View file

@ -77,7 +77,7 @@ struct _GstRTSPSessionPoolClass {
* The function will be called when the pool must be cleaned up because one or * The function will be called when the pool must be cleaned up because one or
* more sessions timed out. * more sessions timed out.
* *
* Returns: %FALSe if the source should be removed. * Returns: %FALSE if the source should be removed.
*/ */
typedef gboolean (*GstRTSPSessionPoolFunc) (GstRTSPSessionPool *pool, gpointer user_data); typedef gboolean (*GstRTSPSessionPoolFunc) (GstRTSPSessionPool *pool, gpointer user_data);

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

@ -178,10 +178,10 @@ gst_rtsp_session_set_property (GObject * object, guint propid,
/** /**
* gst_rtsp_session_manage_media: * gst_rtsp_session_manage_media:
* @sess: a #GstRTSPSession * @sess: a #GstRTSPSession
* @url: the url for the media * @uri: the uri for the media
* @media: a #GstRTSPMediaObject * @media: a #GstRTSPMedia
* *
* Manage the media object @obj in @sess. @url will be used to retrieve this * Manage the media object @obj in @sess. @uri will be used to retrieve this
* media from the session with gst_rtsp_session_get_media(). * media from the session with gst_rtsp_session_get_media().
* *
* Ownership is taken from @media. * Ownership is taken from @media.
@ -222,7 +222,7 @@ gst_rtsp_session_manage_media (GstRTSPSession * sess, const GstRTSPUrl * uri,
/** /**
* gst_rtsp_session_release_media: * gst_rtsp_session_release_media:
* @sess: a #GstRTSPSession * @sess: a #GstRTSPSession
* @media: a #GstRTSPMediaObject * @media: a #GstRTSPMedia
* *
* Release the managed @media in @sess, freeing the memory allocated by it. * Release the managed @media in @sess, freeing the memory allocated by it.
* *

2
gst/rtsp-server/rtsp-session.h
View file

@ -137,7 +137,7 @@ gboolean gst_rtsp_session_release_media (GstRTSPSession *se
GstRTSPSessionMedia *media); GstRTSPSessionMedia *media);
/* get media in a session */ /* get media in a session */
GstRTSPSessionMedia * gst_rtsp_session_get_media (GstRTSPSession *sess, GstRTSPSessionMedia * gst_rtsp_session_get_media (GstRTSPSession *sess,
const GstRTSPUrl *uri); const GstRTSPUrl *url);
/* control media */ /* control media */
gboolean gst_rtsp_session_media_set_state (GstRTSPSessionMedia *media, GstState state); gboolean gst_rtsp_session_media_set_state (GstRTSPSessionMedia *media, GstState state);