document default handlers

Author: DA-344

discord/sinks/m4a.py

@@ -52,6 +52,12 @@
 
 
 class M4AConverterHandler(SinkHandler["M4ASink"]):
+    """Default handler to add received voice packets to the audio cache data in
+    a :class:`~.M4ASink`.
+    
+    .. versionadded:: 2.7
+    """
+
     def handle_packet(
         self, sink: M4ASink, user: abc.Snowflake, packet: RawData
     ) -> None:

discord/sinks/mka.py

@@ -50,6 +50,12 @@
 
 
 class MKAConverterHandler(SinkHandler["MKASink"]):
+    """Default handler to add received voice packets to the audio cache data in
+    a :class:`~.MKASink`.
+    
+    .. versionadded:: 2.7
+    """
+
     def handle_packet(
         self, sink: MKASink, user: abc.Snowflake, packet: RawData
     ) -> None:

discord/sinks/mkv.py

@@ -50,6 +50,12 @@
 
 
 class MKVConverterHandler(SinkHandler["MKVSink"]):
+    """Default handler to add received voice packets to the audio cache data in
+    a :class:`~.MKVSink`.
+    
+    .. versionadded:: 2.7
+    """
+
     def handle_packet(
         self, sink: MKVSink, user: abc.Snowflake, packet: RawData
     ) -> None:

discord/sinks/mp3.py

@@ -50,6 +50,12 @@
 
 
 class MP3ConverterHandler(SinkHandler["MP3Sink"]):
+    """Default handler to add received voice packets to the audio cache data in
+    a :class:`~.MP3Sink`.
+    
+    .. versionadded:: 2.7
+    """
+
     def handle_packet(
         self, sink: MP3Sink, user: abc.Snowflake, packet: RawData
     ) -> None:

discord/sinks/mp4.py

@@ -52,6 +52,12 @@
 
 
 class MP4ConverterHandler(SinkHandler["MP4Sink"]):
+    """Default handler to add received voice packets to the audio cache data in
+    a :class:`~.MP4Sink`.
+    
+    .. versionadded:: 2.7
+    """
+
     def handle_packet(
         self, sink: MP4Sink, user: abc.Snowflake, packet: RawData
     ) -> None:

discord/sinks/ogg.py

@@ -50,6 +50,12 @@
 
 
 class OGGConverterHandler(SinkHandler["OGGSink"]):
+    """Default handler to add received voice packets to the audio cache data in
+    a :class:`~.OGGSink`.
+    
+    .. versionadded:: 2.7
+    """
+
     def handle_packet(
         self, sink: OGGSink, user: abc.Snowflake, packet: RawData
     ) -> None:

discord/sinks/pcm.py

@@ -44,6 +44,12 @@
 
 
 class PCMConverterHandler(SinkHandler["PCMSink"]):
+    """Default handler to add received voice packets to the audio cache data in
+    a :class:`~.PCMSink`.
+    
+    .. versionadded:: 2.7
+    """
+
     def handle_packet(
         self, sink: PCMSink, user: abc.Snowflake, packet: RawData
     ) -> None:

discord/sinks/wave.py

@@ -47,6 +47,12 @@
 
 
 class WaveConverterHandler(SinkHandler["WaveSink"]):
+    """Default handler to add received voice packets to the audio cache data in
+    a :class:`~.WaveSink`.
+    
+    .. versionadded:: 2.7
+    """
+
     def handle_packet(
         self, sink: WaveSink, user: abc.Snowflake, packet: RawData
     ) -> None:
@@ -55,6 +61,10 @@ def handle_packet(
 
 
 WavConverterHandler: SinkHandler[WavSink] = WaveConverterHandler  # type: ignore
+"""An alias for :class:`~.WaveConverterHandler`
+
+.. versionadded:: 2.7
+"""
 
 
 class WaveSink(Sink):

docs/api/sinks.rst

@@ -6,25 +6,28 @@ Sinks
 Core
 ----
 
-.. autoclass:: discord.sinks.Filters
+.. autoclass:: discord.sinks.Sink
     :members:
 
-.. autoclass:: discord.sinks.Sink
+.. autoclass:: discord.sinks.RawData
     :members:
 
-.. autoclass:: discord.sinks.AudioData
+.. autoclass:: discord.sinks.SinkHandler
     :members:
 
-.. autoclass:: discord.sinks.RawData
+.. autoclass:: discord.sinks.SinkFilter
     :members:
 
 
-Sink Classes
-------------
+Default Sinks
+-------------
 
 .. autoclass:: discord.sinks.WaveSink
     :members:
 
+.. autoclass:: discord.sinks.WavSink
+    :members:
+
 .. autoclass:: discord.sinks.MP3Sink
     :members:
 
@@ -42,3 +45,28 @@ Sink Classes
 
 .. autoclass:: discord.sinks.OGGSink
     :members:
+
+
+Default Handlers
+----------------
+
+.. autoclass:: discord.sinks.WaveConverterHandler()
+    :members:
+
+.. autoclass:: discord.sinks.MP3ConverterHandler()
+    :members:
+
+.. autoclass:: discord.sinks.MP4ConverterHandler()
+    :members:
+
+.. autoclass:: discord.sinks.M4AConverterHandler()
+    :members:
+
+.. autoclass:: discord.sinks.MKVConverterHandler()
+    :members:
+
+.. autoclass:: discord.sinks.MKAConverterHandler()
+    :members:
+
+.. autoclass:: discord.sinks.OGGConverterHandler()
+    :members: