AI Dev Kit
Search Results for

    Show / Hide Table of Contents

    Class GENSoundEffectTask

    Task for generating sound effects based on a text prompt.

    Inheritance
    object
    GENTask<GENSoundEffectTask, string, GeneratedAudio>
    GENAudioOutputTask<GENSoundEffectTask, string>
    GENSoundEffectTask
    Implements
    IGENTask
    Inherited Members
    GENAudioOutputTask<GENSoundEffectTask, string>.outputMimeType
    GENAudioOutputTask<GENSoundEffectTask, string>.SetEncoding(AudioEncoding)
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.token
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.enableHistory
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.isCanceled
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.outputMimeType
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.Cancel()
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.SetOption(string, object)
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.TryGetOption<T>(string, out T)
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.SetModel(Model)
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.SetCount(int)
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.SetOutputPath(string)
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.SetSender(string)
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.SetIgnoreLogs(bool)
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.EnablePromptHistory(bool)
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.SetTextToTarget(GeneratedText)
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.SetImageToTarget(GeneratedImage)
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.SetAudioToTarget(GeneratedAudio)
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.ExecuteAsync()
    Namespace: Glitch9.AIDevKit
    Assembly: .dll
    Syntax
    public class GENSoundEffectTask : GENAudioOutputTask<GENSoundEffectTask, string>, IGENTask

    Constructors

    GENSoundEffectTask(string, Object)

    Declaration
    public GENSoundEffectTask(string prompt, UnityEngine.Object target = null)
    Parameters
    Type Name Description
    string prompt
    Object target

    Methods

    ExecuteAsync()

    Executes the task and returns the generated result.

    Declaration
    public override UniTask<GeneratedAudio> ExecuteAsync()
    Returns
    Type Description
    UniTask<GeneratedAudio>
    Overrides
    GENTask<GENSoundEffectTask, string, GeneratedAudio>.ExecuteAsync()

    SetDuration(double)

    Sets the duration of the generated sound effect in seconds.

    Declaration
    public GENSoundEffectTask SetDuration(double durationSeconds)
    Parameters
    Type Name Description
    double durationSeconds
    Returns
    Type Description
    GENSoundEffectTask

    SetPromptInfluence(double)

    Sets the influence of the prompt on the generated sound effect.

    Declaration
    public GENSoundEffectTask SetPromptInfluence(double promptInfluence)
    Parameters
    Type Name Description
    double promptInfluence

    Value between 0 and 1.

    Returns
    Type Description
    GENSoundEffectTask

    Implements

    IGENTask

    Extension Methods

    FluentAPIExtensions.SetOutputFormat(GENSoundEffectTask, ElevenLabsOutputFormat)
    FluentAPIExtensions.SetAspectRatio<TTask>(TTask, AspectRatio)
    FluentAPIExtensions.SetPersonGeneration<TTask>(TTask, PersonGeneration)
    FluentAPIExtensions.SetSize<T>(T, ImageSize)
    In this article
    Back to top Generated by DocFX