Class SoundEffectGenerationRequest

Task for generating sound effects based on a text prompt.

Inheritance
object
UnifiedApiRequestBase<SoundEffectGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>
GenerativeRequest<SoundEffectGenerationRequest, Weighted<Prompt>, IAudioAsset, IAudioRequestOptions>
StreamingGenerativeRequest<SoundEffectGenerationRequest, Weighted<Prompt>, IAudioAsset, Delta<IAudioChunk>, IAudioRequestOptions>
GenerativeAudioRequest<SoundEffectGenerationRequest, Weighted<Prompt>, IAudioRequestOptions>
SoundEffectGenerationRequest
Implements
Inherited Members
Namespace: Glitch9.AIDevKit
Assembly: Glitch9.AIDevKit.dll
Syntax
public class SoundEffectGenerationRequest : GenerativeAudioRequest<SoundEffectGenerationRequest, Weighted<Prompt>, IAudioRequestOptions>, IGenerativeRequest, IStreamingGenerativeRequest<Delta<IAudioChunk>, IAudioAsset>

Constructors

| Edit this page View Source

SoundEffectGenerationRequest(Weighted<Prompt>)

Declaration
public SoundEffectGenerationRequest(Weighted<Prompt> prompt)
Parameters
Type Name Description
Weighted<Prompt> prompt
| Edit this page View Source

SoundEffectGenerationRequest(string, float?)

Declaration
public SoundEffectGenerationRequest(string prompt, float? promptStrength = null)
Parameters
Type Name Description
string prompt
float? promptStrength

Properties

| Edit this page View Source

Api

The cloud service provider associated with this task. Automatically resolved from the selected model if not explicitly set.

Declaration
public override Api Api { get; }
Property Value
Type Description
Api
Overrides
| Edit this page View Source

DurationSeconds

Declaration
public double? DurationSeconds { get; set; }
Property Value
Type Description
double?
| Edit this page View Source

FileNameKey

Declaration
protected override string FileNameKey { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

ModelType

Declaration
public override ModelType ModelType { get; }
Property Value
Type Description
ModelType
Overrides
| Edit this page View Source

RequestType

The endpoint type for this

Declaration
public override RequestType RequestType { get; }
Property Value
Type Description
RequestType
Overrides

Methods

| Edit this page View Source

ExecuteAsyncInternal()

Executes the actual task logic. Must be implemented in derived classes.

Declaration
protected override UniTask<Generated<IAudioAsset>> ExecuteAsyncInternal()
Returns
Type Description
UniTask<Generated<IAudioAsset>>
Overrides
| Edit this page View Source

SetDuration(double)

Sets the duration of the generated sound effect in seconds.

Declaration
public SoundEffectGenerationRequest SetDuration(double durationSeconds)
Parameters
Type Name Description
double durationSeconds
Returns
Type Description
SoundEffectGenerationRequest
| Edit this page View Source

StreamAsyncInternal()

Declaration
protected override IGenerativeStream<Delta<IAudioChunk>, IAudioAsset> StreamAsyncInternal()
Returns
Type Description
IGenerativeStream<Delta<IAudioChunk>, IAudioAsset>
Overrides

Implements

Extension Methods