Rename/move dsl_gst_bin_* to dsl_component_custom_*

docs/api-branch.md

@@ -233,7 +233,7 @@ retval = dsl_branch_component_remove_all('my-branch')
 * [Sink](/docs/api-sink.md)
 * **Branch**
 * [Component](/docs/api-component.md)
-* [Custom Component](/docs/api-gst.md)
+* [GST Element](/docs/api-gst.md)
 * [Pad Probe Handler](/docs/api-pph.md)
 * [ODE Trigger](/docs/api-ode-trigger.md)
 * [ODE Accumulator](/docs/api-ode-accumulator.md)

docs/api-dewarper.md

@@ -236,7 +236,7 @@ retval = dsl_dewarper_num_batch_buffers_set('my-dewarper', 4)
 * [Sink](/docs/api-sink.md)
 * [Branch](/docs/api-branch.md)
 * [Component](/docs/api-component.md)
-* [Custom Component](/docs/api-gst.md)
+* [GST Element](/docs/api-gst.md)
 * [Pad Probe Handler](/docs/api-pph.md)
 * [ODE Trigger](/docs/api-ode-trigger.md)
 * [ODE Accumulator](/docs/api-ode-accumulator.md)

docs/api-display-type.md

@@ -1012,7 +1012,7 @@ retval = dsl_display_type_meta_add('blue-circle', buffer, frame_meta)
 * [Sink](/docs/api-sink.md)
 * [Branch](/docs/api-branch.md)
 * [Component](/docs/api-component.md)
-* [Custom Component](/docs/api-gst.md)
+* [GST Element](/docs/api-gst.md)
 * [Pad Probe Handler](/docs/api-pph.md)
 * [ODE-Trigger](/docs/api-ode-trigger.md)
 * [ODE Accumulator](/docs/api-ode-accumulator.md)

docs/api-gst.md

@@ -1,79 +1,36 @@
-# GStreamer (GST) Element and Bin API Reference
-The GST API is used to create *Custom DSL Pipeline Components*. Once created, *Custom Components* are added to a [Pipeline](/docs/api-pipeline.md) the same as other built-in DSL Components. 
+# GStreamer (GST) Element API Reference
+The GST API is used to create *Custom GStreamer (GST) Elements*. Once created, GST Elements can be added to either a Custom Video Source (TODO), [Custom Component](/docs/api-component.md#custom-components), or Custom Sink (TODO)). 
 
-IMPORTANT! All DSL Pipeline Components, custom or built-in, are derived from the [GStreamer (GST) Bin](https://gstreamer.freedesktop.org/documentation/application-development/basics/bins.html?gi-language=c) container class. Bins are used to  contain [GST Elements](https://gstreamer.freedesktop.org/documentation/application-development/basics/bins.html?gi-language=c). Bins allow you to combine a group of linked Elements into one logical Element.
-
-There are restrictions imposed on the type of Elements that can be created and added to a Bin:
-* Single input pad and output pad only.
+There are restrictions imposed on the type of Elements that can be created and added to one of the Custom Types. 
+Elements added to Custom Components 
+* Must have a single sink (input) pad and source (output) pad only.
 * Therefore, no tees, muxers, aggregators, or demuxers (this list may not be complete).
 
-The first Element in each Bin is typically a [queue](https://gstreamer.freedesktop.org/documentation/coreelements/queue.html?gi-language=c#properties). Adding a queue creates a new thread on the queue's source pad (output) which decouples the processing between input and output, effectively creating a new thread for the custom Pipeline Component.
+The first element adde to a Custom Source
+* Must be a Source element that can be connected via source pad and without a sink pad.
+
+The last element added to a Custom Sink
+* must be a Sink element that can be connected via sink pad and without a source pad.
 
 ## Construction and Destruction
 GST Elements are created by calling [`dsl_gst_element_new`](#dsl_gst_element_new) and deleted by calling [`dsl_gst_element_delete`](#dsl_gst_element_delete), [`dsl_gst_element_delete_many`](#dsl_gst_element_delete_many), or [`dsl_gst_element_delete_all`](#dsl_gst_element_delete_all).
 
-GST Bins are created by calling [`dsl_gst_bin_new`](#dsl_gst_bin_new) or [`dsl_gst_bin_new_element_add_many`](#dsl_gst_bin_new_element_add_many). As with all Pipeline Components, GST Bins are deleted by calling [`dsl_component_delete`](/docs/api-component.md#dsl_component_delete), [`dsl_component_delete_many`](/docs/api-component.md#dsl_component_delete_many), or [`dsl_component_delete_all`](/docs/api-component.md#dsl_component_delete_all).
-
-## Adding and Removing
-The relationship between GST Bins and GST Elements is one to many. Once added to a Bin, an Element must be removed before it can be used with another. Elements can be added to bins when constructed by calling [`dsl_gst_bin_new_element_add_many`](#dsl_gst_bin_new_element_add_many),  or after construction by calling [`dsl_gst_bin_element_add`](#dsl_gst_bin_element_add) and [`dsl_gst_bin_element_add_many`](#dsl_gst_bin_element_add_many). GST Elements can be removed from a GST Bin by calling [`dsl_gst_bin_element_remove`](#dsl_gst_bin_element_remove) or [`dsl_gst_bin_element_remove_many`](#dsl_gst_bin_element_remove_many).
-
-The relationship between Pipelines/Branches  and GST Bins is one to many. Once added to a Pipeline or Branch, a Bin must be removed before it can be used with another. GST Bins are added to a Pipeline by calling [`dsl_pipeline_component_add`](/docs/api-pipeline.md#dsl_pipeline_component_add) or [`dsl_pipeline_component_add_many`](/docs/api-pipeline.md#dsl_pipeline_component_add_many) and removed with [`dsl_pipeline_component_remove`](/docs/api-pipeline.md#dsl_pipeline_component_remove), [`dsl_pipeline_component_remove_many`](/docs/api-pipeline.md#dsl_pipeline_component_remove_many), or [`dsl_pipeline_component_remove_all`](/docs/api-pipeline.md#dsl_pipeline_component_remove_all).
-
-A similar set of Services are used when adding/removing a to/from a branch: [`dsl_branch_component_add`](api-branch.md#dsl_branch_component_add), [`dsl_branch_component_add_many`](/docs/api-branch.md#dsl_branch_component_add_many), [`dsl_branch_component_remove`](/docs/api-branch.md#dsl_branch_component_remove), [`dsl_branch_component_remove_many`](/docs/api-branch.md#dsl_branch_component_remove_many), and [`dsl_branch_component_remove_all`](/docs/api-branch.md#dsl_branch_component_remove_all).
-
-Below is a simple example that creats two GST Elements and adds them to a new GST Bin.
-
-```Python
-# IMPORTANT! We create a queue element to be our first element of our bin.
-# The queue will create a new thread on the source pad (output) to decouple
-# the processing on sink and source pad, effectively creating a new thread for
-# our custom component.
-retval = dsl_gst_element_new('my-queue', 'queue')
-
-# Create a new element from a proprietary plugin
-retval = dsl_gst_element_new('my-element', 'my-plugin-name')
-
-# Create a new bin and add the elements to it. The elements will be linked
-# in the order they're added.
-ret_val = dsl_gst_bin_new_element_add_many('my-custom-bin',
-   elements = ['my-queue', 'my-element', None])
-
-# The Custom Component can now be added to our Pipeline along with
-# the other Pipeline components. Add in the order to be linked.
-retval = dsl_pipeline_new_component_add_many('pipeline',
-   ['my-source', 'my-primary-gie', 'my-iou-tracker', 'my-custom-bin',
-   'my-on-screen-display', 'my-egl-sink', None])
-
-# IMPORTANT! set the link method for the Pipeline to link by
-# add order (and not by fixed position - default)
-retval = dsl_pipeline_link_method_set('pipeline',
-   DSL_PIPELINE_LINK_METHOD_BY_ADD_ORDER)
-```
 
 ## Adding/Removing Pad-Probe-handlers
 Multiple sink (input) and/or source (output) [Pad-Probe Handlers](/docs/api-pph.md) can be added to any Primary or Secondary GIE or TIS by calling [`dsl_gst_element_pph_add`](#dsl_gst_element_pph_add) and removed with [`dsl_gst_element_pph_remove`](#dsl_gst_element_pph_remove).
 
-## Relevant Examples
-For relevant examples see:
-* [pipeline_with_custom_gst_bin_and_elements.py](/examples/python/pipeline_with_custom_gst_bin_and_elements.py)
-* [pipeline_with_custom_gst_bin_and_elements.cpp](/examples/python/pipeline_with_custom_gst_bin_and_elements.cpp)
-
 ---
 
 
 ## GST API
 **Constructors**
 * [`dsl_gst_element_new`](#dsl_gst_element_new)
-* [`dsl_gst_bin_new`](#dsl_gst_bin_new)
-* [`dsl_gst_bin_new_element_add_many`](#dsl_gst_bin_new_element_add_many)
-
 
 **Destructors**
 * [`dsl_gst_element_delete`](#dsl_gst_element_delete)
 * [`dsl_gst_element_delete_many`](#dsl_gst_element_delete_many)
 * [`dsl_gst_element_delete_all`](#dsl_gst_element_delete_all)
 
-
 **Methods**
 * [`dsl_gst_element_property_boolean_get`](#dsl_gst_element_property_boolean_get)
 * [`dsl_gst_element_property_boolean_set`](#dsl_gst_element_property_boolean_set)
@@ -91,17 +48,11 @@ For relevant examples see:
 * [`dsl_gst_element_property_string_set`](#dsl_gst_element_property_string_set)
 * [`dsl_gst_element_pph_add`](#dsl_gst_element_pph_add)
 * [`dsl_gst_element_pph_remove`](#dsl_gst_element_pph_remove)
-* [`dsl_gst_bin_element_add`](#dsl_gst_bin_element_add)
-* [`dsl_gst_bin_element_add_many`](#dsl_gst_bin_element_add_many)
-* [`dsl_gst_bin_element_remove`](#dsl_gst_bin_element_remove)
-* [`dsl_gst_bin_element_remove_many`](#dsl_gst_bin_element_remove_many)
-
 
 ---
 ## Return Values
 The following return codes are used by the GStreamer Element API
 
-
 ```C
 #define DSL_RESULT_GST_ELEMENT_RESULT                               0x00D00000
 #define DSL_RESULT_GST_ELEMENT_NAME_NOT_UNIQUE                      0x00D00001
@@ -114,21 +65,6 @@ The following return codes are used by the GStreamer Element API
 #define DSL_RESULT_GST_ELEMENT_PAD_TYPE_INVALID                     0x00D00008
 ```
 
-
-The following return codes are used by the GStreamer Element API
-```C
-#define DSL_RESULT_GST_BIN_RESULT                                   0x00E00000
-#define DSL_RESULT_GST_BIN_NAME_NOT_UNIQUE                          0x00E00001
-#define DSL_RESULT_GST_BIN_NAME_NOT_FOUND                           0x00E00002
-#define DSL_RESULT_GST_BIN_NAME_BAD_FORMAT                          0x00E00003
-#define DSL_RESULT_GST_BIN_THREW_EXCEPTION                          0x00E00004
-#define DSL_RESULT_GST_BIN_IS_IN_USE                                0x00E00005
-#define DSL_RESULT_GST_BIN_SET_FAILED                               0x00E00006
-#define DSL_RESULT_GST_BIN_ELEMENT_ADD_FAILED                       0x00E00007
-#define DSL_RESULT_GST_BIN_ELEMENT_REMOVE_FAILED                    0x00E00008
-#define DSL_RESULT_GST_BIN_ELEMENT_NOT_IN_USE                       0x00E00009
-```
-
 ---
 
 ## Constructors
@@ -151,48 +87,6 @@ This constructor creates a uniquely named GStreamer Element from a plugin factor
 retval = dsl_gst_element_new('my-element', 'my-plugin)
 ```
 
-<br>
-
-### *dsl_gst_bin_new*
-```C++
-DslReturnType dsl_gst_bin_new(const wchar_t* name);
-```
-This constructor creates a uniquely named GStreamer Bin. Construction will fail if the name is currently in use.
-
-**Parameters**
-* `name` - [in] unique name for the GStreamer Been to create.
-
-**Returns**
-`DSL_RESULT_SUCCESS` on successful creation. One of the [Return Values](#return-values) defined above on failure
-
-**Python Example**
-```Python
-retval = dsl_gst_bin_new('my-bin')
-```
-
-<br>
-
-
-### *dsl_gst_bin_new_element_add_many*
-```C++
-DslReturnType dsl_gst_bin_new_element_add_many(const wchar_t* name,
-   const wchar_t** components);
-```
-This constructor creates a uniquely named GStreamer Bin and adds a list of Elements to it. Construction will fail if the name is currently in use.
-
-**Parameters**
-* `name` - [in] unique name for the GStreamer Been to create.
-* `components` - [in] NULL terminated array of Element names to add.
-
-**Returns**
-`DSL_RESULT_SUCCESS` on successful creation. One of the [Return Values](#return-values) defined above on failure
-
-**Python Example**
-```Python
-retval = dsl_gst_bin_new_element_add_many('my-bin',
-   [my-element-1, my-element-2, my-element-3, None])
-```
-
 ---
 
 ## Destructors
@@ -201,17 +95,15 @@ retval = dsl_gst_bin_new_element_add_many('my-bin',
 ```C++
 DslReturnType dsl_gst_element_delete(const wchar_t* name);
 ```
-This destructor deletes a uniquely named GStreamer Element. This service will fail if the element is currently in-use with a GST Bin.
+This destructor deletes a uniquely named GStreamer Element. This service will fail if the element is currently in-use .
 
 
 **Parameters**
 * `name` - [in] unique name for the GStreamer Element to delete.
 
-
 **Returns**
 `DSL_RESULT_SUCCESS` on successful deletion. One of the [Return Values](#return-values) defined above on failure
 
-
 **Python Example**
 ```Python
 retval = dsl_gst_element_delete('my-element')
@@ -225,11 +117,9 @@ DslReturnType dsl_gst_element_delete_many(const wchar_t** names);
 ```
 This destructor deletes a NULL terminated list of GStreamer Elements. This service will return with an error if any of the Elements are currently in-use or not found.
 
-
 **Parameters**
 * `names` - [in] NULL terminated list of GStreamer Elements to delete.
 
-
 **Returns**
 `DSL_RESULT_SUCCESS` on successful deletion. One of the [Return Values](#return-values) defined above on failure
 
@@ -626,87 +516,7 @@ retval = dsl_gst_element_pph_remove('my-element', 'my-pph-handler', DSL_PAD_SINK
 
 <br>
 
-### *dsl_gst_bin_element_add*
-```C++
-DslReturnType dsl_gst_bin_element_add(const wchar_t* name, const wchar_t* element);
-```
-This service adds a single named Element to a named Bin. The add service will fail if the Element is currently `in-use` by any Bin. The Element's `in-use` state will be set to `true` on successful add.
-
-**Parameters**
-* `name` - [in] unique name for the Bin to update.
-* `element` - [in] unique name of the Element to add.
-
-**Returns**
-* `DSL_RESULT_SUCCESS` on successful addition. One of the [Return Values](#return-values) defined above on failure
-
-**Python Example**
-```Python
-retval = dsl_gst_bin_element_add('my-bin', 'my-element')
-```
-
-<br>
-
-### *dsl_gst_bin_element_add_many*
-```C++
-DslReturnType dsl_gst_bin_element_add_many(const wchar_t* name, const wchar_t** elements);
-```
-Adds a list of named Elements to a named Bin. The add service will fail if any of the Elements are currently `in-use` by any Bin. All of the Element's `in-use` state will be set to true on successful add.
-
-* `name` - [in] unique name for the Bin to update.
-* `elements` - [in] a NULL terminated array of uniquely named Elements to add.
-
-**Returns**
-* `DSL_RESULT_SUCCESS` on successful  addition. One of the [Return Values](#return-values) defined above on failure.
-
-
-**Python Example**
-```Python
-retval = dsl_gst_bin_element_add_many('my-bin',
-   ['my-element-1', 'my-element-2', None])
-```
-
-<br>
-
 ---
-### *dsl_gst_bin_element_remove*
-```C++
-DslReturnType dsl_gst_bin_element_remove(const wchar_t* name, const wchar_t* element);
-```
-This service removes a single named Element from a named Bin.
-
-**Parameters**
-* `name` - [in] unique name for the Bin to update.
-* `element` - [in] unique name of the Element to remove.
-
-**Returns**
-* `DSL_RESULT_SUCCESS` on successful removal. One of the [Return Values](#return-values) defined above on failure
-
-**Python Example**
-```Python
-retval = dsl_gst_bin_element_remove('my-bin', 'my-element')
-```
-
-<br>
-
-### *dsl_gst_bin_element_remove_many*
-```C++
-DslReturnType dsl_gst_bin_element_remove_many(const wchar_t* name, const wchar_t** elements);
-```
-Removes a list of named Elements from a named Bin.
-
-* `name` - [in] unique name for the Bin to update.
-* `elements` - [in] a NULL terminated array of uniquely named Elements to remove.
-
-**Returns**
-* `DSL_RESULT_SUCCESS` on successful removal. One of the [Return Values](#return-values) defined above on failure.
-
-**Python Example**
-```Python
-retval = dsl_gst_bin_element_remove_many('my-bin',
-   ['my-element-1', 'my-element-2', None])
-```
-
-<br>
 
 ## API Reference
 * [List of all Services](/docs/api-reference-list.md)
@@ -724,7 +534,7 @@ retval = dsl_gst_bin_element_remove_many('my-bin',
 * [Remuxer](/docs/api-remuxer.md)
 * [On-Screen Display](/docs/api-osd.md)
 * [Sink](/docs/api-sink.md)
-* **Custom Component**
+* **GST Element**
 * [Pad Probe Handler](/docs/api-pph.md)
 * [ODE Trigger](/docs/api-ode-trigger.md)
 * [ODE Accumulator](/docs/api-ode-accumulator.md)
@@ -734,7 +544,6 @@ retval = dsl_gst_bin_element_remove_many('my-bin',
 * [Display Types](/docs/api-display-types.md)
 * [branch](/docs/api-branch.md)
 * [Component](/docs/api-component.md)
-
 * [Mailer](/docs/api-mailer.md)
 * [WebSocket Server](/docs/api-ws-server.md)
 * [Message Broker](/docs/api-msg-broker.md)

docs/api-infer.md

@@ -502,7 +502,7 @@ retval = dsl_infer_pph_remove('my-primary-gie', 'my-pph-handler', DSL_PAD_SINK)
 * [Sink](/docs/api-sink.md)
 * [Branch](/docs/api-branch.md)
 * [Component](/docs/api-component.md)
-* [Custom Component](/docs/api-gst.md)
+* [GST Element](/docs/api-gst.md)
 * [Pad Probe Handler](/docs/api-pph.md)
 * [ODE Trigger](/docs/api-ode-trigger.md)
 * [ODE Accumulator](/docs/api-ode-accumulator.md)

docs/api-info.md

@@ -309,7 +309,7 @@ retval = dsl_info_log_function_restore()
 * [Sink](/docs/api-sink.md)
 * [Branch](/docs/api-branch.md)
 * [Component](/docs/api-component.md)
-* [Custom Component](/docs/api-gst.md)
+* [GST Element](/docs/api-gst.md)
 * [Pad Probe Handler](/docs/api-pph.md)
 * [ODE Trigger](/docs/api-ode-trigger.md)
 * [ODE Accumulator](/docs/api-ode-accumulator.md)

docs/api-mailer.md

@@ -503,7 +503,7 @@ num_mailers = dsl_mailer_list_size()
 * [Sink](/docs/api-sink.md)
 * [Branch](/docs/api-branch.md)
 * [Component](/docs/api-component.md)
-* [Custom Component](/docs/api-gst.md)
+* [GST Element](/docs/api-gst.md)
 * [Pad Probe Handler](/docs/api-pad-probe-handler.md)
 * [ODE Trigger](/docs/api-ode-trigger.md)
 * [ODE Accumulator](/docs/api-ode-accumulator.md)

docs/api-msg-broker.md

@@ -491,7 +491,7 @@ size = dsl_message_broker_list_size()
 * [Sink](/docs/api-sink.md)
 * [Branch](/docs/api-branch.md)
 * [Component](/docs/api-component.md)
-* [Custom Component](/docs/api-gst.md)
+* [GST Element](/docs/api-gst.md)
 * [Pad Probe Handler](/docs/api-pph.md)
 * [ODE Trigger](/docs/api-ode-trigger.md)
 * [ODE Accumulator](/docs/api-ode-accumulator.md)

docs/api-ode-accumulator.md

@@ -276,7 +276,7 @@ size = dsl_ode_accumulator_list_size()
 * [Sink](/docs/api-sink.md)
 * [Branch](/docs/api-branch.md)
 * [Component](/docs/api-component.md)
-* [Custom Component](/docs/api-gst.md)
+* [GST Element](/docs/api-gst.md)
 * [Pad Probe Handler](/docs/api-pph.md)
 * [ODE Trigger](/docs/api-ode-trigger.md)
 * **ODE Accumulator**

docs/api-ode-action.md

@@ -1935,7 +1935,7 @@ size = dsl_ode_action_list_size()
 * [Sink](/docs/api-sink.md)
 * [Branch](/docs/api-branch.md)
 * [Component](/docs/api-component.md)
-* [Custom Component](/docs/api-gst.md)
+* [GST Element](/docs/api-gst.md)
 * [Pad Probe Handler](/docs/api-pph.md)
 * [ODE Trigger](/docs/api-ode-trigger.md)
 * [ODE Accumulator](/docs/api-ode-accumulator.md)