Class AudioPrompt

A specialized prompt for various audio-related requests, such as voice change, audio isolation, etc.
This class is used to pass the instruction and the audio to the respective audio model for processing.

Inheritance
object
AudioPrompt
Implements
Inherited Members
Namespace: Glitch9.AIDevKit
Assembly: Glitch9.AIDevKit.dll
Syntax
public sealed class AudioPrompt : ILoadablePrompt, IPrompt, IValidatable

Constructors

| Edit this page View Source

AudioPrompt()

Declaration
public AudioPrompt()
| Edit this page View Source

AudioPrompt(Weighted<File<AudioClip>>)

Declaration
public AudioPrompt(Weighted<File<AudioClip>> audio)
Parameters
Type Name Description
Weighted<File<AudioClip>> audio
| Edit this page View Source

AudioPrompt(string)

Declaration
public AudioPrompt(string text)
Parameters
Type Name Description
string text
| Edit this page View Source

AudioPrompt(string, Weighted<File<AudioClip>>)

Declaration
public AudioPrompt(string text, Weighted<File<AudioClip>> audio)
Parameters
Type Name Description
string text
Weighted<File<AudioClip>> audio

Properties

| Edit this page View Source

Audio

It's either the reference audio for audio generation or the audio to be edited for audio editing tasks.

Declaration
public Weighted<File<AudioClip>>? Audio { get; set; }
Property Value
Type Description
Weighted<File<AudioClip>>?
| Edit this page View Source

Text

Either the text description of the audio to be generated or the editing instruction.

Declaration
public string Text { get; set; }
Property Value
Type Description
string

Methods

| Edit this page View Source

ArePromptFilesRequireLoading()

Declaration
public bool ArePromptFilesRequireLoading()
Returns
Type Description
bool
| Edit this page View Source

GetPromptFiles()

Declaration
public IFile[] GetPromptFiles()
Returns
Type Description
IFile[]
| Edit this page View Source

GetPromptText()

Declaration
public string GetPromptText()
Returns
Type Description
string
| Edit this page View Source

IsValid()

Declaration
public bool IsValid()
Returns
Type Description
bool
| Edit this page View Source

LoadPromptFilesAsync()

Declaration
public UniTask LoadPromptFilesAsync()
Returns
Type Description
UniTask
| Edit this page View Source

Validate()

Validates the object's parameters and throws if invalid.

Declaration
public void Validate()

Operators

| Edit this page View Source

implicit operator AudioClip(AudioPrompt)

Declaration
public static implicit operator AudioClip(AudioPrompt prompt)
Parameters
Type Name Description
AudioPrompt prompt
Returns
Type Description
AudioClip
| Edit this page View Source

implicit operator AudioPrompt(File<AudioClip>)

Declaration
public static implicit operator AudioPrompt(File<AudioClip> audioFile)
Parameters
Type Name Description
File<AudioClip> audioFile
Returns
Type Description
AudioPrompt
| Edit this page View Source

implicit operator AudioPrompt(AudioClip)

Declaration
public static implicit operator AudioPrompt(AudioClip audioClip)
Parameters
Type Name Description
AudioClip audioClip
Returns
Type Description
AudioPrompt

Implements

Extension Methods