@ctrl/plex
    Preparing search index...

    Interface LibraryAddOptions<T>

    interface LibraryAddOptions<
        T extends LibrarySectionCreateType = LibrarySectionCreateType,
    > {
        agent: string;
        language?: string;
        locations: string | readonly string[];
        name: string;
        preferences?: Record<string, SettingValue>;
        scanner: string;
        type: T;
    }

    Type Parameters

    Index
    agent language? locations name preferences? scanner type
    agent: string

    Metadata agent identifier, such as tv.plex.agents.movie.

    language?: string

    Library language. Defaults to en-US, matching Plex/Python behavior.

    locations: string | readonly string[]

    One or more server-visible folder paths to add to this section.

    name: string

    Library section title.

    preferences?: Record<string, SettingValue>

    Advanced preference values. Keys are encoded as prefs[<key>].

    scanner: string

    Scanner name, such as Plex Movie.

    type: T

    Plex library section type.

    Settings
    Member Visibility

    On This Page
    Properties