rDVR-class: CLASS rDVR

In rDVR: The rDVR package allows you to start stop and save a video server from within R.

Description

class to communicate with the Video Server.

Details

This is class composing of methods to communicate with the Java Video Server. The methods start a video, save a running video and stop a running video without saving. Please note videos are currently limited to 10 minutes in length. If you want to change this limit you will need to compile a custom binary. Videos are encoded using the Apple QuickTime RLE codec. Currently to change the codec requires compiling a custom binary.

Fields

remoteServerAddr:

Object of class "character", giving the ip of the remote server. Defaults to localhost

port:

Object of class "numeric", the port of the remote server on which to connect to the Video Server.

saveDir:

Object of class "character", the location which the videos are saved. This is set by the Video Server. By default it is the OS temp directory. This option should be left NULL unless you set the directory when starting the Video Server.

Methods

new(...):

Create a new rDVR object. ... is used to define the appropriate slots.

start(fileName, silent):

Start a new video recording.

fileName:

The filename by which to save your video. Defaults to Rtemp. This will be saved as RTemp.mov. YourNAME will be saved as YourNAME.mov.

silent:

A boolean. If TRUE the method will run silently

save(silent, replace):

Save a currently running video to file. The file is given by the fileName used in the start method. The directory that the file is written to is the save directory stipulated when the Video Server was started.

silent:

A boolean. If TRUE the method will run silently

replace:

A boolean. If TRUE then rDVR will replace a file if it already exists. If false rDVR will append 'copy' to the saveFile name.

stop(silent):

Stops a currently running video. Using stop rather then save will result in the video being stopped but not saved.

silent:

A boolean. If TRUE the method will run silently

closeServer(silent):

Stops a currently running Video Server.

silent:

A boolean. If TRUE the method will run silently

rDVR documentation built on May 30, 2017, 4:15 a.m.