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

Base interface for File embedders. More...

#include <FileCommonEmbedder.h>

Classes

class  IFileEmbedderParameters
 

Public Member Functions

virtual AUDIOSDK_Error AddMetadata (const char *metadata)=0
 This method adds optional metadata in embedding report. More...
 
virtual AUDIOSDK_Error SetReportPath (const char *reportPath)=0
 This method sets the path to the report file. More...
 
virtual AUDIOSDK_Error SetInputFileName (const char *inputFileName)=0
 This method sets the input file name. More...
 
virtual AUDIOSDK_Error SetReportStatus (bool bLogStatus, bool bAutomaticStop)=0
 This method adds the log status and the stop status of application in the embedding report. More...
 

Detailed Description

Base interface for File embedders.

Regroup common methods that shall be used by all File embedders.

Member Function Documentation

virtual AUDIOSDK_Error KantarMedia::IFileEmbedder::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::IFileEmbedder::SetInputFileName ( const char *  inputFileName)
pure virtual

This method sets the input file name.

This method specifies the input filename. The input filename is written in the report file, but is not needed by the SDK.

Parameters
[in]inputFileName: the input filename
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_Error code if an error occurs
virtual AUDIOSDK_Error KantarMedia::IFileEmbedder::SetReportPath ( const char *  reportPath)
pure virtual

This method sets the path to the report file.

This method specifies the path to the report file. The report file contains information about watermarking process like the channel name, the watermark id.

Parameters
[in]reportPath: the path to the report file
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_Error code if an error occurs
virtual AUDIOSDK_Error KantarMedia::IFileEmbedder::SetReportStatus ( bool  bLogStatus,
bool  bAutomaticStop 
)
pure virtual

This method adds the log status and the stop status of application in the embedding report.

The log status can be 'OK' or 'NOK' depending of the status of the job. The stop status can be 'Automatic stop' or 'Manual stop' depending if the job has been stopped before the end of the job. Different cases: -> bLogStatus = true and bAutomaticStop = true: In this case the job finished properly. -> bLogStatus = true and bAutomaticStop = false: This case is not possible, if the job has been stopped manually the general status of the job shall be false. -> bLogStatus = false and bAutomaticStop = true: In this case the job has been stopped automatically but there is other issue(s) out of the embedding SDK which result in a failed job. -> bLogStatus = false and bAutomaticStop = false: In this case the job has been stopped manually so the general status of the job is false.

Parameters
[in]bLogStatus: Set to true when all processing is fine. Otherwise to false in case of error during processing: lost access to input file during processing,...
[in]bAutomaticStop: Set to true when the processing finished properly. Otherwise to false if the process is interrupted before the end of the job(user stop)
Returns
AUDIOSDK_SUCCESS if operation succeeds
AUDIOSDK_Error code if an error occurs

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