Difference between revisions of "Documentation:Modules/shout"

From VideoLAN Wiki
Jump to navigation Jump to search
(Create page marked up/adapted from source code/changelog with code comments reproduced)
 
(Paraphrase my own work from Documentation:Modules/access_output_shout: I wrote about the same module twice)
 
(2 intermediate revisions by the same user not shown)
Line 3: Line 3:
  
 
== Access output ==
 
== Access output ==
−
{{Module|name=shout|type=Access output|first_version=0.8.4|description=This module forwards [[vorbis]] streams to an [[icecast]] server}}
+
{{Module|name=shout|type=Access output|first_version=0.8.4|description=This module forwards [[vorbis]] streams to an [[icecast]] server|sc=shout}}
−
 
 
−
This module has a shortcut of <code>shout</code>.
 
  
 
{{Clear}}
 
{{Clear}}
  
−
There is a comment at the start of the module code (4.0.0-dev):
+
Documentation is present directly in the source code (4.0.0-dev) as multiple C comment blocks, relevant comments reproduced here (copyright © 2005 VLC authors and VideoLAN, Authors: Daniel Fischer and Derk-Jan Hartman, LGPL 2.1 or later):
 
  /*****************************************************************************
 
  /*****************************************************************************
 
   * Some Comments:
 
   * Some Comments:
Line 24: Line 22:
 
   *
 
   *
 
   *****************************************************************************/
 
   *****************************************************************************/
 +
v4l refers to [[GNU/Linux]] Video4Linux and won't work for Windows users.
 +
 
This comment precedes the genre option:
 
This comment precedes the genre option:
 
  /* To be listed properly as a public stream on the Yellow Pages of shoutcast/icecast
 
  /* To be listed properly as a public stream on the Yellow Pages of shoutcast/icecast
Line 97: Line 97:
  
 
== Services discovery ==
 
== Services discovery ==
−
{{Module|name=shout|type=Services discovery|first_version=0.8.2|last_version=1.0.6|description=Shoutcast services discovery module}}
+
{{Module|name=shout|type=Services discovery|first_version=0.8.2|last_version=1.0.6|description=Shoutcast services discovery module|sc=shoutcast|sc2=shout}}
  
−
This module had a shortcut of <code>shoutcast</code> and later an additional shortcut of <code>shout</code>. The three sub-modules had shortcuts of <code>shoutcasttv</code>, <code>frenchtv</code> and <code>freebox</code>.
+
Three sub-modules had shortcuts of <code>shoutcasttv</code>, <code>frenchtv</code> and <code>freebox</code>.
  
 
=== Options ===
 
=== Options ===
 
None (<code>--shoutcast-limit</code> was deprecated with {{Commitdiff|p=vlc/vlc-1.0.git|acb5da732a27b6c7e8d6e05c2e183d4ae49a9ea9}}).
 
None (<code>--shoutcast-limit</code> was deprecated with {{Commitdiff|p=vlc/vlc-1.0.git|acb5da732a27b6c7e8d6e05c2e183d4ae49a9ea9}}).
 +
{{Clear}}
  
 +
=== shout-winamp ===
 +
This sub-module had the shortcut <code>shout-winamp</code> with description "New winamp 5.2 shoutcast import". It is scheduled [https://git.videolan.org/?p=vlc.git;a=commitdiff;h=d3859f364921c6f4d48115da331ac3a44d7a6351 to be removed] (currently in 4.0.0-dev) with the note:
 +
<pre>
 +
Removes the long unused Winamp/SHOUTcast directory stream filter for
 +
playlist handling, which was mostly useful together with the service
 +
discovery (modules/services_discovery/shout.c) which is not present
 +
anymore.
 +
</pre>
 +
History:
 +
* [https://git.videolan.org/?p=vlc.git;a=commit;h=acb5da732a27b6c7e8d6e05c2e183d4ae49a9ea9 &#x5B;acb5da732a27b6c7e8d6e05c2e183d4ae49a9ea9&#x5D;] (introduction)
 +
* {{VLCSourceFile|p=vlc/vlc-0.8.git|modules/demux/playlist/shoutcast.c}}
 +
* {{VLCSourceFile|p=vlc/vlc-0.9.git|modules/demux/playlist/shoutcast.c}}
 +
* {{VLCSourceFile|p=vlc/vlc-1.0.git|modules/demux/playlist/shoutcast.c}}
 +
* {{VLCSourceFile|p=vlc/vlc-1.1.git|modules/demux/playlist/shoutcast.c}}
 +
* {{VLCSourceFile|p=vlc/vlc-2.0.git|modules/demux/playlist/shoutcast.c}}
 +
* {{VLCSourceFile|p=vlc/vlc-2.1.git|modules/demux/playlist/shoutcast.c}}
 +
* {{VLCSourceFile|p=vlc/vlc-2.2.git|modules/demux/playlist/shoutcast.c}}
 +
* {{VLCSourceFile|p=vlc/vlc-3.0.git|modules/demux/playlist/shoutcast.c}}
 +
* [https://git.videolan.org/?p=vlc.git;a=commit;h=d3859f364921c6f4d48115da331ac3a44d7a6351 &#x5B;d3859f364921c6f4d48115da331ac3a44d7a6351&#x5D;] (removal)
 
{{Clear}}
 
{{Clear}}
 +
 
== Source code ==
 
== Source code ==
 
* {{VLCSourceFile|modules/access_output/shout.c}}
 
* {{VLCSourceFile|modules/access_output/shout.c}}

Latest revision as of 22:33, 28 May 2019

The services discovery module was removed. The Access output module is current.

Access output

Module: shout
Type Access output
First VLC version 0.8.4
Last VLC version -
Operating system(s) all
Description This module forwards vorbis streams to an icecast server
Shortcut(s) shout

Documentation is present directly in the source code (4.0.0-dev) as multiple C comment blocks, relevant comments reproduced here (copyright © 2005 VLC authors and VideoLAN, Authors: Daniel Fischer and Derk-Jan Hartman, LGPL 2.1 or later): 

/*****************************************************************************
 * Some Comments:
 *
 * - this only works for ogg and/or mp3, and we don't check this yet.
 * - MP3 metadata is not passed along, since metadata is only available after
 *   this module is opened.
 *
 * Typical usage:
 *
 * vlc v4l:/dev/video:input=2:norm=pal:size=192x144 \
 * --sout '#transcode{vcodec=theora,vb=300,acodec=vorb,ab=96}\
 * :std{access=shout,mux=ogg,dst=localhost:8005}'
 *
 *****************************************************************************/

v4l refers to GNU/Linux Video4Linux and won't work for Windows users.

This comment precedes the genre option: 

/* To be listed properly as a public stream on the Yellow Pages of shoutcast/icecast
   the genres should match those used on the corresponding sites. Several examples
   are Alternative, Classical, Comedy, Country etc. */

This comment precedes the stream information options: 

/* The shout module only "transmits" data. It does not have direct access to
   "codec level" information. Stream information such as bitrate, samplerate,
   channel numbers and quality (in case of Ogg streaming) need to be set manually */

Options

  • sout-shout-name <string> : Name to give to this stream/channel on the shoutcast/icecast server default value: "VLC media player - Live stream"
  • sout-shout-description <string> : Description of the stream content or information about your channel default value: "Live stream from VLC media player"
  • sout-shout-mp3 <boolean> : You normally have to feed the shoutcast module with Ogg streams. It is also possible to stream MP3 instead, so you can forward MP3 streams to the shoutcast/icecast server default value: disabled
  • sout-shout-genre <string> : Genre of the content default value: "Alternative"
  • sout-shout-url <string> : URL with information about the stream or your channel default value: "http://www.videolan.org/vlc"
  • sout-shout-bitrate <string> : Bitrate information of the transcoded stream default value: ""
  • sout-shout-samplerate <string> : Samplerate information of the transcoded stream default value: ""
  • sout-shout-channels <string> : Number of channels information of the transcoded stream default value: ""
  • sout-shout-quality <string> : Ogg Vorbis Quality information of the transcoded stream default value: ""
  • sout-shout-public <boolean> : Make the server publicly available on the 'Yellow Pages' (directory listing of streams) on the icecast/shoutcast website. Requires the bitrate information specified for shoutcast. Requires Ogg streaming for icecast default value: disabled

Services discovery

Module: shout
Type Services discovery
First VLC version 0.8.2
Last VLC version 1.0.6
Operating system(s) all
Description Shoutcast services discovery module
Shortcut(s) shoutcast, shout

Three sub-modules had shortcuts of shoutcasttv, frenchtv and freebox.

Options

None (--shoutcast-limit was deprecated with [acb5da732a27b6c7e8d6e05c2e183d4ae49a9ea9]).

shout-winamp

This sub-module had the shortcut shout-winamp with description "New winamp 5.2 shoutcast import". It is scheduled to be removed (currently in 4.0.0-dev) with the note: 

Removes the long unused Winamp/SHOUTcast directory stream filter for
playlist handling, which was mostly useful together with the service
discovery (modules/services_discovery/shout.c) which is not present
anymore.

History:

Source code

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/shout&oldid=61631"