Panda3D
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
MovieVideo Class Reference

A MovieVideo is actually any source that provides a sequence of video frames. More...

Inheritance diagram for MovieVideo:
TypedWritableReferenceCount Namable TypedWritable ReferenceCount TypedObject InkblotVideo WebcamVideo

Public Member Functions

 __init__ (const MovieVideo)
 
 __init__ (str name)
 This constructor returns a null video stream — a stream of plain blue and white frames that last one second each. More...
 
const Filename getFilename ()
 Returns the movie's filename. More...
 
const SubfileInfo getSubfileInfo ()
 If the movie is to be loaded from a subfile on disk, this returns the subfile info. More...
 
MovieVideoCursor open ()
 Open this video, returning a MovieVideoCursor of the appropriate type. More...
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 fillin (DatagramIterator scan, BamReader manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 
- Public Member Functions inherited from Namable
 __init__ (const Namable)
 
 __init__ (str initial_name)
 
 clearName ()
 Resets the Namable's name to empty. More...
 
str getName ()
 
bool hasName ()
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
 output (Ostream out)
 Outputs the Namable. More...
 
 setName (str name)
 

Static Public Member Functions

static MovieVideo get (const Filename name)
 Obtains a MovieVideo that references a file. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle getClassType ()
 

Public Attributes

const Filename filename
 Returns the movie's filename. More...
 
const SubfileInfo subfile_info
 If the movie is to be loaded from a subfile on disk, this returns the subfile info. More...
 
- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 
- Public Attributes inherited from Namable
const String name
 

Detailed Description

A MovieVideo is actually any source that provides a sequence of video frames.

That could include an AVI file, a digital camera, or an internet TV station.

The difference between a MovieVideo and a MovieVideoCursor is like the difference between a filename and a file handle. The MovieVideo just indicates a particular movie. The MovieVideoCursor is what allows access.

Member Function Documentation

◆ __init__() [1/2]

__init__ ( const  MovieVideo)

◆ __init__() [2/2]

__init__ ( str  name)

This constructor returns a null video stream — a stream of plain blue and white frames that last one second each.

To get more interesting video, you need to construct a subclass of this class.

◆ get()

static MovieVideo get ( const Filename  name)
static

Obtains a MovieVideo that references a file.

Just calls MovieTypeRegistry::make_video().

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getFilename()

const Filename getFilename ( )

Returns the movie's filename.

A movie is not guaranteed to have a filename, if not, then this function returns an empty filename.

◆ getSubfileInfo()

const SubfileInfo getSubfileInfo ( )

If the movie is to be loaded from a subfile on disk, this returns the subfile info.

Check info.is_empty() to see if this is valid data.

◆ open()

MovieVideoCursor open ( )

Open this video, returning a MovieVideoCursor of the appropriate type.

Returns NULL on error.

Member Data Documentation

◆ filename

const Filename filename

Returns the movie's filename.

A movie is not guaranteed to have a filename, if not, then this function returns an empty filename.

◆ subfile_info

const SubfileInfo subfile_info

If the movie is to be loaded from a subfile on disk, this returns the subfile info.

Check info.is_empty() to see if this is valid data.