Base interface for embedders.
More...
#include <AudioCommonEmbedder.h>
|
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...
|
|
Base interface for embedders.
Interface for all common methods on embedder objects.
virtual AUDIOSDK_Error KantarMedia::IAudioEmbedder::AddAudioBuffer |
( |
char const *const |
data, |
|
|
size_t const |
size, |
|
|
void const *const |
custom_data |
|
) |
| |
|
pure virtual |
This method provides a buffer to be watermarked by the embedder library.
This is where the client layer passes its buffers to be watermarked. As soon as enough buffers are received, the library starts to perform calls to IEmbedderListener::OnData() to return the watermarked buffers to the client layer. From this point, one can expect a call to IEmbedderListener::OnData() for each single call to AddAudioBuffer(). Client layer is in charge of freeing memory of data parameter.
- Parameters
-
[in] | data | : Pointer to the audio buffer to be watermarked |
[in] | size | : Size of the buffer in octets |
[in] | custom_data | : Pointer to custom data |
- Returns
- AUDIOSDK_SUCCESS if operation succeeds
-
AUDIOSDK_Error code if an error occurs
virtual AUDIOSDK_Error KantarMedia::IAudioEmbedder::EnableRecord |
( |
const char * |
record_path | ) |
|
|
pure virtual |
This method enables the recording of incoming samples to the SDK and the recording of watermarked outgoing samples from the SDK.
This can be used to record all input samples and all output audio watermarked samples as WAVE files. This shall be used for integration purpose only to be sure that the samples are correctly sent to the SDK.
- Parameters
-
[in] | record_path | : Path where the WAVE files containing the recorded samples will be created |
- Returns
- AUDIOSDK_SUCCESS if operation succeeds
-
AUDIOSDK_Error code if an error occurs
This method stops the embedding process and frees all resources allocated at initialization.
This method must be called when embedding process is finished. This method is dedicated for offline embedders. For online embedders use the method which add a jsonReport reference parameter
- See Also
- Initialize
- Returns
- AUDIOSDK_SUCCESS if operation succeeds
-
AUDIOSDK_Error code if an error occurs
virtual AUDIOSDK_Error KantarMedia::IAudioEmbedder::Finalize |
( |
const char ** |
jsonReport | ) |
|
|
pure virtual |
This method stops the embedding process and frees all resources allocated at initialization.
This method must be called when embedding process is finished. This method is dedicated for online embedders. For offline embedders use the method which does not have jsonReport reference parameter If the job report can not be sent to the online server this function will fill the jsonReport reference string with the job report this job report should be resent later when the connection will be resumed with the SendReport() method
- See Also
- Initialize
- Parameters
-
[in] | jsonReport | : const char * that will point to the job report if the transmission to the license server fails. its content is valid as long as the embedder instance is not destroyed. |
- Returns
- AUDIOSDK_SUCCESS if operation succeeds
-
AUDIOSDK_Error code if an error occurs
This method initializes the embedder object with all parameters set before.
It will setup the embedder object to process the AddAudioBuffer() calls. Global configuration checks will be performed there.
- Returns
- AUDIOSDK_SUCCESS if operation succeeds
-
AUDIOSDK_Error code if an error occurs
The documentation for this class was generated from the following file: