Weberni69795
/
BCIgui
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
7 Commits
3 Branches
Branch: dev
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'dev'
${ noResults }
BCIgui/Masterarbeit/openvibe/sdk-master/plugins/processing/file-io/doc/Doc_BoxAlgorithm_GenericStr...

Doc_BoxAlgorithm_GenericStreamWriter.dox-part 2.7KB
Raw Permalink Blame History

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960 
  1. /**

  2.  * \page BoxAlgorithm_GenericStreamWriter Generic stream writer

  3. __________________________________________________________________

  4. 

  5. Detailed description

  6. __________________________________________________________________

  7. 

  8.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamWriter_Description|

  9. This box is able to dump any OpenViBE stream into a binary file. In the cacse where this box

  10. would have multiple inputs, the streams would be multiplexed in the file. Such file can

  11. be read back with the \ref Doc_BoxAlgorithm_GenericStreamReader

  12.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamWriter_Description|

  13. __________________________________________________________________

  14. 

  15. Inputs description

  16. __________________________________________________________________

  17. 

  18.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamWriter_Inputs|

  19. You can add any input you want to this box depending on the number of streams you want to dump.

  20. In the cacse where this box would have multiple inputs, the streams would be multiplexed in the file.

  21.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamWriter_Inputs|

  22. 

  23.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamWriter_Input1|

  24. The default input.

  25. 

  26. <b>Note: it important to correctly configure the type of the inputs</b>. That information will be

  27. used by the \ref Doc_BoxAlgorithm_GenericStreamReader to map the contained streams to its outputs.

  28.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamWriter_Input1|

  29. __________________________________________________________________

  30. 

  31. Settings description

  32. __________________________________________________________________

  33. 

  34.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamWriter_Settings|

  35.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamWriter_Settings|

  36. 

  37.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamWriter_Setting1|

  38. This setting points to the file to write the streams to.

  39.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamWriter_Setting1|

  40. 

  41.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamWriter_Setting2|

  42. Thanks to this setting, you can use compression on each input stream. This means that the basic

  43. structure of the file remains uncompressed but that each stream inside this structure is compressed.

  44. <b>Note: this is not implemented at the moment</b>.

  45.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamWriter_Setting2|

  46. __________________________________________________________________

  47. 

  48. Examples description

  49. __________________________________________________________________

  50. 

  51.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamWriter_Examples|

  52.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamWriter_Examples|

  53. __________________________________________________________________

  54. 

  55. Miscellaneous description

  56. __________________________________________________________________

  57. 

  58.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamWriter_Miscellaneous|

  59.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamWriter_Miscellaneous|

  60.  */