Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
mdhelp: add action prop doc for stream filters
  • Loading branch information
Mark Clarkstone authored and perexg committed May 11, 2016
1 parent e45daba commit 378f312
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/property/action.md
@@ -0,0 +1,10 @@
:

Action | Description
--------------------|------------
**NONE** | No action, may be used for the logging and a comparison verification.
**USE** | Use this elementary stream.
**ONE\_TIME** | Use this elementary stream only one time per service type (like video, audio, subtitles) and language. The first sucessfully compared rule wins. For example, when one AC3 elementary stream is marked to be used with ‘eng’ language and another rule with the ONE\_TIME action was matched, the new AC3 elementary stream will not be added if the language for new AC3 elementary stream is ‘eng’. Note that the second rule might not have the language filter (column) set. For the CA filter, this rule means that the new CA elementary stream is added only if another CA is not already used.
**EXCLUSIVE** | Use only this elementary stream. No other elementary streams will be used.
**EMPTY** | Add this elementary stream only when no elementary streams are used from previous rules.
**IGNORE** | Ignore this elementary stream. This stream is not used. Another successfully compared rule with different action may override it.
13 changes: 13 additions & 0 deletions src/esfilter.c
Expand Up @@ -592,6 +592,7 @@ esfilter_class_action_enum(void *o, const char *lang)
}

CLASS_DOC(filters)
PROP_DOC(action)

const idclass_t esfilter_class = {
.ic_class = "esfilter",
Expand Down Expand Up @@ -701,6 +702,8 @@ const idclass_t esfilter_class_video = {
.get = esfilter_class_action_get,
.set = esfilter_class_action_set,
.list = esfilter_class_action_enum,
.opts = PO_DOC_NLIST,
.doc = prop_doc_action,
},
{
.type = PT_BOOL,
Expand Down Expand Up @@ -794,6 +797,8 @@ const idclass_t esfilter_class_audio = {
.get = esfilter_class_action_get,
.set = esfilter_class_action_set,
.list = esfilter_class_action_enum,
.opts = PO_DOC_NLIST,
.doc = prop_doc_action,
},
{
.type = PT_BOOL,
Expand Down Expand Up @@ -887,6 +892,8 @@ const idclass_t esfilter_class_teletext = {
.get = esfilter_class_action_get,
.set = esfilter_class_action_set,
.list = esfilter_class_action_enum,
.opts = PO_DOC_NLIST,
.doc = prop_doc_action,
},
{
.type = PT_BOOL,
Expand Down Expand Up @@ -980,6 +987,8 @@ const idclass_t esfilter_class_subtit = {
.get = esfilter_class_action_get,
.set = esfilter_class_action_set,
.list = esfilter_class_action_enum,
.opts = PO_DOC_NLIST,
.doc = prop_doc_action,
},
{
.type = PT_BOOL,
Expand Down Expand Up @@ -1083,6 +1092,8 @@ const idclass_t esfilter_class_ca = {
.get = esfilter_class_action_get,
.set = esfilter_class_action_set,
.list = esfilter_class_action_enum,
.opts = PO_DOC_NLIST,
.doc = prop_doc_action,
},
{
.type = PT_BOOL,
Expand Down Expand Up @@ -1163,6 +1174,8 @@ const idclass_t esfilter_class_other = {
.get = esfilter_class_action_get,
.set = esfilter_class_action_set,
.list = esfilter_class_action_enum,
.opts = PO_DOC_NLIST,
.doc = prop_doc_action,
},
{
.type = PT_BOOL,
Expand Down

0 comments on commit 378f312

Please sign in to comment.