danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update docs

Browse source
This commit is contained in:
jbannon 2022-08-14 16:29:04 +00:00
parent 4d64d488a7
commit 4f37e50561
3 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/config.rst
View file

@ -169,6 +169,14 @@ Plugins
""""""" """""""
Plugins are used to perform any type of post-processing to the already downloaded files. 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 music_tags
'''''''''' ''''''''''
.. autoclass:: ytdl_sub.plugins.music_tags.MusicTagsOptions() .. autoclass:: ytdl_sub.plugins.music_tags.MusicTagsOptions()

2
examples/youtube_extract_and_tag_audio.yaml
View file

@ -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: configuration:
working_directory: '.ytdl-sub-downloads' working_directory: '.ytdl-sub-downloads'

4
src/ytdl_sub/plugins/audio_extract.py
View file

@ -14,7 +14,7 @@ from ytdl_sub.validators.validators import FloatValidator
class AudioExtractOptions(PluginOptions): class AudioExtractOptions(PluginOptions):
""" """
Extracts audio from a video file Extracts audio from a video file.
Usage: Usage:
@ -46,7 +46,7 @@ class AudioExtractOptions(PluginOptions):
def quality(self) -> Optional[float]: def quality(self) -> Optional[float]:
""" """
Optional. Specify ffmpeg audio quality. Insert a value between ``0`` (better) and ``9`` 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: if self._quality is not None:
return self._quality.value return self._quality.value