audiobox-doc  2.4.3.28
 All Classes Files Functions Variables
Public Member Functions | Public Attributes | List of all members
AL::Recorder Class Reference

#include <recorder.hpp>

Public Member Functions

void record ()
 
void pause ()
 
void stop ()
 
void abort ()
 
void setFileName (const std::string &filename)
 
std::string getFileName () const
 

Public Attributes

qi::Signal
< qi::SteadyClock::time_point > 
signalPosition
 

Detailed Description

Simple File recorder.

Member Function Documentation

void AL::Recorder::abort ( )

Stop the stream with clipping the end of the output buffer. (faster as possible, but can have some audio artefact)

Note
do nothing if the recording is not active.
std::string AL::Recorder::getFileName ( ) const

Get the current file name that might be read.

Returns
Current set filename
void AL::Recorder::pause ( )

Suspend the recording playing.

Note
do nothing if the recording is not active.
void AL::Recorder::record ( )

Start recording the input.

Note
do nothing if the recording is already active.
void AL::Recorder::setFileName ( const std::string &  filename)

Set the current file name to read.

Parameters
[in]filenameFile name to read
Exceptions
std::runtime_errorif file name error
Note
if the recording is active, the recording file does not change. It just set the next filename.
void AL::Recorder::stop ( )

Stop the current recording with draining the current sample in the output.

Note
do nothing if the recording is not active.

Member Data Documentation

qi::Signal<qi::SteadyClock::time_point> AL::Recorder::signalPosition

Generate the current playing time in second, emited every 0.1s.

Returns
[0..inf]

The documentation for this class was generated from the following file: