Difference between revisions of "Foobar2000:Titleformat Playback Statistics"

From Hydrogenaudio Knowledgebase
Jump to: navigation, search
m (Titleformat Playback Statistics moved to Foobar2000:Titleformat Playback Statistics)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= Playback statistics =
+
{{fb2k}}
 +
This page details the title formatting fields made available by the foobar2000 [[Foobar2000:Components/Playback Statistics v3.x (foo playcount)|Playback Statistics]] component.
  
 
== Special fields ==
 
== Special fields ==
Line 6: Line 7:
  
 
Returns how many times this tracks has been played. If the track has not been played yet, the field does not exist.
 
Returns how many times this tracks has been played. If the track has not been played yet, the field does not exist.
 +
 +
=== %first_played% ===
 +
 +
Returns the date and time when the track was first played. If the track has not been played yet, the field does not exist.
  
 
=== %last_played% ===
 
=== %last_played% ===
Line 11: Line 16:
 
Returns the date and time when the track was last played. If the track has not been played yet, the field does not exist.
 
Returns the date and time when the track was last played. If the track has not been played yet, the field does not exist.
  
The format of the returned value is
+
=== %played_per_day% ===
 +
 
 +
Returns the average of how many times per day track has been played, based on time first played, time last played and times played (average daily playcount between %first_played% and %last_played%). If the track has not been played yet, the field does not exist.
 +
 
 +
=== %added% ===
 +
Returns the date and time at which track has been added to Media Library. Even if the track has not been played yet, the field exists, logically.
 +
 
 +
=== %rating% ===
 +
Returns Rating Value (can be integer from 1 to 5). If the track has not been rated yet, the field does not exist.
 +
 
 +
=== %rating_stars% ===
 +
Returns Song's Rating Value, formatted as up to five stars, e.g. ★★★. If the track has not been rated yet, the field does not exist.
 +
 
 +
=== %rating_stars_fixed% ===
 +
Returns Song's Rating Value, formatted as five stars, e.g. ★★★☆☆. If the track has not been rated yet, the field does not exist.
 +
 
 +
==Notes==
 +
The format of the returned values for both ''%first_played%'' and ''%last_played%'' are
  
 
   YYYY-MM-DD hh:mm:ss
 
   YYYY-MM-DD hh:mm:ss
Line 23: Line 45:
 
* mm: minute (two digits)
 
* mm: minute (two digits)
 
* ss: second (two digits)
 
* ss: second (two digits)
 
= Disclaimer =
 
 
The official playback statistics component is only intended to be a test case for a new API in foobar2000 0.9 beta 13. A more complete version is expected to be created by third parties once the SDK for fooba2000 0.9 is publicly released.
 
 
= Links =
 
 
* [http://www.foobar2000.org/beta/components.html Official playback statistics component]
 

Latest revision as of 12:41, 30 September 2018

Foobar2000_Logo.png

This page details the title formatting fields made available by the foobar2000 Playback Statistics component.

Special fields

%play_count%

Returns how many times this tracks has been played. If the track has not been played yet, the field does not exist.

%first_played%

Returns the date and time when the track was first played. If the track has not been played yet, the field does not exist.

%last_played%

Returns the date and time when the track was last played. If the track has not been played yet, the field does not exist.

%played_per_day%

Returns the average of how many times per day track has been played, based on time first played, time last played and times played (average daily playcount between %first_played% and %last_played%). If the track has not been played yet, the field does not exist.

%added%

Returns the date and time at which track has been added to Media Library. Even if the track has not been played yet, the field exists, logically.

%rating%

Returns Rating Value (can be integer from 1 to 5). If the track has not been rated yet, the field does not exist.

%rating_stars%

Returns Song's Rating Value, formatted as up to five stars, e.g. ★★★. If the track has not been rated yet, the field does not exist.

%rating_stars_fixed%

Returns Song's Rating Value, formatted as five stars, e.g. ★★★☆☆. If the track has not been rated yet, the field does not exist.

Notes

The format of the returned values for both %first_played% and %last_played% are

 YYYY-MM-DD hh:mm:ss

The different parts of the format have the following meaning:

  • YYYY: year (four digits)
  • MM: month (two digits)
  • DD: day of month (two digits)
  • hh: hour (two digits)
  • mm: minute (two digits)
  • ss: second (two digits)