Ocean
Ocean::Media::ExplicitRecorder Class Referenceabstract

This class is the base class for all explicit media recorder. More...

Inheritance diagram for Ocean::Media::ExplicitRecorder:

Public Member Functions

virtual bool start ()=0
 Sets the recorder. More...
 
virtual bool stop ()=0
 Stops the recorder. More...
 
- Public Member Functions inherited from Ocean::Media::Recorder
virtual bool isRecording () const =0
 Returns whether this recorder is currently recording. More...
 
Type type () const
 Returns the type of this recorder. More...
 

Protected Member Functions

 ExplicitRecorder ()
 Creates a new explicit recorder. More...
 
 ~ExplicitRecorder () override
 Destructs a explicit recorder. More...
 
- Protected Member Functions inherited from Ocean::Media::Recorder
 Recorder ()
 Creates a new recorder. More...
 
virtual ~Recorder ()
 Destructs a recorder. More...
 

Additional Inherited Members

- Public Types inherited from Ocean::Media::Recorder
enum  Type {
  RECORDER = 0 , FRAME_RECORDER = 1 , SOUND_RECORDER = 2 , EXPLICIT_RECORDER = 4 ,
  IMPLICIT_RECORDER = 8 , FILE_RECORDER = 16 | EXPLICIT_RECORDER , BUFFER_RECORDER = 32 | EXPLICIT_RECORDER , STREAMING_RECORDER = 64 | IMPLICIT_RECORDER ,
  MOVIE_RECORDER = 128 | FRAME_RECORDER | FILE_RECORDER , FRAME_STREAMING_RECORDER = 256 | FRAME_RECORDER | STREAMING_RECORDER , IMAGE_RECORDER = 512 | FRAME_RECORDER | FILE_RECORDER , BUFFER_IMAGE_RECORDER = 1024 | FRAME_RECORDER | BUFFER_RECORDER ,
  IMAGE_SEQUENCE_RECORDER = 2048 | FRAME_RECORDER | FILE_RECORDER , FRAME_MEMORY_RECORDER = 4096 | FRAME_RECORDER
}
 Definition of different recorder types. More...
 
typedef std::vector< std::string > Encoders
 Definition of a vector holding encoder names. More...
 
- Protected Attributes inherited from Ocean::Media::Recorder
Type recorderType
 Type of this recorder. More...
 
Lock recorderLock
 Lock of this recorder. More...
 

Detailed Description

This class is the base class for all explicit media recorder.

An explicit recorder has to be started explicitly to start the recording process.
Instead, an implicit recorder may be started indirect by an external request.

See also
ImplicitRecorder.

Constructor & Destructor Documentation

◆ ExplicitRecorder()

Ocean::Media::ExplicitRecorder::ExplicitRecorder ( )
protected

Creates a new explicit recorder.

◆ ~ExplicitRecorder()

Ocean::Media::ExplicitRecorder::~ExplicitRecorder ( )
overrideprotected

Destructs a explicit recorder.

Member Function Documentation

◆ start()

◆ stop()


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