Difference between revisions of "Documentation:Modules/rss"

From VideoLAN Wiki
Jump to navigation Jump to search
(Expand, copy-edit, redact false information, remove old notes, remove {{Stub}}, GPL)
Line 1: Line 1:
−
{{Module|name=rss|type=Video subfilter|first_version=0.8.4|description=Overlays RSS and Atom feeds on the video}}
+
{{Module|name=rss|type=Video sub-filter|first_version=0.8.4|description=Overlays [[wikipedia:RSS|RSS]] and [[wikipedia:Atom (Web standard)|Atom]] feeds on the video|sc=rss|sc2=atom}}
  
 
== Options ==
 
== Options ==
−
 
 
{{Option
 
{{Option
 
|name=rss-urls
 
|name=rss-urls
 
|value=string
 
|value=string
−
|default=""
+
|default=NULL
−
|description=Pipe <nowiki>'|'</nowiki> seperated list of RSS and/or Atom feed URLs
+
|description=Pipe <code>'''{{!}}'''</code> separated list of [[wikipedia:RSS|RSS]] and/or [[wikipedia:Atom (Web standard)|Atom]] feed URLs
 
}}
 
}}
  
 +
=== Position ===
 
{{Option
 
{{Option
 
|name=rss-x
 
|name=rss-x
 
|value=integer
 
|value=integer
−
|default=0 (0.8.6d and prior: -1)
+
|default=0
−
|description=X offset from upper left corner. (0.8.6d and prior: This is only if both rss-x and rss-y are positive)
+
|description=X offset, from the left screen edge
 
}}
 
}}
 
{{Option
 
{{Option
Line 20: Line 20:
 
|value=integer
 
|value=integer
 
|default=0
 
|default=0
−
|description=Y offset from upper left corner. (0.8.6d and prior: This is only if both rss-x and rss-y are positive)
+
|description=Y offset, down from the top
 
}}
 
}}
 
{{Option
 
{{Option
 
|name=rss-position
 
|name=rss-position
 
|value=integer
 
|value=integer
−
|default=5
+
|select={0, 1, 2, 4, 8, 5, 6, 9, 10}
−
|description=Feed position: 0=center, 1=left, 2=right, 4=top, 8=bottom, you can also use combinations of these values, eg 6 = top-right. (0.8.6d and prior: This is only used if rss-x or rss-y are negative)
+
|default=-1
 +
|description=You can enforce the text position on the video (0=center, 1=left, 2=right, 4=top, 8=bottom; you can also use combinations of these values, eg 6 = top-right)
 
}}
 
}}
  
 +
=== Font ===
 
{{Option
 
{{Option
 
|name=rss-opacity
 
|name=rss-opacity
 
|value=integer
 
|value=integer
 +
|min=0
 
|default=255
 
|default=255
−
|description=Feed opacity. 0 is transparent, 255 is fully opaque
+
|max=255
 +
|description=Opacity (inverse of transparency) of overlay text. 0 = transparent, 255 = totally opaque
 
}}
 
}}
 
{{Option
 
{{Option
−
|name=rss-color
+
|name=rss-color<span id="key_rss-color"></span>
 
|value=integer
 
|value=integer
−
|default=16777215 (0xFFFFFF, white)
+
|select={0x00000000, 0x00808080, 0x00C0C0C0, 0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00, 0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080, 0x00000080, 0x000000FF, 0x0000FFFF}
−
|description=Feed text color. Use the decimal value of the HTML color code
+
|default=0xFFFFFF
 +
|description=Color<sup>('''[[#appendix_key_rss-color|key]]''')</sup> of the text that will be rendered on the video. This must be an hexadecimal (like HTML colors). The first two chars are for red, then green, then blue
 
}}
 
}}
 
{{Option
 
{{Option
 
|name=rss-size
 
|name=rss-size
 
|value=integer
 
|value=integer
−
|default=-1
+
|min=0
−
|description=Font size in pixels. -1 uses the default font size
+
|default=0
 +
|max=4096
 +
|description=Font size, in pixels. Default is 0 (use default font size)
 
}}
 
}}
  
 +
=== Misc ===
 
{{Option
 
{{Option
 
|name=rss-speed
 
|name=rss-speed
 
|value=integer
 
|value=integer
 
|default=100000
 
|default=100000
−
|description=Speed in characters by µs
+
|description=Speed of the RSS/Atom feeds in [[wiktionary:&micro;s|&micro;s]] (bigger is slower)
 
}}
 
}}
 
{{Option
 
{{Option
Line 58: Line 66:
 
|value=integer
 
|value=integer
 
|default=60
 
|default=60
−
|description=Maximum number of characters to display
+
|description=Maximum number of characters displayed on the screen
 
}}
 
}}
 
{{Option
 
{{Option
Line 64: Line 72:
 
|value=integer
 
|value=integer
 
|default=1800
 
|default=1800
−
|description=Time in seconds between each feed refresh
+
|description=Time in seconds between each feed refresh of the feeds. 0 means that the feeds are never updated. 1800 seconds is 30 minutes
 
}}
 
}}
 
{{Option
 
{{Option
 
|name=rss-images
 
|name=rss-images
 +
|value=boolean
 
|default=enabled
 
|default=enabled
−
|description=Display the feed's image if available
+
|description=Display feed images if available
 
}}
 
}}
 
{{Option
 
{{Option
 
|name=rss-title
 
|name=rss-title
 
|value=integer
 
|value=integer
−
|default=-1
+
|select={<var>default_title</var>, <var>hide_title</var>, <var>prepend_title</var>, <var>scroll_title</var>}
−
|description=-1 for default, 0 to hide the feed's title, 1 to always show it and 2 to make it scroll
+
|default=<var>default_title</var>
 +
|description=Title display mode. 0 is hidden if the feed has an image and feed images are enabled, 1 is always visible, 2 is scroll with feed
 
}}
 
}}
  
 
== Examples ==
 
== Examples ==
 +
Example command line use '''(VLC 0.9.0 and above)''': (untested with 3.x.x)
 +
% '''vlc somevideo.avi --sub-filter=rss --rss-urls="http://news.google.com/news?ned=us&topic=h&output=rss"'''
  
−
Example command line use '''(VLC 0.9.0 and above)''':
+
== Source code ==
−
% '''vlc somevideo.avi --sub-filter=rss --rss-urls="http://news.google.com/news?ned=us&topic=h&output=rss"'''
+
* {{VLCSourceFile|modules/spu/rss.c}}
  
 
== See also ==
 
== See also ==
 
* [[Documentation:Modules/marq]]
 
* [[Documentation:Modules/marq]]
  
−
{{Stub}}
+
== Appendix ==
 +
<span id="appendix_key_rss-color"></span>
 +
{| class="mw-datatable"
 +
|+ Colour key for [[#key_rss-color|--rss-color]]
 +
! scope="col" | Sample !! scope="col" | Hex code !! scope="col" | Colour
 +
|-
 +
|style="background-color:black;"| || <code>0x00000000</code> || Black
 +
|-
 +
|style="background-color:gray;"| || <code>0x00808080</code> || Gray
 +
|-
 +
|style="background-color:silver;"| || <code>0x00C0C0C0</code> || Silver
 +
|-
 +
|style="background-color:white;"| || <code>0x00FFFFFF</code> || White
 +
|-
 +
|style="background-color:maroon;"| || <code>0x00800000</code> || Maroon
 +
|-
 +
|style="background-color:red;"| || <code>0x00FF0000</code> || Red
 +
|-
 +
|style="background-color:fuchsia;"| || <code>0x00FF00FF</code> || Fuchsia
 +
|-
 +
|style="background-color:yellow;"| || <code>0x00FFFF00</code> || Yellow
 +
|-
 +
|style="background-color:olive;"| || <code>0x00808000</code> || Olive
 +
|-
 +
|style="background-color:green;"| || <code>0x00008000</code> || Green
 +
|-
 +
|style="background-color:teal;"| || <code>0x00008080</code> || Teal
 +
|-
 +
|style="background-color:lime;"| || <code>0x0000FF00</code> || Lime
 +
|-
 +
|style="background-color:purple;"| || <code>0x00800080</code> || Purple
 +
|-
 +
|style="background-color:navy;"| || <code>0x00000080</code> || Navy
 +
|-
 +
|style="background-color:blue;"| || <code>0x000000FF</code> || Blue
 +
|-
 +
|style="background-color:aqua;"| || <code>0x0000FFFF</code> || Aqua
 +
|}
  
−
{{Documentation footer}}
+
{{Documentation}}

Revision as of 21:49, 21 May 2019

Module: rss
Type Video sub-filter
First VLC version 0.8.4
Last VLC version -
Operating system(s) all
Description Overlays RSS and Atom feeds on the video
Shortcut(s) rss, atom

Options

  • rss-urls <string> : Pipe | separated list of RSS and/or Atom feed URLs default value: NULL

Position

  • rss-x <integer> : X offset, from the left screen edge default value: 0
  • rss-y <integer> : Y offset, down from the top default value: 0
  • rss-position <integer> {0, 1, 2, 4, 8, 5, 6, 9, 10} : You can enforce the text position on the video (0=center, 1=left, 2=right, 4=top, 8=bottom; you can also use combinations of these values, eg 6 = top-right) default value: -1

Font

  • rss-opacity <integer [0 .. 255]> : Opacity (inverse of transparency) of overlay text. 0 = transparent, 255 = totally opaque default value: 255
  • rss-color <integer> {0x00000000, 0x00808080, 0x00C0C0C0, 0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00, 0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080, 0x00000080, 0x000000FF, 0x0000FFFF} : Color(key) of the text that will be rendered on the video. This must be an hexadecimal (like HTML colors). The first two chars are for red, then green, then blue default value: 0xFFFFFF
  • rss-size <integer [0 .. 4096]> : Font size, in pixels. Default is 0 (use default font size) default value: 0

Misc

  • rss-speed <integer> : Speed of the RSS/Atom feeds in µs (bigger is slower) default value: 100000
  • rss-length <integer> : Maximum number of characters displayed on the screen default value: 60
  • rss-ttl <integer> : Time in seconds between each feed refresh of the feeds. 0 means that the feeds are never updated. 1800 seconds is 30 minutes default value: 1800
  • rss-images <boolean> : Display feed images if available default value: enabled
  • rss-title <integer> {default_title, hide_title, prepend_title, scroll_title} : Title display mode. 0 is hidden if the feed has an image and feed images are enabled, 1 is always visible, 2 is scroll with feed default value: default_title

Examples

Example command line use (VLC 0.9.0 and above): (untested with 3.x.x) 

% vlc somevideo.avi --sub-filter=rss --rss-urls="http://news.google.com/news?ned=us&topic=h&output=rss"

Source code

See also

Appendix

Colour key for --rss-color
Sample Hex code Colour
0x00000000 Black
0x00808080 Gray
0x00C0C0C0 Silver
0x00FFFFFF White
0x00800000 Maroon
0x00FF0000 Red
0x00FF00FF Fuchsia
0x00FFFF00 Yellow
0x00808000 Olive
0x00008000 Green
0x00008080 Teal
0x0000FF00 Lime
0x00800080 Purple
0x00000080 Navy
0x000000FF Blue
0x0000FFFF Aqua
This page is part of official VLC media player Documentation (User Guide • Streaming HowTo • Hacker Guide • Modules)
Please read the Documentation Editing Guidelines before you edit the documentation
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
Retrieved from "https://wiki.videolan.org/index.php?title=Documentation:Modules/rss&oldid=61517"