doc: Add GstNtpPacket to the doc

This commit is contained in:
Nicolas Dufresne 2015-06-13 14:21:41 -04:00
parent 4320337af6
commit c4eb876961
3 changed files with 20 additions and 2 deletions

View file

@ -77,6 +77,7 @@
<xi:include href="xml/gstnettimepacket.xml" />
<xi:include href="xml/gstnettimeprovider.xml" />
<xi:include href="xml/gstptpclock.xml" />
<xi:include href="xml/gstntppacket.xml" />
</chapter>
<chapter id="gstreamer-check">

View file

@ -953,6 +953,22 @@ GST_IS_NET_TIME_PROVIDER_CLASS
gst_net_time_provider_get_type
</SECTION>
<SECTION>
<FILE>gstntppacket</FILE>
<TITLE>GstNtpPacket</TITLE>
GstNtpPacket
gst_ntp_packet_new
gst_ntp_packet_copy
gst_ntp_packet_free
gst_ntp_packet_serialize
gst_ntp_packet_receive
gst_ntp_packet_send
GST_NTP_ERROR
GST_NTP_PACKET_SIZE
<SUBSECTION Private>
gst_ntp_packet_get_type
</SECTION>
<SECTION>
<FILE>gstptpclock</FILE>
<TITLE>GstPtpClock</TITLE>
@ -962,7 +978,7 @@ gst_ptp_deinit
gst_ptp_is_initialized
gst_ptp_is_supported
GstPtpClock
/GstPtpClock
gst_ptp_clock_new
gst_ptp_statistics_callback_add

View file

@ -23,7 +23,7 @@
* SECTION:gstntppacket
* @short_description: Helper structure to construct clock packets used
* by network clocks for NTPv4.
* @see_also: #GstClock, #GstNetClientClock, #GstNtpProvider
* @see_also: #GstClock, #GstNetClientClock, #GstNtpClock
*
* Various functions for receiving, sending an serializing #GstNtpPacket
* structures.
@ -79,6 +79,7 @@ gst_clock_time_to_ntp_timestamp_fraction (GstClockTime gst)
/**
* gst_ntp_packet_new:
* @buffer: (array): a buffer from which to construct the packet, or NULL
* @error: a #GError
*
* Creates a new #GstNtpPacket from a buffer received over the network. The
* caller is responsible for ensuring that @buffer is at least