File: api.rst

package info (click to toggle)
streamlink 1.0.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 3,588 kB
  • sloc: python: 31,121; makefile: 141; sh: 93
file content (84 lines) | stat: -rw-r--r-- 1,280 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
.. _api:

API Reference
=============

.. module:: streamlink

This ia reference of all the available API methods in Streamlink.

Streamlink
------------

.. autofunction:: streams


Session
-------

.. autoclass:: Streamlink
    :members:


Plugins
-------
.. module:: streamlink.plugin
.. autoclass:: Plugin
    :members:

.. module:: streamlink.options
.. autoclass:: Arguments
    :members:

.. autoclass:: Argument
    :members:

    .. automethod:: __init__


Streams
-------

All streams inherit from the :class:`Stream` class.

.. module:: streamlink.stream
.. autoclass:: Stream
    :members:


.. _api-stream-subclasses:

Stream subclasses
^^^^^^^^^^^^^^^^^

You are able to inspect the parameters used by each stream,
different properties are available depending on stream type.

.. autoclass:: AkamaiHDStream
    :members:

.. autoclass:: HDSStream
    :members:

.. autoclass:: HLSStream
    :members:

.. autoclass:: HTTPStream
    :members:

.. autoclass:: RTMPStream
    :members:

.. autoclass:: DASHStream
    :members:


Exceptions
----------

Streamlink has three types of exceptions:

.. autoexception:: streamlink.StreamlinkError
.. autoexception:: streamlink.PluginError
.. autoexception:: streamlink.NoPluginError
.. autoexception:: streamlink.StreamError