From 4f37e50561e6162be42789cdb050685695cbb42f Mon Sep 17 00:00:00 2001 From: jbannon Date: Sun, 14 Aug 2022 16:29:04 +0000 Subject: [PATCH] update docs --- docs/config.rst | 8 ++++++++ examples/youtube_extract_and_tag_audio.yaml | 2 +- src/ytdl_sub/plugins/audio_extract.py | 4 ++-- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/config.rst b/docs/config.rst index dd06cbdd..a646b080 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -169,6 +169,14 @@ Plugins """"""" Plugins are used to perform any type of post-processing to the already downloaded files. +audio_extract +''''''''''''' +.. autoclass:: ytdl_sub.plugins.audio_extract.AudioExtractOptions() + :members: + :member-order: bysource + +------------------------------------------------------------------------------- + music_tags '''''''''' .. autoclass:: ytdl_sub.plugins.music_tags.MusicTagsOptions() diff --git a/examples/youtube_extract_and_tag_audio.yaml b/examples/youtube_extract_and_tag_audio.yaml index 8c004fd1..e738ba59 100644 --- a/examples/youtube_extract_and_tag_audio.yaml +++ b/examples/youtube_extract_and_tag_audio.yaml @@ -1,4 +1,4 @@ -# TODO: add comments explaining stuff +# Extracts audio from YouTube videos, converts it to mp3, and adds audio tags to it. configuration: working_directory: '.ytdl-sub-downloads' diff --git a/src/ytdl_sub/plugins/audio_extract.py b/src/ytdl_sub/plugins/audio_extract.py index 9073f318..a26d4bfb 100644 --- a/src/ytdl_sub/plugins/audio_extract.py +++ b/src/ytdl_sub/plugins/audio_extract.py @@ -14,7 +14,7 @@ from ytdl_sub.validators.validators import FloatValidator class AudioExtractOptions(PluginOptions): """ - Extracts audio from a video file + Extracts audio from a video file. Usage: @@ -46,7 +46,7 @@ class AudioExtractOptions(PluginOptions): def quality(self) -> Optional[float]: """ Optional. Specify ffmpeg audio quality. Insert a value between ``0`` (better) and ``9`` - (worse) for VBR or a specific bitrate like ``128`` for 128k. + (worse) for variable bitrate, or a specific bitrate like ``128`` for 128k. """ if self._quality is not None: return self._quality.value