# RecorderController

from pandac.PandaModules import RecorderController

Class : RecorderController
Description : This object manages the process of recording the user's runtime inputs to a bam file so that the session can be recreated later.

## Inheritance:

RecorderController: TypedReferenceCount
TypedReferenceCount: TypedObject ReferenceCount
TypedObject: MemoryBase
MemoryBase:
ReferenceCount: MemoryBase

## Methods of RecorderController:

RecorderController (Constructor)
addRecorder
beginPlayback
beginRecord
close
getClassType
getClockOffset
getFilename
getFrameOffset
getFrameTie
getRandomSeed
getRecorder
getStartTime
hasRecorder
isError
isOpen
isPlaying
isRecording
playFrame
recordFrame
removeRecorder
setFrameTie
setRandomSeed

## Methods of TypedReferenceCount:

getClassType

## Methods of TypedObject:

getClassType
getType
getTypeIndex
isExactType
isOfType

## Methods of ReferenceCount:

getClassType
getRefCount
ref
testRefCountIntegrity
testRefCountNonzero
unref

RecorderController RecorderController::RecorderController(void); Description:

addRecorder void RecorderController::add_recorder(string const &name, RecorderBase *recorder); Description: Adds the named recorder to the set of recorders that are in use. If the controller is in recording mode, the named recorder will begin recording its status to the session file. If the controller is in playback mode and the name and type matches a recorder in the session file, the recorder will begin receiving data.

beginPlayback bool RecorderController::begin_playback(Filename const &filename); Description: Begins playing back data from the indicated filename. All of the recorders in use should already have been added, although this may define additional recorders if they are present in the file (these new recorders will not be used). This may also undefine recorders that were previously added but are not present in the file.

beginRecord bool RecorderController::begin_record(Filename const &filename); Description: Begins recording data to the indicated filename. All of the recorders in use should already have been added.

close void RecorderController::close(void); Description: Finishes recording data to the indicated filename.

getClassType static TypeHandle RecorderController::get_class_type(void); Undocumented function.

getClockOffset double RecorderController::get_clock_offset(void) const; Description: Returns the delta offset between the actual frame time and the frame time written to the log. This is essentially the time at which the recording (or playback) started.

getFilename Filename const &RecorderController::get_filename(void) const; Description: Returns the filename that was passed to the most recent call to begin_record() or begin_playback().

getFrameOffset int RecorderController::get_frame_offset(void) const; Description: Returns the delta offset between the actual frame count and the frame count written to the log. This is essentially the frame number at which the recording (or playback) started.

getFrameTie bool RecorderController::get_frame_tie(void) const; Description: See set_frame_tie().

getRandomSeed int RecorderController::get_random_seed(void) const; Description: Returns the random seed that was set by a previous call to set_random_seed(), or the number read from the session file after begin_playback() has been called.

getRecorder RecorderBase *RecorderController::get_recorder(string const &name) const; Description: Returns the recorder with the indicated name, or NULL if there is no such recorder. If the controller is in playback mode, this may return the recorder matching the indicated name as read from the session file, even if it was never added to the table by the user. In this case, has_recorder() may return false, but get_recorder() will return a non-NULL value.

getStartTime unsigned int RecorderController::get_start_time(void) const; Description: Returns the time (and date) at which the current session was originally recorded (or, in recording mode, the time at which the current session began).

hasRecorder bool RecorderController::has_recorder(string const &name) const; Description: Returns true if the named recorder has been added to the table by a previous call to add_recorder(), false otherwise. If the controller is in playback mode, this will also return false for a recorder that was found in the session file but was never explicitly added via add_recorder(); see get_recorder().

isError bool RecorderController::is_error(void); Description: Returns true if the controller has been opened for input or output output and there is an error on the stream, or false if the controller is closed or if there is no problem.

isOpen bool RecorderController::is_open(void) const; Description: Returns true if the controller has been opened for either input or output, false otherwise.

isPlaying bool RecorderController::is_playing(void) const; Description: Returns true if the controller has been opened for input, false otherwise.

isRecording bool RecorderController::is_recording(void) const; Description: Returns true if the controller has been opened for output, false otherwise.

playFrame void RecorderController::play_frame(void); Description: Gets the next frame of data from all of the active recorders and adds it to the output file.

recordFrame void RecorderController::record_frame(void); Description: Gets the next frame of data from all of the active recorders and adds it to the output file.

removeRecorder bool RecorderController::remove_recorder(string const &name); Description: Removes the named recorder from the table. Returns true if successful, false if there was no such recorder. If the controller is in recording mode, the named recorder will stop recording. If the controller is in playback mode, the named recorder will disassociate itself from the session file (but if the session file still has data for this name, a default recorder will take its place to decode the data from the session file).

setFrameTie void RecorderController::set_frame_tie(bool frame_tie); Description: Sets the frame_tie flag. When this is true, sessions are played back frame-for-frame, based on the frame count of the recorded session. This gives the most accurate playback, but the playback rate will vary according to the frame rate of the playback machine. When this is false, sessions are played back at real time, based on the clock of the recorded session. This may introduce playback discrepencies if the frames do not fall at exactly the same times as they did in the original.

setRandomSeed void RecorderController::set_random_seed(int random_seed); Description: Indicates an arbitrary number to be recorded in the session file as a random seed, should the application wish to take advantage of it. This must be set before begin_record() is called.

getClassType static TypeHandle TypedReferenceCount::get_class_type(void); Undocumented function.

getClassType static TypeHandle TypedObject::get_class_type(void); Undocumented function.

getType virtual TypeHandle TypedObject::get_type(void) const = 0; Derived classes should override this function to return get_class_type().

getTypeIndex int TypedObject::get_type_index(void) const; Description: Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index().

isExactType bool TypedObject::is_exact_type(TypeHandle handle) const; Description: Returns true if the current object is the indicated type exactly.

isOfType bool TypedObject::is_of_type(TypeHandle handle) const; Description: Returns true if the current object is or derives from the indicated type.

getClassType static TypeHandle ReferenceCount::get_class_type(void); Undocumented function.

getRefCount int ReferenceCount::get_ref_count(void) const; Description: Returns the current reference count.

ref void ReferenceCount::ref(void) const; Description: Explicitly increments the reference count. User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

testRefCountIntegrity bool ReferenceCount::test_ref_count_integrity(void) const; Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

testRefCountNonzero bool ReferenceCount::test_ref_count_nonzero(void) const; Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref bool ReferenceCount::unref(void) const; Description: Explicitly decrements the reference count. Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete(). User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it. The return value is true if the new reference count is nonzero, false if it is zero.