diff options
| author | Dave Clark <[email protected]> | 2017-08-01 21:34:58 -0400 |
|---|---|---|
| committer | Dave Clark <[email protected]> | 2017-08-01 21:34:58 -0400 |
| commit | 0b5cb2081fc8fa69ffc5e8db995afa5baffc43c4 (patch) | |
| tree | 3c1c3e7d7530069a91ecf2b85a09ffd349a42441 /doc/html/ihighlights_8h.html | |
| parent | Initial commit (diff) | |
| download | gfesdk-0b5cb2081fc8fa69ffc5e8db995afa5baffc43c4.tar.xz gfesdk-0b5cb2081fc8fa69ffc5e8db995afa5baffc43c4.zip | |
documentation test
Diffstat (limited to 'doc/html/ihighlights_8h.html')
| -rw-r--r-- | doc/html/ihighlights_8h.html | 572 |
1 files changed, 572 insertions, 0 deletions
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 @@ +<!-- HTML header for doxygen 1.8.12--> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.12"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>NVIDIAGeForceExperienceSDK: C:/dev/gxp/sdk/sdkclient/include/gfesdk/highlights/ihighlights.h File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="customdoxygen.css" rel="stylesheet" type="text/css"/> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">NVIDIAGeForceExperienceSDK + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.12 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('ihighlights_8h.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">ihighlights.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include <<a class="el" href="highlights__types_8h_source.html">gfesdk/highlights/highlights_types.h</a>></code><br /> +</div> +<p><a href="ihighlights_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a0407132e7fd44771370ecfa03fdfce8d"><td class="memItemLeft" align="right" valign="top">NVGSDK_EXPORT void NVGSDKApi </td><td class="memItemRight" valign="bottom"><a class="el" href="ihighlights_8h.html#a0407132e7fd44771370ecfa03fdfce8d">NVGSDK_Highlights_ConfigureAsync</a> (NVGSDK_HANDLE *handle, <a class="el" href="struct_n_v_g_s_d_k___highlight_config_params.html">NVGSDK_HighlightConfigParams</a> const *config, <a class="el" href="sdk__types_8h.html#a1c5cd84ed88c70462c360a7268eb95ac">NVGSDK_EmptyCallback</a> callback, void *context)</td></tr> +<tr class="separator:a0407132e7fd44771370ecfa03fdfce8d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a48a359560944097729acf3dff42e34bb"><td class="memItemLeft" align="right" valign="top">NVGSDK_EXPORT void NVGSDKApi </td><td class="memItemRight" valign="bottom"><a class="el" href="ihighlights_8h.html#a48a359560944097729acf3dff42e34bb">NVGSDK_Highlights_GetUserSettingsAsync</a> (NVGSDK_HANDLE *handle, <a class="el" href="highlights__types_8h.html#a87a246f3f9c2a0f0670b1208b22fa2d9">NVGSDK_Highlights_GetUserSettingsCallback</a> cb, void *cbContext)</td></tr> +<tr class="separator:a48a359560944097729acf3dff42e34bb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa49250dbc063e242607123333f8da892"><td class="memItemLeft" align="right" valign="top">NVGSDK_EXPORT void NVGSDKApi </td><td class="memItemRight" valign="bottom"><a class="el" href="ihighlights_8h.html#aa49250dbc063e242607123333f8da892">NVGSDK_Highlights_OpenGroupAsync</a> (NVGSDK_HANDLE *handle, <a class="el" href="struct_n_v_g_s_d_k___highlight_open_group_params.html">NVGSDK_HighlightOpenGroupParams</a> const *params, <a class="el" href="sdk__types_8h.html#a1c5cd84ed88c70462c360a7268eb95ac">NVGSDK_EmptyCallback</a> callback, void *context)</td></tr> +<tr class="separator:aa49250dbc063e242607123333f8da892"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa3b6190835ada28f4cee015645814e75"><td class="memItemLeft" align="right" valign="top">NVGSDK_EXPORT void NVGSDKApi </td><td class="memItemRight" valign="bottom"><a class="el" href="ihighlights_8h.html#aa3b6190835ada28f4cee015645814e75">NVGSDK_Highlights_CloseGroupAsync</a> (NVGSDK_HANDLE *handle, <a class="el" href="struct_n_v_g_s_d_k___highlight_close_group_params.html">NVGSDK_HighlightCloseGroupParams</a> const *params, <a class="el" href="sdk__types_8h.html#a1c5cd84ed88c70462c360a7268eb95ac">NVGSDK_EmptyCallback</a> callback, void *context)</td></tr> +<tr class="separator:aa3b6190835ada28f4cee015645814e75"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a16d77849897fc5dca0e1c813525cd576"><td class="memItemLeft" align="right" valign="top">NVGSDK_EXPORT void NVGSDKApi </td><td class="memItemRight" valign="bottom"><a class="el" href="ihighlights_8h.html#a16d77849897fc5dca0e1c813525cd576">NVGSDK_Highlights_SetScreenshotHighlightAsync</a> (NVGSDK_HANDLE *handle, <a class="el" href="struct_n_v_g_s_d_k___screenshot_highlight_params.html">NVGSDK_ScreenshotHighlightParams</a> const *params, <a class="el" href="sdk__types_8h.html#a1c5cd84ed88c70462c360a7268eb95ac">NVGSDK_EmptyCallback</a> callback, void *context)</td></tr> +<tr class="separator:a16d77849897fc5dca0e1c813525cd576"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4812495c6dedfc7cc6b2d3c421c161ed"><td class="memItemLeft" align="right" valign="top">NVGSDK_EXPORT void NVGSDKApi </td><td class="memItemRight" valign="bottom"><a class="el" href="ihighlights_8h.html#a4812495c6dedfc7cc6b2d3c421c161ed">NVGSDK_Highlights_SetVideoHighlightAsync</a> (NVGSDK_HANDLE *handle, <a class="el" href="struct_n_v_g_s_d_k___video_highlight_params.html">NVGSDK_VideoHighlightParams</a> const *, <a class="el" href="sdk__types_8h.html#a1c5cd84ed88c70462c360a7268eb95ac">NVGSDK_EmptyCallback</a> callback, void *context)</td></tr> +<tr class="separator:a4812495c6dedfc7cc6b2d3c421c161ed"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac6ee1cb402b4476571a79050f61bcd92"><td class="memItemLeft" align="right" valign="top">NVGSDK_EXPORT void NVGSDKApi </td><td class="memItemRight" valign="bottom"><a class="el" href="ihighlights_8h.html#ac6ee1cb402b4476571a79050f61bcd92">NVGSDK_Highlights_OpenSummaryAsync</a> (NVGSDK_HANDLE *handle, <a class="el" href="struct_n_v_g_s_d_k___summary_params.html">NVGSDK_SummaryParams</a> const *params, <a class="el" href="sdk__types_8h.html#a1c5cd84ed88c70462c360a7268eb95ac">NVGSDK_EmptyCallback</a> callback, void *context)</td></tr> +<tr class="separator:ac6ee1cb402b4476571a79050f61bcd92"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afad5de18b900053c2b291ce2a55985c1"><td class="memItemLeft" align="right" valign="top">NVGSDK_EXPORT void NVGSDKApi </td><td class="memItemRight" valign="bottom"><a class="el" href="ihighlights_8h.html#afad5de18b900053c2b291ce2a55985c1">NVGSDK_Highlights_GetNumberOfHighlightsAsync</a> (NVGSDK_HANDLE *handle, <a class="el" href="struct_n_v_g_s_d_k___group_view.html">NVGSDK_GroupView</a> const *groupParams, <a class="el" href="highlights__types_8h.html#a1ace1def4d575aa419abae45b2738db0">NVGSDK_Highlights_GetNumberOfHighlightsCallback</a> cb, void *context)</td></tr> +<tr class="separator:afad5de18b900053c2b291ce2a55985c1"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>C GfeSDK Highlights API </p> + +<p>Definition in file <a class="el" href="ihighlights_8h_source.html">ihighlights.h</a>.</p> +</div><h2 class="groupheader">Function Documentation</h2> +<a id="a0407132e7fd44771370ecfa03fdfce8d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0407132e7fd44771370ecfa03fdfce8d">§ </a></span>NVGSDK_Highlights_ConfigureAsync()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_ConfigureAsync </td> + <td>(</td> + <td class="paramtype">NVGSDK_HANDLE * </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_n_v_g_s_d_k___highlight_config_params.html">NVGSDK_HighlightConfigParams</a> const * </td> + <td class="paramname"><em>config</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sdk__types_8h.html#a1c5cd84ed88c70462c360a7268eb95ac">NVGSDK_EmptyCallback</a> </td> + <td class="paramname"><em>callback</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>context</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>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.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handle[in]</td><td>- Valid SDK handle returned by NVGSDK_Create </td></tr> + <tr><td class="paramname">config[in]</td><td>- Table of possible Highlights</td></tr> + <tr><td class="paramname">callback[in]</td><td>- Callback return function as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a> </td></tr> + <tr><td class="paramname">context[in]</td><td>- Opaque context pointer as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a></td></tr> + </table> + </dd> +</dl> +<dl class="retval"><dt>Return values</dt><dd> + <table class="retval"> + <tr><td class="paramname">NVGSDK_SUCCESS</td><td>- Call was successful </td></tr> + <tr><td class="paramname">NVGSDK_ERR_INVALID_PARAMETER</td><td>- Invalid handle or other pointer provided </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a48a359560944097729acf3dff42e34bb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a48a359560944097729acf3dff42e34bb">§ </a></span>NVGSDK_Highlights_GetUserSettingsAsync()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_GetUserSettingsAsync </td> + <td>(</td> + <td class="paramtype">NVGSDK_HANDLE * </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="highlights__types_8h.html#a87a246f3f9c2a0f0670b1208b22fa2d9">NVGSDK_Highlights_GetUserSettingsCallback</a> </td> + <td class="paramname"><em>cb</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>cbContext</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>The user is able to enable/disable Highlights. This gives the game that information.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handle[in]</td><td>- Valid SDK handle returned by NVGSDK_Create </td></tr> + <tr><td class="paramname">userSettings[out]</td><td>- On NVGSDK_SUCCESS, will be populated with the user settings.</td></tr> + <tr><td class="paramname">callback[in]</td><td>- Callback return function as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a> </td></tr> + <tr><td class="paramname">context[in]</td><td>- Opaque context pointer as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a></td></tr> + </table> + </dd> +</dl> +<dl class="retval"><dt>Return values</dt><dd> + <table class="retval"> + <tr><td class="paramname">NVGSDK_SUCCESS</td><td>- Call was successful </td></tr> + <tr><td class="paramname">NVGSDK_ERR_INVALID_PARAMETER</td><td>- Invalid handle or other pointer provided </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="aa49250dbc063e242607123333f8da892"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa49250dbc063e242607123333f8da892">§ </a></span>NVGSDK_Highlights_OpenGroupAsync()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_OpenGroupAsync </td> + <td>(</td> + <td class="paramtype">NVGSDK_HANDLE * </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_n_v_g_s_d_k___highlight_open_group_params.html">NVGSDK_HighlightOpenGroupParams</a> const * </td> + <td class="paramname"><em>params</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sdk__types_8h.html#a1c5cd84ed88c70462c360a7268eb95ac">NVGSDK_EmptyCallback</a> </td> + <td class="paramname"><em>callback</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>context</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>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.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handle[in]</td><td>- Valid SDK handle returned by NVGSDK_Create </td></tr> + <tr><td class="paramname">params[in]</td><td>- Parameter struct containing the name of the group and additional metadata</td></tr> + <tr><td class="paramname">callback[in]</td><td>- Callback return function as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a> </td></tr> + <tr><td class="paramname">context[in]</td><td>- Opaque context pointer as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a></td></tr> + </table> + </dd> +</dl> +<dl class="retval"><dt>Return values</dt><dd> + <table class="retval"> + <tr><td class="paramname">NVGSDK_SUCCESS</td><td>- Call was successful </td></tr> + <tr><td class="paramname">NVGSDK_ERR_INVALID_PARAMETER</td><td>- Invalid handle or other pointer provided </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="aa3b6190835ada28f4cee015645814e75"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa3b6190835ada28f4cee015645814e75">§ </a></span>NVGSDK_Highlights_CloseGroupAsync()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_CloseGroupAsync </td> + <td>(</td> + <td class="paramtype">NVGSDK_HANDLE * </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_n_v_g_s_d_k___highlight_close_group_params.html">NVGSDK_HighlightCloseGroupParams</a> const * </td> + <td class="paramname"><em>params</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sdk__types_8h.html#a1c5cd84ed88c70462c360a7268eb95ac">NVGSDK_EmptyCallback</a> </td> + <td class="paramname"><em>callback</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>context</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Closes out a group and purges the unsaved contents. See <a class="el" href="ihighlights_8h.html#aa49250dbc063e242607123333f8da892">NVGSDK_Highlights_OpenGroupAsync</a></p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handle[in]</td><td>- Valid SDK handle returned by NVGSDK_Create </td></tr> + <tr><td class="paramname">groupName[in]</td><td>- Parameter struct containing the name of the group and additional close instructions</td></tr> + <tr><td class="paramname">callback[in]</td><td>- Callback return function as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a> </td></tr> + <tr><td class="paramname">context[in]</td><td>- Opaque context pointer as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a></td></tr> + </table> + </dd> +</dl> +<dl class="retval"><dt>Return values</dt><dd> + <table class="retval"> + <tr><td class="paramname">NVGSDK_SUCCESS</td><td>- Call was successful </td></tr> + <tr><td class="paramname">NVGSDK_ERR_INVALID_PARAMETER</td><td>- Invalid handle or other pointer provided </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a16d77849897fc5dca0e1c813525cd576"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a16d77849897fc5dca0e1c813525cd576">§ </a></span>NVGSDK_Highlights_SetScreenshotHighlightAsync()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_SetScreenshotHighlightAsync </td> + <td>(</td> + <td class="paramtype">NVGSDK_HANDLE * </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_n_v_g_s_d_k___screenshot_highlight_params.html">NVGSDK_ScreenshotHighlightParams</a> const * </td> + <td class="paramname"><em>params</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sdk__types_8h.html#a1c5cd84ed88c70462c360a7268eb95ac">NVGSDK_EmptyCallback</a> </td> + <td class="paramname"><em>callback</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>context</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Records a screenshot highlight for the given group. Attached metadata to it to make the Highlight more interesting.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handle[in]</td><td>- Valid SDK handle returned by NVGSDK_Create </td></tr> + <tr><td class="paramname">params[in]</td><td>- GroupID and metadata to attach to the highlight</td></tr> + <tr><td class="paramname">callback[in]</td><td>- Callback return function as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a> </td></tr> + <tr><td class="paramname">context[in]</td><td>- Opaque context pointer as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a></td></tr> + </table> + </dd> +</dl> +<dl class="retval"><dt>Return values</dt><dd> + <table class="retval"> + <tr><td class="paramname">NVGSDK_SUCCESS</td><td>- Call was successful </td></tr> + <tr><td class="paramname">NVGSDK_ERR_INVALID_PARAMETER</td><td>- Invalid handle or other pointer provided </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a4812495c6dedfc7cc6b2d3c421c161ed"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4812495c6dedfc7cc6b2d3c421c161ed">§ </a></span>NVGSDK_Highlights_SetVideoHighlightAsync()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_SetVideoHighlightAsync </td> + <td>(</td> + <td class="paramtype">NVGSDK_HANDLE * </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_n_v_g_s_d_k___video_highlight_params.html">NVGSDK_VideoHighlightParams</a> const * </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sdk__types_8h.html#a1c5cd84ed88c70462c360a7268eb95ac">NVGSDK_EmptyCallback</a> </td> + <td class="paramname"><em>callback</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>context</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>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.</p> +<p>Examples:</p><ul> +<li>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.</li> +<li>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.</li> +<li>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.</li> +</ul> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handle[in]</td><td>- Valid SDK handle returned by NVGSDK_Create </td></tr> + <tr><td class="paramname">params[in]</td><td>- GroupID and metadata to attach to the highlight</td></tr> + <tr><td class="paramname">callback[in]</td><td>- Callback return function as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a> </td></tr> + <tr><td class="paramname">context[in]</td><td>- Opaque context pointer as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a></td></tr> + </table> + </dd> +</dl> +<dl class="retval"><dt>Return values</dt><dd> + <table class="retval"> + <tr><td class="paramname">NVGSDK_SUCCESS</td><td>- Call was successful </td></tr> + <tr><td class="paramname">NVGSDK_ERR_INVALID_PARAMETER</td><td>- Invalid handle or other pointer provided </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ac6ee1cb402b4476571a79050f61bcd92"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac6ee1cb402b4476571a79050f61bcd92">§ </a></span>NVGSDK_Highlights_OpenSummaryAsync()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_OpenSummaryAsync </td> + <td>(</td> + <td class="paramtype">NVGSDK_HANDLE * </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_n_v_g_s_d_k___summary_params.html">NVGSDK_SummaryParams</a> const * </td> + <td class="paramname"><em>params</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sdk__types_8h.html#a1c5cd84ed88c70462c360a7268eb95ac">NVGSDK_EmptyCallback</a> </td> + <td class="paramname"><em>callback</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>context</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Opens up Summary Dialog for one or more groups</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handle[in]</td><td>- Valid SDK handle returned by NVGSDK_Create </td></tr> + <tr><td class="paramname">params[in]</td><td>- Struct containing the group names and filter params</td></tr> + <tr><td class="paramname">callback[in]</td><td>- Callback return function as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a> </td></tr> + <tr><td class="paramname">context[in]</td><td>- Opaque context pointer as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a> </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="afad5de18b900053c2b291ce2a55985c1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#afad5de18b900053c2b291ce2a55985c1">§ </a></span>NVGSDK_Highlights_GetNumberOfHighlightsAsync()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">NVGSDK_EXPORT void NVGSDKApi NVGSDK_Highlights_GetNumberOfHighlightsAsync </td> + <td>(</td> + <td class="paramtype">NVGSDK_HANDLE * </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_n_v_g_s_d_k___group_view.html">NVGSDK_GroupView</a> const * </td> + <td class="paramname"><em>groupParams</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="highlights__types_8h.html#a1ace1def4d575aa419abae45b2738db0">NVGSDK_Highlights_GetNumberOfHighlightsCallback</a> </td> + <td class="paramname"><em>cb</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>context</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Retrieves the number of highlights given the group ID and filtering params</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handle[in]</td><td>- Valid SDK handle returned by NVGSDK_Create </td></tr> + <tr><td class="paramname">groupParams[in]</td><td>- Struct containing the group names and filter params</td></tr> + <tr><td class="paramname">callback[in]</td><td>- Callback return function as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a> </td></tr> + <tr><td class="paramname">context[in]</td><td>- Opaque context pointer as described by <a class="el" href="index.html#section_async">Asynchronous Calls</a> </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- HTML footer for doxygen 1.8.12--> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="dir_4522e853adfb3285c34ceee6be627ffe.html">sdkclient</a></li><li class="navelem"><a class="el" href="dir_37f49c9d6a230916a5077fbd270eac2a.html">include</a></li><li class="navelem"><a class="el" href="dir_eb56eea0ff74c30c2a48b22915222057.html">gfesdk</a></li><li class="navelem"><a class="el" href="dir_2f4536f343cdc104d7b83de3fff7416d.html">highlights</a></li><li class="navelem"><a class="el" href="ihighlights_8h.html">ihighlights.h</a></li> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + doxygen</a> 1.8.12 </li> + </ul> +</div> +</body> +</html> |