mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-09-24 13:00:36 +00:00
Code Issues 1 Projects Releases Wiki Activity

updated API docs

Browse source 
Original commit message from CVS:
updated API docs
This commit is contained in:
Erik Walthinsen 2001-01-04 22:16:06 +00:00
parent ddfc781f7d
commit df81ae1765
23 changed files with 2137 additions and 1966 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/gst/tmpl/gstasyncdisksrc.sgml
View file

@ -32,23 +32,3 @@ the offset.
@GST_ASYNCDISKSRC_OPEN:
@GST_ASYNCDISKSRC_FLAG_LAST:
<!-- ##### ARG GstAsyncDiskSrc:location ##### -->
<para>
Specify the location of the file to read.
</para>
<!-- ##### ARG GstAsyncDiskSrc:bytesperread ##### -->
<para>
Specify how many bytes to read at a time.
</para>
<!-- ##### ARG GstAsyncDiskSrc:offset ##### -->
<para>
Specify the current offset in the file.
</para>
<!-- ##### ARG GstAsyncDiskSrc:size ##### -->
<para>
</para>

29
docs/gst/tmpl/gstaudiosink.sgml
View file

@ -14,32 +14,3 @@ Output to a sound card via OSS.
</para>
<!-- ##### SIGNAL GstAudioSink::handoff ##### -->
<para>
The buffer is sent to the sound card.
</para>
@gstaudiosink: the object which received the signal.
<!-- # Unused Parameters # -->
@arg1: the audiosink.
<!-- ##### ARG GstAudioSink:mute ##### -->
<para>
</para>
<!-- ##### ARG GstAudioSink:format ##### -->
<para>
</para>
<!-- ##### ARG GstAudioSink:channels ##### -->
<para>
</para>
<!-- ##### ARG GstAudioSink:frequency ##### -->
<para>
</para>

25
docs/gst/tmpl/gstaudiosrc.sgml
View file

@ -14,28 +14,3 @@ Create buffers from an OSS sound card.
</para>
<!-- ##### ARG GstAudioSrc:bytes_per_read ##### -->
<para>
The number of bytes per read.
</para>
<!-- ##### ARG GstAudioSrc:curoffset ##### -->
<para>
Get the current number of bytes read.
</para>
<!-- ##### ARG GstAudioSrc:format ##### -->
<para>
The audio format as defined in soundcard.h
</para>
<!-- ##### ARG GstAudioSrc:channels ##### -->
<para>
The number of channels (mono, stereo, ...)
</para>
<!-- ##### ARG GstAudioSrc:frequency ##### -->
<para>
The frequency.
</para>

9
docs/gst/tmpl/gstbin.sgml
View file

@ -121,12 +121,3 @@ Flags for a bin
@bin:
<!-- ##### SIGNAL GstBin::object-added ##### -->
<para>
is signaled whenever a new <classname>GstElement</classname> is added to the <classname>GstBin</classname>
</para>
@gstbin: the object which received the signal.
@arg1: the element that was added

20
docs/gst/tmpl/gstdisksrc.sgml
View file

@ -33,23 +33,3 @@ with seeking capabilities use a <classname>GstAsynDiskSrc</classname> instead.
@GST_DISKSRC_OPEN:
@GST_DISKSRC_FLAG_LAST:
<!-- ##### ARG GstDiskSrc:location ##### -->
<para>
Specify the location of the file to read.
</para>
<!-- ##### ARG GstDiskSrc:bytesperread ##### -->
<para>
Specify how many bytes to read at a time.
</para>
<!-- ##### ARG GstDiskSrc:offset ##### -->
<para>
Get the current offset in the file.
</para>
<!-- ##### ARG GstDiskSrc:size ##### -->
<para>
</para>

42
docs/gst/tmpl/gstelement.sgml
View file

@ -180,6 +180,7 @@ GstElementDetails struct for the element.
@type:
@details:
@padtemplates:
@numpadtemplates:
<!-- ##### USER_FUNCTION GstElementLoopFunction ##### -->
<para>
@ -500,44 +501,3 @@ circumstances.
@Returns:
<!-- ##### SIGNAL GstElement::state-change ##### -->
<para>
Is trigered whenever the state of an element changes
</para>
@gstelement: the object which received the signal.
@arg1: the new state of the object
<!-- ##### SIGNAL GstElement::new-pad ##### -->
<para>
Is trigered whenever a new pad is added to an element
</para>
@gstelement: the object which received the signal.
@arg1: the new pad that was added
<!-- ##### SIGNAL GstElement::new-ghost-pad ##### -->
<para>
Is trigered whenever a new ghost pad is added to an element
</para>
@gstelement: the object which received the signal.
@arg1: the new ghost pad that was added
<!-- ##### SIGNAL GstElement::error ##### -->
<para>
Is trigered whenever an error occured
</para>
@gstelement: the object which received the signal.
@arg1: the error message
<!-- ##### SIGNAL GstElement::eos ##### -->
<para>
</para>
@gstelement: the object which received the signal.

7
docs/gst/tmpl/gstfakesink.sgml
View file

@ -16,10 +16,3 @@ with the buffer. (fakesink)
</para>
<!-- ##### SIGNAL GstFakeSink::handoff ##### -->
<para>
</para>
@gstfakesink: the object which received the signal.

27
docs/gst/tmpl/gstfakesrc.sgml
View file

@ -14,30 +14,3 @@ The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
</para>
<!-- ##### SIGNAL GstFakeSrc::handoff ##### -->
<para>
</para>
@gstfakesrc: the object which received the signal.
<!-- ##### ARG GstFakeSrc:num_sources ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:loop_based ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:output ##### -->
<para>
</para>
<!-- ##### ARG GstFakeSrc:patern ##### -->
<para>
</para>

5
docs/gst/tmpl/gstfdsink.sgml
View file

@ -14,8 +14,3 @@ Write data to a file descriptor.
</para>
<!-- ##### ARG GstFdSink:fd ##### -->
<para>
The filedescriptor to write to.
</para>

15
docs/gst/tmpl/gstfdsrc.sgml
View file

@ -14,18 +14,3 @@ Read buffers from a file descriptor.
</para>
<!-- ##### ARG GstFdSrc:location ##### -->
<para>
The filedescriptor to read from. Pass the argument as a char* (???)
</para>
<!-- ##### ARG GstFdSrc:bytesperread ##### -->
<para>
The number of bytes per read.
</para>
<!-- ##### ARG GstFdSrc:offset ##### -->
<para>
Get the current offset in the file.
</para>

11
docs/gst/tmpl/gsthttpsrc.sgml
View file

@ -14,14 +14,3 @@ Reads data from a URL.
</para>
<!-- ##### ARG GstHttpSrc:location ##### -->
<para>
Specify the location of the file. The location must be a fully qualified URL.
</para>
<!-- ##### ARG GstHttpSrc:bytesperread ##### -->
<para>
Specify how many bytes to read at a time.
</para>

5
docs/gst/tmpl/gstidentity.sgml
View file

@ -14,8 +14,3 @@ Pass data without modification.
</para>
<!-- ##### ARG GstIdentity:loop_based ##### -->
<para>
</para>

82
docs/gst/tmpl/gstinfo.sgml
View file

@ -6,8 +6,24 @@ info/debugging/error handling
<!-- ##### SECTION Long_Description ##### -->
<para>
GstInfo contains a lot of functions to add debugging information
to your application.
gstinfo.c contains a number of debuggins subsystems.
</para>
<para>The INFO subsystem is used to provide informative printouts to
application and plugin developers. These messages can be enabled and
disabled via a category system, which is a bitmask enabling you to turn
on and off any subset of categories.</para>
<para>The DEBUG subsystem is similar, but is intended for core developers
and those writing more complex pipelines or filters. It uses the same
category system, but must be enabled at configure time else it's not
compiled into the library. autogen.sh automatically enables the DEBUG
subsystem.
</para>
<para>The ERROR subsystem doesn't use categories, but will print out a
more verbose message, and attempt to print out a stack trace of the error
before aborting the application.
</para>
<!-- ##### SECTION See_Also ##### -->
@ -72,30 +88,30 @@ to your application.
<!-- ##### MACRO GST_INFO_ENABLED ##### -->
<para>
When defined, INFO printouts are compiled into the library.
</para>
<!-- ##### MACRO GST_INFO ##### -->
<para>
Print out any information usable at run-time by application developers.
</para>
@cat:
@format:
@args...:
@cat: the GST_CAT_... category for the information
@format: printf-style format string
@args...: printf arguments
<!-- ##### MACRO GST_INFO_ELEMENT ##### -->
<para>
Print out information like #GST_INFO, but with an element pointer to clarify things.
</para>
@cat:
@element:
@format:
@args...:
@cat: the GST_CAT_... category for the information
@element: pointer to the #GstElement in question
@format: printf-style format string
@args...: printf arguments
<!-- ##### FUNCTION gst_debug_get_categories ##### -->
@ -132,25 +148,27 @@ to your application.
<!-- ##### MACRO GST_DEBUG_SET_STRING ##### -->
<para>
Set the debug string for the current function, typically containing the arguments
to the current function, i.e. "('element')"
</para>
@format:
@args...:
@format: printf-style format string
@args...: printf arguments
<!-- ##### MACRO GST_DEBUG_ENTER ##### -->
<para>
Called at the beginning of a function, it simply prints out a DEBUG string of "entering"
in addition to the given string.
</para>
@format:
@args...:
@format: printf-style format string
@args...: printf arguments
<!-- ##### MACRO GST_DEBUG_ENTER_STRING ##### -->
<para>
Combine #GST_DEBUG_ENTER and #GST_DEBUG_SET_STRING.
</para>
@ -183,12 +201,12 @@ to your application.
<!-- ##### MACRO GST_DEBUG ##### -->
<para>
Print out debugging information.
</para>
@cat:
@format:
@args...:
@cat: the GST_CAT_... the debug falls within
@format: printf-style format string
@args...: printf arguments
<!-- ##### MACRO GST_DEBUG_ENABLE_CATEGORIES ##### -->
@ -240,23 +258,23 @@ to your application.
<!-- ##### MACRO GST_ERROR ##### -->
<para>
Print out an error condition and abort the application.
</para>
@element:
@format:
@args...:
@element: the #GstElement in question
@format: printf-style format string
@args...: printf arguments
<!-- ##### MACRO GST_ERROR_OBJECT ##### -->
<para>
Print out an error condition and abort the application.
</para>
@element:
@object:
@format:
@args...:
@element: the #GstElement in question
@object: pointer to a 'contributing' object
@format: printf-style format string
@args...: printf arguments
<!-- ##### FUNCTION gst_default_error_handler ##### -->

8
docs/gst/tmpl/gstobject.sgml
View file

@ -174,11 +174,3 @@ This macro releases a lock on the object.
@Returns:
<!-- ##### SIGNAL GstObject::parent-set ##### -->
<para>
</para>
@gstobject: the object which received the signal.
@arg1: the new parent

5
docs/gst/tmpl/gstpad.sgml
View file

@ -537,8 +537,3 @@ Indicates when this pad will become available
@Returns:
<!-- ##### ARG GstPad:active ##### -->
<para>
Indicates this pad is active
</para>

5
docs/gst/tmpl/gstpipefilter.sgml
View file

@ -15,8 +15,3 @@ buffers from its output.
</para>
<!-- ##### ARG GstPipefilter:command ##### -->
<para>
Sets the command to be executed.
</para>

16
docs/gst/tmpl/gstqueue.sgml
View file

@ -21,19 +21,3 @@ The default queue length is set to 10.
</para>
<!-- ##### ARG GstQueue:level ##### -->
<para>
Get the number of buffers in the queue.
</para>
<!-- ##### ARG GstQueue:max_level ##### -->
<para>
Specify the maximum number of buffers in the queue before the queue
blocks.
</para>
<!-- ##### ARG GstQueue:block ##### -->
<para>
</para>

3627
docs/gst/tmpl/gstreamer-unused.sgml
View file

File diff suppressed because it is too large Load diff

20
docs/gst/tmpl/gstsinesrc.sgml
View file

@ -14,23 +14,3 @@ Create a sine wave of a given frequency and volume.
</para>
<!-- ##### ARG GstSineSrc:volume ##### -->
<para>
The volume as a double 0.0 is silent, 1.0 is loudest.
</para>
<!-- ##### ARG GstSineSrc:format ##### -->
<para>
The format ad defined in soundcard.h
</para>
<!-- ##### ARG GstSineSrc:channels ##### -->
<para>
The number of channels.
</para>
<!-- ##### ARG GstSineSrc:frequency ##### -->
<para>
The fequency.
</para>

6
docs/gst/tmpl/gstthread.sgml
View file

@ -43,9 +43,3 @@ thread flags
@Returns:
<!-- ##### ARG GstThread:create_thread ##### -->
<para>
TRUE if the thread should be created.
</para>

13
docs/gst/tmpl/gsttypefind.sgml
View file

@ -15,16 +15,3 @@ the detected mime type of the stream. It is used in autoplugging.
</para>
<!-- ##### SIGNAL GstTypeFind::have-type ##### -->
<para>
The signal to indicate the mime type was detected.
</para>
@gsttypefind: the object which received the signal.
@arg1: The mime type that was detected
<!-- ##### ARG GstTypeFind:caps ##### -->
<para>
</para>

17
gst/cothreads.c
View file

@ -45,7 +45,7 @@ pthread_key_t _cothread_key = -1;
/**
* cothread_init:
*
* create and initialize a new cotread context
* Create and initialize a new cothread context
*
* Returns: the new cothread context
*/
@ -90,7 +90,7 @@ cothread_init (void)
* cothread_create:
* @ctx: the cothread context
*
* create a new cotread state in the given context
* Create a new cothread state in the given context
*
* Returns: the new cothread state
*/
@ -136,8 +136,8 @@ cothread_create (cothread_context *ctx)
* cothread_setfunc:
* @thread: the cothread state
* @func: the function to call
* @argc: the argument count for the cothread function
* @argv: the arguments for the cothread function
* @argc: argument count for the cothread function
* @argv: arguments for the cothread function
*
* Set the cothread function
*/
@ -153,6 +153,11 @@ cothread_setfunc (cothread_state *thread,
thread->pc = (int *)func;
}
/**
* cothread_main:
* @ctx: cothread context to find main thread of
*
* Returns: the #cothread_state of the main (0th) thread
static cothread_state*
cothread_main(cothread_context *ctx)
{
@ -226,9 +231,9 @@ cothread_get_data (cothread_state *thread,
/**
* cothread_switch:
* @thread: the cothread state
* @thread: cothread state to switch to
*
* switches to the given cothread state
* Switches to the given cothread state
*/
void
cothread_switch (cothread_state *thread)

89
gst/gstinfo.c
View file

@ -65,6 +65,20 @@ static gchar *_gst_info_category_strings[] = {
"XML",
};
/**
* gst_default_info_handler:
* @category: category of the INFO message
* @file: the file the INFO occurs in
* @function: the function the INFO occurs in
* @line: the line number in the file
* @debug_string: the current debug_string in the function, if any
* @element: pointer to the #GstElement in question
* @string: the actual INFO string
*
* Prints out the INFO mesage in a variant of the following form:
*
* INFO:gst_function:542(args): [elementname] something neat happened
*/
void
gst_default_info_handler (gint category, gchar *file, gchar *function,
gint line, gchar *debug_string,
@ -87,6 +101,13 @@ gst_default_info_handler (gint category, gchar *file, gchar *function,
g_free(string);
}
/**
* gst_info_set_categories:
* @categories: bitmask of INFO categories to enable
*
* Enable the output of INFO categories based on the given bitmask.
* The bit for any given category is (1 << GST_CAT_...).
*/
void
gst_info_set_categories (guint32 categories) {
_gst_info_categories = categories;
@ -94,11 +115,23 @@ gst_info_set_categories (guint32 categories) {
GST_INFO (0, "setting INFO categories to 0x%08X\n",categories);
}
/**
* gst_info_get_categories:
*
* Returns: the current bitmask of enabled INFO categories
* The bit for any given category is (1 << GST_CAT_...).
*/
guint32
gst_info_get_categories () {
return _gst_info_categories;
}
/**
* gst_info_enable_category:
* @category: the category to enable
*
* Enables the given GST_CAT_... INFO category.
*/
void
gst_info_enable_category (gint category) {
_gst_info_categories |= (1 << category);
@ -106,6 +139,12 @@ gst_info_enable_category (gint category) {
GST_INFO (0, "setting INFO categories to 0x%08X\n",_gst_info_categories);
}
/**
* gst_info_disable_category:
* @category: the category to disable
*
* Disables the given GST_CAT_... INFO category.
*/
void
gst_info_disable_category (gint category) {
_gst_info_categories &= ~ (1 << category);
@ -119,6 +158,13 @@ gst_info_disable_category (gint category) {
guint32 _gst_debug_categories = 0x00000000;
/**
* gst_debug_set_categories:
* @categories: bitmask of DEBUG categories to enable
*
* Enable the output of DEBUG categories based on the given bitmask.
* The bit for any given category is (1 << GST_CAT_...).
*/
void
gst_debug_set_categories (guint32 categories) {
_gst_debug_categories = categories;
@ -126,11 +172,23 @@ gst_debug_set_categories (guint32 categories) {
GST_INFO (0, "setting DEBUG categories to 0x%08X\n",categories);
}
/**
* gst_debug_get_categories:
*
* Returns: the current bitmask of enabled DEBUG categories
* The bit for any given category is (1 << GST_CAT_...).
*/
guint32
gst_debug_get_categories () {
return _gst_debug_categories;
}
/**
* gst_debug_enable_category:
* @category: the category to enable
*
* Enables the given GST_CAT_... DEBUG category.
*/
void
gst_debug_enable_category (gint category) {
_gst_debug_categories |= (1 << category);
@ -138,6 +196,12 @@ gst_debug_enable_category (gint category) {
GST_INFO (0, "setting DEBUG categories to 0x%08X\n",_gst_debug_categories);
}
/**
* gst_debug_disable_category:
* @category: the category to disable
*
* Disables the given GST_CAT_... DEBUG category.
*/
void
gst_debug_disable_category (gint category) {
_gst_debug_categories &= ~ (1 << category);
@ -145,6 +209,12 @@ gst_debug_disable_category (gint category) {
GST_INFO (0, "setting DEBUG categories to 0x%08X\n",_gst_debug_categories);
}
/**
* gst_get_category_name:
* @category: the category to return the name of
*
* Returns: string containing the name of the category
*/
const gchar *
gst_get_category_name (gint category) {
if ((category >= 0) && (category < GST_CAT_MAX_CATEGORY))
@ -158,6 +228,25 @@ gst_get_category_name (gint category) {
/***** ERROR system *****/
GstErrorHandler _gst_error_handler = gst_default_error_handler;
/**
* gst_default_error_handler:
* @file: the file the ERROR occurs in
* @function: the function the INFO occurs in
* @line: the line number in the file
* @debug_string: the current debug_string in the function, if any
* @element: pointer to the #GstElement in question
* @object: pointer to a related object
* @string: the actual ERROR string
*
* Prints out the given ERROR string in a variant of the following format:
*
* ***** GStreamer ERROR ***** in file gstsomething.c at gst_function:399(arg)
* Element: /pipeline/thread/element.src
* Error: peer is null!
* ***** attempting to stack trace.... *****
*
* At the end, it attempts to print the stack trace via GDB.
*/
void
gst_default_error_handler (gchar *file, gchar *function,
gint line, gchar *debug_string,