ADTF
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
session_intf.h
Go to the documentation of this file.
1
7#pragma once
12
14#define CID_ADTF_SESSION_MANAGER "session_manager.service.adtf.cid"
15
16namespace adtf
17{
18namespace services
19{
20namespace ant
21{
22
23
30{
31 protected:
33 ~ISession() = default;
34 public:
36 ADTF_IID(ISession, "session.ant.services.adtf.iid");
37
38 public:
45 virtual tResult SetSessionName(const char* strSessionFileName) = 0;
46
53 virtual tResult GetSessionName(base::ant::IString&& strSessionName) = 0;
54
64 virtual tResult SetSystemFile(const char* strSystemFileName, const char* strSystemPropertiesFileName) = 0;
65
73 virtual tResult GetSystemFile(base::ant::IString&& strSystemFile) const = 0;
74
82 virtual tResult GetSystemPropertiesFile(base::ant::IString&& strProperties) const = 0;
83
91 virtual tResult SetGraphFile(const char* strGraphFileName, const char* strPropertiesFileName) = 0;
92
100 virtual tResult GetGraphFile(base::ant::IString&& strGraph) const = 0;
101
109 virtual tResult GetGraphPropertiesFile(base::ant::IString&& strProperties) const = 0;
110
111
125
139
150 virtual tResult SetActiveFilterGraph(const char* strActiveFilterGraph) = 0;
151
159 virtual tResult GetActiveFilterGraph(base::ant::IString&& strActiveFilterGraph) const = 0;
160
171 virtual tResult SetActiveStreamingGraph(const char* strActiveStreamingGraph) = 0;
172
180 virtual tResult GetActiveStreamingGraph(base::ant::IString&& strActiveStreamingGraph) const = 0;
181};
182
196{
197protected:
199 ~ISessionManager() = default;
200public:
202 ADTF_IID(ISessionManager, "sessionmanager.ant.services.adtf.iid");
203
204public:
212 virtual tResult CreateSession() = 0;
213
220 virtual tResult CreateSession(const char* strSessionFileName) = 0;
221
226 virtual tResult ReleaseSession() = 0;
227
236 virtual tResult GetSessionFile(base::ant::IString&& strSessionFilePath) const = 0;
237
247};
248
259
271
283
291}
292
293namespace joker
294{
295
297{
298protected:
300 ~ISessionManager() = default;
301public:
303 ADTF_IID(ISessionManager, "session_manager.joker.services.adtf.iid");
304
305 virtual tResult SetEnvironmentFile(const char* strEnvironmentFile) = 0;
306};
307
308}
309
311
313using ant::ISession;
314
315using ant::get_session;
319
320}
321}
Copyright © Audi Electronics Venture GmbH.
A_UTILS_NS::cResult tResult
For backwards compatibility and to bring latest version into scope.
The IString interface provides methods for getting and setting strings through abstract interfaces.
Definition string_intf.h:28
Main interface for a Session.
virtual tResult GetCurrentFilterGraph(ucom::ant::iobject_ptr< streaming::ant::IFilterGraph > &pGraph) const =0
Returns a reference to the current instantiated FilterGraph.
virtual tResult SetSystemFile(const char *strSystemFileName, const char *strSystemPropertiesFileName)=0
Sets and loads a system file.
virtual tResult SetActiveStreamingGraph(const char *strActiveStreamingGraph)=0
Sets the active streaming graph name.
virtual tResult SetActiveFilterGraph(const char *strActiveFilterGraph)=0
Sets the active filter graph name.
virtual tResult GetSystemPropertiesFile(base::ant::IString &&strProperties) const =0
Retrieves the filepath of the set ADTF System File Properties.
virtual tResult SetGraphFile(const char *strGraphFileName, const char *strPropertiesFileName)=0
Sets and loads the current adtfgraph file.
virtual tResult GetSessionName(base::ant::IString &&strSessionName)=0
Retrieves the session name.
virtual tResult GetActiveStreamingGraph(base::ant::IString &&strActiveStreamingGraph) const =0
Returns the name of current active streaming graph set.
virtual tResult GetCurrentStreamingGraph(ucom::ant::iobject_ptr< streaming::ant::IStreamingGraph > &pStreamingGraph) const =0
Returns a reference to the current instantiated FilterGraph.
virtual tResult GetSystemFile(base::ant::IString &&strSystemFile) const =0
Retrieves the filepath of the set ADTF System File.
virtual tResult SetSessionName(const char *strSessionFileName)=0
Sets the session name.
~ISession()=default
not destructable
virtual tResult GetGraphFile(base::ant::IString &&strGraph) const =0
Retrieves the filepath of the set ADTF Graph File.
virtual tResult GetActiveFilterGraph(base::ant::IString &&strActiveFilterGraph) const =0
Returns the name of current active filter graph set.
ADTF_IID(ISession, "session.ant.services.adtf.iid")
definition of interface id
virtual tResult GetGraphPropertiesFile(base::ant::IString &&strProperties) const =0
Retrieves the filepath of the set ADTF Graph File Properties.
Session Manager interface defines a System Core Object.
~ISessionManager()=default
not destructable
ADTF_IID(ISessionManager, "sessionmanager.ant.services.adtf.iid")
definition of interface id
virtual tResult CreateSession(const char *strSessionFileName)=0
Create a section_session within the Sessionmanager and will load the given strSessionFileName.
virtual tResult ReleaseSession()=0
Release a Session.
virtual tResult GetSessionFile(base::ant::IString &&strSessionFilePath) const =0
Returns the current session file if set.
virtual tResult GetCurrentSession(ucom::ant::iobject_ptr< ant::ISession > &pCurrentSession) const =0
Gets the current session if created.
virtual tResult CreateSession()=0
Create a section_session within the Sessionmanager.
~ISessionManager()=default
not destructable
ADTF_IID(ISessionManager, "session_manager.joker.services.adtf.iid")
definition of interface id
Base class for every interface type within the uCOM.
Definition object_intf.h:33
Base object pointer to realize binary compatible reference counting in interface methods.
Copyright © Audi Electronics Venture GmbH.
tResult get_session_filter_graph(ucom::ant::iobject_ptr< adtf::streaming::IFilterGraph > &pCurrentFilterGraph)
Retrieves the current IFilterGraph from ISessionManager.
tResult get_session(ucom::ant::iobject_ptr< ISession > &pCurrentSession)
Retrieves the current ISession from ISessionManager.
tResult create_empty_session()
Creates an empty session.
tResult get_session_streaming_graph(ucom::ant::iobject_ptr< adtf::streaming::IStreamingGraph > &pCurrentStreamingGraph)
Retrieves the current IStreamingGraph from ISessionManager.
Namespace for all service interfaces provided since v3.9.
ant::IObject IObject
Alias always bringing the latest version of ant::IObject into scope.
Namespace for entire ADTF SDK.
Copyright © Audi Electronics Venture GmbH.
Copyright © Audi Electronics Venture GmbH.