Skip to contents

Read Specific Video Frame

Source: R/VideoClass.R, R/VideoStackClass.R, R/generic.R
readFrame.Rd

Read a specific frame of a Video or VideoStack object and returns it as an Image object.

Usage

# S3 method for class 'Rcpp_Video'
readFrame(x, pos, target = "new")

# S3 method for class 'VideoStack'
readFrame(x, pos, target = "new")

readFrame(x, pos, target = "new")

Arguments

x

A Video or VideoStack object.

pos

An integer corresponding to the position of the frame to read in the video or video stack.

target

The location where the results should be stored. It can take 2 values:

"new":

a new Image object is created and the results are stored inside (the default).

An Image object:

the results are stored in another existing Image object. This will replace the content of target. Note that target must have the same dimensions as x.

Value

If target="new", the function returns an Image object. If target is an Image object, the function returns nothing and modifies that Image object in place.

See also

Video, VideoStack, Image, readNext

Author

Simon Garnier, garnier@njit.edu

Examples

balloon <- video(system.file("sample_vid/Balloon.mp4", package = "Rvision"))
#> Error: Could not open the video.
frame10 <- readFrame(balloon, 10)
#> Error in eval(expr, envir, enclos): object 'balloon' not found