Sinks

Core

class discord.sinks.Filters(**kwargs)

Filters for Sink

Adicionado na versão 2.0.

Parâmetros:

container – Container of all Filters.

class discord.sinks.Sink(*, filters=None)

A sink “stores” recorded audio data.

Can be subclassed for extra customizablilty.

Aviso

It is recommended you use the officially provided sink classes, such as WaveSink.

just replace the following like so:

vc.start_recording(
    MySubClassedSink(),
    finished_callback,
    ctx.channel,
)

Adicionado na versão 2.0.

Levanta:

• ClientException – An invalid encoding type was specified.

• ClientException – Audio may only be formatted after recording is finished.

get_all_audio()

Gets all audio files.

get_user_audio(user)

Gets the audio file(s) of one specific user.

Parâmetros:

user (str | int)

class discord.sinks.AudioData(file)

Handles data that’s been completely decrypted and decoded and is ready to be saved to file.

Adicionado na versão 2.0.

write(data)

Writes audio data.

Levanta:

ClientException – The AudioData is already finished writing.

cleanup()

Finishes and cleans up the audio data.

Levanta:

ClientException – The AudioData is already finished writing.

on_format(encoding)

Called when audio data is formatted.

Levanta:

ClientException – The AudioData is still writing.

class discord.sinks.RawData(data, client)

Handles raw data from Discord so that it can be decrypted and decoded to be used.

Adicionado na versão 2.0.

Sink Classes

class discord.sinks.WaveSink(*, filters=None)

A special sink for .wav(wave) files.

Adicionado na versão 2.0.

format_audio(audio)

Formats the recorded audio.

Levanta:

• WaveSinkError – Audio may only be formatted after recording is finished.

• WaveSinkError – Formatting the audio failed.

class discord.sinks.MP3Sink(*, filters=None)

A special sink for .mp3 files.

Adicionado na versão 2.0.

format_audio(audio)

Formats the recorded audio.

Levanta:

• MP3SinkError – Audio may only be formatted after recording is finished.

• MP3SinkError – Formatting the audio failed.

class discord.sinks.MP4Sink(*, filters=None)

A special sink for .mp4 files.

Adicionado na versão 2.0.

format_audio(audio)

Formats the recorded audio.

Levanta:

• MP4SinkError – Audio may only be formatted after recording is finished.

• MP4SinkError – Formatting the audio failed.

class discord.sinks.M4ASink(*, filters=None)

A special sink for .m4a files.

Adicionado na versão 2.0.

format_audio(audio)

Formats the recorded audio.

Levanta:

• M4ASinkError – Audio may only be formatted after recording is finished.

• M4ASinkError – Formatting the audio failed.

class discord.sinks.MKVSink(*, filters=None)

A special sink for .mkv files.

Adicionado na versão 2.0.

format_audio(audio)

Formats the recorded audio.

Levanta:

• MKVSinkError – Audio may only be formatted after recording is finished.

• MKVSinkError – Formatting the audio failed.

class discord.sinks.MKASink(*, filters=None)

A special sink for .mka files.

Adicionado na versão 2.0.

format_audio(audio)

Formats the recorded audio.

Levanta:

• MKASinkError – Audio may only be formatted after recording is finished.

• MKASinkError – Formatting the audio failed.

class discord.sinks.OGGSink(*, filters=None)

A special sink for .ogg files.

Adicionado na versão 2.0.

format_audio(audio)

Formats the recorded audio.

Levanta:

• OGGSinkError – Audio may only be formatted after recording is finished.

• OGGSinkError – Formatting the audio failed.