AI DevKit
Search Results for

    Show / Hide Table of Contents

    Class GENSoundEffectTask

    Task for generating sound effects based on a text prompt.

    Inheritance
    object
    TaskBase<GENSoundEffectTask, GeneratedAudio>
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>
    GENAudioGenerationTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>>
    GENSoundEffectTask
    Implements
    IGENTask
    Inherited Members
    GENAudioGenerationTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>>.ResponseMimeType
    GENAudioGenerationTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>>.Seed
    GENAudioGenerationTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>>.SetEncoding(AudioEncoding)
    GENAudioGenerationTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>>.SetSeed(uint)
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.Api
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.Prompt
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.ModelId
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.OutputFilePath
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.OutputFileNote
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.RecordHistory
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.SaveGeneratedContents
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.N
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.MaxN
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.Options
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.SetModel(Api, string)
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.SetModel(Model)
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.SetCount(int)
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.SaveContentsTo(string, string)
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.EnablePromptHistory(bool)
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.SetRequestMimeType(MIMEType)
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.SetResponseMimeType(MIMEType)
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.SetOptions(IGENSoundEffectOptions)
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.ExecuteAsync()
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.YieldAsync()
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.ResolveOutputPath(Api?, string)
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.GetPrompt()
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.YieldAsyncINTERNAL()
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.CreateMergedHistoryRecordINTERNAL(List<GeneratedAudio>)
    TaskBase<GENSoundEffectTask, GeneratedAudio>.Method
    TaskBase<GENSoundEffectTask, GeneratedAudio>.Cts
    TaskBase<GENSoundEffectTask, GeneratedAudio>.Token
    TaskBase<GENSoundEffectTask, GeneratedAudio>.Api
    TaskBase<GENSoundEffectTask, GeneratedAudio>.Sender
    TaskBase<GENSoundEffectTask, GeneratedAudio>.IgnoreLogs
    TaskBase<GENSoundEffectTask, GeneratedAudio>.IsCanceled
    TaskBase<GENSoundEffectTask, GeneratedAudio>.RequestMimeType
    TaskBase<GENSoundEffectTask, GeneratedAudio>.ResponseMimeType
    TaskBase<GENSoundEffectTask, GeneratedAudio>.IsWrapperTask
    TaskBase<GENSoundEffectTask, GeneratedAudio>.SetSender(string)
    TaskBase<GENSoundEffectTask, GeneratedAudio>.SetIgnoreLogs(bool)
    TaskBase<GENSoundEffectTask, GeneratedAudio>.SetCancellationToken(CancellationToken)
    TaskBase<GENSoundEffectTask, GeneratedAudio>.ExecuteAsync()
    TaskBase<GENSoundEffectTask, GeneratedAudio>.ExecuteAsyncINTERNAL()
    TaskBase<GENSoundEffectTask, GeneratedAudio>.ExecuteAsync<T>()
    TaskBase<GENSoundEffectTask, GeneratedAudio>.CancelTask()
    Namespace: Glitch9.AIDevKit
    Assembly: .dll
    Syntax
    public class GENSoundEffectTask : GENAudioGenerationTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>>, IGENTask

    Constructors

    GENSoundEffectTask(Weighted<string>)

    Declaration
    public GENSoundEffectTask(Weighted<string> prompt)
    Parameters
    Type Name Description
    Weighted<string> prompt

    Properties

    DurationSeconds

    Declaration
    public double? DurationSeconds { get; set; }
    Property Value
    Type Description
    double?

    Method

    Declaration
    public override string Method { get; }
    Property Value
    Type Description
    string
    Overrides
    TaskBase<GENSoundEffectTask, GeneratedAudio>.Method

    Methods

    ExecuteAsyncINTERNAL()

    Declaration
    protected override UniTask<GeneratedAudio> ExecuteAsyncINTERNAL()
    Returns
    Type Description
    UniTask<GeneratedAudio>
    Overrides
    TaskBase<GENSoundEffectTask, GeneratedAudio>.ExecuteAsyncINTERNAL()

    ResolveOutputPath(Api?, string)

    Declaration
    protected override GENSoundEffectTask ResolveOutputPath(Api? api = null, string keyword = null)
    Parameters
    Type Name Description
    Api? api
    string keyword
    Returns
    Type Description
    GENSoundEffectTask
    Overrides
    GENTask<GENSoundEffectTask, IGENSoundEffectOptions, Weighted<string>, GeneratedAudio>.ResolveOutputPath(Api?, string)

    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

    Implements

    IGENTask
    In this article
    Back to top Generated by DocFX