119 lines
No EOL
3.4 KiB
C
119 lines
No EOL
3.4 KiB
C
/**
|
|
* @file UplayMetadata.h
|
|
* @brief The Uplay PC Metadata API
|
|
*/
|
|
#ifndef UPLAY_METADATA_H
|
|
#define UPLAY_METADATA_H
|
|
|
|
#include "Uplay/UplayUser.h"
|
|
#include "Uplay/UplayTypes.h"
|
|
|
|
#if _MSC_VER > 1000
|
|
#pragma once
|
|
#endif
|
|
|
|
#ifndef UPLAY_API
|
|
#ifdef _WIN32
|
|
#if defined EXPORTING_DLL
|
|
#define UPLAY_API __declspec(dllexport)
|
|
#elif defined IMPORTING_DLL
|
|
#define UPLAY_API __declspec(dllimport)
|
|
#else
|
|
#define UPLAY_API
|
|
#endif
|
|
#endif // _Win32
|
|
|
|
#ifdef __APPLE__
|
|
#define UPLAY_API __attribute__((visibility("default")))
|
|
#define __cdecl
|
|
#endif // __APPLE__
|
|
#endif // UPLAY_API
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif // __cplusplus
|
|
|
|
/**
|
|
* @defgroup metadata Metadata
|
|
* @brief Functions for the metadata subsystem
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/************************************************************************************//**
|
|
* @fn int UPLAY_METADATA_SetSingleEventTag(const char*, const char*)
|
|
* @brief Create single time event metadata tag.
|
|
*
|
|
* Creates a single time event tag that will be applied to all metadata-enabled
|
|
* media Uplay can produce (e.g. screenshots, streaming).
|
|
* Calling this function will result in:
|
|
* -# A screenshot being taken and given tag attached to it
|
|
* along with all other standard tags and continuous tags (see UPLAY_METADATA_SetContinuousTag)
|
|
* (if the user has automatic screenshots enabled).
|
|
*
|
|
* More effects may occur as Uplay is being developed.
|
|
*
|
|
* @param aNameUtf8
|
|
* Null terminated UTF-8 string containing the metadata tag name
|
|
* @param aValueUtf8
|
|
* Null terminated UTF-8 string containing the metadata tag value
|
|
*
|
|
* @returns Non-zero on success
|
|
*/
|
|
int
|
|
UPLAY_API UPLAY_METADATA_SetSingleEventTag(
|
|
const char* aNameUtf8,
|
|
const char* aValueUtf8);
|
|
|
|
/************************************************************************************//**
|
|
* @fn int UPLAY_METADATA_SetContinuousTag(const char*, const char*)
|
|
* @brief Create continuous metadata tag.
|
|
*
|
|
* Creates a continuous time event tag that will be applied to all metadata-enabled
|
|
* media Uplay can produce.<br>
|
|
* Calling this function will result in:
|
|
* -# All screenshots taken from this point up until respective UPLAY_METADATA_ClearContinuousTag call
|
|
* will contain the specified tag.
|
|
*
|
|
* More effects may occur as Uplay is being developed.
|
|
*
|
|
* @param aNameUtf8
|
|
* Null terminated UTF-8 string containing the metadata tag name
|
|
* @param aValueUtf8
|
|
* Null terminated UTF-8 string containing the metadata tag value
|
|
*
|
|
* @returns Non-zero on success
|
|
*/
|
|
int
|
|
UPLAY_API UPLAY_METADATA_SetContinuousTag(
|
|
const char* aNameUtf8,
|
|
const char* aValueUtf8);
|
|
|
|
/************************************************************************************//**
|
|
* @fn int UPLAY_METADATA_ClearContinuousTag(const char*)
|
|
* @brief Deletes continuous metadata tag.
|
|
* Call of this function will clear specified continuous tag so that it will stop to be asociated with any media
|
|
* produced by Uplay.
|
|
* In effect:
|
|
* -# The tag will stop being attached to screenshots.
|
|
* -# Stream tagged time span asociated with this tag will end (if the user is streaming);
|
|
*
|
|
* More effects may occur as Uplay is being developed.
|
|
*
|
|
* @param aNameUtf8
|
|
* Null terminated UTF-8 string containing the metadata tag name
|
|
*
|
|
* @returns Non-zero on success
|
|
*/
|
|
int
|
|
UPLAY_API UPLAY_METADATA_ClearContinuousTag(
|
|
const char* aNameUtf8);
|
|
|
|
/** @} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif // __cplusplus
|
|
|
|
#endif // UPLAY_METADATA_H
|