Commit a59136fe7f18852ebad84616adbd48d11e4a3038
1 parent
f4e12619
Exists in
master
and in
1 other branch
Atualiza documentação do Mixer
Showing
1 changed file
with
56 additions
and
0 deletions
Show diff stats
mixer/src/include/mixer.h
1 | +/** | |
2 | + * \file Mixer.h | |
3 | + * | |
4 | + * \author Eduardo | |
5 | + * \date 17/01/2012 | |
6 | + */ | |
7 | + | |
8 | +/** | |
9 | +* edit: Wesnydy Ribeiro | |
10 | +* date: 16/10/2015 | |
11 | +*/ | |
12 | + | |
1 | 13 | #ifndef MIXER_H |
2 | 14 | #define MIXER_H |
3 | 15 | |
... | ... | @@ -23,13 +35,34 @@ |
23 | 35 | using namespace std; |
24 | 36 | using namespace util; |
25 | 37 | |
38 | +/** \brief Classe que implementa o mixador de vídeos. | |
39 | + * | |
40 | + * \headerfile mixer/src/include/mixer.h | |
41 | + */ | |
26 | 42 | class Mixer { |
27 | 43 | |
28 | 44 | public: |
45 | + /** Construtor. | |
46 | + * | |
47 | + * \param mVideo Path do vídeo principal. | |
48 | + * \param sVideo Path do vídeo secundário. | |
49 | + * \param ssVideo Tamanho do vídeo secundario. | |
50 | + * \param psVideo Posição do vídeo secundário em relação ao vídeo principal. | |
51 | + * \param tsVideo Transparência do vídeo sencundário. | |
52 | + * \param id Identificação do cliente na base de dados. | |
53 | + * \param pathTemp Path onde serão armazenados os arquivos temporários. | |
54 | + * \param pathContents Path onde será armazenado o vídeo mixado. | |
55 | + */ | |
29 | 56 | Mixer(string mVideo, string sVideo, int ssVideo, int psVideo, int tsVideo, |
30 | 57 | string id, string pathTemp, string pathContents); |
58 | + | |
59 | + /** Destrutor. */ | |
31 | 60 | ~Mixer(); |
32 | 61 | |
62 | + /** Inicializa o processo de mixagem. | |
63 | + * | |
64 | + * A mixagem é feita através de uma chamada do FFMPEG. | |
65 | + */ | |
33 | 66 | void initialize(); |
34 | 67 | |
35 | 68 | private: |
... | ... | @@ -53,9 +86,32 @@ private: |
53 | 86 | int sizeSVideo; |
54 | 87 | int transpSVideo; |
55 | 88 | |
89 | + /** Realiza a mixagem dos vídeos. | |
90 | + * | |
91 | + * Chama o FFMPEG passando os parâmetros necessários | |
92 | + * para a mixagem dos vídeos. | |
93 | + */ | |
56 | 94 | void mixVideos(); |
95 | + | |
96 | + /** Define o tamanho do vídeo secundário. | |
97 | + * | |
98 | + * O tamanho do vídeo secundário depende do tamanho | |
99 | + * do vídeo principal e da opção de resolução selecionada. | |
100 | + */ | |
57 | 101 | void setSVSize(); |
102 | + | |
103 | + /** Define a posição do vídeo secundário. | |
104 | + * | |
105 | + * A posição do vídeo secundário depende da posição | |
106 | + * selecionada pelo usuário. | |
107 | + */ | |
58 | 108 | void setSVPosition(); |
109 | + | |
110 | + /** Seta o path dos arquivos. | |
111 | + * | |
112 | + * O path dos arquivos temporários e do vídeo mixado | |
113 | + * são setados através desse método. | |
114 | + */ | |
59 | 115 | void setPathOfFiles(); |
60 | 116 | }; |
61 | 117 | ... | ... |