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

Base interface for Snap embedders. More...

#include <SnapCommonEmbedder.h>

Inheritance diagram for KantarMedia::ISnapEmbedder:
KantarMedia::ISnapLiveAudioEmbedder

Public Member Functions

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...
 

Detailed Description

Base interface for Snap embedders.

Regroup common methods that shall be used by all SNAP embedders

Member Function Documentation

virtual AUDIOSDK_Error KantarMedia::ISnapEmbedder::GetChannelNameIDList ( char **&  nameList,
long long *&  idList,
size_t &  nb_elements 
)
pure virtual

This method gets all the channel names and IDs listed in the audience measurement license.

Parameters
[out]nameList: List of all available channel name values available in the audience license file
[out]idList: List of all available channel id values available in the audience license file
[out]nb_elements: Number of channel name available in list
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_Error code if an error occurs
virtual AUDIOSDK_Error KantarMedia::ISnapEmbedder::GetChannelNameList ( char **&  list,
size_t &  nb_elements 
)
pure virtual

This method gets all the channel names listed in the audience measurement license.

Parameters
[out]list: List of all available channel name values available in the audience license file
[out]nb_elements: Number of channel name available in list
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_Error code if an error occurs
virtual AUDIOSDK_Error KantarMedia::ISnapEmbedder::SetChannelName ( const char *  channel_name)
pure virtual

This method sets the channel name to be used for the embedding process.

This will select the associated watermark value from the audience measurement license.

Parameters
[in]channel_name: Channel name to be used. This will select the corresponding payload value in the audience license file.
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_Error code if an error occurs

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