Home > chronux > fly_track > videoIO > videoIO_2006a > @videoReader > getframe.m

getframe

PURPOSE ^

FRAME=GETFRAME(VR)

SYNOPSIS ^

function frame = getframe(vr)

DESCRIPTION ^

FRAME=GETFRAME(VR)
  Returns the current frame that has been read in from video VR.  Calling
  GETFRAME does not automatically advance the current frame so the user
  must first call NEXT, STEP, or SEEK before calling GETFRAME the
  first time.  This makes it easy to write loops such as:
    vr = videoReader(...);
    while (next(vr))
      img = getframe(vr);
      ...do something...
    end
    vr = close(vr);

SEE ALSO
  videoReader

Copyright (c) 2006 Gerald Dalley
See "MIT.txt" in the installation directory for licensing details (especially
when using this library on GNU/Linux).

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function frame = getframe(vr)
0002 %FRAME=GETFRAME(VR)
0003 %  Returns the current frame that has been read in from video VR.  Calling
0004 %  GETFRAME does not automatically advance the current frame so the user
0005 %  must first call NEXT, STEP, or SEEK before calling GETFRAME the
0006 %  first time.  This makes it easy to write loops such as:
0007 %    vr = videoReader(...);
0008 %    while (next(vr))
0009 %      img = getframe(vr);
0010 %      ...do something...
0011 %    end
0012 %    vr = close(vr);
0013 %
0014 %SEE ALSO
0015 %  videoReader
0016 %
0017 %Copyright (c) 2006 Gerald Dalley
0018 %See "MIT.txt" in the installation directory for licensing details (especially
0019 %when using this library on GNU/Linux).
0020 
0021 frame = feval(vr.plugin, 'getframe', vr.handle);
0022

Generated on Fri 28-Sep-2012 12:34:30 by m2html © 2005