LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Media::AudioSearchRequest Struct Reference

Describes a request for an audio search in an IAudioPile. More...

#include "iaudiopile.h"

Public Member Functions

 AudioSearchRequest ()
 Creates an empty audio search request. More...
 

Public Attributes

QString Title_
 The title of a track. More...
 
QString Artist_
 The artist performing the track. More...
 
QString Album_
 The album containing this track. More...
 
int TrackLength_
 The approximate length of the track. More...
 
QString FreeForm_
 Free form engine-specific request. More...
 

Detailed Description

Describes a request for an audio search in an IAudioPile.

Different audio piles support filtering by different criteria, so calling plugins should not rely on all criteria being fulfilled. But at least filtering by either title, artist or free form request should be supported.

See Also
IAudioPile

Definition at line 122 of file iaudiopile.h.

Constructor & Destructor Documentation

Media::AudioSearchRequest::AudioSearchRequest ( )
inline

Creates an empty audio search request.

Definition at line 155 of file iaudiopile.h.

Member Data Documentation

QString Media::AudioSearchRequest::Album_

The album containing this track.

Definition at line 138 of file iaudiopile.h.

QString Media::AudioSearchRequest::Artist_

The artist performing the track.

At least this or Title_ field should not be empty.

Definition at line 134 of file iaudiopile.h.

QString Media::AudioSearchRequest::FreeForm_

Free form engine-specific request.

Calling plugins should set this instead of Title_ or Artist_ fields if they are not sure what user has entered.

Definition at line 151 of file iaudiopile.h.

QString Media::AudioSearchRequest::Title_

The title of a track.

At least this or Artist_ field should not be empty.

Definition at line 128 of file iaudiopile.h.

int Media::AudioSearchRequest::TrackLength_

The approximate length of the track.

Set this to 0 to disable by-track filtering.

Definition at line 144 of file iaudiopile.h.


The documentation for this struct was generated from the following file: