]> git.ipfire.org Git - thirdparty/tvheadend.git/commitdiff
mdhelp: add action prop doc for stream filters
authorMark Clarkstone <hello@markclarkstone.co.uk>
Wed, 11 May 2016 08:46:45 +0000 (09:46 +0100)
committerJaroslav Kysela <perex@perex.cz>
Wed, 11 May 2016 19:09:23 +0000 (21:09 +0200)
docs/property/action.md [new file with mode: 0644]
src/esfilter.c

diff --git a/docs/property/action.md b/docs/property/action.md
new file mode 100644 (file)
index 0000000..a084b36
--- /dev/null
@@ -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.
index f7bd67c5f30943766c2eebf28edbf9d600ca34ff..0c61a8851d5639322747ccbee9abb0a8939f451e 100644 (file)
@@ -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",
@@ -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,
@@ -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,
@@ -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,
@@ -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,
@@ -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,
@@ -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,