.\" Man page generated from reStructuredText.
.
.TH "LIVESTREAMER" "1" "May 03, 2015" "1.12.2" "Livestreamer"
.SH NAME
livestreamer \- extracts streams from various services and pipes them into a video player of choice
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH TUTORIAL
.sp
Livestreamer is command\-line application, this means the commands described
here should be typed into a terminal. On Windows this means you should open
the \fI\%command prompt\fP or \fI\%PowerShell\fP, on Mac OS X open the \fI\%Terminal\fP app
and if you\(aqre on Linux or BSD you probably already know the drill.
.sp
The way Livestreamer works is that it\(aqs only a means to extract and transport
the streams, and the playback is done by an external video player. Livestreamer
works best with \fI\%VLC\fP or \fI\%mpv\fP, which are also cross\-platform, but other players
may be compatible too, see the \fIPlayers\fP page for a complete overview.
.sp
Now to get into actually using Livestreamer, let\(aqs say you want to watch the
stream located on \fI\%http://twitch.tv/day9tv\fP, you start off by telling Livestreamer
where to attempt to extract streams from. This is done by giving the URL to the
command \fBlivestreamer\fP as the first argument:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ livestreamer twitch.tv/day9tv
[cli][info] Found matching plugin twitch for URL twitch.tv/day9tv
Available streams: audio, high, low, medium, mobile (worst), source (best)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
You don\(aqt need to include the protocol when dealing with HTTP URLs,
e.g. just \fBtwitch.tv/day9tv\fP is enough and quicker to type.
.UNINDENT
.UNINDENT
.sp
This command will tell Livestreamer to attempt to extract streams from the URL
specified, and if it\(aqs successful, print out a list of available streams to choose
from.
.sp
To select a stream and start playback, we simply add the stream name as a second
argument to the \fBlivestreamer\fP command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ livestreamer twitch.tv/day9tv source
[cli][info] Found matching plugin twitch for URL twitch.tv/day9tv
[cli][info] Opening stream: source (hls)
[cli][info] Starting player: vlc
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The stream you chose should now be playing in the player. It\(aqs a common use case
to just want start the highest quality stream and not be bothered with what it\(aqs
named. To do this just specify \fBbest\fP as the stream name and Livestreamer will
attempt to rank the streams and open the one of highest quality. You can also
specify \fBworst\fP to get the lowest quality.
.sp
Now that you have a basic grasp of how Livestreamer works, you may want to look
into customizing it to your own needs, such as:
.INDENT 0.0
.IP \(bu 2
Creating a \fI\%configuration file\fP of options you
want to use
.IP \(bu 2
Setting up your player to \fIcache some data\fP
before playing the stream to help avoiding buffering issues
.UNINDENT
.SH CONFIGURATION FILE
.sp
Writing the command\-line options every time is inconvenient, that\(aqs why Livestreamer
is capable of reading options from a configuration file instead.
.sp
Livestreamer will look for config files in different locations depending on
your platform:
.TS
center;
|l|l|.
_
T{
Platform
T}	T{
Location
T}
_
T{
Unix\-like (POSIX)
T}	T{
.INDENT 0.0
.IP \(bu 2
$XDG_CONFIG_HOME/livestreamer/config
.IP \(bu 2
~/.livestreamerrc
.UNINDENT
T}
_
T{
Windows
T}	T{
%APPDATA%\elivestreamer\elivestreamerrc
T}
_
.TE
.sp
You can also specify the location yourself using the \fI\%\-\-config\fP option.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fI$XDG_CONFIG_HOME\fP is \fB~/.config\fP if it has not been overridden
.IP \(bu 2
\fI%APPDATA%\fP is usually \fB<your user directory>\eApplication Data\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
On Windows there is a default config created by the installer but on any
other platform you must create the file yourself.
.UNINDENT
.UNINDENT
.SS Syntax
.sp
The config file is a simple text file and should contain one
\fI\%command\-line option\fP (omitting the dashes) per
line in the format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
option=value
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or for a option without value:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
option
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Any quotes used will be part of the value, so only use when the value needs them,
e.g. specifiying a player with a path containing spaces.
.UNINDENT
.UNINDENT
.SS Example
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Player options
player=mpv \-\-cache 2048
player\-no\-close

# Authenticate with Twitch
twitch\-oauth\-token=mytoken
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PLUGIN SPECIFIC CONFIGURATION FILE
.sp
You may want to use specific options for some plugins only. This
can be accomplished by placing those settings inside a plugin specific
config file. Options inside these config files will override the main
config file when a URL matching the plugin is used.
.sp
Livestreamer expects this config to be named like the main config but
with \fB\&.<plugin name>\fP attached to the end.
.SS Examples
.TS
center;
|l|l|.
_
T{
Platform
T}	T{
Location
T}
_
T{
Unix\-like (POSIX)
T}	T{
.INDENT 0.0
.IP \(bu 2
$XDG_CONFIG_HOME/livestreamer/config\fB\&.twitch\fP
.IP \(bu 2
~/.livestreamerrc\fB\&.ustreamtv\fP
.UNINDENT
T}
_
T{
Windows
T}	T{
%APPDATA%\elivestreamer\elivestreamerrc\fB\&.youtube\fP
T}
_
.TE
.sp
Have a look at the \fIlist of plugins\fP to see
the name of each built\-in plugin.
.SH PLUGIN SPECIFIC USAGE
.SS Authenticating with Twitch
.sp
It\(aqs possible to access subscription content on Twitch by giving Livestreamer
access to your account.
.sp
Authentication is done by creating an OAuth token that Livestreamer will
use to access your account. It\(aqs done like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ livestreamer \-\-twitch\-oauth\-authenticate
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will open a web browser where Twitch will ask you if you want to give
Livestreamer permission to access your account, then forwards you to a page
with further instructions on how to use it.
.SS Authenticating with Crunchyroll
.sp
Crunchyroll requires authenticating with a premium account to access some of
their content. To do so, the plugin provides a couple of options to input your
information, \fI\%\-\-crunchyroll\-username\fP and \fI\%\-\-crunchyroll\-password\fP\&.
.sp
You can login like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ livestreamer \-\-crunchyroll\-username=xxxx \-\-crunchyroll\-password=xxx http://crunchyroll.com/a\-crunchyroll\-episode\-link
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If you omit the password, livestreamer will ask for it.
.UNINDENT
.UNINDENT
.sp
Once logged in, the plugin makes sure to save the session credentials to avoid
asking your username and password again.
.sp
Neverthless, these credentials are valid for a limited amount of time, so it
might be a good idea to save your username and password in your
\fI\%configuration file\fP anyway.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
The API this plugin uses isn\(aqt supposed to be available to use it on
computers. The plugin tries to blend in as a valid device using custom
headers and following the API usual flow (e.g. reusing credentials), but
this does not assure that your account will be safe from being spotted for
unusual behavior.
.UNINDENT
.UNINDENT
.SS HTTP proxy with Crunchyroll
.sp
You can use the \fI\%\-\-http\-proxy\fP \fBand\fP \fI\%\-\-https\-proxy\fP
options (you need both since the plugin uses both protocols) to access the
Crunchyroll servers through a proxy to be able to stream region locked content.
.sp
When doing this, it\(aqs very probable that you will get denied to access the
stream; this occurs because the session and credentials used by the plugin
where obtained when logged from your own region, and the server still assumes
you\(aqre in that region.
.sp
For this, the plugin provides the \fI\%\-\-crunchyroll\-purge\-credentials\fP
option, which removes your saved session and credentials and tries to log
in again using your username and password.
.SH SIDELOADING PLUGINS
.sp
Livestreamer will attempt to load standalone plugins from these directories:
.TS
center;
|l|l|.
_
T{
Platform
T}	T{
Location
T}
_
T{
Unix\-like (POSIX)
T}	T{
$XDG_CONFIG_HOME/livestreamer/plugins
T}
_
T{
Windows
T}	T{
%APPDATA%\elivestreamer\eplugins
T}
_
.TE
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
If a plugin is added with the same name as a built\-in plugin then
the added plugin will take precedence. This is useful if you want
to upgrade plugins independently of the Livestreamer version.
.UNINDENT
.UNINDENT
.SH PLAYING BUILT-IN STREAMING PROTOCOLS DIRECTLY
.sp
There are many types of streaming protocols used by services today and
Livestreamer supports most of them. It\(aqs possible to tell Livestreamer
to access a streaming protocol directly instead of relying on a plugin
to extract the streams from a URL for you.
.sp
A protocol can be accessed directly by specifying it in the URL format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
protocol://path [key=value]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Accessing a stream that requires extra parameters to be passed along
(e.g. RTMP):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ livestreamer "rtmp://streaming.server.net/playpath live=1 swfVfy=http://server.net/flashplayer.swf"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Most streaming technologies simply requires you to pass a HTTP URL, this is
a Adobe HDS stream:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ livestreamer hds://streaming.server.net/playpath/manifest.f4m
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Supported streaming protocols
.TS
center;
|l|l|.
_
T{
Name
T}	T{
Prefix
T}
_
T{
Adobe HTTP Dynamic Streaming
T}	T{
hds://
T}
_
T{
Akamai HD Adaptive Streaming
T}	T{
akamaihd://
T}
_
T{
Apple HTTP Live Streaming
T}	T{
hls:// hlsvariant://
T}
_
T{
Real Time Messaging Protocol
T}	T{
rtmp:// rtmpe:// rtmps:// rtmpt:// rtmpte://
T}
_
T{
Progressive HTTP, HTTPS, etc
T}	T{
httpstream://
T}
_
.TE
.SH COMMAND-LINE USAGE
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ livestreamer [OPTIONS] [URL] [STREAM]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Positional arguments
.INDENT 0.0
.TP
.B [URL]
A URL to attempt to extract streams from.
.sp
If it\(aqs a HTTP URL then "\fI\%http://\fP" can be omitted.
.UNINDENT
.INDENT 0.0
.TP
.B [STREAM]
Stream to play.
.sp
Use "best" or "worst" for highest or lowest quality available.
.sp
Fallback streams can be specified by using a comma\-separated list:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
"720p,480p,best"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If no stream is specified and \fI\%\-\-default\-stream\fP is not used then a
list of available streams will be printed.
.UNINDENT
.SS General options
.INDENT 0.0
.TP
.B \-h, \-\-help
Show this help message and exit.
.UNINDENT
.INDENT 0.0
.TP
.B \-V, \-\-version
Show version number and exit.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-plugins
Print a list of all currently installed plugins.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-can\-handle\-url URL
Check if Livestreamer has a plugin that can handle the specified URL.
.sp
Returns status code 1 for false and 0 for true.
.sp
Useful for external scripting.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-config FILENAME
Load options from this config file.
.sp
Can be repeated to load multiple files, in which case
the options are merged on top of each other where the
last config has highest priority.
.UNINDENT
.INDENT 0.0
.TP
.B \-l LEVEL, \-\-loglevel LEVEL
Set the log message threshold.
.sp
Valid levels are: none, error, warning, info, debug
.UNINDENT
.INDENT 0.0
.TP
.B \-Q, \-\-quiet
Hide all log output.
.sp
Alias for "\fI\%\-\-loglevel\fP none".
.UNINDENT
.INDENT 0.0
.TP
.B \-j, \-\-json
Output JSON representations instead of the normal text output.
.sp
Useful for external scripting.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-version\-check
Unused, kept for compatibility reasons.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-version\-check
Runs a version check and exits.
.UNINDENT
.SS Player options
.INDENT 0.0
.TP
.B \-p COMMAND, \-\-player COMMAND
Player to feed stream data to. This is a shell\-like syntax to
support passing options to the player. For example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
"vlc \-\-file\-caching=5000"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use a player that is located in a path with spaces you must
quote the path:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
"\(aq/path/with spaces/vlc\(aq \-\-file\-caching=5000"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default VLC will be used if it can be found in its default
location.
.UNINDENT
.INDENT 0.0
.TP
.B \-a ARGUMENTS, \-\-player\-args ARGUMENTS
This option allows you to customize the default arguments which
are put together with the value of \fI\%\-\-player\fP to create a command
to execute.
.sp
This value can contain formatting variables surrounded by curly
braces, { and }. If you need to include a brace character, it
can be escaped by doubling, e.g. {{ and }}.
.sp
Formatting variables available:
.INDENT 7.0
.TP
.B filename
This is the filename that the player will use.
It\(aqs usually "\-" (stdin), but can also be a URL or a file
depending on the options used.
.UNINDENT
.sp
It\(aqs usually enough to use \fI\%\-\-player\fP instead of this unless you
need to add arguments after the filename.
.sp
Default is: \fB"{filename}"\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-verbose\-player
Allow the player to display its console output.
.UNINDENT
.INDENT 0.0
.TP
.B \-n, \-\-player\-fifo, \-\-fifo
Make the player read the stream through a named pipe instead of
the stdin pipe.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-player\-http
Make the player read the stream through HTTP instead of
the stdin pipe.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-player\-continuous\-http
Make the player read the stream through HTTP, but unlike
\fI\%\-\-player\-http\fP it will continuously try to open the stream if the
player requests it.
.sp
This makes it possible to handle stream disconnects if your player
is capable of reconnecting to a HTTP stream. This is usually
done by setting your player to a "repeat mode".
.UNINDENT
.INDENT 0.0
.TP
.B \-\-player\-external\-http
Serve stream data through HTTP without running any player. This is useful
to allow external devices like smartphones or streaming boxes to watch
streams they wouldn\(aqt be able to otherwise.
.sp
Behavior will be similar to the continuous HTTP option, but no player
program will be started, and the server will listen on all available
connections instead of just in the local (loopback) interface.
.sp
The URLs that can be used to access the stream will be printed to the
console, and the server can be interrupted using CTRL\-C.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-player\-external\-http\-port PORT
A fixed port to use for the external HTTP server if that mode is enabled.
Omit or set to 0 to use a random high (>1024) port.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-player\-passthrough TYPES
A comma\-delimited list of stream types to pass to the player as a
URL to let it handle the transport of the stream instead.
.sp
Stream types that can be converted into a playable URL are:
.INDENT 7.0
.IP \(bu 2
hls
.IP \(bu 2
http
.IP \(bu 2
rtmp
.UNINDENT
.sp
Make sure your player can handle the stream type when using this.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-player\-no\-close
By default Livestreamer will close the player when the stream ends.
This is to avoid "dead" GUI players lingering after a stream ends.
.sp
It does however have the side\-effect of sometimes closing a player
before it has played back all of its cached data.
.sp
This option will instead let the player decide when to exit.
.UNINDENT
.SS File output options
.INDENT 0.0
.TP
.B \-o FILENAME, \-\-output FILENAME
Write stream data to FILENAME instead of playing it.
.sp
You will be prompted if the file already exists.
.UNINDENT
.INDENT 0.0
.TP
.B \-f, \-\-force
When using \-o, always write to file even if it already exists.
.UNINDENT
.INDENT 0.0
.TP
.B \-O, \-\-stdout
Write stream data to stdout instead of playing it.
.UNINDENT
.SS Stream options
.INDENT 0.0
.TP
.B \-\-default\-stream STREAM
Open this stream when no stream argument is specified, e.g. "best".
.UNINDENT
.INDENT 0.0
.TP
.B \-\-retry\-streams DELAY
Will retry fetching streams until streams are found while
waiting DELAY (seconds) between each attempt.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-retry\-open ATTEMPTS
Will try ATTEMPTS times to open the stream until giving up.
.sp
Default is: \fB1\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-stream\-types TYPES, \-\-stream\-priority TYPES
A comma\-delimited list of stream types to allow.
.sp
The order will be used to separate streams when there are multiple
streams with the same name but different stream types.
.sp
Default is: \fB"rtmp,hls,hds,http,akamaihd"\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-stream\-sorting\-excludes STREAMS
Fine tune best/worst synonyms by excluding unwanted streams.
.sp
Uses a filter expression in the format:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
[operator]<value>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Valid operators are >, >=, < and <=. If no operator is specified
then equality is tested.
.sp
For example this will exclude streams ranked higher than "480p":
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
">480p"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple filters can be used by separating each expression with
a comma.
.sp
For example this will exclude streams from two quality types:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
">480p,>medium"
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Stream transport options
.INDENT 0.0
.TP
.B \-\-hds\-live\-edge SECONDS
The time live HDS streams will start from the edge of stream.
.sp
Default is: \fB10.0\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hds\-segment\-attempts ATTEMPTS
How many attempts should be done to download each HDS segment
before giving up.
.sp
Default is: \fB3\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hds\-segment\-threads THREADS
The size of the thread pool used to download HDS segments.
Minimum value is 1 and maximum is 10.
.sp
Default is: \fB1\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hds\-segment\-timeout TIMEOUT
HDS segment connect and read timeout.
.sp
Default is: \fB10.0\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hds\-timeout TIMEOUT
Timeout for reading data from HDS streams.
.sp
Default is: \fB60.0\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hls\-live\-edge SEGMENTS
How many segments from the end to start live HLS streams on.
.sp
The lower the value the lower latency from the source you will be,
but also increases the chance of buffering.
.sp
Default is: \fB3\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hls\-segment\-attempts ATTEMPTS
How many attempts should be done to download each HLS segment
before giving up.
.sp
Default is: \fB3\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hls\-segment\-threads THREADS
The size of the thread pool used to download HLS segments.
Minimum value is 1 and maximum is 10.
.sp
Default is: \fB1\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hls\-segment\-timeout TIMEOUT
HLS segment connect and read timeout.
.sp
Default is: \fB10.0\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-hls\-timeout TIMEOUT
Timeout for reading data from HLS streams.
.sp
Default is: \fB60.0\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-http\-stream\-timeout TIMEOUT
Timeout for reading data from HTTP streams.
.sp
Default is: \fB60.0\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ringbuffer\-size SIZE
The maximum size of ringbuffer. Add a M or K suffix to specify mega
or kilo bytes instead of bytes.
.sp
The ringbuffer is used as a temporary storage between the stream
and the player. This is to allows us to download the stream faster
than the player wants to read it.
.sp
The smaller the size, the higher chance of the player buffering
if there are download speed dips and the higher size the more data
we can use as a storage to catch up from speed dips.
.sp
It also allows you to temporary pause as long as the ringbuffer
doesn\(aqt get full since we continue to download the stream in the
background.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
A smaller size is recommended on lower end systems (such as
Raspberry Pi) when playing stream types that require some extra
processing (such as HDS) to avoid unnecessary background
processing.
.UNINDENT
.UNINDENT
.sp
Default is: \fB"16M"\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-rtmp\-proxy PROXY, \-\-rtmpdump\-proxy PROXY
A SOCKS proxy that RTMP streams will use.
.sp
Example: 127.0.0.1:9050
.UNINDENT
.INDENT 0.0
.TP
.B \-\-rtmp\-rtmpdump FILENAME, \-\-rtmpdump FILENAME, \-r FILENAME
RTMPDump is used to access RTMP streams. You can specify the
location of the rtmpdump executable if it is not in your PATH.
.sp
Example: "/usr/local/bin/rtmpdump"
.UNINDENT
.INDENT 0.0
.TP
.B \-\-rtmp\-timeout TIMEOUT
Timeout for reading data from RTMP streams.
.sp
Default is: \fB60.0\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-stream\-segment\-attempts ATTEMPTS
How many attempts should be done to download each segment before giving up.
.sp
This is generic option used by streams not covered by other options,
such as stream protocols specific to plugins, e.g. UStream.
.sp
Default is: \fB3\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-stream\-segment\-threads THREADS
The size of the thread pool used to download segments.
Minimum value is 1 and maximum is 10.
.sp
This is generic option used by streams not covered by other options,
such as stream protocols specific to plugins, e.g. UStream.
.sp
Default is: \fB1\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-stream\-segment\-timeout TIMEOUT
Segment connect and read timeout.
.sp
This is generic option used by streams not covered by other options,
such as stream protocols specific to plugins, e.g. UStream.
.sp
Default is: \fB10.0\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-stream\-timeout TIMEOUT
Timeout for reading data from streams.
.sp
This is generic option used by streams not covered by other options,
such as stream protocols specific to plugins, e.g. UStream.
.sp
Default is: \fB60.0\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-stream\-url
If possible, translate the stream to a URL and print it.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-subprocess\-cmdline, \-\-cmdline, \-c
Print command\-line used internally to play stream.
.sp
This is only available on RTMP streams.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-subprocess\-errorlog, \-\-errorlog, \-e
Log possible errors from internal subprocesses to a temporary file.
The file will be saved in your systems temporary directory.
.sp
Useful when debugging rtmpdump related issues.
.UNINDENT
.SS HTTP options
.INDENT 0.0
.TP
.B \-\-http\-proxy HTTP_PROXY
A HTTP proxy to use for all HTTP requests.
.sp
Example: \fI\%http://hostname:port/\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-https\-proxy HTTPS_PROXY
A HTTPS capable proxy to use for all HTTPS requests.
.sp
Example: \fI\%http://hostname:port/\fP
.UNINDENT
.INDENT 0.0
.TP
.B \-\-http\-cookie KEY=VALUE
A cookie to add to each HTTP request.
.sp
Can be repeated to add multiple cookies.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-http\-header KEY=VALUE
A header to add to each HTTP request.
.sp
Can be repeated to add multiple headers.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-http\-query\-param KEY=VALUE
A query parameter to add to each HTTP request.
.sp
Can be repeated to add multiple query parameters.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-http\-ignore\-env
Ignore HTTP settings set in the environment such as environment
variables (HTTP_PROXY, etc) or ~/.netrc authentication.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-http\-no\-ssl\-verify
Don\(aqt attempt to verify SSL certificates.
.sp
Usually a bad idea, only use this if you know what you\(aqre doing.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-http\-ssl\-cert FILENAME
SSL certificate to use.
.sp
Expects a .pem file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-http\-ssl\-cert\-crt\-key CRT_FILENAME KEY_FILENAME
SSL certificate to use.
.sp
Expects a .crt and a .key file.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-http\-timeout TIMEOUT
General timeout used by all HTTP requests except the ones covered
by other options.
.sp
Default is: \fB20.0\fP\&.
.UNINDENT
.SS Plugin options
.INDENT 0.0
.TP
.B \-\-plugin\-dirs DIRECTORY
Attempts to load plugins from these directories.
.sp
Multiple directories can be used by separating them with a
semi\-colon.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-twitch\-oauth\-token TOKEN
An OAuth token to use for Twitch authentication.
Use \fI\%\-\-twitch\-oauth\-authenticate\fP to create a token.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-twitch\-oauth\-authenticate
Open a web browser where you can grant Livestreamer access
to your Twitch account which creates a token for use with
\fI\%\-\-twitch\-oauth\-token\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-twitch\-cookie COOKIES
Twitch cookies to authenticate to allow access to subscription channels.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
"_twitch_session_id=xxxxxx; persistent=xxxxx"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This method is the old and clunky way of authenticating with
Twitch, using \fI\%\-\-twitch\-oauth\-authenticate\fP is the recommended and
simpler way of doing it now.
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-ustream\-password PASSWORD
A password to access password protected UStream.tv channels.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-crunchyroll\-username USERNAME
A Crunchyroll username to allow access to restricted streams.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-crunchyroll\-password [PASSWORD]
A Crunchyroll password for use with \fI\%\-\-crunchyroll\-username\fP\&.
.sp
If left blank you will be prompted.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-crunchyroll\-purge\-credentials
Purge cached Crunchyroll credentials to initiate a new session
and reauthenticate.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-livestation\-email EMAIL
A Livestation account email to access restricted or premium
quality streams.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-livestation\-password PASSWORD
A Livestation account password to use with \fI\%\-\-livestation\-email\fP\&.
.UNINDENT
.SH AUTHOR
Christopher Rosell
.SH COPYRIGHT
2011-2015, Christopher Rosell
.\" Generated by docutils manpage writer.
.