MPEG SDK --> MpegAnalyzer

class FrameList

A FrameList is a list of Frames sorted by frame number.

Source:
FrameList.h:59

Constructors Index

FrameList
[public] Construct an empty FrameList.
FrameList
[public] Construct a FrameList with two frames.


Methods Index

addFrame
[public] Add a frame and keep the list sorted.
addFrame
[public] Add a frame and keep the list sorted.
clean
[public] Remove all Frames.
contains
[public] Whether this FrameList contains the given frame.
contains
[public] Whether this FrameList contains the given frame.
deleteFrame
[public] Delete a frame.
deleteFrame
[public] Delete a frame.
get
[public] Get the ith Frame.
getSourceFile
[public] After a FrameList file has been read, this function returns the MPEG source file for the FrameList.
read
[public] Read from file. Returns the number of frames read.
setSourceFile
[public] Set the source file.
size
[public] The number of Frames.
write
[public] Save frame indices to file.


Constructors

FrameList

public FrameList ( ) ;

Construct an empty FrameList.

FrameList

public FrameList ( int first_frame ,
                   int last_frame ,
                   string filename = "" ) ;

Construct a FrameList with two frames.


Methods

getSourceFile

public string getSourceFile ( ) const ;

After a FrameList file has been read, this function returns the MPEG source file for the FrameList.

setSourceFile

public void setSourceFile ( string filename ) ;

Set the source file.

size

public int size ( ) const ;

The number of Frames.

get

public Frame get ( int i ) const ;

Get the ith Frame.

addFrame

public void addFrame ( int frame ,
                       string type = "" ) ;

Add a frame and keep the list sorted.

addFrame

public void addFrame ( const Frame & inframe ) ;

Add a frame and keep the list sorted.

deleteFrame

public bool deleteFrame ( int frame ) ;

Delete a frame.

deleteFrame

public bool deleteFrame ( Frame inframe ) ;

Delete a frame.

contains

public bool contains ( int frame ) const ;

Whether this FrameList contains the given frame.

contains

public bool contains ( Frame inframe ) const ;

Whether this FrameList contains the given frame.

read

public int read ( std_istream & in ) ;

Read from file. Returns the number of frames read.

write

public void write ( std_ostream & out ) const ;

Save frame indices to file.

clean

public void clean ( ) ;

Remove all Frames.


This documentation was generated automatically by the ccdoc tool (version 0.7a).
Click here to submit a bug report or feature request.

Click here to return to the top of the page.