mpd/search.h File Reference
MPD client library.
More...
Go to the source code of this file.
Enumerations |
enum | mpd_operator { MPD_OPERATOR_DEFAULT
} |
Functions |
bool | mpd_search_db_songs (struct mpd_connection *connection, bool exact) |
bool | mpd_search_add_db_songs (struct mpd_connection *connection, bool exact) |
bool | mpd_search_queue_songs (struct mpd_connection *connection, bool exact) |
bool | mpd_search_db_tags (struct mpd_connection *connection, enum mpd_tag_type type) |
bool | mpd_count_db_songs (struct mpd_connection *connection) |
bool | mpd_search_add_uri_constraint (struct mpd_connection *connection, enum mpd_operator oper, const char *value) |
bool | mpd_search_add_tag_constraint (struct mpd_connection *connection, enum mpd_operator oper, enum mpd_tag_type type, const char *value) |
bool | mpd_search_add_any_tag_constraint (struct mpd_connection *connection, enum mpd_operator oper, const char *value) |
bool | mpd_search_commit (struct mpd_connection *connection) |
void | mpd_search_cancel (struct mpd_connection *connection) |
mpd_malloc struct mpd_pair * | mpd_recv_pair_tag (struct mpd_connection *connection, enum mpd_tag_type type) |
Detailed Description
MPD client library.
Search songs in the database or the queue.
Do not include this header directly. Use mpd/client.h instead.
Definition in file search.h.
Enumeration Type Documentation
This type is not yet used, it is reserved for a future protocol extension which will allow us to specify a comparison operator for constraints.
- Enumerator:
MPD_OPERATOR_DEFAULT |
The default search operator. If "exact" was passed as "true", then it means "full string comparison"; if false, then it means "search for substring".
|
Definition at line 55 of file search.h.
Function Documentation
Same as mpd_recv_pair_named(), but the pair name is specified as mpd_tag_type.
- Parameters:
-
| connection | the connection to MPD |
| type | the tag type you are looking for |
- Returns:
- a pair, or NULL on error or if there are no more matching pairs in this response
Add a constraint to a search, search for a value in any tag.
- Parameters:
-
- Returns:
- true on success, false on error
bool mpd_search_add_db_songs |
( |
struct mpd_connection * |
connection, |
|
|
bool |
exact | |
|
) |
| | |
Search for songs in the database and adds the result to the queue. Constraints may be specified with mpd_search_add_tag_constraint(). Send the search command with mpd_search_commit().
- Parameters:
-
| connection | the connection to MPD |
| exact | if to match exact (only "true" supported by MPD 0.16) |
- Returns:
- true on success, false on error
Add a constraint to a search limiting the value of a tag.
- Parameters:
-
- Returns:
- true on success, false on error
Add a constraint on the song's URI.
- Parameters:
-
- Returns:
- true on success, false on error
Cancels the search request before you have called mpd_search_commit(). Call this to clear the current search request.
- Parameters:
-
| connection | the connection to MPD |
Starts the real search with constraints added with mpd_search_add_constraint().
- Parameters:
-
| connection | the connection to MPD |
- Returns:
- true on success, false on error
bool mpd_search_db_songs |
( |
struct mpd_connection * |
connection, |
|
|
bool |
exact | |
|
) |
| | |
Obtains a list of unique tag values from the database. Constraints may be specified with mpd_search_add_tag_constraint(). Send the search command with mpd_search_commit(), and read the response items with mpd_recv_pair_tag().
- Parameters:
-
| connection | the connection to MPD |
| type | The type of the tags to search for |
- Returns:
- true on success, false on error
bool mpd_search_queue_songs |
( |
struct mpd_connection * |
connection, |
|
|
bool |
exact | |
|
) |
| | |