View source for Documentation:Modules/rss

{{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 ==
{{Option
|name=rss-urls
|value=string
|default=NULL
|description=Pipe <code>'''{{!}}'''</code> separated list of [[wikipedia:RSS|RSS]] and/or [[wikipedia:Atom (Web standard)|Atom]] feed URLs
}}

=== Position ===
{{Option
|name=rss-x
|value=integer
|default=0
|description=X offset, from the left screen edge
}}
{{Option
|name=rss-y
|value=integer
|default=0
|description=Y offset, down from the top
}}
{{Option
|name=rss-position<span id="rss-position"></span>
|value=integer
|select=[[#appendix_rss-position|{0, 1, 2, 4, 8, 5, 6, 9, 10}]]
|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
|name=rss-opacity
|value=integer
|min=0
|default=255
|max=255
|description=Opacity (inverse of transparency) of overlay text. 0 = transparent, 255 = totally opaque
}}
{{Option
|name=rss-color<span id="rss-color"></span>
|value=integer
|select={0x00000000, 0x00808080, 0x00C0C0C0, 0x00FFFFFF, 0x00800000, 0x00FF0000, 0x00FF00FF, 0x00FFFF00, 0x00808000, 0x00008000, 0x00008080, 0x0000FF00, 0x00800080, 0x00000080, 0x000000FF, 0x0000FFFF}
|default=0xFFFFFF
|description=Color<sup>('''[[#appendix_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
|name=rss-size
|value=integer
|min=0
|default=0
|max=4096
|description=Font size, in pixels. Default is 0 (use default font size)
}}

=== Misc ===
{{Option
|name=rss-speed
|value=integer
|default=100000
|description=Speed of the RSS/Atom feeds in [[wiktionary:&micro;s|&micro;s]] (bigger is slower)
}}
{{Option
|name=rss-length
|value=integer
|default=60
|description=Maximum number of characters displayed on the screen
}}
{{Option
|name=rss-ttl
|value=integer
|default=1800
|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
|name=rss-images
|value=boolean
|default=enabled
|description=Display feed images if available
}}
{{Option
|name=rss-title
|value=integer
|select={<var>default_title</var>, <var>hide_title</var>, <var>prepend_title</var>, <var>scroll_title</var>}
|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 ==
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 ==
* {{VLCSourceFile|modules/spu/rss.c}}

== See also ==
* [[Documentation:Modules/marq]]

== Appendix ==
<span id="appendix_rss-color"></span>
{| class="mw-datatable"
|+ Colour key for [[#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
|}
<span id="appendix_rss-position"></span>
For --[[#rss-position|rss-position]]:
{{Alignment mapping}}

{{Documentation}}