gavl
Macros
Defined metadata keys

Macros

#define GAVL_META_TITLE   "Title"
 Title of the song/movie...
 
#define GAVL_META_SEARCH_TITLE   "SearchTitle"
 Title of the song/movie...
 
#define GAVL_META_ORIGINAL_TITLE   "OriginalTitle"
 
#define GAVL_META_ID   "ID"
 Unique ID within this database.
 
#define GAVL_META_UUID   "UUID"
 
#define GAVL_META_HASH   "Hash"
 
#define GAVL_META_LOCKED   "Locked"
 
#define GAVL_META_NEXT_ID   "NextID"
 
#define GAVL_META_PREVIOUS_ID   "PreviousID"
 
#define GAVL_META_ARTIST   "Artist"
 Performing artist.
 
#define GAVL_META_ALBUMARTIST   "Albumartist"
 Artist of the Album.
 
#define GAVL_META_AUTHOR   "Author"
 Author.
 
#define GAVL_META_COPYRIGHT   "Copyright"
 Copyright.
 
#define GAVL_META_ALBUM   "Album"
 Album.
 
#define GAVL_META_GENRE   "Genre"
 Genre.
 
#define GAVL_META_CATEGORY   "Category"
 Category.
 
#define GAVL_META_TRACKNUMBER   "Track"
 Tracknumber within the album or (more generically) index within parent container.
 
#define GAVL_META_DATE   "Date"
 Generic date.
 
#define GAVL_META_DATE_CREATE   "CreationDate"
 Creation date.
 
#define GAVL_META_DATE_MODIFY   "ModificationDate"
 Modification date.
 
#define GAVL_META_MTIME   "mtime"
 
#define GAVL_META_TOTAL_BYTES   "totalbytes"
 
#define GAVL_META_YEAR   "Year"
 Generic year.
 
#define GAVL_META_LANGUAGE   "Language"
 Language.
 
#define GAVL_META_COMMENT   "Comment"
 Comment.
 
#define GAVL_META_RELURL   "RelURL"
 Related URL.
 
#define GAVL_META_SOFTWARE   "Software"
 Referenced URL (means: Redirector)
 
#define GAVL_META_CREATOR   "Creator"
 Person, who created the file.
 
#define GAVL_META_FORMAT   "Format"
 Format.
 
#define GAVL_META_FORMAT_MP3   "MP3"
 
#define GAVL_META_FORMAT_FLAC   "Flac"
 
#define GAVL_META_LABEL   "Label"
 Label.
 
#define GAVL_META_BITRATE   "Bitrate"
 Bitrate.
 
#define GAVL_META_FRAMERATE   "Framerate"
 
#define GAVL_META_AUDIO_BITS   "BitsPerSample"
 Valid bits per audio sample.
 
#define GAVL_META_VIDEO_BPP   "BitsPerPixel"
 Valid bits per pixel.
 
#define GAVL_META_VENDOR   "Vendor"
 Vendor of the device/software, which created the file.
 
#define GAVL_META_DISK_NAME   GAVL_META_LABEL
 
#define GAVL_META_DEVICE   "Device"
 Model name of the device, which created the file.
 
#define GAVL_META_STATION   "Station"
 Name of the station for Radio or TV streams.
 
#define GAVL_META_STATION_URL   "StationURL"
 
#define GAVL_META_LOGO_URL   "LogoURL"
 
#define GAVL_META_APPROX_DURATION   "ApproxDuration"
 Approximate duration.
 
#define GAVL_META_MIMETYPE   "MimeType"
 MimeType associated with an item.
 
#define GAVL_META_URI   "URI"
 Location used for opening this resource.
 
#define GAVL_META_REAL_URI   "RealURI"
 Actual location (i.e. after http redirection)
 
#define GAVL_META_SRC   "src"
 src attribute, can be either an array (for multiple sources) or a dictionary with at least GAVL_META_URI set
 
#define GAVL_META_TOTAL_TRACKS   "TotalTracks"
 
#define GAVL_META_BIG_ENDIAN   "BigEndian"
 "1" is big endian, 0 else
 
#define GAVL_META_ACTOR   "Actor"
 Movie Actor. Can be array for multiple entries.
 
#define GAVL_META_DIRECTOR   "Director"
 Movie Director. Can be array for multiple entries.
 
#define GAVL_META_COUNTRY   "Country"
 Country. Can be array for multiple entries.
 
#define GAVL_META_COUNTRY_CODE_3   "CountryCode3"
 Country (). Can be array for multiple entries.
 
#define GAVL_META_COUNTRY_CODE_2   "CountryCode2"
 
#define GAVL_META_GROUP   "Group"
 
#define GAVL_META_DESCRIPTION   "Description"
 
#define GAVL_META_PLOT   GAVL_META_DESCRIPTION
 Movie plot.
 
#define GAVL_META_AUDIO_LANGUAGES   "AudioLanguages"
 Audio languages Array of language LABELS (not ISO codes) in the root metadata dictionary.
 
#define GAVL_META_SUBTITLE_LANGUAGES   "SubtitleLanguages"
 Subtitle language Array of language LABELS (not ISO codes) in the root metadata dictionary.
 
#define GAVL_META_COVER_URL   "CoverURL"
 Cover art.
 
#define GAVL_META_COVER_EMBEDDED   "CoverEmbedded"
 
#define GAVL_META_COVER_OFFSET   "CoverOffset"
 
#define GAVL_META_COVER_SIZE   "CoverSize"
 
#define GAVL_META_WALLPAPER_URL   "WallpaperURL"
 
#define GAVL_META_POSTER_URL   "PosterURL"
 
#define GAVL_META_ICON_URL   "IconURL"
 
#define GAVL_META_ICON_NAME   "IconName"
 
#define GAVL_META_CAN_SEEK   "CanSeek"
 
#define GAVL_META_CAN_PAUSE   "CanPause"
 
#define GAVL_META_SAMPLE_ACCURATE   "SampleAccurate"
 
#define GAVL_META_TIME_PTS   "PTS"
 
#define GAVL_META_TIME_CLOCK   "Clock"
 
#define GAVL_META_TIME_START   "Start"
 
#define GAVL_META_TIME_PTS_TO_CLOCK   "PTSToClock"
 
#define GAVL_META_TIME_PTS_TO_START   "PTSToStart"
 
#define GAVL_META_ASYNC   "Async"
 
#define GAVL_META_AVG_BITRATE   "AVGBitrate"
 
#define GAVL_META_AVG_FRAMERATE   "AVGFramerate"
 
#define GAVL_META_AUDIO_CHANNELS   "Channels"
 
#define GAVL_META_AUDIO_SAMPLERATE   "Samplerate"
 
#define GAVL_META_AUDIO_BITRATE   "AudioBitrate"
 
#define GAVL_META_VIDEO_BITRATE   "VideoBitrate"
 
#define GAVL_META_AUDIO_CODEC   "AudioCodec"
 
#define GAVL_META_VIDEO_CODEC   "VideoCodec"
 
#define GAVL_META_VIDEO_ASPECT_RATIO   "VideoAspectRatio"
 
#define GAVL_META_WIDTH   "w"
 
#define GAVL_META_HEIGHT   "h"
 
#define GAVL_META_X   "x"
 
#define GAVL_META_Y   "y"
 
#define GAVL_META_TRANSCODED   "transcoded"
 
#define GAVL_META_NUM_CHILDREN   "NumChildren"
 
#define GAVL_META_NUM_ITEM_CHILDREN   "NumItemChildren"
 
#define GAVL_META_NUM_CONTAINER_CHILDREN   "NumContainerChildren"
 
#define GAVL_META_CHILDREN   "children"
 
#define GAVL_META_IDX   "idx"
 
#define GAVL_META_TOTAL   "total"
 
#define GAVL_META_SHOW   "Show"
 
#define GAVL_META_SEASON   "Season"
 
#define GAVL_META_PODCAST   "Podcast"
 
#define GAVL_META_EPISODENUMBER   "EPNum"
 
#define GAVL_META_RATING   "Rating"
 
#define GAVL_META_PARENTAL_CONTROL   "ParentalControl"
 
#define GAVL_META_TAG   "Tag"
 
#define GAVL_META_NFO_FILE   "NFOFILE"
 
#define GAVL_META_TOOLTIP   "tooltip"
 
#define GAVL_META_STREAM_DURATION   "duration"
 
#define GAVL_META_STREAM_FORMAT   "fmt"
 
#define GAVL_META_STREAM_PACKET_TIMESCALE   "pscale"
 
#define GAVL_META_STREAM_SAMPLE_TIMESCALE   "sscale"
 
#define GAVL_META_STREAM_ENABLED   "enabled"
 
#define GAVL_META_STREAM_ID   "streamid"
 
#define GAVL_META_STREAM_ID_MSG_GAVF   -2
 
#define GAVL_META_STREAM_ID_MSG_PROGRAM   -1
 
#define GAVL_META_STREAM_ID_MEDIA_START   1
 
#define GAVL_META_STREAM_COMPRESSION_INFO   "cmp"
 
#define GAVL_META_STREAM_STATS   "stats"
 
#define GAVL_META_STREAM_STATS_NUM_BYTES   GAVL_META_TOTAL_BYTES
 
#define GAVL_META_STREAM_STATS_NUM_PACKETS   "TotalPackets"
 
#define GAVL_META_STREAM_STATS_PTS_START   "PTSStart"
 
#define GAVL_META_STREAM_STATS_PTS_END   "PTSEnd"
 
#define GAVL_META_STREAM_STATS_PACKET_SIZE_MIN   "minsize"
 
#define GAVL_META_STREAM_STATS_PACKET_SIZE_MAX   "maxsize"
 
#define GAVL_META_STREAM_STATS_PACKET_DURATION_MIN   "mindur"
 
#define GAVL_META_STREAM_STATS_PACKET_DURATION_MAX   "maxdur"
 
#define GAVL_META_STREAMS   "streams"
 
#define GAVL_META_STREAMS_EXT   "streams-ext"
 
#define GAVL_META_STREAM_TYPE   "streamtype"
 
#define GAVL_META_METADATA   "metadata"
 
#define GAVL_META_EDL   "edl"
 
#define GAVL_META_TRACKS   GAVL_META_CHILDREN
 
#define GAVL_META_URLVARS   "urlvars"
 
#define GAVL_META_CURIDX   "curidx"
 
#define GAVL_META_PARTS   "parts"
 
#define GAVL_META_VARIANTS   "variants"
 
#define GAVL_META_MSG_TIMESTAMP   "timestamp"
 
#define GAVL_META_MEDIA_CLASS   "MediaClass"
 
#define GAVL_META_CHILD_CLASS   "ChildClass"
 
#define GAVL_META_MEDIA_CLASS_ITEM   "item"
 
#define GAVL_META_MEDIA_CLASS_AUDIO_FILE   "item.audio"
 
#define GAVL_META_MEDIA_CLASS_VIDEO_FILE   "item.video"
 
#define GAVL_META_MEDIA_CLASS_AUDIO_DISK_TRACK   "item.audio.disktrack"
 
#define GAVL_META_MEDIA_CLASS_VIDEO_DISK_TRACK   "item.video.disktrack"
 
#define GAVL_META_MEDIA_CLASS_SONG   "item.audio.song"
 
#define GAVL_META_MEDIA_CLASS_MOVIE   "item.video.movie"
 
#define GAVL_META_MEDIA_CLASS_MOVIE_PART   "item.video.movie.part"
 
#define GAVL_META_MEDIA_CLASS_AUDIO_PODCAST_EPISODE   "item.audio.podcastepisode"
 
#define GAVL_META_MEDIA_CLASS_VIDEO_PODCAST_EPISODE   "item.video.podcastepisode"
 
#define GAVL_META_MEDIA_CLASS_TV_EPISODE   "item.video.episode"
 
#define GAVL_META_MEDIA_CLASS_BROADCAST   "item.broadcast"
 
#define GAVL_META_MEDIA_CLASS_AUDIO_BROADCAST   "item.audio.broadcast"
 
#define GAVL_META_MEDIA_CLASS_VIDEO_BROADCAST   "item.video.broadcast"
 
#define GAVL_META_MEDIA_CLASS_IMAGE   "item.image"
 
#define GAVL_META_MEDIA_CLASS_FILE   "item.file"
 
#define GAVL_META_MEDIA_CLASS_LOCATION   "item.location"
 
#define GAVL_META_MEDIA_CLASS_SUBTITLE_FILE   "item.subtitles"
 
#define GAVL_META_MEDIA_CLASS_AUDIO_RECORDER   "item.recorder.audio"
 
#define GAVL_META_MEDIA_CLASS_VIDEO_RECORDER   "item.recorder.video"
 
#define GAVL_META_MEDIA_CLASS_CONTAINER   "container"
 
#define GAVL_META_MEDIA_CLASS_MUSICALBUM   "container.musicalbum"
 
#define GAVL_META_MEDIA_CLASS_PHOTOALBUM   "container.photoalbum"
 
#define GAVL_META_MEDIA_CLASS_PLAYLIST   "container.playlist"
 
#define GAVL_META_MEDIA_CLASS_PODCAST   "container.podcast"
 
#define GAVL_META_MEDIA_CLASS_CONTAINER_CATEGORY   "container.category"
 
#define GAVL_META_MEDIA_CLASS_CONTAINER_ACTOR   "container.category.actor"
 
#define GAVL_META_MEDIA_CLASS_CONTAINER_DIRECTOR   "container.category.director"
 
#define GAVL_META_MEDIA_CLASS_CONTAINER_ARTIST   "container.category.artist"
 
#define GAVL_META_MEDIA_CLASS_CONTAINER_COUNTRY   "container.category.country"
 
#define GAVL_META_MEDIA_CLASS_CONTAINER_GENRE   "container.category.genre"
 
#define GAVL_META_MEDIA_CLASS_CONTAINER_LANGUAGE   "container.category.language"
 
#define GAVL_META_MEDIA_CLASS_CONTAINER_TAG   "container.category.tag"
 
#define GAVL_META_MEDIA_CLASS_CONTAINER_YEAR   "container.category.year"
 
#define GAVL_META_MEDIA_CLASS_CONTAINER_TV   "container.tv"
 
#define GAVL_META_MEDIA_CLASS_CONTAINER_RADIO   "container.radio"
 
#define GAVL_META_MEDIA_CLASS_TV_SEASON   "container.season"
 
#define GAVL_META_MEDIA_CLASS_TV_SHOW   "container.tvshow"
 
#define GAVL_META_MEDIA_CLASS_DIRECTORY   "container.directory"
 
#define GAVL_META_MEDIA_CLASS_MULTITRACK_FILE   "container.multitrackfile"
 
#define GAVL_META_MEDIA_CLASS_ROOT   "container.root"
 
#define GAVL_META_MEDIA_CLASS_ROOT_PLAYQUEUE   "container.root.playqueue"
 
#define GAVL_META_MEDIA_CLASS_ROOT_MUSICALBUMS   "container.root.musicalbums"
 
#define GAVL_META_MEDIA_CLASS_ROOT_SONGS   "container.root.songs"
 
#define GAVL_META_MEDIA_CLASS_ROOT_MOVIES   "container.root.movies"
 
#define GAVL_META_MEDIA_CLASS_ROOT_TV_SHOWS   "container.root.tvshows"
 
#define GAVL_META_MEDIA_CLASS_ROOT_STREAMS   "container.root.streams"
 
#define GAVL_META_MEDIA_CLASS_ROOT_DIRECTORIES   "container.root.directories"
 
#define GAVL_META_MEDIA_CLASS_ROOT_PHOTOS   "container.root.photos"
 
#define GAVL_META_MEDIA_CLASS_ROOT_PODCASTS   "container.root.podcasts"
 
#define GAVL_META_MEDIA_CLASS_ROOT_RECORDERS   "container.root.recorders"
 
#define GAVL_META_MEDIA_CLASS_ROOT_FAVORITES   "container.root.favorites"
 
#define GAVL_META_MEDIA_CLASS_ROOT_BOOKMARKS   "container.root.bookmarks"
 
#define GAVL_META_MEDIA_CLASS_ROOT_LIBRARY   "container.root.library"
 
#define GAVL_META_MEDIA_CLASS_ROOT_REMOVABLE   "container.root.removable"
 
#define GAVL_META_MEDIA_CLASS_ROOT_REMOVABLE_AUDIOCD   "container.root.removable.cd.audio"
 
#define GAVL_META_MEDIA_CLASS_ROOT_REMOVABLE_VCD   "container.root.removable.cd.vcd"
 
#define GAVL_META_MEDIA_CLASS_ROOT_REMOVABLE_SVCD   "container.root.removable.cd.svcd"
 
#define GAVL_META_MEDIA_CLASS_ROOT_REMOVABLE_VIDEODVD   "container.root.removable.dvd.video"
 
#define GAVL_META_MEDIA_CLASS_ROOT_REMOVABLE_FILESYSTEM   "container.root.removable.filesystem"
 
#define GAVL_META_MEDIA_CLASS_ROOT_REMOVABLE_FILESYSTEM_HDD   "container.root.removable.filesystem.hdd"
 
#define GAVL_META_MEDIA_CLASS_ROOT_REMOVABLE_FILESYSTEM_PENDRIVE   "container.root.removable.filesystem.pendrive"
 
#define GAVL_META_MEDIA_CLASS_ROOT_REMOVABLE_FILESYSTEM_MEMORYCARD   "container.root.removable.filesystem.memorycard"
 
#define GAVL_META_MEDIA_CLASS_ROOT_REMOVABLE_FILESYSTEM_MOBILE   "container.root.removable.filesystem.mobile"
 
#define GAVL_META_MEDIA_CLASS_ROOT_REMOVABLE_FILESYSTEM_CD   "container.root.removable.filesystem.cdrom"
 
#define GAVL_META_MEDIA_CLASS_ROOT_REMOVABLE_FILESYSTEM_DVD   "container.root.removable.filesystem.dvd"
 
#define GAVL_META_MEDIA_CLASS_ROOT_SERVER   "container.root.server"
 
#define GAVL_META_MEDIA_CLASS_BACKEND_RENDERER   "backend.renderer"
 
#define GAVL_META_MEDIA_CLASS_BACKEND_SERVER   "backend.server"
 
#define GAVL_META_MEDIA_CLASS_BACKEND_CONTROLPANEL   "backend.controlpanel"
 
#define GAVL_META_MEDIA_CLASS_SINK_AUDIO   "sink.audio"
 
#define GAVL_META_MEDIA_CLASS_SINK_VIDEO   "sink.video"
 
#define GAVL_META_MEDIA_CLASS_WEBPAGE   "item.webpage"
 
#define GAVL_META_GUI_ERROR   "GUIError"
 
#define GAVL_META_GUI_SELECTED   "GUISelected"
 
#define GAVL_META_GUI_CURRENT   "GUICurrent"
 

Detailed Description

For interoperability reasons, try to use these macros as metadata keys whenever possible.

Since 1.4.0

Macro Definition Documentation

◆ GAVL_META_TITLE

#define GAVL_META_TITLE   "Title"

Title of the song/movie...

◆ GAVL_META_SEARCH_TITLE

#define GAVL_META_SEARCH_TITLE   "SearchTitle"

Title of the song/movie...

◆ GAVL_META_ID

#define GAVL_META_ID   "ID"

Unique ID within this database.

◆ GAVL_META_ARTIST

#define GAVL_META_ARTIST   "Artist"

Performing artist.

◆ GAVL_META_ALBUMARTIST

#define GAVL_META_ALBUMARTIST   "Albumartist"

Artist of the Album.

◆ GAVL_META_AUTHOR

#define GAVL_META_AUTHOR   "Author"

Author.

◆ GAVL_META_COPYRIGHT

#define GAVL_META_COPYRIGHT   "Copyright"

Copyright.

◆ GAVL_META_ALBUM

#define GAVL_META_ALBUM   "Album"

Album.

◆ GAVL_META_GENRE

#define GAVL_META_GENRE   "Genre"

Genre.

◆ GAVL_META_CATEGORY

#define GAVL_META_CATEGORY   "Category"

Category.

◆ GAVL_META_TRACKNUMBER

#define GAVL_META_TRACKNUMBER   "Track"

Tracknumber within the album or (more generically) index within parent container.

Integer starting with 1

◆ GAVL_META_DATE

#define GAVL_META_DATE   "Date"

Generic date.

YYYY-MM-DD [HH:MM:SS]

◆ GAVL_META_DATE_CREATE

#define GAVL_META_DATE_CREATE   "CreationDate"

Creation date.

YYYY-MM-DD [HH:MM:SS]

◆ GAVL_META_DATE_MODIFY

#define GAVL_META_DATE_MODIFY   "ModificationDate"

Modification date.

YYYY-MM-DD [HH:MM:SS]

◆ GAVL_META_YEAR

#define GAVL_META_YEAR   "Year"

Generic year.

◆ GAVL_META_LANGUAGE

#define GAVL_META_LANGUAGE   "Language"

Language.

Use this for subtitles or audio streams

◆ GAVL_META_COMMENT

#define GAVL_META_COMMENT   "Comment"

Comment.

◆ GAVL_META_RELURL

#define GAVL_META_RELURL   "RelURL"

Related URL.

◆ GAVL_META_SOFTWARE

#define GAVL_META_SOFTWARE   "Software"

Referenced URL (means: Redirector)

Software

For media files, this is the multiplexer software. For single stream this is the encoder software

◆ GAVL_META_CREATOR

#define GAVL_META_CREATOR   "Creator"

Person, who created the file.

◆ GAVL_META_FORMAT

#define GAVL_META_FORMAT   "Format"

Format.

For media files, this is the container format. For single stream this is the name of the codec

◆ GAVL_META_LABEL

#define GAVL_META_LABEL   "Label"

Label.

For streams it's the label (e.g. "Directors comments") to display in the stream menu

In global metadata it's the label which should be displayed when this file is played

◆ GAVL_META_BITRATE

#define GAVL_META_BITRATE   "Bitrate"

Bitrate.

Bitrate as integer in bits/s. Can also be a string (like VBR)

◆ GAVL_META_AUDIO_BITS

#define GAVL_META_AUDIO_BITS   "BitsPerSample"

Valid bits per audio sample.

◆ GAVL_META_VIDEO_BPP

#define GAVL_META_VIDEO_BPP   "BitsPerPixel"

Valid bits per pixel.

◆ GAVL_META_VENDOR

#define GAVL_META_VENDOR   "Vendor"

Vendor of the device/software, which created the file.

◆ GAVL_META_DEVICE

#define GAVL_META_DEVICE   "Device"

Model name of the device, which created the file.

◆ GAVL_META_STATION

#define GAVL_META_STATION   "Station"

Name of the station for Radio or TV streams.

◆ GAVL_META_APPROX_DURATION

#define GAVL_META_APPROX_DURATION   "ApproxDuration"

Approximate duration.

◆ GAVL_META_MIMETYPE

#define GAVL_META_MIMETYPE   "MimeType"

MimeType associated with an item.

◆ GAVL_META_URI

#define GAVL_META_URI   "URI"

Location used for opening this resource.

◆ GAVL_META_REAL_URI

#define GAVL_META_REAL_URI   "RealURI"

Actual location (i.e. after http redirection)

◆ GAVL_META_SRC

#define GAVL_META_SRC   "src"

src attribute, can be either an array (for multiple sources) or a dictionary with at least GAVL_META_URI set

◆ GAVL_META_BIG_ENDIAN

#define GAVL_META_BIG_ENDIAN   "BigEndian"

"1" is big endian, 0 else

◆ GAVL_META_ACTOR

#define GAVL_META_ACTOR   "Actor"

Movie Actor. Can be array for multiple entries.

◆ GAVL_META_DIRECTOR

#define GAVL_META_DIRECTOR   "Director"

Movie Director. Can be array for multiple entries.

◆ GAVL_META_COUNTRY

#define GAVL_META_COUNTRY   "Country"

Country. Can be array for multiple entries.

◆ GAVL_META_COUNTRY_CODE_3

#define GAVL_META_COUNTRY_CODE_3   "CountryCode3"

Country (). Can be array for multiple entries.

◆ GAVL_META_PLOT

#define GAVL_META_PLOT   GAVL_META_DESCRIPTION

Movie plot.

◆ GAVL_META_AUDIO_LANGUAGES

#define GAVL_META_AUDIO_LANGUAGES   "AudioLanguages"

Audio languages Array of language LABELS (not ISO codes) in the root metadata dictionary.

◆ GAVL_META_SUBTITLE_LANGUAGES

#define GAVL_META_SUBTITLE_LANGUAGES   "SubtitleLanguages"

Subtitle language Array of language LABELS (not ISO codes) in the root metadata dictionary.

◆ GAVL_META_COVER_URL

#define GAVL_META_COVER_URL   "CoverURL"

Cover art.