frame: Reader Head Position

View source: R/generic.R

frame.Rcpp_QueueR Documentation

Reader Head Position

Description

Retrieve or set the index of the frame to be read next in a Video, VideoStack or Queue object.

Usage

## S3 method for class 'Rcpp_Queue'
frame(x)

## S3 method for class 'Rcpp_Video'
frame(x)

## S3 replacement method for class 'Rcpp_Video'
frame(x) <- value

## S3 method for class 'VideoStack'
frame(x)

## S3 replacement method for class 'VideoStack'
frame(x) <- value

frame(x)

frame(x) <- value

Arguments

x

A Video, VideoStack or Queue object.

value

The index of the frame to be read next.

Value

A numeric value or 'x' with a new head position.

Note

Frame index starts at 1 (i.e. the first image has index 1).

Author(s)

Simon Garnier, garnier@njit.edu

See Also

Video, VideoStack, Queue

Examples

balloon <- video(system.file("sample_vid/Balloon.mp4", package = "Rvision"))
frame(balloon)


swarm-lab/Rvision documentation built on Feb. 7, 2024, 4:59 a.m.