Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias SearchHint

    Class SearchHintResult.

    type SearchHint = {
        ItemId?: string;
        Id?: string;
        Name?: string;
        MatchedTerm?: string | null;
        IndexNumber?: number | null;
        ProductionYear?: number | null;
        ParentIndexNumber?: number | null;
        PrimaryImageTag?: string | null;
        ThumbImageTag?: string | null;
        ThumbImageItemId?: string | null;
        BackdropImageTag?: string | null;
        BackdropImageItemId?: string | null;
        Type?:
            | "AggregateFolder"
            | "Audio"
            | "AudioBook"
            | "BasePluginFolder"
            | "Book"
            | "BoxSet"
            | "Channel"
            | "ChannelFolderItem"
            | "CollectionFolder"
            | "Episode"
            | "Folder"
            | "Genre"
            | "ManualPlaylistsFolder"
            | "Movie"
            | "LiveTvChannel"
            | "LiveTvProgram"
            | "MusicAlbum"
            | "MusicArtist"
            | "MusicGenre"
            | "MusicVideo"
            | "Person"
            | "Photo"
            | "PhotoAlbum"
            | "Playlist"
            | "PlaylistsFolder"
            | "Program"
            | "Recording"
            | "Season"
            | "Series"
            | "Studio"
            | "Trailer"
            | "TvChannel"
            | "TvProgram"
            | "UserRootFolder"
            | "UserView"
            | "Video"
            | "Year";
        IsFolder?: boolean
        | null;
        RunTimeTicks?: number | null;
        MediaType?: "Unknown" | "Video" | "Audio" | "Photo" | "Book";
        StartDate?: string | null;
        EndDate?: string | null;
        Series?: string | null;
        Status?: string | null;
        Album?: string | null;
        AlbumId?: string | null;
        AlbumArtist?: string | null;
        Artists?: string[];
        SongCount?: number | null;
        EpisodeCount?: number | null;
        ChannelId?: string | null;
        ChannelName?: string | null;
        PrimaryImageAspectRatio?: number | null;
    }
    Index
    ItemId? Id? Name? MatchedTerm? IndexNumber? ProductionYear? ParentIndexNumber? PrimaryImageTag? ThumbImageTag? ThumbImageItemId? BackdropImageTag? BackdropImageItemId? Type? IsFolder? RunTimeTicks? MediaType? StartDate? EndDate? Series? Status? Album? AlbumId? AlbumArtist? Artists? SongCount? EpisodeCount? ChannelId? ChannelName? PrimaryImageAspectRatio?
    ItemId?: string

    Gets or sets the item id.

    Id?: string

    Gets or sets the item id.

    Name?: string

    Gets or sets the name.

    MatchedTerm?: string | null

    Gets or sets the matched term.

    IndexNumber?: number | null

    Gets or sets the index number.

    ProductionYear?: number | null

    Gets or sets the production year.

    ParentIndexNumber?: number | null

    Gets or sets the parent index number.

    PrimaryImageTag?: string | null

    Gets or sets the image tag.

    ThumbImageTag?: string | null

    Gets or sets the thumb image tag.

    ThumbImageItemId?: string | null

    Gets or sets the thumb image item identifier.

    BackdropImageTag?: string | null

    Gets or sets the backdrop image tag.

    BackdropImageItemId?: string | null

    Gets or sets the backdrop image item identifier.

    Type?:
        | "AggregateFolder"
        | "Audio"
        | "AudioBook"
        | "BasePluginFolder"
        | "Book"
        | "BoxSet"
        | "Channel"
        | "ChannelFolderItem"
        | "CollectionFolder"
        | "Episode"
        | "Folder"
        | "Genre"
        | "ManualPlaylistsFolder"
        | "Movie"
        | "LiveTvChannel"
        | "LiveTvProgram"
        | "MusicAlbum"
        | "MusicArtist"
        | "MusicGenre"
        | "MusicVideo"
        | "Person"
        | "Photo"
        | "PhotoAlbum"
        | "Playlist"
        | "PlaylistsFolder"
        | "Program"
        | "Recording"
        | "Season"
        | "Series"
        | "Studio"
        | "Trailer"
        | "TvChannel"
        | "TvProgram"
        | "UserRootFolder"
        | "UserView"
        | "Video"
        | "Year"

    Gets or sets the type.

    IsFolder?: boolean | null

    Gets or sets a value indicating whether this instance is folder.

    RunTimeTicks?: number | null

    Gets or sets the run time ticks.

    MediaType?: "Unknown" | "Video" | "Audio" | "Photo" | "Book"

    Gets or sets the type of the media.

    StartDate?: string | null

    Gets or sets the start date.

    EndDate?: string | null

    Gets or sets the end date.

    Series?: string | null

    Gets or sets the series.

    Status?: string | null

    Gets or sets the status.

    Album?: string | null

    Gets or sets the album.

    AlbumId?: string | null

    Gets or sets the album id.

    AlbumArtist?: string | null

    Gets or sets the album artist.

    Artists?: string[]

    Gets or sets the artists.

    SongCount?: number | null

    Gets or sets the song count.

    EpisodeCount?: number | null

    Gets or sets the episode count.

    ChannelId?: string | null

    Gets or sets the channel identifier.

    ChannelName?: string | null

    Gets or sets the name of the channel.

    PrimaryImageAspectRatio?: number | null

    Gets or sets the primary image aspect ratio.

    Settings
    Member Visibility

    On This Page
    Properties