API Reference - Streamlink 2.1.1 documentation
interface
(str) Set the network interface,
default: None
ipv4
(bool) Resolve address names to IPv4 only.
This option overrides ipv6, default: False
ipv6
(bool) Resolve address names to IPv6 only.
This option overrides ipv4, default: False
hds-live-edge
(float) Specify the time live HDS
streams will start from the edge of
stream, default: 10.0
hds-segment-attempts
(int) How many attempts should be done
to download each HDS segment, default: 3
hds-segment-threads
(int) The size of the thread pool used
to download segments, default: 1
hds-segment-timeout
(float) HDS segment connect and read
timeout, default: 10.0
hds-timeout
(float) Timeout for reading data from
HDS streams, default: 60.0
hls-live-edge
(int) How many segments from the end
to start live streams on, default: 3
hls-segment-attempts
(int) How many attempts should be done
to download each HLS segment, default: 3
hls-segment-ignore-names
(str[]) List of segment names without
file endings which should get filtered out,
default: []
hls-segment-threads
(int) The size of the thread pool used
to download segments, default: 1
hls-segment-stream-data
(bool) Stream HLS segment downloads,
default: False
hls-segment-timeout
(float) HLS segment connect and read
timeout, default: 10.0
hls-timeout
(float) Timeout for reading data from
HLS streams, default: 60.0
http-proxy
(str) Specify a HTTP proxy to use for all HTTP requests
https-proxy
(str) Specify a HTTPS proxy to use for all HTTPS requests
http-cookies
(dict or str) A dict or a semi-colon (;)
delimited str of cookies to add to each
HTTP request, e.g. foo=bar;baz=qux
http-headers
(dict or str) A dict or semi-colon (;)
delimited str of headers to add to each
HTTP request, e.g. foo=bar;baz=qux
http-query-params
(dict or str) A dict or a ampersand (&)
delimited string of query parameters to
add to each HTTP request,
e.g. foo=bar&baz=qux
http-trust-env
(bool) Trust HTTP settings set in the environment, such as environment variables (HTTP_PROXY, etc) and ~/.netrc authentication
http-ssl-verify
(bool) Verify SSL certificates,
default: True
http-ssl-cert
(str or tuple) SSL certificate to use, can be either a .pem file (str) or a .crt/.key pair (tuple)
http-timeout
(float) General timeout used by all HTTP
requests except the ones covered by
other options, default: 20.0
http-stream-timeout
(float) Timeout for reading data from
HTTP streams, default: 60.0
subprocess-errorlog
(bool) Log errors from subprocesses to a file located in the temp directory
subprocess-errorlog-path
(str) Log errors from subprocesses to a specific file
ringbuffer-size
(int) The size of the internal ring
buffer used by most stream types,
default: 16777216 (16MB)
rtmp-proxy
(str) Specify a proxy (SOCKS) that RTMP streams will use
rtmp-rtmpdump
(str) Specify the location of the
rtmpdump executable used by RTMP streams,
e.g. /usr/local/bin/rtmpdump
rtmp-timeout
(float) Timeout for reading data from
RTMP streams, default: 60.0
ffmpeg-ffmpeg
(str) Specify the location of the
ffmpeg executable use by Muxing streams
e.g. /usr/local/bin/ffmpeg
ffmpeg-verbose
(bool) Log stderr from ffmpeg to the console
ffmpeg-verbose-path
(str) Specify the location of the ffmpeg stderr log file
ffmpeg-fout
(str) The output file format
when muxing with ffmpeg
e.g. matroska
ffmpeg-video-transcode
(str) The codec to use if transcoding
video when muxing with ffmpeg
e.g. h264
ffmpeg-audio-transcode
(str) The codec to use if transcoding
audio when muxing with ffmpeg
e.g. aac
ffmpeg-copyts
(bool) When used with ffmpeg, do not shift input timestamps.
ffmpeg-start-at-zero
(bool) When used with ffmpeg and copyts,
shift input timestamps so they start at zero
default: False
mux-subtitles
(bool) Mux available subtitles into the output stream.
stream-segment-attempts
(int) How many attempts should be done
to download each segment, default: 3.
General option used by streams not
covered by other options.
stream-segment-threads
(int) The size of the thread pool used
to download segments, default: 1.
General option used by streams not
covered by other options.
stream-segment-timeout
(float) Segment connect and read
timeout, default: 10.0.
General option used by streams not
covered by other options.
stream-timeout
(float) Timeout for reading data from
stream, default: 60.0.
General option used by streams not
covered by other options.
locale
(str) Locale setting, in the RFC 1766 format
eg. en_US or es_ES
default: system locale.
user-input-requester
(UserInputRequester) instance of UserInputRequester
to collect input from the user at runtime. Must be
set before the plugins are loaded.
default: UserInputRequester.