Snap Live SDK  8.1
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Groups
Public Member Functions | List of all members
KantarMedia::IOnlineEmbedder Class Referenceabstract

Base interface for Online embedders. More...

#include <OnlineCommonEmbedder.h>

Public Member Functions

virtual AUDIOSDK_Error GetLicenses (char **&licenseNameList, long long *&licenseIdList, size_t &nbLicense)=0
 This method gets all the licenses available. More...
 
virtual AUDIOSDK_Error SelectLicense (long long licenseId)=0
 This method select the license to use with the SDK. More...
 
virtual AUDIOSDK_Error SendReport (const char *jsonReport)=0
 This method allow to send job report in case of failure on Finalize method (connection failed). More...
 

Detailed Description

Base interface for Online embedders.

Regroup common methods that shall be used by all Online embedders

Member Function Documentation

virtual AUDIOSDK_Error KantarMedia::IOnlineEmbedder::GetLicenses ( char **&  licenseNameList,
long long *&  licenseIdList,
size_t &  nbLicense 
)
pure virtual

This method gets all the licenses available.

Parameters
[out]licenseNameList: List of available license name
[out]licenseIdList: List of corresponding license id
[out]nbLicense: Number of license for previous list
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_Error code if an error occurs
virtual AUDIOSDK_Error KantarMedia::IOnlineEmbedder::SelectLicense ( long long  licenseId)
pure virtual

This method select the license to use with the SDK.

Parameters
[in]licenseId: The license id find with GetLicenses method
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_Error code if an error occurs
virtual AUDIOSDK_Error KantarMedia::IOnlineEmbedder::SendReport ( const char *  jsonReport)
pure virtual

This method allow to send job report in case of failure on Finalize method (connection failed).

Parameters
[in]jsonReport: The json report to send
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_Error code if an error occurs

The documentation for this class was generated from the following file: