gsttracerutils

## Functions

### gst_trace_event

    gst_trace_event (GstTraceFormat * format,
                     const GstTraceValue* values)

Emits a point event for format: a single timestamped record with no duration, the counterpart to the begin/end pair of gst_trace_span_begin and the structured replacement for gst_tracer_record_log.

The event is delivered to tracers through the "event" hook; the `log` tracer renders it to the GST_TRACER debug log. Values are positional and must match format; keep their computation cheap as they are built whenever tracing is enabled.

Parameters:

`format` –

a GstTraceFormat describing the fields of the event

`values` ( [array][nullable]) –

the positional values for format's fields, in declaration order; NULL logs all fields as unset

Since : 1.30

### Gst.prototype.trace_event

    function Gst.prototype.trace_event(format: Gst.TraceFormat, values: [ Gst.TraceValue]): {
        // javascript wrapper for 'gst_trace_event'
    }

Emits a point event for format: a single timestamped record with no duration, the counterpart to the begin/end pair of Gst.prototype.trace_span_begin and the structured replacement for gst_tracer_record_log (not introspectable).

The event is delivered to tracers through the "event" hook; the `log` tracer renders it to the GST_TRACER debug log. Values are positional and must match format; keep their computation cheap as they are built whenever tracing is enabled.

Parameters:

`format` (Gst.TraceFormat) –

a Gst.TraceFormat describing the fields of the event

`values` ([ Gst.TraceValue]) –

the positional values for format's fields, in declaration order; null logs all fields as unset

Since : 1.30

### Gst.trace_event

    def Gst.trace_event (format, values):
        #python wrapper for 'gst_trace_event'

Emits a point event for format: a single timestamped record with no duration, the counterpart to the begin/end pair of Gst.trace_span_begin and the structured replacement for gst_tracer_record_log (not introspectable).

The event is delivered to tracers through the "event" hook; the `log` tracer renders it to the GST_TRACER debug log. Values are positional and must match format; keep their computation cheap as they are built whenever tracing is enabled.

Parameters:

`format` (Gst.TraceFormat) –

a Gst.TraceFormat describing the fields of the event

`values` ([ Gst.TraceValue]) –

the positional values for format's fields, in declaration order; None logs all fields as unset

Since : 1.30

### gst_trace_span_begin

    GstTraceSpanId
    gst_trace_span_begin (GstTraceFormat * format,
                          const GstTraceValue* values)

Emits a span begin hook for format.

Values are borrowed for the duration of the hook call. The number of values must match the fields of the structure used to register format.

Parameters:

`format` –

a GstTraceFormat

`values` ( [array][nullable]) –

positional values matching format

Returns –

a span id to pass to gst_trace_span_end, or GST_TRACE_SPAN_ID_NONE if no tracer is listening for spans

Since : 1.30

### Gst.prototype.trace_span_begin

    function Gst.prototype.trace_span_begin(format: Gst.TraceFormat, values: [ Gst.TraceValue]): {
        // javascript wrapper for 'gst_trace_span_begin'
    }

Emits a span begin hook for format.

Values are borrowed for the duration of the hook call. The number of values must match the fields of the structure used to register format.

Parameters:

`format` (Gst.TraceFormat) –

a Gst.TraceFormat

`values` ([ Gst.TraceValue]) –

positional values matching format

Returns (Number) –

a span id to pass to Gst.prototype.trace_span_end, or Gst.TRACE_SPAN_ID_NONE if no tracer is listening for spans

Since : 1.30

### Gst.trace_span_begin

    def Gst.trace_span_begin (format, values):
        #python wrapper for 'gst_trace_span_begin'

Emits a span begin hook for format.

Values are borrowed for the duration of the hook call. The number of values must match the fields of the structure used to register format.

Parameters:

`format` (Gst.TraceFormat) –

a Gst.TraceFormat

`values` ([ Gst.TraceValue]) –

positional values matching format

Returns (int) –

a span id to pass to Gst.trace_span_end, or Gst.TRACE_SPAN_ID_NONE if no tracer is listening for spans

Since : 1.30

### gst_trace_span_end

    gst_trace_span_end (GstTraceSpanId span_id)

Emits a span end hook. Passing GST_TRACE_SPAN_ID_NONE is allowed and is a no-op.

Parameters:

`span_id` –

a span id returned by gst_trace_span_begin

Since : 1.30

### Gst.prototype.trace_span_end

    function Gst.prototype.trace_span_end(span_id: Number): {
        // javascript wrapper for 'gst_trace_span_end'
    }

Emits a span end hook. Passing Gst.TRACE_SPAN_ID_NONE is allowed and is a no-op.

Parameters:

`span_id` (Number) –

a span id returned by Gst.prototype.trace_span_begin

Since : 1.30

### Gst.trace_span_end

    def Gst.trace_span_end (span_id):
        #python wrapper for 'gst_trace_span_end'

Emits a span end hook. Passing Gst.TRACE_SPAN_ID_NONE is allowed and is a no-op.

Parameters:

`span_id` (int) –

a span id returned by Gst.trace_span_begin

Since : 1.30

### gst_trace_span_end_and_clear

    gst_trace_span_end_and_clear (GstTraceSpanId * span_id)

Ends the span pointed to by span_id and resets it to GST_TRACE_SPAN_ID_NONE. Safe to call when span_id already holds GST_TRACE_SPAN_ID_NONE. Intended for spans stored on long-lived state (struct fields) where the slot must be cleared after closing the span.

Parameters:

`span_id` ( [inout]) –

a pointer to a GstTraceSpanId; may not be NULL

Since : 1.30

### Gst.prototype.trace_span_end_and_clear

    function Gst.prototype.trace_span_end_and_clear(span_id: Number): {
        // javascript wrapper for 'gst_trace_span_end_and_clear'
    }

Ends the span pointed to by span_id and resets it to Gst.TRACE_SPAN_ID_NONE. Safe to call when span_id already holds Gst.TRACE_SPAN_ID_NONE. Intended for spans stored on long-lived state (struct fields) where the slot must be cleared after closing the span.

Parameters:

`span_id` (Number) –

a pointer to a Number; may not be null

Since : 1.30

### Gst.trace_span_end_and_clear

    def Gst.trace_span_end_and_clear (span_id):
        #python wrapper for 'gst_trace_span_end_and_clear'

Ends the span pointed to by span_id and resets it to Gst.TRACE_SPAN_ID_NONE. Safe to call when span_id already holds Gst.TRACE_SPAN_ID_NONE. Intended for spans stored on long-lived state (struct fields) where the slot must be cleared after closing the span.

Parameters:

`span_id` (int) –

a pointer to a int; may not be None

Since : 1.30

### gst_tracing_get_active_tracers

    GList *
    gst_tracing_get_active_tracers ()

Get a list of all active tracer objects owned by the tracing framework for the entirety of the run-time of the process or till gst_deinit is called.

Returns ( [transfer: full][element-type Gst.Tracer]) –

A GList of GstTracer objects

Since : 1.18

### Gst.prototype.tracing_get_active_tracers

    function Gst.prototype.tracing_get_active_tracers(): {
        // javascript wrapper for 'gst_tracing_get_active_tracers'
    }

Get a list of all active tracer objects owned by the tracing framework for the entirety of the run-time of the process or till Gst.prototype.deinit is called.

Returns ([ Gst.Tracer ]) –

A GLib.List of Gst.Tracer objects

Since : 1.18

### Gst.tracing_get_active_tracers

    def Gst.tracing_get_active_tracers ():
        #python wrapper for 'gst_tracing_get_active_tracers'

Get a list of all active tracer objects owned by the tracing framework for the entirety of the run-time of the process or till Gst.deinit is called.

Returns ([ Gst.Tracer ]) –

A GLib.List of Gst.Tracer objects

Since : 1.18

### gst_tracing_register_hook

    gst_tracing_register_hook (GstTracer * tracer,
                               const gchar * detail,
                               GCallback func)

Register func to be called when the trace hook detail is getting invoked. Use NULL for detail to register to all hooks.

Parameters:

`tracer` –

the tracer

`detail` –

the detailed hook

`func` ( [scope async]) –

the callback

Since : 1.8

### Gst.prototype.tracing_register_hook

    function Gst.prototype.tracing_register_hook(tracer: Gst.Tracer, detail: String, func: GObject.Callback): {
        // javascript wrapper for 'gst_tracing_register_hook'
    }

Register func to be called when the trace hook detail is getting invoked. Use null for detail to register to all hooks.

Parameters:

`tracer` (Gst.Tracer) –

the tracer

`detail` (String) –

the detailed hook

`func` (GObject.Callback) –

the callback

Since : 1.8

### Gst.tracing_register_hook

    def Gst.tracing_register_hook (tracer, detail, func):
        #python wrapper for 'gst_tracing_register_hook'

Register func to be called when the trace hook detail is getting invoked. Use None for detail to register to all hooks.

Parameters:

`tracer` (Gst.Tracer) –

the tracer

`detail` (str) –

the detailed hook

`func` (GObject.Callback) –

the callback

Since : 1.8

The results of the search are