pyrit.prompt_converter.AudioFrequencyConverter

pyrit.prompt_converter.AudioFrequencyConverter#

class AudioFrequencyConverter(*, output_format: Literal['wav'] = 'wav', shift_value: int = 20000)[source]#

Bases: PromptConverter

The AudioFrequencyConverter takes an audio file and shifts its frequency, by default it will shift it above human range (=20kHz). :param output_format: The format of the audio file. Defaults to “wav”. :type output_format: str :param shift_value: The value by which the frequency will be shifted. Defaults to 20000 Hz. :type shift_value: int

__init__(*, output_format: Literal['wav'] = 'wav', shift_value: int = 20000) → None[source]#

Methods

__init__(*[, output_format, shift_value])

convert_async(*, prompt[, input_type])

Convert an audio file by shifting its frequency.

convert_tokens_async(*, prompt[, ...])

Converts substrings within a prompt that are enclosed by specified start and end tokens.

get_identifier()

input_supported(input_type)

Checks if the input type is supported by the converter

output_supported(output_type)

Checks if the output type is supported by the converter

Attributes

AcceptedAudioFormats

alias of Literal['wav']

supported_input_types

Returns a list of supported input types for the converter.

supported_output_types

Returns a list of supported output types for the converter.
AcceptedAudioFormats#

alias of Literal[‘wav’]

async convert_async(*, prompt: str, input_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'url', 'error'] = 'audio_path') → ConverterResult[source]#

Convert an audio file by shifting its frequency.

Parameters:

  • prompt (str) – File path to audio file

  • input_type (PromptDataType) – Type of data, defaults to “audio_path”

Raises:

ValueError – If the input type is not supported.

Returns:

The converted audio file as a ConverterResult object.

Return type:

ConverterResult

input_supported(input_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'url', 'error']) → bool[source]#

Checks if the input type is supported by the converter

Parameters:

input_type – The input type to check

Returns:

True if the input type is supported, False otherwise

Return type:

bool

output_supported(output_type: Literal['text', 'image_path', 'audio_path', 'video_path', 'url', 'error']) → bool[source]#

Checks if the output type is supported by the converter

Parameters:

output_type – The output type to check

Returns:

True if the output type is supported, False otherwise

Return type:

bool

Contents