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

#include <Recorder.h>

Inheritance diagram for Ocean::Media::Recorder:

Public Types
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.

Public Member Functions
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
	Recorder ()
	Creates a new recorder.

virtual	~Recorder ()
	Destructs a recorder.

Protected Attributes
Type	recorderType
	Type of this recorder.

Lock	recorderLock
	Lock of this recorder.

Friends
class	ObjectRef< Recorder >

Detailed Description

This class is the base class for all recorder.

Member Typedef Documentation

◆ Encoders

typedef std::vector<std::string> Ocean::Media::Recorder::Encoders

Definition of a vector holding encoder names.

Member Enumeration Documentation

◆ Type

enum Ocean::Media::Recorder::Type

Definition of different recorder types.

Enumerator
RECORDER	Simple recorder.
FRAME_RECORDER	Frame recorder.
SOUND_RECORDER	Sound recorder.
EXPLICIT_RECORDER	Explicit recorder.
IMPLICIT_RECORDER	Implicit recorder.
FILE_RECORDER	File recorder.
BUFFER_RECORDER	Buffer recorder.
STREAMING_RECORDER	Streaming recorder.
MOVIE_RECORDER	Movie recorder.
FRAME_STREAMING_RECORDER	Frame streaming recorder.
IMAGE_RECORDER	Image recorder.
BUFFER_IMAGE_RECORDER	Buffer image recorder.
IMAGE_SEQUENCE_RECORDER	Image sequence recorder.
FRAME_MEMORY_RECORDER	Frame memory recorder.

Constructor & Destructor Documentation

◆ Recorder()

Ocean::Media::Recorder::Recorder ( )

protected

Creates a new recorder.

◆ ~Recorder()

virtual Ocean::Media::Recorder::~Recorder ( )

protectedvirtual

Destructs a recorder.

Member Function Documentation

◆ isRecording()

virtual bool Ocean::Media::Recorder::isRecording ( ) const

pure virtual

Returns whether this recorder is currently recording.

Returns: True, if so

Implemented in Ocean::Media::Android::AMovieRecorder, Ocean::Media::AVFoundation::AVFMovieRecorder, Ocean::Media::BufferImageRecorder, Ocean::Media::DirectShow::DSFileRecorder, Ocean::Media::ImageRecorder, Ocean::Media::MediaFoundation::MFMovieRecorder, and Ocean::Media::OpenImageLibraries::OILImageSequenceRecorder.

◆ setPreferredBitrate()

virtual bool Ocean::Media::Recorder::setPreferredBitrate ( const unsigned int preferredBitrate )

virtual

Sets the preferred bit rate when recording the data.

Parameters

preferredBitrate Preferred bit rate, in bits per seconds, with range (0, infinity); 0 to use the default bit rate

Returns: True, if succeeded

Reimplemented in Ocean::Media::Android::AMovieRecorder, Ocean::Media::AVFoundation::AVFMovieRecorder, and Ocean::Media::MediaFoundation::MFMovieRecorder.

◆ type()

Recorder::Type Ocean::Media::Recorder::type ( ) const

inline

Returns the type of this recorder.

Returns: Recorder type

Friends And Related Symbol Documentation

◆ ObjectRef< Recorder >

friend class ObjectRef< Recorder >

friend

Field Documentation

◆ recorderLock

Lock Ocean::Media::Recorder::recorderLock

mutableprotected

Lock of this recorder.

◆ recorderType

Type Ocean::Media::Recorder::recorderType