summaryrefslogtreecommitdiff
path: root/docs/libs
diff options
context:
space:
mode:
authorEdward Hervey <edward@collabora.com>2013-07-04 08:43:37 +0200
committerEdward Hervey <edward@collabora.com>2013-07-04 08:45:33 +0200
commitf24c0b62e3c6a054a3b291d684cfd9139a5646f4 (patch)
treedc0c33243b4d46bd0d502475bbfe32c003fadf6e /docs/libs
parent7814ed196b35ccb700cb98980932cea706a9d1a0 (diff)
downloadgstreamer-plugins-bad-f24c0b62e3c6a054a3b291d684cfd9139a5646f4.tar.gz
mpegts: Improve documentation
* Add a base page for the library * Add pages for the base MPEG-TS section and descriptors * Add pages for the known variants * Add documentation on more fields/sections/types * Remove some fixmes that were ... fixed
Diffstat (limited to 'docs/libs')
-rw-r--r--docs/libs/gst-plugins-bad-libs-docs.sgml6
-rw-r--r--docs/libs/gst-plugins-bad-libs-sections.txt156
2 files changed, 105 insertions, 57 deletions
diff --git a/docs/libs/gst-plugins-bad-libs-docs.sgml b/docs/libs/gst-plugins-bad-libs-docs.sgml
index 3a8d99414..66c4dee6a 100644
--- a/docs/libs/gst-plugins-bad-libs-docs.sgml
+++ b/docs/libs/gst-plugins-bad-libs-docs.sgml
@@ -42,8 +42,14 @@
<filename>gstreamer-plugins-bad-&GST_API_VERSION;.pc</filename> and adding
<filename>-lgstmpegts-&GST_API_VERSION;</filename> to the library flags.
</para>
+ <xi:include href="xml/gstmpegts.xml" />
<xi:include href="xml/gstmpegtssection.xml" />
<xi:include href="xml/gstmpegtsdescriptor.xml" />
+ <xi:include href="xml/gst-atsc-section.xml" />
+ <xi:include href="xml/gst-dvb-section.xml" />
+ <xi:include href="xml/gst-atsc-descriptor.xml" />
+ <xi:include href="xml/gst-dvb-descriptor.xml" />
+ <xi:include href="xml/gst-isdb-descriptor.xml" />
</chapter>
<chapter id="tools">
diff --git a/docs/libs/gst-plugins-bad-libs-sections.txt b/docs/libs/gst-plugins-bad-libs-sections.txt
index 91ab28d3d..5c5d8d41d 100644
--- a/docs/libs/gst-plugins-bad-libs-sections.txt
+++ b/docs/libs/gst-plugins-bad-libs-sections.txt
@@ -167,40 +167,19 @@ gst_mpeg4_parse_video_packet_header
</SECTION>
<SECTION>
+<FILE>gstmpegts</FILE>
+<SUBSECTION Common>
+gst_mpegts_initialize
+</SECTION>
+
+<SECTION>
<FILE>gstmpegtsdescriptor</FILE>
<SUBSECTION Common>
GstMpegTsDescriptor
GstMpegTsDescriptorType
-GstMpegTsATSCDescriptorType
-GstMpegTsDVBDescriptorType
-GstMpegTsISDBDescriptorType
GstMpegTsMiscDescriptorType
gst_mpegts_find_descriptor
gst_mpegts_parse_descriptors
-<SUBSECTION component>
-GstMpegTsComponentDescriptor
-gst_mpegts_descriptor_parse_dvb_component
-<SUBSECTION extended_event>
-GstMpegTsExtendedEventItem
-GstMpegTsExtendedEventDescriptor
-gst_mpegts_descriptor_parse_dvb_extended_event
-<SUBSECTION satellite_delivery>
-GstMpegTsSatelliteDeliverySystemDescriptor
-GstMpegTsDVBCodeRate
-GstMpegTsModulationType
-GstMpegTsSatellitePolarizationType
-GstMpegTsSatelliteRolloff
-gst_mpegts_descriptor_parse_satellite_delivery_system
-<SUBSECTION cable_delivery>
-GstMpegTsCableDeliverySystemDescriptor
-GstMpegTsCableOuterFECScheme
-gst_mpegts_descriptor_parse_cable_delivery_system
-<SUBSECTION short_event>
-gst_mpegts_descriptor_parse_dvb_short_event
-gst_mpegts_descriptor_parse_dvb_network_name
-<SUBSECTION service>
-GstMpegTsDVBServiceType
-gst_mpegts_descriptor_parse_dvb_service
<SUBSECTION iso639>
GstMpegTsISO639LanguageDescriptor
GstMpegTsIso639AudioType
@@ -220,7 +199,6 @@ GST_TYPE_MPEGTS_DESCRIPTOR
GST_TYPE_MPEG_TS_DVB_SERVICE_TYPE
GST_TYPE_MPEG_TS_DESCRIPTOR_TYPE
GST_TYPE_MPEG_TS_ISO639_AUDIO_TYPE
-GST_TYPE_MPEG_TS_RUNNING_STATUS
GST_TYPE_MPEG_TS_ATSC_DESCRIPTOR_TYPE
GST_TYPE_MPEG_TS_DVB_DESCRIPTOR_TYPE
GST_TYPE_MPEG_TS_ISDB_DESCRIPTOR_TYPE
@@ -237,18 +215,63 @@ gst_mpeg_ts_dvb_descriptor_type_get_type
gst_mpeg_ts_isdb_descriptor_type_get_type
gst_mpeg_ts_misc_descriptor_type_get_type
gst_mpeg_ts_iso639_audio_type_get_type
-gst_mpeg_ts_running_status_get_type
gst_mpeg_ts_dvb_service_type_get_type
</SECTION>
<SECTION>
+<FILE>gst-atsc-descriptor</FILE>
+GstMpegTsATSCDescriptorType
+<SUBSECTION Standard>
+GST_TYPE_MPEG_TS_ATSC_DESCRIPTOR_TYPE
+gst_mpeg_ts_atsc_descriptor_type_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gst-dvb-descriptor</FILE>
+GstMpegTsDVBDescriptorType
+<SUBSECTION component>
+GstMpegTsComponentDescriptor
+gst_mpegts_descriptor_parse_dvb_component
+<SUBSECTION extended_event>
+GstMpegTsExtendedEventItem
+GstMpegTsExtendedEventDescriptor
+gst_mpegts_descriptor_parse_dvb_extended_event
+<SUBSECTION satellite_delivery>
+GstMpegTsSatelliteDeliverySystemDescriptor
+GstMpegTsDVBCodeRate
+GstMpegTsModulationType
+GstMpegTsSatellitePolarizationType
+GstMpegTsSatelliteRolloff
+gst_mpegts_descriptor_parse_satellite_delivery_system
+<SUBSECTION cable_delivery>
+GstMpegTsCableDeliverySystemDescriptor
+GstMpegTsCableOuterFECScheme
+gst_mpegts_descriptor_parse_cable_delivery_system
+<SUBSECTION short_event>
+gst_mpegts_descriptor_parse_dvb_short_event
+gst_mpegts_descriptor_parse_dvb_network_name
+<SUBSECTION service>
+GstMpegTsDVBServiceType
+gst_mpegts_descriptor_parse_dvb_service
+<SUBSECTION Standard>
+GST_TYPE_MPEG_TSDVB_CODE_RATE
+gst_mpeg_tsdvb_code_rate_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gst-isdb-descriptor</FILE>
+GstMpegTsISDBDescriptorType
+<SUBSECTION Standard>
+GST_TYPE_MPEG_TS_ISDB_DESCRIPTOR_TYPE
+gst_mpeg_ts_isdb_descriptor_type_get_type
+</SECTION>
+
+<SECTION>
<FILE>gstmpegtssection</FILE>
<SUBSECTION section>
GST_MPEGTS_SECTION_TYPE
GstMpegTsSection
GstMpegTsSectionTableID
-GstMpegTsSectionATSCTableID
-GstMpegTsSectionDVBTableID
GstMpegTsSectionType
gst_message_new_mpegts_section
gst_message_parse_mpegts_section
@@ -263,64 +286,83 @@ GstMpegTsPMT
GstMpegTsPMTStream
GstMpegTsStreamType
gst_mpegts_section_get_pmt
-<SUBSECTION BAT>
-GstMpegTsBAT
-GstMpegTsBATStream
+<SUBSECTION TSDT>
+gst_mpegts_section_get_tsdt
<SUBSECTION CAT>
gst_mpegts_section_get_cat
-<SUBSECTION EIT>
-GstMpegTsEIT
-GstMpegTsEITEvent
-GstMpegTsRunningStatus
-gst_mpegts_section_get_eit
+<SUBSECTION Standard>
+GST_TYPE_MPEG_TS_SECTION_TABLE_ID
+GST_TYPE_MPEG_TS_SECTION_TYPE
+GST_TYPE_MPEG_TS_SECTION_DVB_TABLE_ID
+GST_MPEGTS_SECTION
+GST_TYPE_MPEG_TS_STREAM_TYPE
+GST_TYPE_MPEGTS_PMT
+GST_TYPE_MPEGTS_PMT_STREAM
+GST_TYPE_MPEGTS_SECTION
+gst_mpeg_ts_section_table_id_get_type
+gst_mpeg_ts_section_type_get_type
+gst_mpegts_pmt_get_type
+gst_mpegts_pmt_stream_get_type
+gst_mpegts_section_get_type
+gst_mpeg_ts_stream_type_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gst-atsc-section</FILE>
+GstMpegTsSectionATSCTableID
+<SUBSECTION Standard>
+GST_TYPE_MPEG_TS_SECTION_ATSC_TABLE_ID
+gst_mpeg_ts_section_atsc_table_id_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gst-dvb-section</FILE>
+GstMpegTsSectionDVBTableID
<SUBSECTION NIT>
GstMpegTsNIT
GstMpegTsNITStream
gst_mpegts_section_get_nit
+<SUBSECTION BAT>
+GstMpegTsBAT
+GstMpegTsBATStream
<SUBSECTION SDT>
GstMpegTsSDT
GstMpegTsSDTService
gst_mpegts_section_get_sdt
-GstMpegTsTOT
+<SUBSECTION EIT>
+GstMpegTsEIT
+GstMpegTsEITEvent
+GstMpegTsRunningStatus
+gst_mpegts_section_get_eit
+<SUBSECTION TDT>
gst_mpegts_section_get_tdt
+<SUBSECTION TOT>
+GstMpegTsTOT
gst_mpegts_section_get_tot
-gst_mpegts_section_get_tsdt
<SUBSECTION Standard>
-GST_TYPE_MPEG_TS_SECTION_TABLE_ID
-GST_TYPE_MPEG_TS_SECTION_TYPE
-GST_TYPE_MPEG_TS_SECTION_ATSC_TABLE_ID
-GST_TYPE_MPEG_TS_SECTION_DVB_TABLE_ID
-GST_MPEGTS_SECTION
-GST_TYPE_MPEG_TS_STREAM_TYPE
GST_TYPE_MPEGTS_BAT
GST_TYPE_MPEGTS_EIT
GST_TYPE_MPEGTS_EIT_EVENT
GST_TYPE_MPEGTS_NIT
GST_TYPE_MPEGTS_NIT_STREAM
-GST_TYPE_MPEGTS_PMT
-GST_TYPE_MPEGTS_PMT_STREAM
GST_TYPE_MPEGTS_SDT
GST_TYPE_MPEGTS_SDT_SERVICE
-GST_TYPE_MPEGTS_SECTION
GST_TYPE_MPEGTS_TOT
-gst_mpeg_ts_section_table_id_get_type
-gst_mpeg_ts_section_atsc_table_id_get_type
+GST_TYPE_MPEG_TS_SECTION_DVB_TABLE_ID
+GST_TYPE_MPEG_TS_RUNNING_STATUS
+gst_mpeg_ts_running_status_get_type
gst_mpeg_ts_section_dvb_table_id_get_type
-gst_mpeg_ts_section_type_get_type
gst_mpegts_bat_get_type
gst_mpegts_eit_event_get_type
gst_mpegts_eit_get_type
gst_mpegts_nit_get_type
gst_mpegts_nit_stream_get_type
-gst_mpegts_pmt_get_type
-gst_mpegts_pmt_stream_get_type
gst_mpegts_sdt_get_type
gst_mpegts_sdt_service_get_type
-gst_mpegts_section_get_type
gst_mpegts_tot_get_type
-gst_mpeg_ts_stream_type_get_type
</SECTION>
+
<SECTION>
<FILE>gstphotography</FILE>
GST_PHOTOGRAPHY_AUTOFOCUS_DONE