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

Snap Live Embedder interface declaration. More...

#include <SnapLiveAudioEmbedder.h>

Inheritance diagram for KantarMedia::ISnapLiveAudioEmbedder:
KantarMedia::IAudioEmbedder KantarMedia::ISnapEmbedder KantarMedia::ILiveEmbedder KantarMedia::IThreadManager KantarMedia::IProductLicense

Classes

class  IEmbedderParameters
 Parameters for SNAP live embedding. More...
 

Public Member Functions

virtual AUDIOSDK_Error GetEmbedderParameters (ISnapLiveAudioEmbedder::IEmbedderParameters *&param)=0
 This method gets the embedder parameters with default values. More...
 
virtual AUDIOSDK_Error AddMetadata (const char *metadata)=0
 This method adds optional metadata in embedding report. More...
 
- Public Member Functions inherited from KantarMedia::IAudioEmbedder
virtual AUDIOSDK_Error Initialize ()=0
 This method initializes the embedder object with all parameters set before. More...
 
virtual AUDIOSDK_Error Finalize ()=0
 This method stops the embedding process and frees all resources allocated at initialization. More...
 
virtual AUDIOSDK_Error Finalize (const char **jsonReport)=0
 This method stops the embedding process and frees all resources allocated at initialization. More...
 
virtual AUDIOSDK_Error AddAudioBuffer (char const *const data, size_t const size, void const *const custom_data)=0
 This method provides a buffer to be watermarked by the embedder library. More...
 
virtual AUDIOSDK_Error EnableRecord (const char *record_path)=0
 This method enables the recording of incoming samples to the SDK and the recording of watermarked outgoing samples from the SDK. More...
 
- Public Member Functions inherited from KantarMedia::ISnapEmbedder
virtual AUDIOSDK_Error GetChannelNameList (char **&list, size_t &nb_elements)=0
 This method gets all the channel names listed in the audience measurement license. More...
 
virtual AUDIOSDK_Error GetChannelNameIDList (char **&nameList, long long *&idList, size_t &nb_elements)=0
 This method gets all the channel names and IDs listed in the audience measurement license. More...
 
virtual AUDIOSDK_Error SetChannelName (const char *channel_name)=0
 This method sets the channel name to be used for the embedding process. More...
 
- Public Member Functions inherited from KantarMedia::ILiveEmbedder
virtual AUDIOSDK_Error ResynchronizeTimecode ()=0
 This method resynchronizes the timecode with the system time. More...
 
- Public Member Functions inherited from KantarMedia::IThreadManager
virtual AUDIOSDK_Error SetThreadCPUAffinity (size_t affinity_mask)=0
 Set CPU affinity for all threads created by the watermarking library. More...
 
virtual AUDIOSDK_Error SetThreadPriority (eSchedulerPolicy policy, int priority)=0
 Set thread priority on all threads created by the SDK. More...
 
- Public Member Functions inherited from KantarMedia::IProductLicense
virtual AUDIOSDK_Error GetLicenseRemainingDays (int &remaingDays)=0
 This method gets the remaining days on product license. More...
 

Additional Inherited Members

- Public Types inherited from KantarMedia::IThreadManager
enum  eSchedulerPolicy { SCHED_POLICY_OTHER, SCHED_POLICY_FIFO, SCHED_POLICY_RR }
 scheduler policies available for thread priority management More...
 

Detailed Description

Snap Live Embedder interface declaration.

This class regroups all specific methods for the Snap Live Embedder object

Member Function Documentation

virtual AUDIOSDK_Error KantarMedia::ISnapLiveAudioEmbedder::AddMetadata ( const char *  metadata)
pure virtual

This method adds optional metadata in embedding report.

This method adds metadata in embedding report. Metadata are optional, they are not needed by SDK. This method can be called maximum 8 times, metadata are sorted in FIFO according to AddMetadata method call. This method has to be used in conjunction with SetUniqueContentId and SetChannelName. This method is mutually exclusive with method SetMetadataFilePath.

Parameters
[in]metadata: metadata to add in embedding report, maximum length is 256 bytes (string length depends on encoding)
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_Error code if an error occurs
virtual AUDIOSDK_Error KantarMedia::ISnapLiveAudioEmbedder::GetEmbedderParameters ( ISnapLiveAudioEmbedder::IEmbedderParameters *&  param)
pure virtual

This method gets the embedder parameters with default values.

This method is used to initialize embedder parameters with default values. This method shall be called before calling the Initialize method.

See Also
ISnapLiveAudioEmbedder::IEmbedderParameters
Parameters
[out]param: pointer to a ISnapLiveAudioEmbedder::IEmbedderParameters object
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_Error code if an error occurs

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