Class: Gst::TracerRecord

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Instance Method Summary collapse

Methods inherited from Object

#add_control_binding, check_uniqueness, #control_bindings_disabled=, #control_rate, #control_rate=, default_deep_notify, #default_error, #get_control_binding, #get_g_value_array, #get_value, #get_value_array, #has_active_control_bindings, #has_ancestor, #has_as_ancestor, #has_as_parent, #name, #name=, #parent, #parent=, #path_string, #ref, ref_sink, #remove_control_binding, replace, #set_control_binding_disabled, #suggest_next_sync, #sync_values, #unparent, #unref

Constructor Details

#initialize(name, firstfield, array) ⇒ Gst::TracerRecord

Create a new tracer record. The record instance can be used to efficiently log entries using gst_tracer_record_log(). nil 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 Gst::Structure 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 Gst::TracerRecord 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.

Parameters:

  • name (String)

    name of new record, must end on ".class".

  • firstfield (String)

    name of first field to set

  • array (Array)

    additional arguments

Instance Method Details

#log(array) ⇒ nil

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.

Parameters:

  • array (Array)

    the args as described in the spec-

Returns:

  • (nil)