diff --git a/mixer/src/include/Mixer.h b/mixer/src/include/Mixer.h index 73e0c02..a14be78 100644 --- a/mixer/src/include/Mixer.h +++ b/mixer/src/include/Mixer.h @@ -1,8 +1,8 @@ -/* - * File: Mixer.h - * Author: eduardo +/** + * \file Mixer.h * - * Created on 17 de Janeiro de 2012, 15:28 + * \author Eduardo + * \date 17/01/2012 */ #ifndef MIXER_H @@ -37,30 +37,88 @@ using namespace std; using namespace util; +/** \brief Classe que implementa o mixer de vídeo. + * + * \headerfile mixer/src/include/Mixer.h + */ class Mixer { public: + /** Construtor. + * + * \param mainVideo O vídeo principal. + * \param secondaryVideo O vídeo secundário. + */ Mixer(string,string); + + /** Construtor */ Mixer(); + + /** Destrutor */ virtual ~Mixer(); + /** Ajusta o FPS do vídeo principal para 45 se preciso. */ void adjustVideosFps(); + /** Realiza a Mixagem do vídeo original com o vídeo de LIBRAS. */ void mixVideos(); + + /** Seta o tamanho do vídeo de LIBRAS. */ void setSize(int); - /* Setters e getters...*/ + /** Seta o path do vídeo principal. */ void setMainVideo(string); + + /** Retorna o path do vídeo principal. + * + * \return Path do vídeo principal. + */ string getMainVideo(); + + /** Seta o path do vídeo secundario. */ void setSecondaryVideo(string); + + /** Retorna o path do vídeo secundário. + * + * \return Path do vídeo secundário. + */ string getSecondaryVideo(); + + /** Seta a posição do vídeo secundário em relação ao vídeo principal. */ void setPositionSecondaryVideo(int); + + /** Retorna a posição do vídeo secundário em relação ao vídeo principal. + * + * \return A posição do vídeo. + */ int getPositionSecondaryVideo(); + + /** Seta a transparência do vídeo secundário. */ void setTransparency(int); + + /** Retorna a Transparência do vídeo secundário. + * + * \return A transparência do vídeo. + */ int getTransparency(); + + /** seta o número de threads utilizadas na mixagem. */ void setNumThreads(string); + + /** Retorna o número de threads utilizadas na mixagem. + * + * \return O número de threads. + */ string getNumThreads(); + + /** Inicializa o processo de mixagem. + * + * \param mainVideo O vídeo princial. + * \param slVideo O vídeo secundário. + */ void initialize(string mainVideo, string slVideo, int, int, int, char*, char*, char*); + + /** Seta o path do vídeo mixado */ void setPathFinal(); private: -- libgit2 0.21.2