Member Junction
    Preparing search index...

    Interface NarrationOptions

    Options for RunNarrationPipeline.

    interface NarrationOptions {
        AgentID?: string;
        AgentRunID?: string;
        APIKeys?: AIAPIKey[];
        BindingText?: Record<string, string>;
        CancellationToken?: AbortSignal;
        ContextUser: UserInfo;
        CredentialScope?: AICredentialScope;
        FilmBounds?: FilmDurationBounds;
        ModelID?: string;
        Provider?: IMetadataProvider;
        StorageAccountID?: string;
    }
    Index

    Properties

    AgentID? AgentRunID? APIKeys? BindingText? CancellationToken? ContextUser CredentialScope? FilmBounds? ModelID? Provider? StorageAccountID?

    Properties

    AgentID?: string

    Optional owning AIAgent.ID for prompt-run attribution.

    AgentRunID?: string

    Optional owning AIAgentRun.ID for prompt-run attribution.

    APIKeys?: AIAPIKey[]

    Optional runtime API keys forwarded to AITextToSpeechRunner.

    BindingText?: Record<string, string>

    Map of binding keys to pre-formatted display text for {Key} placeholder substitution.

    CancellationToken?: AbortSignal

    Optional cancellation signal forwarded to each TTS runner invocation.

    ContextUser: UserInfo

    Authenticated user context for model configuration, prompt runner, and storage.

    CredentialScope?: AICredentialScope

    Optional credential resolution scope forwarded to AITextToSpeechRunner.

    FilmBounds?: FilmDurationBounds

    Optional film-level duration bounds from the video archetype.

    ModelID?: string

    Optional explicit AIModel.ID override; when omitted, resolved from Audio.Narration.Provider.

    Provider?: IMetadataProvider

    Optional scoped metadata provider forwarded to the runner and storage engine.

    StorageAccountID?: string

    Optional explicit FileStorageAccount.ID for clip and caption uploads.

    Settings

    Member Visibility

    On This Page

    Properties