PLEngine::Camcorder Class Reference

Camcorder interaction component. More...

#include <Camcorder.h>

Inheritance diagram for PLEngine::Camcorder:

List of all members.

Public Member Functions
PL_API	Camcorder (EngineApplication &cApplication)
	Constructor.
virtual PL_API	~Camcorder ()
	Destructor.
PL_API EngineApplication &	GetApplication () const
	Returns the owner application.
PL_API void	StartRecord (const PLCore::String &sName)
	Starts the record.
PL_API bool	IsRecording () const
	Returns whether or not recording is currently active.
PL_API void	StopRecord ()
	Stops the record.
PL_API void	StartPlayback (const PLCore::String &sName)
	Starts the playback.
PL_API bool	IsPlaying () const
	Returns whether or not playback is currently active.
PL_API void	StopPlayback ()
	Stops the playback.
PL_API void	Update ()
	Updates the camcorder component.
virtual PL_API bool	Unload () override
	Unloads the loadable.
virtual PL_API PLCore::String	GetLoadableTypeName () const override
	Returns the loadable type name.
Protected Member Functions
virtual PL_API bool	CallLoadable (PLCore::File &cFile, PLCore::Loader &cLoader, const PLCore::String &sMethod, const PLCore::String &sParams) override
	Calls the loadable in order to load or save.

---

Detailed Description

Camcorder interaction component.

Note:

• Do not perform playback if the current camera is using physics...

---

Constructor & Destructor Documentation

PL_API PLEngine::Camcorder::Camcorder

(

EngineApplication &

cApplication

)

Constructor.

Parameters:

[in]

cApplication

Owner application

virtual PL_API PLEngine::Camcorder::~Camcorder

(

)

[virtual]

Destructor.

---

Member Function Documentation

PL_API EngineApplication& PLEngine::Camcorder::GetApplication

(

)

const

Returns the owner application.

Returns:

The owner application

PL_API void PLEngine::Camcorder::StartRecord

(

const PLCore::String &

sName

)

Starts the record.

Parameters:

[in]

sName

Record name, if empty string, no recording can be started

Note:

• The currently used application camera will be recorded
• If playback is currently enabled, the playback will be stopped at once

PL_API bool PLEngine::Camcorder::IsRecording

(

)

const

Returns whether or not recording is currently active.

Returns:

'true' if recording is currently active, else 'false'

PL_API void PLEngine::Camcorder::StopRecord

(

)

Stops the record.

PL_API void PLEngine::Camcorder::StartPlayback

(

const PLCore::String &

sName

)

Starts the playback.

Parameters:

[in]

sName

Record name, must be valid

Note:

• The currently used application camera will be feed with the recorded data
• If recording is currently enabled, the recording will be stopped at once

PL_API bool PLEngine::Camcorder::IsPlaying

(

)

const

Returns whether or not playback is currently active.

Returns:

'true' if playback is currently active, else 'false'

PL_API void PLEngine::Camcorder::StopPlayback

(

)

Stops the playback.

PL_API void PLEngine::Camcorder::Update

(

)

Updates the camcorder component.

virtual PL_API bool PLEngine::Camcorder::Unload

(

)

[override, virtual]

Unloads the loadable.

Returns:

'true' if all went fine, else 'false'

Reimplemented from PLCore::Loadable.

virtual PL_API PLCore::String PLEngine::Camcorder::GetLoadableTypeName

(

)

const [override, virtual]

Returns the loadable type name.

Returns:

The loadable type name

Reimplemented from PLCore::Loadable.

virtual PL_API bool PLEngine::Camcorder::CallLoadable	(	PLCore::File &	cFile,
		PLCore::Loader &	cLoader,
		const PLCore::String &	sMethod,
		const PLCore::String &	sParams
	)		[override, protected, virtual]

Calls the loadable in order to load or save.

Parameters:

[in]	cFile	File to load from, MUST be opened
[in]	cLoader	Loader to use
[in]	sMethod	Name of the method to use
[in]	sParams	Method parameters

Returns:

'true' if all went fine, else 'false'

Note:

• The default implementation is empty and will return always 'false'

Reimplemented from PLCore::Loadable.

---

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

• Camcorder.h