Search Results for

    Show / Hide Table of Contents

    Class MusicGenerationRequest

    Request for generating music from a text prompt.

    Inheritance
    object
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>
    StreamingGenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, Delta<IAudioChunk>, IAudioRequestOptions>
    GenerativeAudioRequest<MusicGenerationRequest, Prompt, IAudioRequestOptions>
    MusicGenerationRequest
    Implements
    IGenerativeRequest
    IStreamingGenerativeRequest<Delta<IAudioChunk>, IAudioAsset>
    Inherited Members
    GenerativeAudioRequest<MusicGenerationRequest, Prompt, IAudioRequestOptions>.ResponseType
    GenerativeAudioRequest<MusicGenerationRequest, Prompt, IAudioRequestOptions>.OutputFormat
    GenerativeAudioRequest<MusicGenerationRequest, Prompt, IAudioRequestOptions>.SetEncoding(AudioEncoding)
    GenerativeAudioRequest<MusicGenerationRequest, Prompt, IAudioRequestOptions>.SetElevenLabsFormat(ElevenLabsTypes.OutputFormat)
    StreamingGenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, Delta<IAudioChunk>, IAudioRequestOptions>.StreamAsync(CancellationToken)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.ModelType
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.Api
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.Prompt
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.Model
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.N
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.Seed
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.MeasureLatency
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.OnLatencyMeasured
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.RequestedAt
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.RecordOptions
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.RecordedContext
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.SetModel(Api, string)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.SetModel(ModelBase)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.SetCount(int)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.SetN(int)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.SetSeed(long)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.SetRecordOptions(bool?, bool?, string, string, GenerationRecord, RecordMerger, Action<GenerationRecord>)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.SetRecordOptions(GenerationRecordOptions)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.SetMeasureLatency(Action<double>)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.SetMeasureLatency(bool, Action<double>)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.SetPlaygroundSettings(string, string, string, bool, Action<double>, Action<GenerationRecord>)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.ExecuteAsync(CancellationToken)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.ExecuteAsyncT<T>(CancellationToken)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.ProcessPostRequestTasks<T>(Generated<T>)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.ProcessPostRequestTasks(IResult)
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.GetPrompt()
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.GetPromptStringToRecord()
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.Api
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.RequestType
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.HttpOptions
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.DownloadOptions
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.Sender
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.LogOptions
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.ContentType
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.ResponseType
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.IsCanceled
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.Stream
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.SafetyIdentifier
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.ServiceTier
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.Metadata
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.ProviderOptions
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.Options
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.SetSender(string)
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.SetLogOptions(CurlLogOptions)
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.SetOutputPath(string)
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.SetOutputPath(string, string)
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.SetOutputDirectory(string)
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.SetDownloadOptions(DownloadOptions)
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.SetRequestMimeType(MimeType)
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.SetResponseMimeType(MimeType)
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.SetStream(bool)
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.SetMetadata(ServerDictionary)
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.SetSafetyIdentifier(string)
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.SetProviderOptions(IAudioRequestOptions)
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.SetSpecificOptions(IAudioRequestOptions)
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.GetConfig<T>()
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.ExecuteAsync(CancellationToken)
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.Cancel()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Glitch9.AIDevKit
    Assembly: Glitch9.AIDevKit.dll
    Syntax
    public sealed class MusicGenerationRequest : GenerativeAudioRequest<MusicGenerationRequest, Prompt, IAudioRequestOptions>, IGenerativeRequest, IStreamingGenerativeRequest<Delta<IAudioChunk>, IAudioAsset>

    Constructors

    | Edit this page View Source

    MusicGenerationRequest(Prompt)

    Declaration
    public MusicGenerationRequest(Prompt prompt)
    Parameters
    Type Name Description
    Prompt prompt

    Properties

    | Edit this page View Source

    DurationSeconds

    The duration of the generated music in seconds.

    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
    GenerativeAudioRequest<MusicGenerationRequest, Prompt, IAudioRequestOptions>.FileNameKey
    | Edit this page View Source

    ModelType

    Declaration
    public override ModelType ModelType { get; }
    Property Value
    Type Description
    ModelType
    Overrides
    GenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, IAudioRequestOptions>.ModelType
    | Edit this page View Source

    RequestType

    The endpoint type for this

    Declaration
    public override RequestType RequestType { get; }
    Property Value
    Type Description
    RequestType
    Overrides
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.RequestType

    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
    UnifiedApiRequestBase<MusicGenerationRequest, Generated<IAudioAsset>, IAudioRequestOptions>.ExecuteAsyncInternal()
    | Edit this page View Source

    SetDuration(double)

    Sets the duration of the generated music in seconds.

    Declaration
    public MusicGenerationRequest SetDuration(double durationSeconds)
    Parameters
    Type Name Description
    double durationSeconds

    Duration in seconds (typically between 10-300 seconds depending on provider).

    Returns
    Type Description
    MusicGenerationRequest

    This request instance for method chaining.

    | Edit this page View Source

    StreamAsyncInternal()

    Declaration
    protected override IGenerativeStream<Delta<IAudioChunk>, IAudioAsset> StreamAsyncInternal()
    Returns
    Type Description
    IGenerativeStream<Delta<IAudioChunk>, IAudioAsset>
    Overrides
    StreamingGenerativeRequest<MusicGenerationRequest, Prompt, IAudioAsset, Delta<IAudioChunk>, IAudioRequestOptions>.StreamAsyncInternal()

    Implements

    IGenerativeRequest
    IStreamingGenerativeRequest<TEvent, TAsset>

    Extension Methods

    ArrayExtensions.ToArrayOrEmpty<T>(T)
    ArrayExtensions.ToArrayOrNull<T>(T)
    EventExtensions.ToDelta<T>(T, string, int, string, bool)
    EventExtensions.ToDone<T>(T, string, int, string)
    EventExtensions.ToEvent<T>(T)
    EventExtensions.UpcastDelta<T1, T2>(T1, string, int, string, bool)
    FallbackExtensions.IsOr<TParent, TChild>(TParent, TChild)
    ResponseCastingExtensions.GetResult<T>(T)
    SystemExtensions.GetName(object)
    • Edit this page
    • View Source
    In this article
    Back to top AI DevKit Documentation