Skip to main content
`Ctrl`+`K`

# SearchParams

class beets.metadata_plugins.SearchParams(query_type: QueryType, query: str, filters: dict[str, str], limit: int)

  Bases: `NamedTuple`

  Bundle normalized search context passed to provider search hooks.

  Shared search orchestration constructs this value so plugin hooks receive one object describing search intent, query text, and provider filters.

  __init__()

  Public methods summary

  `count`(value, /) | Return number of occurrences of value.
  `index`(value[, start, stop]) | Return first index of value.

  Methods definition

  query_type: Literal['album', 'track']

    Alias for field number 0

  query: str

    Alias for field number 1

  filters: dict[str, str]

    Alias for field number 2

  limit: int

    Alias for field number 3

  count(value, /)

    Return number of occurrences of value.

  index(value, start=0, stop=9223372036854775807, /)

    Return first index of value.

    Raises ValueError if the value is not present.