GstTracerRecord

GstTracerRecord

GObject
    ╰──GInitiallyUnowned
        ╰──GstObject
            ╰──GstTracerRecord

Since : 1.8

Class structure

gst_tracer_record_new

GstTracerRecord *
gst_tracer_record_new (const gchar * name,
                       const gchar * firstfield,
                       ... ...)

Create a new tracer record. The record instance can be used to efficiently log entries using gst_tracer_record_log. NULL terminator required after the last argument.

The name without the ".class" suffix will be used for the log records. There must be fields for each value that gets logged where the field name is the value name. The field must be a GstStructure describing the value. The sub structure must contain a field called 'type' of G_TYPE_GTYPE that contains the GType of the value. The resulting GstTracerRecord will take ownership of the field structures.

The way to deal with optional values is to log an additional boolean before the optional field, that if TRUE signals that the optional field is valid and FALSE signals that the optional field should be ignored. One must still log a placeholder value for the optional field though. Please also note, that pointer type values must not be NULL - the underlying serialisation can not handle that right now.

Please note that this is still under discussion and subject to change.

Since : 1.8

gst_tracer_record_log

gst_tracer_record_log (GstTracerRecord * self,
                       ... ...)

Serialzes the trace event into the log.

Right now this is using the gstreamer debug log with the level TRACE (7) and the category "GST_TRACER".

Please note that this is still under discussion and subject to change.

Since : 1.8

GST_TRACER_RECORD_CAST

#define GST_TRACER_RECORD_CAST(obj)       ((GstTracerRecord *)(obj))

GstTracerValueFlags

Flag that describe the value. These flags help applications processing the logs to understand the values.

GstTracerValueScope

Tracing record will contain fields that contain a measured value or extra meta-data. One such meta data are values that tell where a measurement was taken. This enumerating declares to which scope such a meta data field relates to. If it is e.g. GST_TRACER_VALUE_SCOPE_PAD, then each of the log events may contain values for different GstPad.

Since : 1.8