aboutsummaryrefslogtreecommitdiff
path: root/doc/html/ihighlights__cpp_8h_source.html
blob: b736b195e42d88c9d989de652c13d856ed846885 (plain) (blame)
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
<!-- 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/bindings/cpp/highlights/ihighlights_cpp.h Source File</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__cpp_8h_source.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="headertitle">
<div class="title">ihighlights_cpp.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="ihighlights__cpp_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/* Copyright (c) 2017, NVIDIA CORPORATION.  All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">* NVIDIA CORPORATION and its licensors retain all intellectual property</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">* and proprietary rights in and to this software, related documentation</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">* and any modifications thereto.  Any use, reproduction, disclosure or</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">* distribution of this software and related documentation without an express</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">* license agreement from NVIDIA CORPORATION is strictly prohibited.</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef GFESDK_IHIGHLIGHTS_CPP_H</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define GFESDK_IHIGHLIGHTS_CPP_H</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="isdk__cpp_8h.html">gfesdk/bindings/cpp/isdk_cpp.h</a>&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &lt;gfesdk/bindings/cpp/highlights/highlights_types_cpp.h&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_gfe_s_d_k.html">GfeSDK</a></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;{</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment">// Avoid polluting global namespace with C api, so put it inside namespace</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="ihighlights_8h.html">gfesdk/highlights/ihighlights.h</a>&gt;</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="class_gfe_s_d_k_1_1_highlights.html">   28</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_gfe_s_d_k_1_1_highlights.html">Highlights</a></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;{</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <span class="keyword">static</span> <a class="code" href="class_gfe_s_d_k_1_1_highlights.html">Highlights</a>* Create(<a class="code" href="class_gfe_s_d_k_1_1_core.html">Core</a>* core);</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="class_gfe_s_d_k_1_1_highlights.html">Highlights</a>() {}</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_gfe_s_d_k_1_1_highlights.html#a8e522535c3393a1911e2bbb65c71eb52">ConfigureAsync</a>(<a class="code" href="struct_gfe_s_d_k_1_1_highlight_config_params.html">HighlightConfigParams</a> <span class="keyword">const</span>&amp; params, TCallback cb = <span class="keyword">nullptr</span>, <span class="keywordtype">void</span>* cbContext = <span class="keyword">nullptr</span>) = 0;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_gfe_s_d_k_1_1_highlights.html#a593d1bd58183bc0b53c7dee7991d8491">GetUserSettingsAsync</a>(TGetUserSettingsCallback cb = <span class="keyword">nullptr</span>, <span class="keywordtype">void</span>* cbContext = <span class="keyword">nullptr</span>) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_gfe_s_d_k_1_1_highlights.html#ab1b35bd4fe9e8aac357db3aeabfefa1b">OpenGroupAsync</a>(<a class="code" href="struct_gfe_s_d_k_1_1_highlight_open_group_params.html">HighlightOpenGroupParams</a> <span class="keyword">const</span>&amp; params, TCallback cb = <span class="keyword">nullptr</span>, <span class="keywordtype">void</span>* cbContext = <span class="keyword">nullptr</span>) = 0;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_gfe_s_d_k_1_1_highlights.html#ac53536039527813888e5404a3a20e4ab">CloseGroupAsync</a>(<a class="code" href="struct_gfe_s_d_k_1_1_highlight_close_group_params.html">HighlightCloseGroupParams</a> <span class="keyword">const</span>&amp; params, TCallback cb = <span class="keyword">nullptr</span>, <span class="keywordtype">void</span>* cbContext = <span class="keyword">nullptr</span>) = 0;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_gfe_s_d_k_1_1_highlights.html#a84475c751b97bf00d55e767b55e89bff">SetScreenshotHighlightAsync</a>(<a class="code" href="struct_gfe_s_d_k_1_1_screenshot_highlight_params.html">ScreenshotHighlightParams</a> <span class="keyword">const</span>&amp; params, TCallback cb = <span class="keyword">nullptr</span>, <span class="keywordtype">void</span>* cbContext = <span class="keyword">nullptr</span>) = 0;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_gfe_s_d_k_1_1_highlights.html#a982f27414a0672d50f6f156ecf557791">SetVideoHighlightAsync</a>(<a class="code" href="struct_gfe_s_d_k_1_1_video_highlight_params.html">VideoHighlightParams</a> <span class="keyword">const</span>&amp; params, TCallback cb = <span class="keyword">nullptr</span>, <span class="keywordtype">void</span>* cbContext = <span class="keyword">nullptr</span>) = 0;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_gfe_s_d_k_1_1_highlights.html#a9d1ab59542571efe90391aea1503411b">OpenSummaryAsync</a>(<a class="code" href="struct_gfe_s_d_k_1_1_summary_params.html">SummaryParams</a> <span class="keyword">const</span>&amp; params, TCallback cb = <span class="keyword">nullptr</span>, <span class="keywordtype">void</span>* cbContext = <span class="keyword">nullptr</span>) = 0;</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_gfe_s_d_k_1_1_highlights.html#ad640f12621aa2ab8f0bf39b859f8d849">GetNumberOfHighlightsAsync</a>(<a class="code" href="struct_gfe_s_d_k_1_1_group_view.html">GroupView</a> <span class="keyword">const</span>&amp; params, TGetNumberOfHighlightsCallback cb = <span class="keyword">nullptr</span>, <span class="keywordtype">void</span>* cbContext = <span class="keyword">nullptr</span>) = 0;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;};</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;}</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="preprocessor">#endif //GFESDK_IHIGHLIGHTS_CPP_H</span></div><div class="ttc" id="class_gfe_s_d_k_1_1_highlights_html_ad640f12621aa2ab8f0bf39b859f8d849"><div class="ttname"><a href="class_gfe_s_d_k_1_1_highlights.html#ad640f12621aa2ab8f0bf39b859f8d849">GfeSDK::Highlights::GetNumberOfHighlightsAsync</a></div><div class="ttdeci">virtual void GetNumberOfHighlightsAsync(GroupView const &amp;params, TGetNumberOfHighlightsCallback cb=nullptr, void *cbContext=nullptr)=0</div></div>
<div class="ttc" id="struct_gfe_s_d_k_1_1_summary_params_html"><div class="ttname"><a href="struct_gfe_s_d_k_1_1_summary_params.html">GfeSDK::SummaryParams</a></div><div class="ttdoc">C++ binding for NVGSDK_SummaryParams. </div><div class="ttdef"><b>Definition:</b> <a href="highlights__types__cpp_8h_source.html#l00080">highlights_types_cpp.h:80</a></div></div>
<div class="ttc" id="struct_gfe_s_d_k_1_1_screenshot_highlight_params_html"><div class="ttname"><a href="struct_gfe_s_d_k_1_1_screenshot_highlight_params.html">GfeSDK::ScreenshotHighlightParams</a></div><div class="ttdoc">C++ binding for NVGSDK_ScreenshotHighlightParams. </div><div class="ttdef"><b>Definition:</b> <a href="highlights__types__cpp_8h_source.html#l00056">highlights_types_cpp.h:56</a></div></div>
<div class="ttc" id="struct_gfe_s_d_k_1_1_highlight_close_group_params_html"><div class="ttname"><a href="struct_gfe_s_d_k_1_1_highlight_close_group_params.html">GfeSDK::HighlightCloseGroupParams</a></div><div class="ttdoc">C++ binding for NVGSDK_HighlightCloseGroupParams. </div><div class="ttdef"><b>Definition:</b> <a href="highlights__types__cpp_8h_source.html#l00049">highlights_types_cpp.h:49</a></div></div>
<div class="ttc" id="struct_gfe_s_d_k_1_1_highlight_open_group_params_html"><div class="ttname"><a href="struct_gfe_s_d_k_1_1_highlight_open_group_params.html">GfeSDK::HighlightOpenGroupParams</a></div><div class="ttdoc">C++ binding for NVGSDK_HighlightOpenGroupParams. </div><div class="ttdef"><b>Definition:</b> <a href="highlights__types__cpp_8h_source.html#l00042">highlights_types_cpp.h:42</a></div></div>
<div class="ttc" id="class_gfe_s_d_k_1_1_highlights_html_ac53536039527813888e5404a3a20e4ab"><div class="ttname"><a href="class_gfe_s_d_k_1_1_highlights.html#ac53536039527813888e5404a3a20e4ab">GfeSDK::Highlights::CloseGroupAsync</a></div><div class="ttdeci">virtual void CloseGroupAsync(HighlightCloseGroupParams const &amp;params, TCallback cb=nullptr, void *cbContext=nullptr)=0</div></div>
<div class="ttc" id="struct_gfe_s_d_k_1_1_highlight_config_params_html"><div class="ttname"><a href="struct_gfe_s_d_k_1_1_highlight_config_params.html">GfeSDK::HighlightConfigParams</a></div><div class="ttdoc">C++ binding for NVGSDK_HighlightConfigParams. </div><div class="ttdef"><b>Definition:</b> <a href="highlights__types__cpp_8h_source.html#l00035">highlights_types_cpp.h:35</a></div></div>
<div class="ttc" id="struct_gfe_s_d_k_1_1_video_highlight_params_html"><div class="ttname"><a href="struct_gfe_s_d_k_1_1_video_highlight_params.html">GfeSDK::VideoHighlightParams</a></div><div class="ttdoc">C++ binding for NVGSDK_VideoHighlightParams. </div><div class="ttdef"><b>Definition:</b> <a href="highlights__types__cpp_8h_source.html#l00063">highlights_types_cpp.h:63</a></div></div>
<div class="ttc" id="class_gfe_s_d_k_1_1_highlights_html_a593d1bd58183bc0b53c7dee7991d8491"><div class="ttname"><a href="class_gfe_s_d_k_1_1_highlights.html#a593d1bd58183bc0b53c7dee7991d8491">GfeSDK::Highlights::GetUserSettingsAsync</a></div><div class="ttdeci">virtual void GetUserSettingsAsync(TGetUserSettingsCallback cb=nullptr, void *cbContext=nullptr) const =0</div></div>
<div class="ttc" id="isdk__cpp_8h_html"><div class="ttname"><a href="isdk__cpp_8h.html">isdk_cpp.h</a></div></div>
<div class="ttc" id="struct_gfe_s_d_k_1_1_group_view_html"><div class="ttname"><a href="struct_gfe_s_d_k_1_1_group_view.html">GfeSDK::GroupView</a></div><div class="ttdoc">C++ binding for NVGSDK_GroupView. </div><div class="ttdef"><b>Definition:</b> <a href="highlights__types__cpp_8h_source.html#l00072">highlights_types_cpp.h:72</a></div></div>
<div class="ttc" id="class_gfe_s_d_k_1_1_highlights_html_a84475c751b97bf00d55e767b55e89bff"><div class="ttname"><a href="class_gfe_s_d_k_1_1_highlights.html#a84475c751b97bf00d55e767b55e89bff">GfeSDK::Highlights::SetScreenshotHighlightAsync</a></div><div class="ttdeci">virtual void SetScreenshotHighlightAsync(ScreenshotHighlightParams const &amp;params, TCallback cb=nullptr, void *cbContext=nullptr)=0</div></div>
<div class="ttc" id="class_gfe_s_d_k_1_1_highlights_html_a8e522535c3393a1911e2bbb65c71eb52"><div class="ttname"><a href="class_gfe_s_d_k_1_1_highlights.html#a8e522535c3393a1911e2bbb65c71eb52">GfeSDK::Highlights::ConfigureAsync</a></div><div class="ttdeci">virtual void ConfigureAsync(HighlightConfigParams const &amp;params, TCallback cb=nullptr, void *cbContext=nullptr)=0</div></div>
<div class="ttc" id="class_gfe_s_d_k_1_1_highlights_html_a982f27414a0672d50f6f156ecf557791"><div class="ttname"><a href="class_gfe_s_d_k_1_1_highlights.html#a982f27414a0672d50f6f156ecf557791">GfeSDK::Highlights::SetVideoHighlightAsync</a></div><div class="ttdeci">virtual void SetVideoHighlightAsync(VideoHighlightParams const &amp;params, TCallback cb=nullptr, void *cbContext=nullptr)=0</div></div>
<div class="ttc" id="class_gfe_s_d_k_1_1_core_html"><div class="ttname"><a href="class_gfe_s_d_k_1_1_core.html">GfeSDK::Core</a></div><div class="ttdef"><b>Definition:</b> <a href="isdk__cpp_8h_source.html#l00037">isdk_cpp.h:37</a></div></div>
<div class="ttc" id="namespace_gfe_s_d_k_html"><div class="ttname"><a href="namespace_gfe_s_d_k.html">GfeSDK</a></div><div class="ttdef"><b>Definition:</b> <a href="highlights__types__cpp_8h_source.html#l00016">highlights_types_cpp.h:16</a></div></div>
<div class="ttc" id="class_gfe_s_d_k_1_1_highlights_html_a9d1ab59542571efe90391aea1503411b"><div class="ttname"><a href="class_gfe_s_d_k_1_1_highlights.html#a9d1ab59542571efe90391aea1503411b">GfeSDK::Highlights::OpenSummaryAsync</a></div><div class="ttdeci">virtual void OpenSummaryAsync(SummaryParams const &amp;params, TCallback cb=nullptr, void *cbContext=nullptr)=0</div></div>
<div class="ttc" id="class_gfe_s_d_k_1_1_highlights_html_ab1b35bd4fe9e8aac357db3aeabfefa1b"><div class="ttname"><a href="class_gfe_s_d_k_1_1_highlights.html#ab1b35bd4fe9e8aac357db3aeabfefa1b">GfeSDK::Highlights::OpenGroupAsync</a></div><div class="ttdeci">virtual void OpenGroupAsync(HighlightOpenGroupParams const &amp;params, TCallback cb=nullptr, void *cbContext=nullptr)=0</div></div>
<div class="ttc" id="ihighlights_8h_html"><div class="ttname"><a href="ihighlights_8h.html">ihighlights.h</a></div></div>
<div class="ttc" id="class_gfe_s_d_k_1_1_highlights_html"><div class="ttname"><a href="class_gfe_s_d_k_1_1_highlights.html">GfeSDK::Highlights</a></div><div class="ttdef"><b>Definition:</b> <a href="ihighlights__cpp_8h_source.html#l00028">ihighlights_cpp.h:28</a></div></div>
</div><!-- fragment --></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_f78f74a3131a0cfd456c5ed856861cff.html">bindings</a></li><li class="navelem"><a class="el" href="dir_ab8ba62fc8fdaf78364406bae0a66d43.html">cpp</a></li><li class="navelem"><a class="el" href="dir_9e1fb0299a0600dff10179bfe2b8a156.html">highlights</a></li><li class="navelem"><a class="el" href="ihighlights__cpp_8h.html">ihighlights_cpp.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>