This class is the base class for all buffer recorders. More...

#include <BufferRecorder.h>

Inheritance diagram for Ocean::Media::BufferRecorder:

Public Member Functions
virtual bool	buffer (std::vector< unsigned char > &data) const =0
	Returns the buffer of the most recently saved image.

virtual const std::string &	bufferType () const
	Returns the buffer type of this recorder.

virtual bool	setBufferType (const std::string &bufferType)
	Sets the type of the buffer.

Public Member Functions inherited from Ocean::Media::ExplicitRecorder
virtual bool	start ()=0
	Sets the recorder.

virtual bool	stop ()=0
	Stops the recorder.

Public Member Functions inherited from Ocean::Media::Recorder
virtual bool	isRecording () const =0
	Returns whether this recorder is currently recording.

virtual bool	setPreferredBitrate (const unsigned int preferredBitrate)
	Sets the preferred bit rate when recording the data.

Type	type () const
	Returns the type of this recorder.

Protected Member Functions
	BufferRecorder ()
	Creates a new buffer recorder.

	~BufferRecorder () override
	Destructs a buffer recorder.

Protected Member Functions inherited from Ocean::Media::ExplicitRecorder
	ExplicitRecorder ()
	Creates a new explicit recorder.

	~ExplicitRecorder () override
	Destructs a explicit recorder.

Protected Member Functions inherited from Ocean::Media::Recorder
	Recorder ()
	Creates a new recorder.

virtual	~Recorder ()
	Destructs a recorder.

Protected Attributes
std::string	recorderBufferType
	Buffer type of this recorder.

Protected Attributes inherited from Ocean::Media::Recorder
Type	recorderType
	Type of this recorder.

Lock	recorderLock
	Lock of this recorder.

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.

Detailed Description

This class is the base class for all buffer recorders.

Constructor & Destructor Documentation

◆ BufferRecorder()

Ocean::Media::BufferRecorder::BufferRecorder ( )

protected

Creates a new buffer recorder.

◆ ~BufferRecorder()

Ocean::Media::BufferRecorder::~BufferRecorder ( )

overrideprotected

Destructs a buffer recorder.

Member Function Documentation

◆ buffer()

virtual bool Ocean::Media::BufferRecorder::buffer ( std::vector< unsigned char > & data ) const

pure virtual

Returns the buffer of the most recently saved image.

Returns: Buffer of most recently saved image

Implemented in Ocean::Media::OpenImageLibraries::OILBufferImageRecorder.

◆ bufferType()

virtual const std::string & Ocean::Media::BufferRecorder::bufferType ( ) const

virtual

Returns the buffer type of this recorder.

Returns: Buffer type

See also: setBufferType().

◆ setBufferType()

virtual bool Ocean::Media::BufferRecorder::setBufferType ( const std::string & bufferType )

virtual

Sets the type of the buffer.

For images this type will be the file extension of a corresponding image file, e.g. bmp, jpg, png, etc.

Parameters

bufferType Buffer type to be set

Returns: True, if succeeded

Field Documentation

◆ recorderBufferType

std::string Ocean::Media::BufferRecorder::recorderBufferType

protected

Buffer type of this recorder.

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

BufferRecorder.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members