libopenmpt  0.2.6401
cross-platform C++ and C library to decode tracked music files
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
openmpt::string Namespace Reference

Functions

LIBOPENMPT_CXX_API std::string get (const std::string &key)
 Get library related metadata. More...
 

Variables

static const char library_version [] = "library_version"
 Return a verbose library version string from openmpt::string::get(). More...
 
static const char library_features [] = "library_features"
 Return a verbose library features string from openmpt::string::get(). More...
 
static const char core_version [] = "core_version"
 Return a verbose OpenMPT core version string from openmpt::string::get(). More...
 
static const char build [] = "build"
 Return information about the current build (e.g. the build date or compiler used) from openmpt::string::get(). More...
 
static const char credits [] = "credits"
 Return all contributors from openmpt::string::get(). More...
 
static const char contact [] = "contact"
 Return contact infromation about libopenmpt from openmpt::string::get(). More...
 
static const char license [] = "license"
 Return the libopenmpt license from openmpt::string::get(). More...
 

Function Documentation

LIBOPENMPT_CXX_API std::string openmpt::string::get ( const std::string &  key)

Get library related metadata.

Parameters
keyKey to query. Possible keys are:
  • "library_version": verbose library version string
  • "library_features": verbose library features string
  • "core_version": verboseOpenMPT core version string
  • "source_url": original source code URL
  • "source_date": original source code date
  • "build": information about the current build (e.g. the build date or compiler used)
  • "build_compiler": information about the compiler used to build libopenmpt
  • "credits": all contributors
  • "contact": contact infromation about libopenmpt
  • "license": the libopenmpt license
  • "url": libopenmpt website URL
  • "support_forum_url": libopenmpt support and discussions forum URL
  • "bugtracker_url": libopenmpt bug and issue tracker URL
Returns
A (possibly multi-line) string containing the queried information. If no information is available, the string is empty.

Variable Documentation

const char openmpt::string::build[] = "build"
static

Return information about the current build (e.g. the build date or compiler used) from openmpt::string::get().

Deprecated:
Please use
"build"
directly.
const char openmpt::string::contact[] = "contact"
static

Return contact infromation about libopenmpt from openmpt::string::get().

Deprecated:
Please use
"contact"
directly.
const char openmpt::string::core_version[] = "core_version"
static

Return a verbose OpenMPT core version string from openmpt::string::get().

Deprecated:
Please use
"core_version"
directly.
const char openmpt::string::credits[] = "credits"
static

Return all contributors from openmpt::string::get().

Deprecated:
Please use
"credits"
directly.
const char openmpt::string::library_features[] = "library_features"
static

Return a verbose library features string from openmpt::string::get().

Deprecated:
Please use
"library_features"
directly.
const char openmpt::string::library_version[] = "library_version"
static

Return a verbose library version string from openmpt::string::get().

Deprecated:
Please use
"library_version"
directly.
const char openmpt::string::license[] = "license"
static

Return the libopenmpt license from openmpt::string::get().

Deprecated:
Please use
"license"
directly.