Documentation
¶
Overview ¶
Package recorder handles recording and playback of user input. The Recorder type implements the riot.input.EventRecorder() interface. Once added as a transcriber to the VCS port, it will record all user input to the specified file.
To keep things simple, recording gameplay will use the VCS in it's default state. Future versions of the recorder fileformat will support localised preferences.
Index ¶
Constants ¶
const (
PlaybackHashError = "playback: hash error [line %d]"
)
Sentinal error returned by GetPlayback if a hash error is encountered.
Variables ¶
This section is empty.
Functions ¶
func IsPlaybackFile ¶
IsPlaybackFile returns true if the specified file appears to be a playback file. It does not care about the nature of any errors that may be generated or if the file appears to be a playback file but is of an unsupported version.
Types ¶
type Playback ¶
type Playback struct {
CartLoad cartridgeloader.Loader
TVSpec string
// contains filtered or unexported fields
}
Playback is used to reperform the user input recorded in a previously recorded file. It implements the ports.Playback interface.
func NewPlayback ¶
NewPlayback is the preferred method of implementation for the Playback type.
func (*Playback) AttachToVCS ¶
AttachToVCS attaches the playback instance (an implementation of the playback interface) to all the ports of the VCS, including the panel.
Note that this will reset the VCS.
func (Playback) EndFrame ¶
EndFrame returns true if emulation has gone past the last frame of the playback.
func (*Playback) GetPlayback ¶ added in v0.7.1
GetPlayback returns an event and source portID for an event occurring at the current TV frame/scanline/horizpos.
type Recorder ¶
type Recorder struct {
// contains filtered or unexported fields
}
Recorder transcribes user input to a file. The recorded file is intended for future playback. The Recorder type implements the ports.EventRecorder interface.
func NewRecorder ¶
NewRecorder is the preferred method of implementation for the FileRecorder type. Note that attaching of the Recorder to all the ports of the VCS (including the panel) is implicit in this function call.
Note that this will reset the VCS.
Source Files