1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
|
<!-- 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.11"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NVIDIAGeForceExperienceSDK: C:/u/workspace/dev/sdkwinauto/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);
$(window).load(resizeHeight);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</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#ac758b6034dd2bb8bbde7de7576141fd6">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#a69743e304d126860275dec9f1335f16f">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 class="anchor" id="a0407132e7fd44771370ecfa03fdfce8d"></a>
<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 class="anchor" id="a48a359560944097729acf3dff42e34bb"></a>
<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#ac758b6034dd2bb8bbde7de7576141fd6">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 class="anchor" id="aa49250dbc063e242607123333f8da892"></a>
<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 class="anchor" id="aa3b6190835ada28f4cee015645814e75"></a>
<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 class="anchor" id="a16d77849897fc5dca0e1c813525cd576"></a>
<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 class="anchor" id="a4812495c6dedfc7cc6b2d3c421c161ed"></a>
<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 class="anchor" id="ac6ee1cb402b4476571a79050f61bcd92"></a>
<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 class="anchor" id="afad5de18b900053c2b291ce2a55985c1"></a>
<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#a69743e304d126860275dec9f1335f16f">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.11 </li>
</ul>
</div>
</body>
</html>
|