IProgress.hpp

Go to the documentation of this file.

#ifndef _AV_TRANSCODER_IPROGRESS_LISTENER_HPP_
#define _AV_TRANSCODER_IPROGRESS_LISTENER_HPP_

#include <AvTranscoder/common.hpp>

namespace avtranscoder
{

/**
 * @brief Indicate the state of a process.
 */
enum EJobStatus
{
    eJobStatusContinue = 0,
    eJobStatusCancel
};

/**
 * @brief Base class of Progress.
 * Inherit this class to have your own way to manage a progress bar.
 * You can inherit this class in C++, but also in python / Java binding.
 */
class AvExport IProgress
{
public:
    virtual ~IProgress(){};

    /**
     * @brief Manage the progress.
     * @param processedDuration: what is processed
     * @param programDuration: what you need to process (the totality)
     * @return return EJobStatus to manage the process (continuing, stopping, paused, etc)
     */
    virtual EJobStatus progress(const double processedDuration, const double programDuration) = 0;
};
}

#endif