aroarfw
Enumerations
meta.h File Reference

Go to the source code of this file.

Enumerations

enum  rmeta_type_t {
  RMETA_NONE = 0, RMETA_TITLE = 1, RMETA_ALBUM = 2, RMETA_AUTHOR = 3,
  RMETA_ARTIST = RMETA_AUTHOR, RMETA_VERSION = 4, RMETA_DATE = 5, RMETA_LICENSE = 6,
  RMETA_TRACKNUMBER = 7, RMETA_ORGANIZATION = 8, RMETA_DESCRIPTION = 9, RMETA_GENRE = 10,
  RMETA_LOCATION = 11, RMETA_CONTACT = 12, RMETA_STREAMURL = 13, RMETA_HOMEPAGE = 14,
  RMETA_THUMBNAIL = 15, RMETA_LENGTH = 16, RMETA_COMMENT = 17, RMETA_OTHER = 18,
  RMETA_FILENAME = 19, RMETA_FILEURL = 20, RMETA_SERVER = 21, RMETA_DURATION = 22,
  RMETA_WWW = RMETA_HOMEPAGE, RMETA_WOAF = 23, RMETA_ENCODER = 24, RMETA_ENCODEDBY = RMETA_ENCODER,
  RMETA_YEAR = 25, RMETA_DISCID = 26, RMETA_RPG_TRACK_PEAK = 27, RMETA_RPG_TRACK_GAIN = 28,
  RMETA_RPG_ALBUM_PEAK = 29, RMETA_RPG_ALBUM_GAIN = 30, RMETA_HASH = 31, RMETA_SIGNALINFO = 32,
  RMETA_AUDIOINFO = RMETA_SIGNALINFO, RMETA_OFFSET = 33, RMETA_PERFORMER = 34, RMETA_COPYRIGHT = 35,
  RMETA_LIKENESS = 36, RMETA_COMPOSER = 37, RMETA_RIGHTS = 38, RMETA_ISRC = 39,
  RMETA_LANGUAGE = 40, RMETA_GTIN = 41, RMETA_ISBN = RMETA_GTIN, RMETA_EAN = RMETA_GTIN,
  RMETA_PUBLISHER = 42, RMETA_DISCNUMBER = 43, RMETA_SOURCEMEDIA = 44, RMETA_LABEL = 45,
  RMETA_LABELNO = 46
}
 Meta data types. More...
 
enum  rmeta_mode_t {
  RMETAMODE_SET = 0, RMETAMODE_ADD = 1, RMETAMODE_DELETE = 2, RMETAMODE_CLEAR = 3,
  RMETAMODE_FINALIZE = 4
}
 Modes for meta data updates. More...
 

Enumeration Type Documentation

Modes for meta data updates.

Enumerator
RMETAMODE_SET 

Set (or update) a meta date, overwriting old values.

RMETAMODE_ADD 

Add a meta date, not overwriting old values.

RMETAMODE_DELETE 

Delete a meta data for a given type.

RMETAMODE_CLEAR 

Delete all meta data from a stream.

RMETAMODE_FINALIZE 

Mark end of update sequence.

Definition at line 188 of file meta.h.

Meta data types.

Enumerator
RMETA_NONE 

This is used for empty meta data elements.

RMETA_TITLE 

Title of work.

RMETA_ALBUM 

Album work is part of.

RMETA_AUTHOR 

Author of work.

RMETA_ARTIST 

Alias for RMETA_AUTHOR. Should not be used in code but in functions to convert meta data types from strings to IDs.

RMETA_VERSION 

Version of work.

RMETA_DATE 

Date of creation. Format: "YYYY-MM-DD" or "YYYY-MM-DD HH:MM:SS UTC". Time in later form is start time of recording.

RMETA_LICENSE 

License of work.

RMETA_TRACKNUMBER 

Track number of work within the album (or other compilation). (printf: %.2d)

RMETA_ORGANIZATION 

Organization of creation.

RMETA_DESCRIPTION 

General description.

RMETA_GENRE 

Genre. Freeform string but should match one of the genres defined for the RoarAudio protocol or in form of s(0xx) with readable name and genre ID.

RMETA_LOCATION 

Location of work creation.

RMETA_CONTACT 

Contact information for work. Should be in form: first ["']nick["'] last (comment) <email>/OpenPGPkey/Phone/Room)

RMETA_STREAMURL 

URL of this stream. Used for examples in stream dumps as source refrence. Also used in VCLT Playlists. See also RMETA_FILEURL.

RMETA_HOMEPAGE 

Homepage of this album, compilation or work.

RMETA_THUMBNAIL 

URL to thumbnail of this work. Can be used for display within the media player. Should point to PNG or JPEG image.

RMETA_LENGTH 

Playback length of the work. (printf: %.2d:%.2d:%.2d, last element may be float with dot as decimal delimeter) Main use for this is meta data stored outside the data stream. Examples include VCLT Playlist files.

RMETA_COMMENT 

Free form comment about this work.

RMETA_OTHER 

The OTHER meta data type can be used to use non-standardized meta data which have no ID assigned. Usage of this should be avoided.

RMETA_FILENAME 

Filename of the given work. Mainly used in VCLT Playlists.

RMETA_FILEURL 

URL of the work. Mainly used in VCLT Playlists. The diffrence between RMETA_STREAMURL and RMETA_FILEURL is that RMETA_STREAMURL is for (radio) streams and RMETA_FILEURL for files of finit size (often refrered to as seekable and unseekable data).

RMETA_SERVER 

Server software name and version.

RMETA_DURATION 

This is used to store the duration of some work. It's format and usage is undefined. This should not be used. See also: RMETA_LENGTH.

RMETA_WWW 

Alias for RMETA_HOMEPAGE. Should not be used in code but in functions to convert meta data types from strings to IDs.

RMETA_WOAF 

ID3: Official audio file webpage. Should not be used when creating new files.

RMETA_ENCODER 

Encoder software name and version.

RMETA_ENCODEDBY 

Alias to RMETA_ENCODER. Should not be used when creating new files.

RMETA_YEAR 

Year of recording in form YYYY.

RMETA_DISCID 

CDDB DiskID, (printf: %.8x)

RMETA_RPG_TRACK_PEAK 

RePlayGain of track: Peak amplitude.

RMETA_RPG_TRACK_GAIN 

RePlayGain of track: correction gain.

RMETA_RPG_ALBUM_PEAK 

RePlayGain of album: Peak amplitude.

RMETA_RPG_ALBUM_GAIN 

RePlayGain of album: correction gain.

RMETA_HASH 

Used to store hashes for HashTable or Tantalos IDs. Format: {TYPE}value[,{TYPE}value[,{TYPE}value[,...]]] For possible types see rht_t from crypto.h. See also RMETA_GTIN.

RMETA_SIGNALINFO 

Information about the signal. Used in VCLT Playlist files. See https://bts.keep-cool.org/wiki/Specs/SignalInfoFormat for format specification.

RMETA_AUDIOINFO 

Alias for RMETA_SIGNALINFO. Only valid for Audio only streams. See https://bts.keep-cool.org/wiki/Specs/SignalInfoFormat for details.

RMETA_OFFSET 

Offset of the work within the refrenced file or data stream. This is used by VCLT Playlist files. The exact format is not yet defined.

RMETA_PERFORMER 

The performer of the work.

RMETA_COPYRIGHT 

Copyright information of the work.

RMETA_LIKENESS 

Likeness of the given work by the user. Used in VCLT Playlist files. (printf: f with dot as decimal delimeter). Range: 0.0: user dislikes this very much (is never played by player), 1.0: normal likeness. Inf: The user likes this very much (is played by player endlessly).

RMETA_COMPOSER 

The composer of the work.

RMETA_RIGHTS 

XXX.

RMETA_ISRC 

The ISRC code for the work. See Vorbis comments specification.

RMETA_LANGUAGE 

The language of this work in POSIX notation or short POSIX notation (two letter code). Possible values include 'en' for English, 'de' for German. 'de_DE' for Germany German, 'de_CH' for Switzerland German.

RMETA_GTIN 

GTIN of work. Possible formats are 14 digits GTIN-14, 13 digits GTIN-13 (most common), 8 digit GTIN-8 (also common) or ISBN-13 without dashes (which is the same as the corresponding GTIN-13). EAN-8 and EAN-13 are synonyms for GTIN-8 and GTIN-13. The data is a string of digits without dashes or spaces. Any dashes or spaces should be ignored by the reading application.

RMETA_ISBN 

This is an alias for RMETA_GTIN. Should not be used in code but in functions to convert meta data types from strings to IDs. If used in files as string like VCLT Playlist files only ISBN-13 values are valid within the meta date.

RMETA_EAN 

This is an alias for RMETA_GTIN. Should not be used in code but in functions to convert meta data types from strings to IDs. If used in files as string like VCLT Playlist files only EAN-8 or EAN-13 values are valid within the meta date.

RMETA_PUBLISHER 

The person or company who published this work.

RMETA_DISCNUMBER 

The number of the disc within the compilation or album.

RMETA_SOURCEMEDIA 

The source media this was converted from.

RMETA_LABEL 

The label which published this work (if any)

RMETA_LABELNO 

The catalog number of this work, album or compilation as used by the label. Needs RMETA_LABEL to be present, too.

Definition at line 29 of file meta.h.