gstreamer/docs/gst/tmpl/gsttrace.sgml
Stefan Kost a34f2613f9 more tests (and fixes) for the controller more docs for the controller integrated companies docs for the adapter
Original commit message from CVS:
more tests (and fixes) for the controller
more docs for the controller
integrated companies docs for the adapter
2005-08-05 10:02:44 +00:00

234 lines
2.9 KiB
Text

<!-- ##### SECTION Title ##### -->
GstTrace
<!-- ##### SECTION Short_Description ##### -->
Tracing functionality
<!-- ##### SECTION Long_Description ##### -->
<para>
Tracing functionality
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstTrace ##### -->
<para>
</para>
@filename:
@fd:
@buf:
@bufsize:
@bufoffset:
<!-- ##### STRUCT GstTraceEntry ##### -->
<para>
</para>
@timestamp:
@sequence:
@data:
@message:
<!-- ##### FUNCTION gst_trace_new ##### -->
<para>
</para>
@filename:
@size:
@Returns:
<!-- ##### FUNCTION gst_trace_destroy ##### -->
<para>
</para>
@trace:
<!-- ##### FUNCTION gst_trace_flush ##### -->
<para>
</para>
@trace:
<!-- ##### FUNCTION gst_trace_text_flush ##### -->
<para>
</para>
@trace:
<!-- ##### MACRO gst_trace_get_size ##### -->
<para>
</para>
@trace:
<!-- ##### MACRO gst_trace_get_offset ##### -->
<para>
</para>
@trace:
<!-- ##### MACRO gst_trace_get_remaining ##### -->
<para>
</para>
@trace:
<!-- ##### FUNCTION gst_trace_set_default ##### -->
<para>
</para>
@trace:
<!-- ##### FUNCTION gst_trace_read_tsc ##### -->
<para>
</para>
@dst:
<!-- ##### ENUM GstAllocTraceFlags ##### -->
<para>
Flags indicating which tracing feature to enable.
</para>
@GST_ALLOC_TRACE_LIVE: Trace number of non-freed memory
@GST_ALLOC_TRACE_MEM_LIVE: trace pointers of unfreed memory
<!-- ##### STRUCT GstAllocTrace ##### -->
<para>
The main tracing object
</para>
@name: The name of the tracing object
@flags: Flags for this object
@live: counter for live memory
@mem_live: list with pointers to unfreed memory
<!-- ##### FUNCTION gst_alloc_trace_available ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_alloc_trace_list ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_alloc_trace_live_all ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_alloc_trace_print_all ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_alloc_trace_set_flags_all ##### -->
<para>
</para>
@flags:
<!-- ##### FUNCTION gst_alloc_trace_get ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_alloc_trace_print ##### -->
<para>
</para>
@trace:
<!-- ##### FUNCTION gst_alloc_trace_set_flags ##### -->
<para>
</para>
@trace:
@flags:
<!-- ##### MACRO gst_alloc_trace_register ##### -->
<para>
Register a new alloc tracer with the given name
</para>
@name: The name of the tracer object
<!-- ##### MACRO gst_alloc_trace_new ##### -->
<para>
Use the tracer to trace a new memory allocation
</para>
@trace: The tracer to use
@mem: The memory allocated
<!-- ##### MACRO gst_alloc_trace_free ##### -->
<para>
Trace a memory free operation
</para>
@trace: The traver to use
@mem: The memory that is freed
<!-- ##### MACRO gst_trace_add_entry ##### -->
<para>
</para>
@trace:
@seq:
@data:
@msg: