Project Malmo  0.30.0
Public Member Functions | Friends | List of all members
malmo::MissionRecordSpec Struct Reference

Specifies the type of data that should be recorded from the mission. More...

#include <MissionRecordSpec.h>

Public Member Functions

 MissionRecordSpec ()
 Constructs an empty mission record specification, saying that nothing should be recorded.
 
 MissionRecordSpec (std::string destination)
 Constructs a mission record with a target file (e.g. More...
 
void setDestination (const std::string &destination)
 Specifies the destination for the recording.
 
void recordMP4 (int frames_per_second, int64_t bit_rate)
 Requests that video be recorded, at the specified quality. More...
 
void recordObservations ()
 Requests that observations be recorded.
 
void recordRewards ()
 Requests that rewards be recorded.
 
void recordCommands ()
 Requests that commands be recorded.
 
bool isRecording () const
 Are we recording anything?
 

Friends

class MissionRecord
 
std::ostream & operator<< (std::ostream &os, const MissionRecordSpec &msp)
 

Detailed Description

Specifies the type of data that should be recorded from the mission.

Constructor & Destructor Documentation

malmo::MissionRecordSpec::MissionRecordSpec ( std::string  destination)

Constructs a mission record with a target file (e.g.

'data.tgz'). By default, nothing is recorded. Use the other functions to specify what channels should be recorded. WARNING: You cannot re-use the instance of MissionRecordSpec - make a new one per call to AgentHost.startMission.

Parameters
destinationFilename to save to.

Member Function Documentation

void malmo::MissionRecordSpec::recordMP4 ( int  frames_per_second,
int64_t  bit_rate 
)

Requests that video be recorded, at the specified quality.

Ensure that the width of the video requested is divisible by 4, and the height of the video requested is divisible by 2.

Parameters
frames_per_secondThe number of frames to record per second. e.g. 20.
bit_rateThe bit rate to record at. e.g. 400000 for 400kbps.

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