चेतावनी

In order to use PCM based AudioSources, you must have the opus library installed on your system and loaded through opus.load_opus(). Otherwise, your AudioSources must be opus encoded (e.g. using FFmpegOpusAudio) or the library will not be able to transmit audio.

मापदण्ड:

client (Client)
channel (Connectable)

property guild: Guild | None¶: The guild we're connected to, if applicable.

property user: ClientUser¶: The user connected to voice (i.e. ourselves).

property latency: float¶

Latency between a HEARTBEAT and a HEARTBEAT_ACK in seconds.

This could be referred to as the Discord Voice WebSocket latency and is an analogue of user's voice latencies as seen in the Discord client.

Added in version 1.4.

property average_latency: float¶: Average of most recent 20 HEARTBEAT latencies in seconds.

Added in version 1.4.

await disconnect(*, force=False)[स्रोत]¶

This function is a coroutine.

Disconnects this voice client from voice.

मापदण्ड:: force (bool)
प्रदत्त प्रकार :: None

await move_to(channel)[स्रोत]¶

This function is a coroutine.

Moves you to a different voice channel.

मापदण्ड:: channel (abc.Connectable) -- The channel to move to. Must be a voice channel.
प्रदत्त प्रकार :: None

is_connected()[स्रोत]¶

Indicates if the voice client is connected to voice.

प्रदत्त प्रकार :: bool

play(source, *, after=None, wait_finish=False)[स्रोत]¶

Plays an AudioSource.

The finalizer, after is called after the source has been exhausted or an error occurred.

If an error happens while the audio player is running, the exception is caught and the audio player is then stopped. If no after callback is passed, any caught exception will be displayed as if it were raised.

मापदण्ड:

source (AudioSource) -- The audio source we're reading from.
after (Callable[[Optional[Exception]], Any]) -- The finalizer that is called after the stream is exhausted. This function must have a single parameter, error, that denotes an optional exception that was raised during playing.
wait_finish (bool) --
If True, an awaitable will be returned, which can be used to wait for audio to stop playing. This awaitable will return an exception if raised, or None when no exception is raised.

If False, None is returned and the function does not block.

Added in version v2.5.

उभारता है :

ClientException -- Already playing audio or not connected.
TypeError -- Source is not a AudioSource or after is not a callable.
OpusNotLoaded -- Source is not opus encoded and opus is not loaded.

प्रदत्त प्रकार :

None | Future

unpack_audio(data)[स्रोत]¶

Takes an audio packet received from Discord and decodes it into pcm audio data. If there are no users talking in the channel, None will be returned.

You must be connected to receive audio.

Added in version 2.0.

मापदण्ड:: data (bytes) -- Bytes received by Discord via the UDP connection used for sending and receiving voice data.

start_recording(sink, callback, *args, sync_start=False)[स्रोत]¶

The bot will begin recording audio from the current voice channel it is in. This function uses a thread so the current code line will not be stopped. Must be in a voice channel to use. Must not be already recording.

Added in version 2.0.

मापदण्ड:

sink (Sink) -- A Sink which will "store" all the audio data.
callback (coroutine) -- A function which is called after the bot has stopped recording.
*args -- Args which will be passed to the callback function.
sync_start (bool) -- If True, the recordings of subsequent users will start with silence. This is useful for recording audio just as it was heard.

उभारता है :

RecordingException -- Not connected to a voice channel.
RecordingException -- Already recording.
RecordingException -- Must provide a Sink object.

stop_recording()[स्रोत]¶

Stops the recording. Must be already recording.

Added in version 2.0.

उभारता है :: RecordingException -- Not currently recording.

toggle_pause()[स्रोत]¶

Pauses or unpauses the recording. Must be already recording.

Added in version 2.0.

उभारता है :: RecordingException -- Not currently recording.

is_playing()[स्रोत]¶

Indicates if we're currently playing audio.

प्रदत्त प्रकार :: bool

is_paused()[स्रोत]¶

Indicates if we're playing audio, but if we're paused.

प्रदत्त प्रकार :: bool

stop()[स्रोत]¶

Stops playing audio.

प्रदत्त प्रकार :: None

pause()[स्रोत]¶

Pauses the audio playing.

प्रदत्त प्रकार :: None

resume()[स्रोत]¶

Resumes the audio playing.

प्रदत्त प्रकार :: None

property source: AudioSource | None¶

The audio source being played, if playing.

This property can also be used to change the audio source currently being played.

send_audio_packet(data, *, encode=True)[स्रोत]¶

Sends an audio packet composed of the data.

You must be connected to play audio.

मापदण्ड:

data (bytes) -- The bytes-like object denoting PCM or Opus voice data.
encode (bool) -- Indicates if data should be encoded into Opus.

उभारता है :

ClientException -- You are not connected.
opus.OpusError -- Encoding the data failed.

प्रदत्त प्रकार :

None

elapsed()[स्रोत]¶

Returns the elapsed time of the playing audio.

प्रदत्त प्रकार :: timedelta

Methods

defcleanup
asyncconnect
asyncdisconnect
asyncon_voice_server_update
asyncon_voice_state_update

class discord.VoiceProtocol(client, channel)[स्रोत]¶

A class that represents the Discord voice protocol.

This is an abstract class. The library provides a concrete implementation under VoiceClient.

This class allows you to implement a protocol to allow for an external method of sending voice, such as Lavalink or a native library implementation.

These classes are passed to abc.Connectable.connect.

मापदण्ड:

client (Client) -- The client (or its subclasses) that started the connection request.
channel (abc.Connectable) -- The voice channel that is being connected to.

await on_voice_state_update(data)[स्रोत]¶

This function is a coroutine.

An abstract method that is called when the client's voice state has changed. This corresponds to VOICE_STATE_UPDATE.

मापदण्ड:

data (dict) --

The raw voice state payload.

प्रदत्त प्रकार :

None

await on_voice_server_update(data)[स्रोत]¶

This function is a coroutine.

An abstract method that is called when initially connecting to voice. This corresponds to VOICE_SERVER_UPDATE.

मापदण्ड:

data (dict) --

The raw voice server update payload.

प्रदत्त प्रकार :

None

await connect(*, timeout, reconnect)[स्रोत]¶

This function is a coroutine.

An abstract method called when the client initiates the connection request.

When a connection is requested initially, the library calls the constructor under __init__ and then calls connect(). If connect() fails at some point then disconnect() is called.

Within this method, to start the voice connection flow it is recommended to use Guild.change_voice_state() to start the flow. After which, on_voice_server_update() and on_voice_state_update() will be called. The order that these two are called is unspecified.

मापदण्ड:

timeout (float) -- The timeout for the connection.
reconnect (bool) -- Whether reconnection is expected.

प्रदत्त प्रकार :

None

await disconnect(*, force)[स्रोत]¶

This function is a coroutine.

An abstract method called when the client terminates the connection.

See cleanup().

मापदण्ड:: force (bool) -- Whether the disconnection was forced.
प्रदत्त प्रकार :: None

cleanup()[स्रोत]¶

This method must be called to ensure proper clean-up during a disconnect.

It is advisable to call this from within disconnect() when you are completely done with the voice protocol instance.

This method removes it from the internal state cache that keeps track of currently alive voice clients. Failure to clean-up will cause subsequent connections to report that it's still connected.

प्रदत्त प्रकार :: None

Methods

defcleanup
defis_opus
defread

class discord.AudioSource[स्रोत]¶

Represents an audio stream.

The audio stream can be Opus encoded or not, however if the audio stream is not Opus encoded then the audio format must be 16-bit 48KHz stereo PCM.

चेतावनी

The audio source reads are done in a separate thread.

read()[स्रोत]¶

Reads 20ms worth of audio.

Subclasses must implement this.

If the audio is complete, then returning an empty bytes-like object to signal this is the way to do so.

If is_opus() method returns True, then it must return 20ms worth of Opus encoded audio. Otherwise, it must be 20ms worth of 16-bit 48KHz stereo PCM, which is about 3,840 bytes per frame (20ms worth of audio).

प्रदत्त :: A bytes like object that represents the PCM or Opus data.
प्रदत्त प्रकार :: bytes

is_opus()[स्रोत]¶

Checks if the audio source is already encoded in Opus.

प्रदत्त प्रकार :: bool

cleanup()[स्रोत]¶

Called when clean-up is needed to be done.

Useful for clearing buffer data or processes after it is done playing audio.

प्रदत्त प्रकार :: None

Attributes

stream

Methods

defread

class discord.PCMAudio(stream)[स्रोत]¶

Represents raw 16-bit 48KHz stereo PCM audio source.

stream¶

A file-like object that reads byte data representing raw PCM.

Type:: file object

मापदण्ड:: stream (BufferedIOBase)

read()[स्रोत]¶

Reads 20ms worth of audio.

Subclasses must implement this.

If the audio is complete, then returning an empty bytes-like object to signal this is the way to do so.

प्रदत्त :: A bytes like object that represents the PCM or Opus data.
प्रदत्त प्रकार :: bytes

Methods

defcleanup

class discord.FFmpegAudio(source, *, executable='ffmpeg', args, **subprocess_kwargs)[स्रोत]¶

Represents an FFmpeg (or AVConv) based AudioSource.

User created AudioSources using FFmpeg differently from how FFmpegPCMAudio and FFmpegOpusAudio work should subclass this.

Added in version 1.3.

मापदण्ड:

source (str | BufferedIOBase)
executable (str)
args (Any)
subprocess_kwargs (Any)

cleanup()[स्रोत]¶

Called when clean-up is needed to be done.

Useful for clearing buffer data or processes after it is done playing audio.

प्रदत्त प्रकार :: None

Methods

defis_opus
defread

class discord.FFmpegPCMAudio(source, *, executable='ffmpeg', pipe=False, stderr=None, before_options=None, options=None)[स्रोत]¶

An audio source from FFmpeg (or AVConv).

This launches a sub-process to a specific input file given.

चेतावनी

You must have the ffmpeg or avconv executable in your path environment variable in order for this to work.

मापदण्ड:

source (Union[str, io.BufferedIOBase]) -- The input that ffmpeg will take and convert to PCM bytes. If pipe is True then this is a file-like object that is passed to the stdin of ffmpeg.
executable (str) -- The executable name (and path) to use. Defaults to ffmpeg.
pipe (bool) -- If True, denotes that source parameter will be passed to the stdin of ffmpeg. Defaults to False.
stderr (Optional[file object]) -- A file-like object to pass to the Popen constructor. Could also be an instance of subprocess.PIPE.
before_options (Optional[str]) -- Extra command line arguments to pass to ffmpeg before the -i flag.
options (Optional[str]) -- Extra command line arguments to pass to ffmpeg after the -i flag.

उभारता है :

ClientException -- The subprocess failed to be created.

read()[स्रोत]¶

Reads 20ms worth of audio.

Subclasses must implement this.

If the audio is complete, then returning an empty bytes-like object to signal this is the way to do so.

प्रदत्त :: A bytes like object that represents the PCM or Opus data.
प्रदत्त प्रकार :: bytes

is_opus()[स्रोत]¶

Checks if the audio source is already encoded in Opus.

प्रदत्त प्रकार :: bool

Methods

asyncfrom_probe
defis_opus
asyncprobe
defread

class discord.FFmpegOpusAudio(source, *, bitrate=128, codec=None, executable='ffmpeg', pipe=False, stderr=None, before_options=None, options=None)[स्रोत]¶

An audio source from FFmpeg (or AVConv).

This launches a sub-process to a specific input file given. However, rather than producing PCM packets like FFmpegPCMAudio does that need to be encoded to Opus, this class produces Opus packets, skipping the encoding step done by the library.

Alternatively, instead of instantiating this class directly, you can use FFmpegOpusAudio.from_probe() to probe for bitrate and codec information. This can be used to opportunistically skip pointless re-encoding of existing Opus audio data for a boost in performance at the cost of a short initial delay to gather the information. The same can be achieved by passing copy to the codec parameter, but only if you know that the input source is Opus encoded beforehand.

Added in version 1.3.

चेतावनी

You must have the ffmpeg or avconv executable in your path environment variable in order for this to work.

मापदण्ड:

source (Union[str, io.BufferedIOBase]) -- The input that ffmpeg will take and convert to Opus bytes. If pipe is True then this is a file-like object that is passed to the stdin of ffmpeg.
bitrate (int) -- The bitrate in kbps to encode the output to. Defaults to 128.
codec (Optional[str]) --
The codec to use to encode the audio data. Normally this would be just libopus, but is used by FFmpegOpusAudio.from_probe() to opportunistically skip pointlessly re-encoding Opus audio data by passing copy as the codec value. Any values other than copy, or libopus will be considered libopus. opus will also be considered libopus since the opus encoder is still in development. Defaults to libopus.

चेतावनी

Do not provide this parameter unless you are certain that the audio input is already Opus encoded. For typical use FFmpegOpusAudio.from_probe() should be used to determine the proper value for this parameter.
executable (str) -- The executable name (and path) to use. Defaults to ffmpeg.
pipe (bool) -- If True, denotes that source parameter will be passed to the stdin of ffmpeg. Defaults to False.
stderr (Optional[file object]) -- A file-like object to pass to the Popen constructor. Could also be an instance of subprocess.PIPE.
before_options (Optional[str]) -- Extra command line arguments to pass to ffmpeg before the -i flag.
options (Optional[str]) -- Extra command line arguments to pass to ffmpeg after the -i flag.

उभारता है :

ClientException -- The subprocess failed to be created.

classmethod await from_probe(source, *, method=None, **kwargs)[स्रोत]¶

This function is a coroutine.

A factory method that creates a FFmpegOpusAudio after probing the input source for audio codec and bitrate information.

मापदण्ड:

source (str) -- Identical to the source parameter for the constructor.
method (Optional[Union[str, Callable[str, str]]]) -- The probing method used to determine bitrate and codec information. As a string, valid values are native to use ffprobe (or avprobe) and fallback to use ffmpeg (or avconv). As a callable, it must take two string arguments, source and executable. Both parameters are the same values passed to this factory function. executable will default to ffmpeg if not provided as a keyword argument.
kwargs (Any) -- The remaining parameters to be passed to the FFmpegOpusAudio constructor, excluding bitrate and codec.

प्रदत्त :

An instance of this class.

प्रदत्त प्रकार :

FFmpegOpusAudio

उभारता है :

AttributeError -- Invalid probe method, must be 'native' or 'fallback'.
TypeError -- Invalid value for probe parameter, must be str or a callable.

कुछ उदाहरण

Use this function to create an FFmpegOpusAudio instance instead of the constructor:

source = await discord.FFmpegOpusAudio.from_probe("song.webm")
voice_client.play(source)

If you are on Windows and don't have ffprobe installed, use the fallback method to probe using ffmpeg instead:

source = await discord.FFmpegOpusAudio.from_probe("song.webm", method='fallback')
voice_client.play(source)

Using a custom method of determining codec and bitrate:

def custom_probe(source, executable):
    # some analysis code here
    return codec, bitrate

source = await discord.FFmpegOpusAudio.from_probe("song.webm", method=custom_probe)
voice_client.play(source)

classmethod await probe(source, *, method=None, executable=None)[स्रोत]¶

This function is a coroutine.

Probes the input source for bitrate and codec information.

मापदण्ड:

source (str) -- Identical to the source parameter for FFmpegOpusAudio.
method (Union[str, Callable[[str, str], tuple[str | None, int | None]], None]) -- Identical to the method parameter for FFmpegOpusAudio.from_probe().
executable (str) -- Identical to the executable parameter for FFmpegOpusAudio.

प्रदत्त :

A 2-tuple with the codec and bitrate of the input source.

प्रदत्त प्रकार :

Optional[Tuple[Optional[str], Optional[int]]]

उभारता है :

AttributeError -- Invalid probe method, must be 'native' or 'fallback'.
TypeError -- Invalid value for probe parameter, must be str or a callable.

read()[स्रोत]¶

Reads 20ms worth of audio.

Subclasses must implement this.

If the audio is complete, then returning an empty bytes-like object to signal this is the way to do so.

प्रदत्त :: A bytes like object that represents the PCM or Opus data.
प्रदत्त प्रकार :: bytes

is_opus()[स्रोत]¶

Checks if the audio source is already encoded in Opus.

प्रदत्त प्रकार :: bool

Attributes

volume

Methods

defcleanup
defread

class discord.PCMVolumeTransformer(original, volume=1.0)[स्रोत]¶

Transforms a previous AudioSource to have volume controls.

This does not work on audio sources that have AudioSource.is_opus() set to True.

मापदण्ड:

original (AudioSource) -- The original AudioSource to transform.
volume (float) -- The initial volume to set it to. See volume for more info.

उभारता है :

TypeError -- Not an audio source.
ClientException -- The audio source is opus encoded.

property volume: float¶: Retrieves or sets the volume as a floating point percentage (e.g. 1.0 for 100%).

cleanup()[स्रोत]¶

Called when clean-up is needed to be done.

Useful for clearing buffer data or processes after it is done playing audio.

प्रदत्त प्रकार :: None

read()[स्रोत]¶

Reads 20ms worth of audio.

Subclasses must implement this.

If the audio is complete, then returning an empty bytes-like object to signal this is the way to do so.

प्रदत्त :: A bytes like object that represents the PCM or Opus data.
प्रदत्त प्रकार :: bytes

Opus Library¶

discord.opus.load_opus(name)[स्रोत]¶

Loads the libopus shared library for use with voice.

If this function is not called then the library uses the function ctypes.util.find_library() and then loads that one if available.

Not loading a library and attempting to use PCM based AudioSources will lead to voice not working.

This function propagates the exceptions thrown.

चेतावनी

The bitness of the library must match the bitness of your python interpreter. If the library is 64-bit then your python interpreter must be 64-bit as well. Usually if there's a mismatch in bitness then the load will throw an exception.

टिप्पणी

On Windows, this function should not need to be called as the binaries are automatically loaded.

टिप्पणी

On Windows, the .dll extension is not necessary. However, on Linux the full extension is required to load the library, e.g. libopus.so.1. On Linux however, ctypes.util.find_library() will usually find the library automatically without you having to call this.

मापदण्ड:: name (str) -- The filename of the shared library.
प्रदत्त प्रकार :: None

discord.opus.is_loaded()[स्रोत]¶

Function to check if opus lib is successfully loaded either via the ctypes.util.find_library() call of load_opus().

This must return True for voice to work.

प्रदत्त :: Indicates if the opus library has been loaded.
प्रदत्त प्रकार :: bool