Download as
Browse Code »

Commit c7cb6b74f2f92a802ded836a8793f738354f7a24

Authored by Wesnydy Ribeiro
1 parent bb4f663f
Exists in master and in 1 other branch devel

Documentação do componente mixer

Showing 1 changed file with 63 additions and 5 deletions   Show diff stats
mixer/src/include/Mixer.h
  Diff comments   View file @c7cb6b7
1 -/*  
2 - * File: Mixer.h  
3 - * Author: eduardo 1 +/**
  2 + * \file Mixer.h
4 * 3 *
5 - * Created on 17 de Janeiro de 2012, 15:28 4 + * \author Eduardo
  5 + * \date 17/01/2012
6 */ 6 */
7 7
8 #ifndef MIXER_H 8 #ifndef MIXER_H
@@ -37,30 +37,88 @@ @@ -37,30 +37,88 @@
37 using namespace std; 37 using namespace std;
38 using namespace util; 38 using namespace util;
39 39
  40 +/** \brief Classe que implementa o mixer de vídeo.
  41 + *
  42 + * \headerfile mixer/src/include/Mixer.h
  43 + */
40 class Mixer { 44 class Mixer {
41 public: 45 public:
42 46
  47 + /** Construtor.
  48 + *
  49 + * \param mainVideo O vídeo principal.
  50 + * \param secondaryVideo O vídeo secundário.
  51 + */
43 Mixer(string,string); 52 Mixer(string,string);
  53 +
  54 + /** Construtor */
44 Mixer(); 55 Mixer();
  56 +
  57 + /** Destrutor */
45 virtual ~Mixer(); 58 virtual ~Mixer();
46 59
  60 + /** Ajusta o FPS do vídeo principal para 45 se preciso. */
47 void adjustVideosFps(); 61 void adjustVideosFps();
48 62
  63 + /** Realiza a Mixagem do vídeo original com o vídeo de LIBRAS. */
49 void mixVideos(); 64 void mixVideos();
  65 +
  66 + /** Seta o tamanho do vídeo de LIBRAS. */
50 void setSize(int); 67 void setSize(int);
51 68
52 - /* Setters e getters...*/ 69 + /** Seta o path do vídeo principal. */
53 void setMainVideo(string); 70 void setMainVideo(string);
  71 +
  72 + /** Retorna o path do vídeo principal.
  73 + *
  74 + * \return Path do vídeo principal.
  75 + */
54 string getMainVideo(); 76 string getMainVideo();
  77 +
  78 + /** Seta o path do vídeo secundario. */
55 void setSecondaryVideo(string); 79 void setSecondaryVideo(string);
  80 +
  81 + /** Retorna o path do vídeo secundário.
  82 + *
  83 + * \return Path do vídeo secundário.
  84 + */
56 string getSecondaryVideo(); 85 string getSecondaryVideo();
  86 +
  87 + /** Seta a posição do vídeo secundário em relação ao vídeo principal. */
57 void setPositionSecondaryVideo(int); 88 void setPositionSecondaryVideo(int);
  89 +
  90 + /** Retorna a posição do vídeo secundário em relação ao vídeo principal.
  91 + *
  92 + * \return A posição do vídeo.
  93 + */
58 int getPositionSecondaryVideo(); 94 int getPositionSecondaryVideo();
  95 +
  96 + /** Seta a transparência do vídeo secundário. */
59 void setTransparency(int); 97 void setTransparency(int);
  98 +
  99 + /** Retorna a Transparência do vídeo secundário.
  100 + *
  101 + * \return A transparência do vídeo.
  102 + */
60 int getTransparency(); 103 int getTransparency();
  104 +
  105 + /** seta o número de threads utilizadas na mixagem. */
61 void setNumThreads(string); 106 void setNumThreads(string);
  107 +
  108 + /** Retorna o número de threads utilizadas na mixagem.
  109 + *
  110 + * \return O número de threads.
  111 + */
62 string getNumThreads(); 112 string getNumThreads();
  113 +
  114 + /** Inicializa o processo de mixagem.
  115 + *
  116 + * \param mainVideo O vídeo princial.
  117 + * \param slVideo O vídeo secundário.
  118 + */
63 void initialize(string mainVideo, string slVideo, int, int, int, char*, char*, char*); 119 void initialize(string mainVideo, string slVideo, int, int, int, char*, char*, char*);
  120 +
  121 + /** Seta o path do vídeo mixado */
64 void setPathFinal(); 122 void setPathFinal();
65 123
66 private: 124 private: