VLC  3.0.15
Macros | Enumerations
vlc_media_library.h File Reference
Include dependency graph for vlc_media_library.h:

Go to the source code of this file.

Macros

#define ML_PERSON_ARTIST   "Artist"
 
#define ML_PERSON_ALBUM_ARTIST   "Album Artist"
 
#define ML_PERSON_ENCODER   "Encoder"
 
#define ML_PERSON_PUBLISHER   "Publisher"
 

Enumerations

enum  ml_select_e {
  ML_ALBUM = 1, ML_ALBUM_ID, ML_ALBUM_COVER, ML_ARTIST,
  ML_ARTIST_ID, ML_COMMENT, ML_COUNT_MEDIA, ML_COUNT_ALBUM,
  ML_COUNT_PEOPLE, ML_COVER, ML_DURATION, ML_DISC_NUMBER,
  ML_EXTRA, ML_FIRST_PLAYED, ML_FILESIZE, ML_GENRE,
  ML_ID, ML_IMPORT_TIME, ML_LANGUAGE, ML_LAST_PLAYED,
  ML_LAST_SKIPPED, ML_ORIGINAL_TITLE, ML_PEOPLE, ML_PEOPLE_ID,
  ML_PEOPLE_ROLE, ML_PLAYED_COUNT, ML_PREVIEW, ML_SKIPPED_COUNT,
  ML_SCORE, ML_TITLE, ML_TRACK_NUMBER, ML_TYPE,
  ML_URI, ML_VOTE, ML_YEAR, ML_DIRECTORY,
  ML_MEDIA, ML_MEDIA_SPARSE, ML_MEDIA_EXTRA, ML_LIMIT = -1,
  ML_SORT_DESC = -2, ML_SORT_ASC = -3, ML_DISTINCT = -4, ML_END = -42
}
 List of Query select types. More...
 
enum  ml_type_e {
  ML_UNKNOWN = 0, ML_AUDIO = 1 << 0, ML_VIDEO = 1 << 1, ML_STREAM = 1 << 2,
  ML_NODE = 1 << 3, ML_REMOVABLE = 1 << 4
}
 Media types (audio, video, etc...) More...
 
enum  ml_result_type_e { ML_TYPE_INT, ML_TYPE_PSZ, ML_TYPE_TIME, ML_TYPE_MEDIA }
 Query result item/list type: integers, strings, medias, timestamps. More...
 

Macro Definition Documentation

◆ ML_PERSON_ALBUM_ARTIST

#define ML_PERSON_ALBUM_ARTIST   "Album Artist"

◆ ML_PERSON_ARTIST

#define ML_PERSON_ARTIST   "Artist"

◆ ML_PERSON_ENCODER

#define ML_PERSON_ENCODER   "Encoder"

◆ ML_PERSON_PUBLISHER

#define ML_PERSON_PUBLISHER   "Publisher"

Enumeration Type Documentation

◆ ml_result_type_e

Query result item/list type: integers, strings, medias, timestamps.

Enumerator
ML_TYPE_INT 

Object is an int.

ML_TYPE_PSZ 

A string char*.

ML_TYPE_TIME 

A timestamp mtime_t.

ML_TYPE_MEDIA 

A pointer to a media ml_media_t*.

◆ ml_select_e

List of Query select types.

In a query array or variable argument list, each select type is followed by an argument (X) of variable type (char* or int,

See also
ml_element_t). These types can be used either in the query list or in the result array. Some types are reserved for the result array:
Enumerator
ML_ALBUM 

Album Title.

ML_ALBUM_ID 

Album ID.

ML_ALBUM_COVER 

Album Cover art url.

ML_ARTIST 

Artist, interpreted as ML_PEOPLE && ML_PEOPLE_ROLE = ML_PERSON_ARTIST.

ML_ARTIST_ID 

Artist ID, interpreted as ML_PEOPLE_ID && ML_PEOPLE_ROLE = ML_PERSON_ARTIST.

ML_COMMENT 

Comment about media.

ML_COUNT_MEDIA 

Number of medias.

ML_COUNT_ALBUM 

Number of albums.

ML_COUNT_PEOPLE 

Number of people.

ML_COVER 

Cover art url.

ML_DURATION 

Duration in ms.

ML_DISC_NUMBER 

Disc number of the track.

ML_EXTRA 

Extra/comment (string) on the media.

ML_FIRST_PLAYED 

First time media was played.

ML_FILESIZE 

Size of the media file.

ML_GENRE 

Genre of the media (if any)

ML_ID 

Media ID.

ML_IMPORT_TIME 

Date when media was imported.

ML_LANGUAGE 

Language.

ML_LAST_PLAYED 

Last play UNIX timestamp.

ML_LAST_SKIPPED 

Time when media was last skipped.

ML_ORIGINAL_TITLE 

Media original title (if any)

ML_PEOPLE 

Any People associated with this media.

ML_PEOPLE_ID 

Id of a person.

ML_PEOPLE_ROLE 

Person role.

ML_PLAYED_COUNT 

Media play count.

ML_PREVIEW 

Url of the video preview.

ML_SKIPPED_COUNT 

Number of times skipped.

ML_SCORE 

Computed media score.

ML_TITLE 

Media title.

ML_TRACK_NUMBER 

Media track number (if any)

ML_TYPE 

Media type.

See also
ml_type_e
ML_URI 

Media full URI.

ML_VOTE 

Media user vote value.

ML_YEAR 

Media publishing year.

ML_DIRECTORY 

Monitored directory.

ML_MEDIA 

Full media descriptor.

See also
ml_media_t
ML_MEDIA_SPARSE 

Sparse media.

See also
ml_media_t
ML_MEDIA_EXTRA 

Sparse + Extra = Full media.

ML_LIMIT 

Limit a query to X results.

ML_SORT_DESC 

Sort a query descending on argument X.

ML_SORT_ASC 

Sort a query ascending on argument X.

ML_DISTINCT 

Add DISTINCT to SELECT statements.

ML_END 

End of argument list.

◆ ml_type_e

enum ml_type_e

Media types (audio, video, etc...)

Enumerator
ML_UNKNOWN 

Unknown media type.

ML_AUDIO 

Audio only media.

ML_VIDEO 

Video media.

May contain audio channels

ML_STREAM 

Streamed media = not a local file.

ML_NODE 

Nodes like simple nodes, directories, playlists, etc.

ML_REMOVABLE 

Removable media: CD/DVD/Card/...