Documentation:Modules/rss

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> { 0x000000, 0x808080, 0xC0C0C0, 0xFFFFFF, 0x800000, 0xFF0000, 0xFF00FF, 0xFFFF00, 0x808000, 0x008000, 0x008080, 0x00FF00, 0x800080, 0x000080, 0x0000FF, 0x00FFFF } : 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

• modules/spu/rss.c

See also

• Documentation:Modules/marq

Appendix

For --rss-color:

Colour key

Sample	Hex code	Colour
	0x000000	Black
	0x808080	Gray
	0xC0C0C0	Silver
	0xFFFFFF	White
	0x800000	Maroon
	0xFF0000	Red
	0xFF00FF	Fuchsia
	0xFFFF00	Yellow
	0x808000	Olive
	0x008000	Green
	0x008080	Teal
	0x00FF00	Lime
	0x800080	Purple
	0x000080	Navy
	0x0000FF	Blue
	0x00FFFF	Aqua

For --rss-position:

Integer alignment mapping

Integer	Alignment	Comment
0	Center
1	Left
2	Right
4	Top
8	Bottom
5	Top-Left	4 + 1
6	Top-Right	4 + 2
9	Bottom-Left	8 + 1
10	Bottom-Right	8 + 2
3	n/a	contradictory
7	n/a	contradictory

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.