Ocean
Public Member Functions | Protected Member Functions
Ocean::Media::ImplicitRecorder Class Referenceabstract
Ocean Media Abstraction Library

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

Inheritance diagram for Ocean::Media::ImplicitRecorder:

Public Member Functions

virtual bool isEnabled () const =0
 Returns whether this recorder is currently enabled. More...
 
virtual bool enable ()=0
 Enables the streaming recorder. More...
 
virtual bool disable ()=0
 Disables the streaming 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

 ImplicitRecorder ()
 Creates a new implicit recorder. More...
 
 ~ImplicitRecorder () override
 Destructs a implicit 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 implicit media recorder.

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

See also
ExplicitRecorder.

Constructor & Destructor Documentation

◆ ImplicitRecorder()

Ocean::Media::ImplicitRecorder::ImplicitRecorder ( )
protected

Creates a new implicit recorder.

◆ ~ImplicitRecorder()

Ocean::Media::ImplicitRecorder::~ImplicitRecorder ( )
overrideprotected

Destructs a implicit recorder.

Member Function Documentation

◆ disable()

virtual bool Ocean::Media::ImplicitRecorder::disable ( )
pure virtual

Disables the streaming recorder.

Returns
True, if succeeded

◆ enable()

virtual bool Ocean::Media::ImplicitRecorder::enable ( )
pure virtual

Enables the streaming recorder.

Returns
True, if succeeded

◆ isEnabled()

virtual bool Ocean::Media::ImplicitRecorder::isEnabled ( ) const
pure virtual

Returns whether this recorder is currently enabled.

Returns
True, if so
The documentation for this class was generated from the following file: