diff options
| author | Tim-Philipp Müller <tim@centricular.net> | 2006-03-12 14:56:31 +0000 |
|---|---|---|
| committer | Tim-Philipp Müller <tim@centricular.net> | 2006-03-12 14:56:31 +0000 |
| commit | c4ae62d634630c17a7e1f64223568242c7143649 (patch) | |
| tree | 5d18f59eaa5eb455c9bcf633a596facff0b07012 /gst-libs/gst/cdda | |
| parent | 7762b252a32b677673b8026c39ec2e7edd4066f7 (diff) | |
docs/plugins/: Add cdparanoiasrc to docs.
Original commit message from CVS:
* docs/plugins/gst-plugins-base-plugins-docs.sgml:
* docs/plugins/gst-plugins-base-plugins-sections.txt:
* docs/plugins/gst-plugins-base-plugins.hierarchy:
Add cdparanoiasrc to docs.
* gst-libs/gst/cdda/gstcddabasesrc.c:
More GstCddaBaseSrc docs.
Diffstat (limited to 'gst-libs/gst/cdda')
| -rw-r--r-- | gst-libs/gst/cdda/gstcddabasesrc.c | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/gst-libs/gst/cdda/gstcddabasesrc.c b/gst-libs/gst/cdda/gstcddabasesrc.c index 192fe32e9..1f02539ad 100644 --- a/gst-libs/gst/cdda/gstcddabasesrc.c +++ b/gst-libs/gst/cdda/gstcddabasesrc.c @@ -44,6 +44,32 @@ * Provides a base class for CDDA sources, which handles things like seeking, * querying, discid calculation, tags, and buffer timestamping. * </para> + * <title>Using GstCddaBaseSrc-based elements in applications</title> + * <para> + * GstCddaBaseSrc registers two #GstFormat<!-- -->s of its own, namely + * the "track" format and the "sector" format. Applications will usually + * only find the "track" format interesting. You can retrieve that #GstFormat + * for use in seek events or queries with gst_format_get_by_nick("track"). + * </para> + * <para> + * In order to query the number of tracks, for example, an application would + * set the CDDA source element to READY or PAUSED state and then query the + * the number of tracks via gst_element_query_duration() using the track + * format acquired above. Applications can query the currently playing track + * in the same way. + * </para> + * <para> + * Alternatively, applications may retrieve the currently playing track and + * the total number of tracks from the taglist that will posted on the bus + * whenever the CD is opened or the currently playing track changes. The + * taglist will contain GST_TAG_TRACK_NUMBER and GST_TAG_TRACK_COUNT tags. + * </para> + * <para> + * Applications playing back CD audio using playbin and cdda://n URIs should + * issue a seek command in track format to change between tracks, rather than + * setting a new cdda://n+1 URI on playbin (as setting a new URI on playbin + * involves closing and re-opening the CD device, which is much much slower). + * </para> * </refsect2> */ |