Snap Live SDK  8.2.1
Classes | Enumerations | Functions

Classes

class  KantarMedia::IACRProcessor
 Base interface for ACR processors. More...
 
class  KantarMedia::IACRLiveProcessor
 ACR Live Processor interface declaration. More...
 
class  KantarMedia::IAudioEmbedder
 Base interface for embedders. More...
 
class  KantarMedia::IEmbedderListener
 Class used to catch different types of events (info and data) raised by the embedder library. More...
 
class  KantarMedia::IFileEmbedder
 Base interface for File embedders. More...
 
class  KantarMedia::ILiveEmbedder
 Base interface for Live embedders. More...
 
class  KantarMedia::IOnlineEmbedder
 Base interface for Online embedders. More...
 
class  KantarMedia::IProductLicense
 Base interface for product licenses. More...
 
class  KantarMedia::ISnapEmbedder
 Base interface for Snap embedders. More...
 
class  KantarMedia::ISnapLiveAudioEmbedder
 Snap Live Embedder interface declaration. More...
 
class  KantarMedia::IThreadManager
 Base interface for thread priority/affinity management. More...
 

Enumerations

enum  KantarMedia::AUDIOSDK_Error {
  KantarMedia::AUDIOSDK_SUCCESS = 0, KantarMedia::AUDIOSDK_GENERAL_FAILURE, KantarMedia::AUDIOSDK_NULL_POINTER, KantarMedia::AUDIOSDK_EMPTY_PARAMETER,
  KantarMedia::AUDIOSDK_INVALID_OBJECT, KantarMedia::AUDIOSDK_BAD_ALLOCATION, KantarMedia::AUDIOSDK_INTERNAL_ERROR, KantarMedia::AUDIOSDK_INVALID_POLICY,
  KantarMedia::AUDIOSDK_INVALID_PRIORITY, KantarMedia::AUDIOSDK_ACCESS_DENIED, KantarMedia::AUDIOSDK_FORBIDEN_METHOD, KantarMedia::AUDIOSDK_CREATE_EMBEDDER_FAILED,
  KantarMedia::AUDIOSDK_SELECT_LICENSE_FAILED, KantarMedia::AUDIOSDK_ONLINE_NOT_SUPPORTED, KantarMedia::AUDIOSDK_ONLINE_SETPARAMETER, KantarMedia::AUDIOSDK_LISTENER_NOTSET = 20,
  KantarMedia::AUDIOSDK_NOT_INITIALIZED, KantarMedia::AUDIOSDK_INIT_FAILLED, KantarMedia::AUDIOSDK_ALREADY_INITIALIZED, KantarMedia::AUDIOSDK_PARAMETERS_NOTINITIALIZED,
  KantarMedia::AUDIOSDK_INVALID_BITSPERSAMPLE, KantarMedia::AUDIOSDK_INVALID_NUMCHANNELS, KantarMedia::AUDIOSDK_INVALID_BUFFER_SIZE, KantarMedia::AUDIOSDK_EMBEDDER_SETTINGS_MISSING,
  KantarMedia::AUDIOSDK_INVALID_TECHNO, KantarMedia::AUDIOSDK_INVALID_FILE_DURATION, KantarMedia::AUDIOSDK_INVALID_STRING_ENCODING, KantarMedia::AUDIOSDK_LICENSE_INVALID = 40,
  KantarMedia::AUDIOSDK_AUDIO_LICENSE_INVALID, KantarMedia::AUDIOSDK_ONLINE_INVALID_PARAMETER, KantarMedia::AUDIOSDK_ONLINE_INVALID_LOGIN, KantarMedia::AUDIOSDK_ONLINE_LICENSE_NOT_FOUND,
  KantarMedia::AUDIOSDK_ONLINE_LICENSE_INVALID_ID, KantarMedia::AUDIOSDK_ONLINE_AUDIENCE_FAILED, KantarMedia::AUDIOSDK_ONLINE_CONNECTION_FAILED, KantarMedia::AUDIOSDK_ONLINE_SERVER_ERROR,
  KantarMedia::AUDIOSDK_ONLINE_FINISH_JOB_FAILED, KantarMedia::AUDIOSDK_ONLINE_REPORT_MISSING, KantarMedia::AUDIOSDK_ONLINE_REPORT_JSON_PARSE, KantarMedia::AUDIOSDK_INVALID_PAYLOADSIZE = 60,
  KantarMedia::AUDIOSDK_INVALID_ID, KantarMedia::AUDIOSDK_INVALID_TIMECODE, KantarMedia::AUDIOSDK_WMK_DURATION_INVALID, KantarMedia::AUDIOSDK_TC_LOOP,
  KantarMedia::AUDIOSDK_INVALID_CHANNELNAME = 80, KantarMedia::AUDIOSDK_RESYNC_NOTALLOWED, KantarMedia::AUDIOSDK_NO_ID_AVAILABLE, KantarMedia::AUDIOSDK_RECORD_IO_ERROR = 100,
  KantarMedia::AUDIOSDK_INVALID_METADATA_OP = 110, KantarMedia::AUDIOSDK_INVALID_METADATA_BBIS, KantarMedia::AUDIOSDK_INVALID_OFFSET_DURATION, KantarMedia::AUDIOSDK_INVALID_WMK_DURATION,
  KantarMedia::AUDIOSDK_BAD_METADATA_FILE, KantarMedia::AUDIOSDK_ADD_METADATA_FULL, KantarMedia::AUDIOSDK_ONLINE_METADATA_MISSING, KantarMedia::AUDIOSDK_ONLINE_METADATA_JSON_PARSE,
  KantarMedia::AUDIOSDK_LOG_ERROR = 120
}
 Error codes definition. More...
 

Functions

AUDIOSDK_API AUDIOSDK_Error KantarMedia::CreateACRLiveProcessor (const char *kantarMedia_license_path, IEmbedderListener *listener, IACRLiveProcessor **embedder, const char *kantarMedia_license_password=NULL)
 This function creates an instance of an IACRLiveProcessor object. More...
 
AUDIOSDK_API AUDIOSDK_Error KantarMedia::DestroyACRLiveProcessor (IACRLiveProcessor *&embedder)
 This function destroys an IACRLiveProcessor object. More...
 
AUDIOSDK_API char const * KantarMedia::GetVersion ()
 This function returns the library version. More...
 
AUDIOSDK_API AUDIOSDK_Error KantarMedia::CreateSnapLiveAudioEmbedder (const char *kantarMedia_license_path, const char *audience_license_path, IEmbedderListener *listener, ISnapLiveAudioEmbedder **embedder, const char *kantarMedia_license_password=NULL)
 This function creates an instance of an ISnapLiveAudioEmbedder object. More...
 
AUDIOSDK_API AUDIOSDK_Error KantarMedia::CreateOnlineSnapLiveAudioEmbedder (IEmbedderListener *listener, ISnapLiveAudioEmbedder **embedder, const char *login, const char *password, int port=443, const char *server="license.kantarmedia.com")
 
AUDIOSDK_API AUDIOSDK_Error KantarMedia::DestroySnapLiveAudioEmbedder (ISnapLiveAudioEmbedder *&embedder)
 This function destroys an ISnapLiveAudioEmbedder object. More...
 

Detailed Description

Enumeration Type Documentation

◆ AUDIOSDK_Error

Error codes definition.

Enumerator
AUDIOSDK_SUCCESS 

Success code. No error returned.

AUDIOSDK_GENERAL_FAILURE 

An undefined error occurred.

AUDIOSDK_NULL_POINTER 

A NULL pointer has been provided.

AUDIOSDK_EMPTY_PARAMETER 

An empty parameter has been provided.

AUDIOSDK_INVALID_OBJECT 

The object pointer provided is not of the correct type.

AUDIOSDK_BAD_ALLOCATION 

Memory Allocation error - System cannot allocate memory.

AUDIOSDK_INTERNAL_ERROR 

An internal error occurred.

AUDIOSDK_INVALID_POLICY 

Thread policy set is invalid.

AUDIOSDK_INVALID_PRIORITY 

Thread priority set is invalid.

AUDIOSDK_ACCESS_DENIED 

Insufficient rights to perform operation.

AUDIOSDK_FORBIDEN_METHOD 

Call to a method that is not allowed for the given product - technology - online/offline combination.

AUDIOSDK_CREATE_EMBEDDER_FAILED 

Embedder creation has failed.

AUDIOSDK_SELECT_LICENSE_FAILED 

License selection has failed.

AUDIOSDK_ONLINE_NOT_SUPPORTED 

online embedding is not available for this platform, use CreateACRFileProcessor function instead

AUDIOSDK_ONLINE_SETPARAMETER 

Call to set embedder parameter that is not supported for online implementation.

AUDIOSDK_LISTENER_NOTSET 

Listener provided is a NULL pointer.

AUDIOSDK_NOT_INITIALIZED 

Embedder has not already been initialized.

AUDIOSDK_INIT_FAILLED 

Embedder initialization has failled.

AUDIOSDK_ALREADY_INITIALIZED 

Embedder has already been initialized.

AUDIOSDK_PARAMETERS_NOTINITIALIZED 

Embedder parameters have not been initialized.

AUDIOSDK_INVALID_BITSPERSAMPLE 

Bits per sample value provided is invalid - bits per sample value shall be either 16, 24 or 32.

AUDIOSDK_INVALID_NUMCHANNELS 

Number of audio channels provided is invalid - This shall be greater than 0.

AUDIOSDK_INVALID_BUFFER_SIZE 

A buffer whose size is not a factor of sample size has been provided.

AUDIOSDK_EMBEDDER_SETTINGS_MISSING 

Some settings are not provided for embedder initialization.

AUDIOSDK_INVALID_TECHNO 

Watermarking technology is invalid.

AUDIOSDK_INVALID_FILE_DURATION 

File duration is invalid.

AUDIOSDK_INVALID_STRING_ENCODING 

Invalid string encoding. UTF8 required.

AUDIOSDK_LICENSE_INVALID 

KantarMedia License is invalid.

AUDIOSDK_AUDIO_LICENSE_INVALID 

Audio license (when needed) is invalid.

AUDIOSDK_ONLINE_INVALID_PARAMETER 

Invalid parameter for connection to olg (address, port, login, password)

AUDIOSDK_ONLINE_INVALID_LOGIN 

Invalid login or password.

AUDIOSDK_ONLINE_LICENSE_NOT_FOUND 

Unable to get online license.

AUDIOSDK_ONLINE_LICENSE_INVALID_ID 

Invalid licenseId to select online license.

AUDIOSDK_ONLINE_AUDIENCE_FAILED 

Unable to retrieve audience license.

AUDIOSDK_ONLINE_CONNECTION_FAILED 

Error connection to server.

AUDIOSDK_ONLINE_SERVER_ERROR 

Online license server returned an error.

AUDIOSDK_ONLINE_FINISH_JOB_FAILED 

Unable to finish online job.

AUDIOSDK_ONLINE_REPORT_MISSING 

Missing report in json is mandatory for send report to job.

AUDIOSDK_ONLINE_REPORT_JSON_PARSE 

Report json have a problem parsing to json.

AUDIOSDK_INVALID_PAYLOADSIZE 

Payload configuration is invalid.

AUDIOSDK_INVALID_ID 

The payload ID value provided is invalid.

AUDIOSDK_INVALID_TIMECODE 

The payload Timecode value provided is invalid.

AUDIOSDK_WMK_DURATION_INVALID 

Watermark duration is lower than payload duration.

AUDIOSDK_TC_LOOP 

Timecode looped while embedding.

AUDIOSDK_INVALID_CHANNELNAME 

Invalid channel name set - Channel name not present in audio license.

AUDIOSDK_RESYNC_NOTALLOWED 

The time resynchronization feature is not allowed.

AUDIOSDK_NO_ID_AVAILABLE 

All Ids for this channel name are already locked.

AUDIOSDK_RECORD_IO_ERROR 

Input/Output error for recording option. Check if directory exists, or if rights are granted.

AUDIOSDK_INVALID_METADATA_OP 

Do not use SetMetadataFilePath along with SetUniqueContentId, SetChannelName or SetMetadataList.

AUDIOSDK_INVALID_METADATA_BBIS 

Error with Metadata 3 Broadcast Bis not recognized as well formed date or anterior to 2006-01-01 00:00:00.

AUDIOSDK_INVALID_OFFSET_DURATION 

File offset duration is invalid.

AUDIOSDK_INVALID_WMK_DURATION 

Watermarking duration is invalid.

AUDIOSDK_BAD_METADATA_FILE 

Error on metadata file.

AUDIOSDK_ADD_METADATA_FULL 

Maximum 7 metadata can be added.

AUDIOSDK_ONLINE_METADATA_MISSING 

Metadata (json) string is mandatory for online SDK.

AUDIOSDK_ONLINE_METADATA_JSON_PARSE 

Metadata (json) string parsing error.

AUDIOSDK_LOG_ERROR 

Log manager error.

Function Documentation

◆ CreateACRLiveProcessor()

AUDIOSDK_API AUDIOSDK_Error KantarMedia::CreateACRLiveProcessor ( const char *  kantarMedia_license_path,
IEmbedderListener listener,
IACRLiveProcessor **  embedder,
const char *  kantarMedia_license_password = NULL 
)

This function creates an instance of an IACRLiveProcessor object.

This function shall be used to create an instance of an IACRLiveProcessor object. The object created can then be used to perform watermarking operation using the IACRLiveProcessor interface. The IACRLiveProcessor object created shall be freed using the DestroyACRLiveProcessor function.

See also
IACRLiveProcessor
DestroyACRLiveProcessor()
Parameters
[in]kantarMedia_license_path: Path to the KantarMedia license file
[in]audience_license_path: Path to the Audience license file
[in]listener: Listener object to be used for notifying event
[in]kantarMedia_license_passwordFor specific KantarMedia license file a password is mandatory
[out]embedder: Pointer to the created IACRLiveProcessor object
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_LISTENER_NOTSET if listener pointer is NULL
AUDIOSDK_LICENSE_INVALID if KantarMedia license provided is invalid
AUDIOSDK_AUDIO_LICENSE_INVALID if audience license provided is invalid

◆ CreateSnapLiveAudioEmbedder()

AUDIOSDK_API AUDIOSDK_Error KantarMedia::CreateSnapLiveAudioEmbedder ( const char *  kantarMedia_license_path,
const char *  audience_license_path,
IEmbedderListener listener,
ISnapLiveAudioEmbedder **  embedder,
const char *  kantarMedia_license_password = NULL 
)

This function creates an instance of an ISnapLiveAudioEmbedder object.

This function shall be used to create an instance of an ISnapLiveAudioEmbedder object. The object created can then be used to perform watermarking operation using the ISnapLiveAudioEmbedder interface. The ISnapLiveAudioEmbedder object created shall be freed using the DestroySnapLiveAudioEmbedder function.

See also
ISnapLiveAudioEmbedder
DestroySnapLiveAudioEmbedder()
Parameters
[in]kantarMedia_license_path: Path to the KantarMedia license file
[in]audience_license_path: Path to the Audience license file
[in]listener: Listener object to be used for notifying event
[in]kantarMedia_license_passwordFor specific KantarMedia license file a password is mandatory
[out]embedder: Pointer to the created ISnapLiveAudioEmbedder object
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_LISTENER_NOTSET if listener pointer is NULL
AUDIOSDK_LICENSE_INVALID if KantarMedia license provided is invalid
AUDIOSDK_AUDIO_LICENSE_INVALID if audience license provided is invalid

◆ DestroyACRLiveProcessor()

AUDIOSDK_API AUDIOSDK_Error KantarMedia::DestroyACRLiveProcessor ( IACRLiveProcessor *&  embedder)

This function destroys an IACRLiveProcessor object.

This function shall be used to destroy a previously allocated IACRLiveProcessor object using the CreateACRLiveProcessor function.

See also
IACRLiveProcessor
CreateACRLiveProcessor()
Parameters
[in]embedder: Pointer to an IACRLiveProcessor object to be destroyed
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_INVALID_OBJECT if pointer provided as parameter is not an IACRLiveProcessor object pointer

◆ DestroySnapLiveAudioEmbedder()

AUDIOSDK_API AUDIOSDK_Error KantarMedia::DestroySnapLiveAudioEmbedder ( ISnapLiveAudioEmbedder *&  embedder)

This function destroys an ISnapLiveAudioEmbedder object.

This function shall be used to destroy a previously allocated ISnapLiveAudioEmbedder object using the CreateSnapLiveAudioEmbedder function.

See also
ISnapLiveAudioEmbedder
CreateSnapLiveAudioEmbedder()
Parameters
[in]embedder: Pointer to an ISnapLiveAudioEmbedder object to be destroyed
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_INVALID_OBJECT if pointer provided as parameter is not an ISnapLiveAudioEmbedder object pointer

◆ GetVersion()

AUDIOSDK_API char const* KantarMedia::GetVersion ( )

This function returns the library version.

Returns
This function returns the library version formatted as a C string