@ctrl/plex
    Preparing search index...

    Interface SearchArgs

    interface SearchArgs {
        container_size: number;
        container_start: number;
        duplicate: number;
        filters?: AdvancedSearchFilters;
        includeGuids: boolean;
        libtype:
            | "track"
            | "artist"
            | "album"
            | "movie"
            | "show"
            | "season"
            | "episode"
            | "trailer"
            | "comic"
            | "person"
            | "picture"
            | "clip"
            | "photo"
            | "photoalbum"
            | "playlist"
            | "playlistFolder"
            | "collection"
            | "optimizedVersion"
            | "userPlaylistItem";
        limit: number;
        maxresults: number;
        sort: string
        | string[]
        | FilteringSort
        | FilteringSort[];
        title: string | string[];
        [key: string]: SearchArgValue;
    }

    Indexable

    Index

    Properties

    container_size container_start duplicate filters? includeGuids libtype limit maxresults sort title

    Properties

    container_size: number

    Default 100 (X_PLEX_CONTAINER_SIZE)

    container_start: number

    Default 0

    duplicate: number

    Return only results that have duplicates.

    filters?: AdvancedSearchFilters

    Advanced filters object used by music searches.

    includeGuids: boolean

    Include GUID data in metadata responses. Defaults to true.

    libtype:
        | "track"
        | "artist"
        | "album"
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem"

    Return results of a specific type (movie, show, season, episode, artist, album, track, photoalbum, photo, collection) (e.g. libtype='movie' will only return Movie objects)

    limit: number

    Limit the number of results from the filter.

    maxresults: number

    Only return the specified number of results.

    sort: string | string[] | FilteringSort | FilteringSort[]

    A string of comma separated sort fields or a list of sort fields in the format column:dir.

    title: string | string[]

    General string query to search for. Partial string matches are allowed.

    Settings

    Member Visibility

    On This Page

    Properties