Skip to content

Commit

Permalink
V0.09a.alpha (#382)
Browse files Browse the repository at this point in the history
* Update api-osd.md

* Update api-osd.md

* Update api-osd.md

* Update api-sink.md

* Update api-tap.md

* Update api-ode-trigger.md
  • Loading branch information
rjhowell44 authored Feb 25, 2021
1 parent 5a17dbe commit 5f25f1f
Show file tree
Hide file tree
Showing 4 changed files with 276 additions and 17 deletions.
71 changes: 58 additions & 13 deletions docs/api-ode-trigger.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,12 @@ As with Actions, multiple ODE areas can be added to an ODE Trigger and the same
* [dsl_ode_trigger_reset](#dsl_ode_trigger_reset)
* [dsl_ode_trigger_enabled_get](#dsl_ode_trigger_enabled_get)
* [dsl_ode_trigger_enabled_set](#dsl_ode_trigger_enabled_set)
* [dsl_ode_trigger_source_get](#dsl_ode_trigger_source_get)
* [dsl_ode_trigger_source_set](#dsl_ode_trigger_source_set)
* [dsl_ode_trigger_class_id_get](#dsl_ode_trigger_class_id_get)
* [dsl_ode_trigger_class_id_set](#dsl_ode_trigger_class_id_set)
* [dsl_ode_trigger_source_id_get](#dsl_ode_trigger_source_id_get)
* [dsl_ode_trigger_source_id_set](#dsl_ode_trigger_source_id_set)
* [dsl_ode_trigger_limit_get](#dsl_ode_trigger_limit_get)
* [dsl_ode_trigger_limit_set](#dsl_ode_trigger_limit_set)
* [dsl_ode_trigger_confidence_min_get](#dsl_ode_trigger_confidence_min_get)
* [dsl_ode_trigger_confidence_min_set](#dsl_ode_trigger_confidence_min_set)
* [dsl_ode_trigger_dimensions_min_get](#dsl_ode_trigger_dimensions_min_get)
Expand Down Expand Up @@ -532,6 +534,49 @@ retval = dsl_ode_trigger_enabled_set('my-trigger', False)

<br>


### *dsl_ode_trigger_source_get*
```c++
DslReturnType dsl_ode_trigger_source_get(const wchar_t* name, const wchar_t** source);
```
This service returns the current source_id filter setting for the named ODE Trigger. A value of `DSL_ODE_ANY_SOURCE` indicates that the filter is disable and Source name will not be used as criteria for ODE occurrence.
**Parameters**
* `name` - [in] unique name of the ODE Trigger to query.
* `source` - [out] current source name filter for the ODE Trigger to filter on. A value of
**Returns**
* `DSL_RESULT_SUCCESS` on successful query. One of the [Return Values](#return-values) defined above on failure
**Python Example**
```Python
retval, source_name = dsl_ode_trigger_source_get('my-trigger')
```

<br>

### *dsl_ode_trigger_source_set*
```c++
DslReturnType dsl_ode_trigger_source_set(const wchar_t* name, const wchar_t* source);
```
This service sets the current source filter setting for the named ODE Trigger. A value of `DSL_ODE_ANY_SOURCE` disables the filter and the Source name will not be used as criteria for ODE occurrence.
**Parameters**
* `name` - [in] unique name of the ODE Trigger to query.
* `source` - [in] new Source name for the ODE Trigger to filter on, or `DSL_ODE_ANY_SOURCE` to disable.
**Returns**
* `DSL_RESULT_SUCCESS` on successful query. One of the [Return Values](#return-values) defined above on failure
**Python Example**
```Python
retval = dsl_ode_trigger_source_id_set('my-trigger', 'my-source-1')
```

<br>

### *dsl_ode_trigger_class_id_get*
```c++
DslReturnType dsl_ode_trigger_class_id_get(const wchar_t* name, uint* class_id);
Expand Down Expand Up @@ -569,49 +614,49 @@ This service sets the current class_id filter setting for the named ODE Trigger.
**Python Example**
```Python
retval, enabled = dsl_ode_trigger_class_id_set('my-trigger', DSL_ODE_ANY_CLASS)
retval = dsl_ode_trigger_class_id_set('my-trigger', DSL_ODE_ANY_CLASS)
```

<br>

### *dsl_ode_trigger_source_id_get*
### *dsl_ode_trigger_limit_get*
```c++
DslReturnType dsl_ode_trigger_source_id_get(const wchar_t* name, uint* source_id);
DslReturnType dsl_ode_trigger_limit_get(const wchar_t* name, uint* limit);
```
This service returns the current source_id filter setting for the named ODE Trigger. A value of `DSL_ODE_ANY_SOURCE` (default) indicates that the filter is disable and the Unique Source Id will not be used as criteria for ODE occurrence.
This service returns the current Trigger limit setting for the named ODE Trigger. A value of zero indicates NO Limit
**Parameters**
* `name` - [in] unique name of the ODE Trigger to query.
* `source_id` - [out] current source Id filter for the ODE Trigger to filter on, set to `DSL_ODE_ANY_SOURCE` during construction
* `limit` - [out] current limit setting for the ODE Trigger.
**Returns**
* `DSL_RESULT_SUCCESS` on successful query. One of the [Return Values](#return-values) defined above on failure
**Python Example**
```Python
retval, class_id = dsl_ode_trigger_source_id_get('my-trigger')
retval, limit = dsl_ode_trigger_limit_get('my-trigger')
```

<br>

### *dsl_ode_trigger_source_id_set*
### *dsl_ode_trigger_limit_set*
```c++
DslReturnType dsl_ode_trigger_source_id_set(const wchar_t* name, uint source_id);
DslReturnType dsl_ode_trigger_limit_set(const wchar_t* name, uint limit);
```
This service sets the current source_id filter setting for the named ODE Trigger. A value of `DSL_ODE_ANY_SOURCE` disables the filter and the Source Id will not be used as criteria for ODE occurrence.
This service sets the current limit setting for the named ODE Trigger. Setting the limit to zert disables the limit check, i.e. no limit.
**Parameters**
* `name` - [in] unique name of the ODE Trigger to query.
* `source_id` - [in] new Source Id filter for the ODE Trigger to filter on, or `DSL_ODE_ANY_SOURCE` to disable.
* `limit` - [in] new limit for the ODE Trigger to filter on, 0 to indicate no limit.
**Returns**
* `DSL_RESULT_SUCCESS` on successful query. One of the [Return Values](#return-values) defined above on failure
**Python Example**
```Python
retval, enabled = dsl_ode_trigger_source_id_set('my-trigger', 0)
retval = dsl_ode_trigger_limit_set('my-trigger', 0)
```

<br>
Expand Down
51 changes: 48 additions & 3 deletions docs/api-osd.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Once added to a Pipeline or Branch, an OSD must be removed before it can be used
* [dsl_osd_new](#dsl_osd_new)

**Methods:**
* [dsl_osd_text_enabled_get](#dsl_osd_text_enabled_get)
* [dsl_osd_text_enabled_set](#dsl_osd_text_enabled_set)
* [dsl_osd_clock_enabled_get](#dsl_osd_clock_enabled_get)
* [dsl_osd_clock_enabled_set](#dsl_osd_clock_enabled_set)
* [dsl_osd_clock_offsets_get](#dsl_osd_clock_offsets_get)
Expand Down Expand Up @@ -48,25 +50,68 @@ The following return codes are used by the On-Screen Display API
## Constructors
### *dsl_osd_new*
```c++
DslReturnType dsl_osd_new(const wchar_t* name, boolean clock_enabled);
DslReturnType dsl_osd_new(const wchar_t* name,
boolean text_enabled, boolean clock_enabled);
```
The constructor creates a uniquely named On-Screen Display with an optional clock. Construction will fail if the name is currently in use.
**Parameters**
* `name` - [in] unique name for the On-Screen Display to create.
* `text_enable` - [in] set to true to enable On-Screen object text - class label and tracking number - false otherwise
* `clock_enable` - [in] set to true to enable On-Screen clock, false otherwise
**Returns**
* `DSL_RESULT_SUCCESS` on successful creation. One of the [Return Values](#return-values) defined above on failure
**Python Example**
```Python
retval = dsl_osd_new('my-on-screen-display', True)
retval = dsl_osd_new('my-on-screen-display', True, True)
```

<br>

## Methods
### *dsl_osd_text_enabled_get*
```c++
DslReturnType dsl_osd_text_enabled_get(const wchar_t* name, boolean* enabled);
```
This service returns the current object text enabled setting for the named On-Screen Display
**Parameters**
* `name` - [in] unique name of the On-Screen Display to query.
* `enabled` - [out] true if the On-Screen object text - class label and tracking number - is currently enabled, false otherwise
**Returns**
* `DSL_RESULT_SUCCESS` on successful query. One of the [Return Values](#return-values) defined above on failure
**Python Example**
```Python
retval, enabled = dsl_osd_text_enabled_get('my-on-screen-display')
```

<br>

### *dsl_osd_text_enabled_set*
```c++
DslReturnType dsl_osd_text_enabled_set(const wchar_t* name, boolean enabled);
```
This service sets the current clock enabled setting for the named On-Screen Display
**Parameters**
* `name` - [in] unique name of the On-Screen Display to query.
* `enable` - [in] set to true to enable On-Screen object text - class label and tracking number - false otherwise
**Returns**
* `DSL_RESULT_SUCCESS` on successful update. One of the [Return Values](#return-values) defined above on failure
**Python Example**
```Python
retval = dsl_osd_text_enabled_set('my-on-screen-display', False)
```

<br>

### *dsl_osd_clock_enabled_get*
```c++
DslReturnType dsl_osd_clock_enabled_get(const wchar_t* name, boolean* enabled);
Expand Down Expand Up @@ -98,7 +143,7 @@ This service sets the current clock enabled setting for the named On-Screen Disp
* `enabled` - [in] set to true to enable the On-Screen clock, false otherwise
**Returns**
* `DSL_RESULT_SUCCESS` on successful query. One of the [Return Values](#return-values) defined above on failure
* `DSL_RESULT_SUCCESS` on successful update. One of the [Return Values](#return-values) defined above on failure
**Python Example**
```Python
Expand Down
85 changes: 85 additions & 0 deletions docs/api-sink.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ The maximum number of in-use Sinks is set to `DSL_DEFAULT_SINK_IN_USE_MAX` on DS
* [dsl_sink_window_dimensions_get](#dsl_sink_window_dimensions_get)
* [dsl_sink_window_dimensions_set](#dsl_sink_window_dimensions_set)
* [dsl_sink_record_session_start](#dsl_sink_record_session_start)
* [dsl_sink_record_session_stop](#dsl_sink_record_session_stop)
* [dsl_sink_record_outdir_get](#dsl_sink_record_outdir_get)
* [dsl_sink_record_outdir_set](#dsl_sink_record_outdir_set)
* [dsl_sink_record_container_get](#dsl_sink_record_container_get)
* [dsl_sink_record_container_set](#dsl_sink_record_container_set)
* [dsl_sink_record_cache_size_get](#dsl_sink_record_cache_size_get)
* [dsl_sink_record_cache_size_set](#dsl_sink_record_cache_size_set)
* [dsl_sink_record_dimensions_get](#dsl_sink_record_dimensions_get)
Expand Down Expand Up @@ -487,6 +492,86 @@ retval = dsl_sink_record_session_stop('my-record-sink', current_session)

<br>

### *dsl_sink_record_outdir_get*
```C++
DslReturnType dsl_sink_record_outdir_get(const wchar_t* name, const wchar_t** outdir);
```
This service returns the video recording output directory.
**Parameters**
* `name` [in] name of the Record Sink to query
* `outdir` - [out] absolute pathspec for the directory to save the recorded video streams.
**Returns**
* `DSL_RESULT_SUCCESS` on successful Query. One of the [Return Values](#return-values) defined above on failure
**Python Example**
```Python
retval, outdir = dsl_sink_record_outdir_get('my-record-sink')
```

<br>

### *dsl_sink_record_outdir_set*
```C++
DslReturnType dsl_sink_record_outdir_set(const wchar_t* name, const wchar_t* outdir);
```
This service sets the video recording output directory.
**Parameters**
* `name` [in] name of the Record Sink to update
* `outdir` - [in] absolute or relative pathspec for the directory to save the recorded video streams.
**Returns**
* `DSL_RESULT_SUCCESS` on successful update. One of the [Return Values](#return-values) defined above on failure
**Python Example**
```Python
retval = dsl_sink_record_outdir_set('my-record-sink', './recordings')
```

<br>

### *dsl_sink_record_container_get*
```C++
DslReturnType dsl_sink_record_container_get(const wchar_t* name, uint* container);
```
This service returns the media container type used when recording.
**Parameters**
* `name` [in] name of the Record Sink to query
* `container` - [out] one of the [Video Container Types](#video-container-types) defined above
**Returns**
* `DSL_RESULT_SUCCESS` on successful Query. One of the [Return Values](#return-values) defined above on failure
**Python Example**
```Python
retval, container_type = dsl_sink_record_container_get('my-record-sink')
```

<br>

### *dsl_sink_record_container_set*
```C++
DslReturnType dsl_sink_record_container_set(const wchar_t* name, uint container);
```
This service sets the media container type to use when recording.
**Parameters**
* `name` [in] name of the Record Sink to update
* `container` - [in] on of the [Video Container Types](#video-container-types) defined above
**Returns**
* `DSL_RESULT_SUCCESS` on successful update. One of the [Return Values](#return-values) defined above on failure
**Python Example**
```Python
retval = dsl_sink_record_container_set('my-record-sink', DSL_CONTAINER_MP4)
```

<br>

### *dsl_sink_record_cache_size_get*
```C++
DslReturnType dsl_sink_record_cache_size_get(const wchar_t* name, uint* cache_size);
Expand Down
Loading

0 comments on commit 5f25f1f

Please sign in to comment.