File: api.rst

package info (click to toggle)
livestreamer 1.10.2-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,828 kB
  • ctags: 2,390
  • sloc: python: 13,370; makefile: 135
file content (73 lines) | stat: -rw-r--r-- 1,124 bytes parent folder | download | duplicates (2)
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
.. _api:

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

.. module:: livestreamer

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

Livestreamer
------------

.. autofunction:: streams


Session
-------

.. autoclass:: Livestreamer
    :members:


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


Streams
-------

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

.. module:: livestreamer.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:


Exceptions
----------

Livestreamer has three types of exceptions:

.. autoexception:: livestreamer.LivestreamerError
.. autoexception:: livestreamer.PluginError
.. autoexception:: livestreamer.NoPluginError
.. autoexception:: livestreamer.StreamError