mpegts: add missing Since comments after SCTE 35 work

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/913>
This commit is contained in:
Mathieu Duponchelle 2021-09-25 00:09:00 +02:00 committed by GStreamer Marge Bot
parent 555a5ea9dd
commit f0a158407c
4 changed files with 54 additions and 7 deletions

View file

@ -619,7 +619,7 @@ gst_mpegts_scte_splice_event_new (void)
/**
* gst_mpegts_scte_splice_component_new:
* tag: the elementary PID stream identifier
* @tag: the elementary PID stream identifier
*
* Allocates and initializes a #GstMpegtsSCTESpliceComponent.
*

View file

@ -103,9 +103,20 @@ typedef enum {
} GstMpegtsSectionSCTETableID;
#define GST_TYPE_MPEGTS_SCTE_SPLICE_COMPONENT (gst_mpegts_scte_splice_component_get_type())
#define GST_MPEGTS_TYPE_SCTE_SPLICE_COMPONENT (gst_mpegts_scte_splice_component_get_type())
typedef struct _GstMpegtsSCTESpliceComponent GstMpegtsSCTESpliceComponent;
/**
* GstMpegtsSCTESpliceComponent:
* @tag: the elementary PID stream containing the Splice Point
* @splice_time_specified: Whether @splice_time was specified
* @splice_time: the presentation time of the signaled splice event
* @utc_splice_time: The UTC time of the signaled splice event
*
* Per-PID splice information.
*
* Since: 1.20
*/
struct _GstMpegtsSCTESpliceComponent {
guint8 tag;
@ -136,8 +147,22 @@ struct _GstMpegtsSCTESpliceEvent {
gboolean program_splice_time_specified; /* Only valid for insert_event && program_splice */
guint64 program_splice_time; /* Only valid for insert_event && program_splice */
/**
* GstMpegtsSCTESpliceEvent.utc_splice_time:
*
* The UTC time of the signaled splice event
*
* Since: 1.20
*/
guint32 utc_splice_time; /* Only valid for !insert_event (schedule) && program_splice */
/**
* GstMpegtsSCTESpliceEvent.components:
*
* Per-PID splice time information
*
* Since: 1.20
*/
GPtrArray *components; /* Only valid for !program_splice */
gboolean break_duration_auto_return;
@ -195,11 +220,24 @@ struct _GstMpegtsSCTESIT
GPtrArray *descriptors;
/* When encrypted, or when encountering an unknown command type,
* we may still want to pass the sit through */
/**
* GstMpegtsSCTESIT.fully_parsed:
*
* When encrypted, or when encountering an unknown command type,
* we may still want to pass the sit through.
*
* Since: 1.20
*/
gboolean fully_parsed;
/* When the SIT was constructed by the application, splice times
* are in running_time and must be translated before packetizing */
/**
* GstMpegtsSCTESIT.is_running_time:
*
* When the SIT was constructed by the application, splice times
* are in running_time and must be translated before packetizing.
*
* Since: 1.20
*/
gboolean is_running_time;
};

View file

@ -357,6 +357,15 @@ gst_message_new_mpegts_section (GstObject * parent, GstMpegtsSection * section)
return msg;
}
/**
* gst_event_new_mpegts_section:
* @section: (transfer none): The #GstMpegtsSection to put in a message
*
* Creates a new #GstEvent for a #GstMpegtsSection.
*
* Returns: (transfer full): The new custom #GstEvent.
* Since: 1.20
*/
GstEvent *
gst_event_new_mpegts_section (GstMpegtsSection * section)
{

View file

@ -398,7 +398,7 @@ gst_ts_demux_class_init (GstTSDemuxClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* mpegtsdemux:send-scte35-events:
* tsdemux:send-scte35-events:
*
* Whether SCTE 35 sections should be forwarded as events.
*