Ocean::Media::MovieRecorder Class Reference
This class is the base class for all movie recorder. More...
Inheritance diagram for Ocean::Media::MovieRecorder:
Protected Member Functions | |
| MovieRecorder () | |
| Creates a new movie recorder. More... | |
| ~MovieRecorder () override | |
| Destructs a movie recorder. More... | |
 Protected Member Functions inherited from Ocean::Media::FileRecorder | |
| FileRecorder () | |
| Creates a new file recorder. More... | |
| ~FileRecorder () override | |
| Destructs a file recorder. More... | |
| Protected Member Functions inherited from Ocean::Media::ExplicitRecorder | |
| 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... | |
| Protected Member Functions inherited from Ocean::Media::FrameRecorder | |
| FrameRecorder () | |
| Creats a new frame recorder. More... | |
| ~FrameRecorder () override | |
| Destructs a frame 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... | |
| Public Member Functions inherited from Ocean::Media::FileRecorder | |
| const std::string & | filename () const |
| Returns the filename of this recorder. More... | |
| bool | filenameSuffixed () const |
| Returns whether the filename of this recorder will be suffixed with date and time. More... | |
| virtual bool | setFilename (const std::string &filename) |
| Sets the filename of this recorder. More... | |
| virtual bool | setFilenameSuffixed (const bool suffixed) |
| Sets whether the filename will be suffixed with date and time. More... | |
| Public Member Functions inherited from Ocean::Media::ExplicitRecorder | |
| 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... | |
| Public Member Functions inherited from Ocean::Media::FrameRecorder | |
| const FrameType & | frameType () const |
| Returns the actual frame type of this recorder. More... | |
| double | frameFrequency () const |
| Returns the frame frequency of this recorder in Hz. More... | |
| const std::string & | frameEncoder () const |
| Returns the name of the encoder used to encoder the frames. More... | |
| virtual Encoders | frameEncoders () const |
| Returns a list of possible frame encoders for this recorder. More... | |
| virtual bool | frameEncoderHasConfiguration () |
| Returns whether the selected frame encoder has a configuration possibility. More... | |
| virtual bool | setPreferredFrameType (const FrameType &type) |
| Sets the preferred frame type of this recorder. More... | |
| virtual bool | setFrameFrequency (const double frequency) |
| Sets the frame frequency of this recorder. More... | |
| virtual bool | setFrameEncoder (const std::string &encoder) |
| Sets the frame encoder used to encode the frames. More... | |
| virtual bool | frameEncoderConfiguration (long long data) |
| Starts the frame encoder configuration possibility. More... | |
| virtual bool | lockBufferToFill (Frame &recorderFrame, const bool respectFrameFrequency=true)=0 |
| Locks the most recent frame and returns it so that the image data can be written to this frame. More... | |
| virtual void | unlockBufferToFill ()=0 |
| Unlocks the filled buffer. More... | |
| Static Public Member Functions inherited from Ocean::Media::FileRecorder | |
| static std::string | addOptionalSuffixToFilename (const std::string &filename, const bool addSuffix) |
| Determines the filename to be used for the next file. More... | |
| static std::string | addOptionalSuffixToFilename (const std::string &filename, const unsigned int index, const bool addSuffix) |
| Determines the filename to be used for the next file. More... | |
| Protected Attributes inherited from Ocean::Media::FileRecorder | |
| std::string | recorderFilename |
| Filename of this recorder. More... | |
| bool | recorderFilenameSuffixed |
| Flag determining whether the filename will be suffixed with date and time. More... | |
| Protected Attributes inherited from Ocean::Media::Recorder | |
| Type | recorderType |
| Type of this recorder. More... | |
| Lock | recorderLock |
| Lock of this recorder. More... | |
| Protected Attributes inherited from Ocean::Media::FrameRecorder | |
| FrameType | recorderFrameType |
| Type of the frame to record. More... | |
| double | recorderFrameFrequency |
| Frame frequency used by the recorder. More... | |
| std::string | recorderFrameEncoder |
| Name of the frame encoder used to encode the frames. More... | |
Detailed Description
This class is the base class for all movie recorder.
Constructor & Destructor Documentation
◆ MovieRecorder()
|
protected |
Creates a new movie recorder.
◆ ~MovieRecorder()
|
overrideprotected |
Destructs a movie recorder.
The documentation for this class was generated from the following file:
