From 0b5cb2081fc8fa69ffc5e8db995afa5baffc43c4 Mon Sep 17 00:00:00 2001 From: Dave Clark Date: Tue, 1 Aug 2017 21:34:58 -0400 Subject: documentation test --- doc/html/ihighlights_8h.html | 572 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 572 insertions(+) create mode 100644 doc/html/ihighlights_8h.html (limited to 'doc/html/ihighlights_8h.html') diff --git a/doc/html/ihighlights_8h.html b/doc/html/ihighlights_8h.html new file mode 100644 index 0000000..4c2ad54 --- /dev/null +++ b/doc/html/ihighlights_8h.html @@ -0,0 +1,572 @@ + + + + + + + + +NVIDIAGeForceExperienceSDK: C:/dev/gxp/sdk/sdkclient/include/gfesdk/highlights/ihighlights.h File Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
NVIDIAGeForceExperienceSDK +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Functions
+
+
ihighlights.h File Reference
+
+
+
#include <gfesdk/highlights/highlights_types.h>
+
+

Go to the source code of this file.

+ + + + + + + + + + + + + + + + + + +

+Functions

NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_ConfigureAsync (NVGSDK_HANDLE *handle, NVGSDK_HighlightConfigParams const *config, NVGSDK_EmptyCallback callback, void *context)
 
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_GetUserSettingsAsync (NVGSDK_HANDLE *handle, NVGSDK_Highlights_GetUserSettingsCallback cb, void *cbContext)
 
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_OpenGroupAsync (NVGSDK_HANDLE *handle, NVGSDK_HighlightOpenGroupParams const *params, NVGSDK_EmptyCallback callback, void *context)
 
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_CloseGroupAsync (NVGSDK_HANDLE *handle, NVGSDK_HighlightCloseGroupParams const *params, NVGSDK_EmptyCallback callback, void *context)
 
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_SetScreenshotHighlightAsync (NVGSDK_HANDLE *handle, NVGSDK_ScreenshotHighlightParams const *params, NVGSDK_EmptyCallback callback, void *context)
 
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_SetVideoHighlightAsync (NVGSDK_HANDLE *handle, NVGSDK_VideoHighlightParams const *, NVGSDK_EmptyCallback callback, void *context)
 
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_OpenSummaryAsync (NVGSDK_HANDLE *handle, NVGSDK_SummaryParams const *params, NVGSDK_EmptyCallback callback, void *context)
 
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_GetNumberOfHighlightsAsync (NVGSDK_HANDLE *handle, NVGSDK_GroupView const *groupParams, NVGSDK_Highlights_GetNumberOfHighlightsCallback cb, void *context)
 
+

Detailed Description

+

C GfeSDK Highlights API

+ +

Definition in file ihighlights.h.

+

Function Documentation

+ +

§ NVGSDK_Highlights_ConfigureAsync()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_ConfigureAsync (NVGSDK_HANDLE * handle,
NVGSDK_HighlightConfigParams const * config,
NVGSDK_EmptyCallback callback,
void * context 
)
+
+

Gives a list of possible Highlights to GFE. The user will be able to see this list and determine which of them she cares about. Future calls to NVGSDK_SetVideoHighlight and NVGSDK_SetScreenshotHighlight will refer to an entry in this list by name.

+
Parameters
+ + + + + +
handle[in]- Valid SDK handle returned by NVGSDK_Create
config[in]- Table of possible Highlights
callback[in]- Callback return function as described by Asynchronous Calls
context[in]- Opaque context pointer as described by Asynchronous Calls
+
+
+
Return values
+ + + +
NVGSDK_SUCCESS- Call was successful
NVGSDK_ERR_INVALID_PARAMETER- Invalid handle or other pointer provided
+
+
+ +
+
+ +

§ NVGSDK_Highlights_GetUserSettingsAsync()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_GetUserSettingsAsync (NVGSDK_HANDLE * handle,
NVGSDK_Highlights_GetUserSettingsCallback cb,
void * cbContext 
)
+
+

The user is able to enable/disable Highlights. This gives the game that information.

+
Parameters
+ + + + + +
handle[in]- Valid SDK handle returned by NVGSDK_Create
userSettings[out]- On NVGSDK_SUCCESS, will be populated with the user settings.
callback[in]- Callback return function as described by Asynchronous Calls
context[in]- Opaque context pointer as described by Asynchronous Calls
+
+
+
Return values
+ + + +
NVGSDK_SUCCESS- Call was successful
NVGSDK_ERR_INVALID_PARAMETER- Invalid handle or other pointer provided
+
+
+ +
+
+ +

§ NVGSDK_Highlights_OpenGroupAsync()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_OpenGroupAsync (NVGSDK_HANDLE * handle,
NVGSDK_HighlightOpenGroupParams const * params,
NVGSDK_EmptyCallback callback,
void * context 
)
+
+

Begins a "group" which groups several Highlights together. As an example, an online game will commonly consist of a round of action, followed by a down period sitting in the lobby. The game can choose to define a Group as the time between starting and finishing this round of action. At the end, all of the highlights recorded during that group may be displayed to the user in a group summary.

+
Parameters
+ + + + + +
handle[in]- Valid SDK handle returned by NVGSDK_Create
params[in]- Parameter struct containing the name of the group and additional metadata
callback[in]- Callback return function as described by Asynchronous Calls
context[in]- Opaque context pointer as described by Asynchronous Calls
+
+
+
Return values
+ + + +
NVGSDK_SUCCESS- Call was successful
NVGSDK_ERR_INVALID_PARAMETER- Invalid handle or other pointer provided
+
+
+ +
+
+ +

§ NVGSDK_Highlights_CloseGroupAsync()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_CloseGroupAsync (NVGSDK_HANDLE * handle,
NVGSDK_HighlightCloseGroupParams const * params,
NVGSDK_EmptyCallback callback,
void * context 
)
+
+

Closes out a group and purges the unsaved contents. See NVGSDK_Highlights_OpenGroupAsync

+
Parameters
+ + + + + +
handle[in]- Valid SDK handle returned by NVGSDK_Create
groupName[in]- Parameter struct containing the name of the group and additional close instructions
callback[in]- Callback return function as described by Asynchronous Calls
context[in]- Opaque context pointer as described by Asynchronous Calls
+
+
+
Return values
+ + + +
NVGSDK_SUCCESS- Call was successful
NVGSDK_ERR_INVALID_PARAMETER- Invalid handle or other pointer provided
+
+
+ +
+
+ +

§ NVGSDK_Highlights_SetScreenshotHighlightAsync()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_SetScreenshotHighlightAsync (NVGSDK_HANDLE * handle,
NVGSDK_ScreenshotHighlightParams const * params,
NVGSDK_EmptyCallback callback,
void * context 
)
+
+

Records a screenshot highlight for the given group. Attached metadata to it to make the Highlight more interesting.

+
Parameters
+ + + + + +
handle[in]- Valid SDK handle returned by NVGSDK_Create
params[in]- GroupID and metadata to attach to the highlight
callback[in]- Callback return function as described by Asynchronous Calls
context[in]- Opaque context pointer as described by Asynchronous Calls
+
+
+
Return values
+ + + +
NVGSDK_SUCCESS- Call was successful
NVGSDK_ERR_INVALID_PARAMETER- Invalid handle or other pointer provided
+
+
+ +
+
+ +

§ NVGSDK_Highlights_SetVideoHighlightAsync()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_SetVideoHighlightAsync (NVGSDK_HANDLE * handle,
NVGSDK_VideoHighlightParams const * ,
NVGSDK_EmptyCallback callback,
void * context 
)
+
+

Records a video highlight for the given group. Attached metadata to it to make the Highlight more interesting. Set the start and end delta to change the length of the video clip.

+

Examples:

    +
  • The API call is made at T+0, with startDelta at -5000 and endDelta 5000. The start of the desired highlight will be at T-5s, and the clip will be 10s long.
    • +
  • The API call is made at T+0, with startDelta at -10000 and endDelta -5000. The start of the desired highlight will be at T-10s, and the clip will be 5s long.
    • +
  • The API call is made at T+0, with startDelta at 5000 and endDelta 10000. The start of the desired highlight will be at T+5s, and the clip will be 5s long.
    • +
+
Parameters
+ + + + + +
handle[in]- Valid SDK handle returned by NVGSDK_Create
params[in]- GroupID and metadata to attach to the highlight
callback[in]- Callback return function as described by Asynchronous Calls
context[in]- Opaque context pointer as described by Asynchronous Calls
+
+
+
Return values
+ + + +
NVGSDK_SUCCESS- Call was successful
NVGSDK_ERR_INVALID_PARAMETER- Invalid handle or other pointer provided
+
+
+ +
+
+ +

§ NVGSDK_Highlights_OpenSummaryAsync()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_OpenSummaryAsync (NVGSDK_HANDLE * handle,
NVGSDK_SummaryParams const * params,
NVGSDK_EmptyCallback callback,
void * context 
)
+
+

Opens up Summary Dialog for one or more groups

+
Parameters
+ + + + + +
handle[in]- Valid SDK handle returned by NVGSDK_Create
params[in]- Struct containing the group names and filter params
callback[in]- Callback return function as described by Asynchronous Calls
context[in]- Opaque context pointer as described by Asynchronous Calls
+
+
+ +
+
+ +

§ NVGSDK_Highlights_GetNumberOfHighlightsAsync()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_GetNumberOfHighlightsAsync (NVGSDK_HANDLE * handle,
NVGSDK_GroupView const * groupParams,
NVGSDK_Highlights_GetNumberOfHighlightsCallback cb,
void * context 
)
+
+

Retrieves the number of highlights given the group ID and filtering params

+
Parameters
+ + + + + +
handle[in]- Valid SDK handle returned by NVGSDK_Create
groupParams[in]- Struct containing the group names and filter params
callback[in]- Callback return function as described by Asynchronous Calls
context[in]- Opaque context pointer as described by Asynchronous Calls
+
+
+ +
+
+
+
+ + + + + -- cgit v1.2.3