Skip to content

Commit 9057478

Browse files
committed
Some doc corrections
1 parent 1d0eb7c commit 9057478

File tree

3 files changed

+18
-11
lines changed

3 files changed

+18
-11
lines changed

docs/source/index.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,24 @@
66
Media decoder documentation
77
===========================
88

9-
This library allows you to decode and render movies in Python. It is based on
10-
the (rather excellent) MoviePy_ module created by Zulko, which offers a convenient
11-
Python interface to ffmpeg. This library should hence be able to render any media
12-
format that ffmpeg supports. If ffmpeg is not found, moviepy will download it for
13-
you on first usage, which may take some time
9+
This library allows you to decode and render video files (and in the future also
10+
audio files) in Python. It provides an internal clock that determines which
11+
(video and/or audio) frame needs to be displayed at a specified time, and this frame
12+
can then (optionally) be passed on to a callback function that takes care of the
13+
actual rendering of the frame. In short, this library should help you get started
14+
when you want to implement your own video player and want to have full control over
15+
the way audio and video is rendered.
16+
17+
It is based on the (rather excellent) MoviePy_ module created by Zulko, which offers
18+
a convenient Python interface to ffmpeg. This library should hence be able to
19+
render any media format that ffmpeg supports. If ffmpeg is not found, moviepy
20+
will download it for you on first usage, which may take some time
1421
(so keep an eye on that terminal/command prompt to track the download progress).
1522

1623
This library's main purpose is to decode video and/or audio files and supply the
1724
user with video and audio frames depending on the playtime of the media stream.
1825
The user thus has to take care of the rendering of these frames himself (although
19-
modules for sound rendering are included in the package.
26+
modules for sound rendering are included in the package).
2027
The ``play.py`` contains an example of how to play a video using OpenGL+pygame for
2128
the video rendering and pyaudio for audio playback (using pygame.mixer is also an
2229
option, but that doesn't work smoothly yet). You can play a video by calling

mediadecoder/decoder.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,8 +213,8 @@ def set_audiorenderer(self, renderer):
213213
214214
Parameters
215215
----------
216-
renderer : sound_renderers.SoundRenderer
217-
A subclass of sound_renderers.SoundRenderer that takes care of the
216+
renderer : soundrenderers.SoundRenderer
217+
A subclass of soundrenderers.SoundRenderer that takes care of the
218218
audio rendering.
219219
220220
Raises

mediadecoder/timer.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111
from moviepy.tools import cvsecs
1212

1313
class Timer(object):
14-
""" Timer serves as a video clock that can be used which frame needs to be
15-
displayed at an arbitrary moment in time. It runs in a separate thread.
14+
""" Timer serves as a video clock that is used to determine which frame needs to be
15+
displayed at the specified time. It runs in a separate thread.
1616
Time can be polled by checking its property clock.time, and the current frame
17-
can be determined using clock.current_frame. """
17+
can be determined by checking clock.current_frame. """
1818

1919
def __init__(self, fps=None, max_duration=None):
2020
""" Constructor.

0 commit comments

Comments
 (0)