conscience_core::bridging::commands::CommandVideoRecord Class Reference

#include <CommandVideoRecord.h>

Inheritance diagram for conscience_core::bridging::commands::CommandVideoRecord:

Public Member Functions
	CommandVideoRecord (ptr< CscEntityReflexion > entityReflexion, const string &outputPath, optional< string > streamId={})
Public Member Functions inherited from conscience_core::bridging::commands::CscCommand
const CscCommandExecutionResult *	_execute (CscEnvironmentSimulator &environmentSimulator)
template<class TResult = CscCommandExecutionResult>
const TResult *	execute (CscEnvironmentSimulator &environmentSimulator)
const CommandTypeId &	getTypeId () const
virtual	~CscCommand ()
void	setOriginalCommandString (string command)

Static Public Attributes
static const CommandTypeId	COMMAND_ID = "START_VIDEO_RECORD"

Protected Member Functions
ptr< CscEntityReflexion >	getEntityReflexion () const override
const CscCommandExecutionResult *	doExecute (CscEnvironmentSimulator &environmentSimulator) override
Protected Member Functions inherited from conscience_core::bridging::commands::CscCommand
	CscCommand (const CommandTypeId &typeId)
const CscCommandExecutionResultNone *	resultNone ()
const CscCommandExecutionResultSequence *	resultSequence (CscSequence *sequence, const string &entitySerialNumber, bool doNotPlay=false)
const CscCommandExecutionResultFile *	resultFile (const fs::path &resultingFilePath)
template<class TResult >
const CscCommandExecutionResultObject< TResult > *	resultObject (TResult *result)
const CscWorldElementId	getEntityId () const

Protected Attributes
ptr< CscEntityReflexion >	entityReflexion
optional< string >	streamId
Protected Attributes inherited from conscience_core::bridging::commands::CscCommand
const CommandTypeId	typeId
optional< string >	originalCommandString = {}

Additional Inherited Members
Public Types inherited from conscience_core::bridging::commands::CscCommand
typedef function< void(CscCommand *command)>	CommandExecutedListener
Static Public Member Functions inherited from conscience_core::bridging::commands::CscCommand
static void	addCommandExecutedListener (CommandExecutedListener listener)

Detailed Description

This command records an entity's video stream to a file on the file system of the machine hosting Conscience Core. If Conscience Studio, outputPath will be on local FS

Constructor & Destructor Documentation

CommandVideoRecord()

conscience_core::bridging::commands::CommandVideoRecord::CommandVideoRecord	(	ptr< CscEntityReflexion >	entityReflexion,
		const string &	outputPath,
		optional< string >	streamId = {}
	)

Parameters

entityReflexion	entity from which read video stream
outputPath	output path of the video file on the Conscience Core's machine file system
streamId	id of the stream to be consumed - please see ENTITY_STREAMS_GET to list entity streams

Member Function Documentation

doExecute()

const CscCommandExecutionResult * conscience_core::bridging::commands::CommandVideoRecord::doExecute ( CscEnvironmentSimulator &  environmentSimulator )

overrideprotectedvirtual

Implements conscience_core::bridging::commands::CscCommand.

getEntityReflexion()

ptr< CscEntityReflexion > conscience_core::bridging::commands::CommandVideoRecord::getEntityReflexion ( ) const

overrideprotectedvirtual

return entity reflexion if this command applies on an entityReflexion, otherwise return nullptr

Implements conscience_core::bridging::commands::CscCommand.

Member Data Documentation

COMMAND_ID

const CommandTypeId conscience_core::bridging::commands::CommandVideoRecord::COMMAND_ID = "START_VIDEO_RECORD"

inlinestatic

entityReflexion

ptr<CscEntityReflexion> conscience_core::bridging::commands::CommandVideoRecord::entityReflexion

protected

streamId

optional<string> conscience_core::bridging::commands::CommandVideoRecord::streamId

protected

---

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

• Bridging/EnvironmentInteractionCommands/CommandVideoRecord.h
• Bridging/EnvironmentInteractionCommands/CommandVideoRecord.cpp