Product Home • Class Index • Download

CK_Movie

CK_Movie objects represent an AVI or MPEG movie.  Movies can be integrated seamlessly with other graphics and animations.  CK_Label components can display a movie.  The movie will be "mixed-in" with any other components on the screen.  If another component occludes the movie, the movie will play properly underneath the occluding component.  If the CK_Label changes position on the screen, the movie will follow.

Internally, the library uses the Microsoft DirectShow API to implement the CK_Movie class.  This allows any AVI or MPEG file to be played at any pixel depth, and in windowed or full-screen mode. 

The 'Lite' version of the Chilkat SDK exists for applications that do not wish to display movies.  The Lite version includes stubs for the CK_Movie class so that the Microsoft DirectShow runtime libraries are not required to build the application.

The CK_Movie class provides functions to control a movie in the following ways:

• Play in looping mode or once-through.
• Pause the movie.
• Play the first frame and immediately pause.
• Stop the movie.
• Resume the movie.

Factory Methods

createMovie

Creates a CK_Movie from an AVI or MPEG file.

Public Methods

getHeight

Get the height in pixels of the movie.

getWidth

Get the width in pixels of the movie.

pauseMovie

Pauses the movie at the current frame.

playMovie

Plays the movie once.

playMovieLooping

Plays the movie continuously, restarting from the beginning when the end is reached.

replaceMovie

Loads the CK_Movie object with a different movie.

resumeMovie

Continues the movie from its paused state.

setClipped  (not necessary in v1.02 or higher)

Tells the CK_Movie that it could be clipped.

setFrameDelay

Sets the speed at which the movie plays.

setMovable (not necessary in v1.02 or higher)

Tells the CK_Movie that it could be moved around the screen.

showFirstFrame

Can be called after creating the movie to display the first frame and pause it immediately.

stopMovie

Stops the movie.  The movie cannot be resumed after stopping, but can be restarted.

• static CK_Movie *createMovie(const char *fileName);

Creates a CK_Movie from an AVI or MPEG file. Returns a pointer to the CK_Movie created.

Parameters

fileName

The name of an AVI (.avi) or MPEG (.mpg) from which a CK_Movie object will be created.

• int getHeight(void) const;

Returns the height in pixels of the movie.

• int getWidth(void) const;

Returns the width in pixels of the movie.

• void pauseMovie(void);

Pauses the movie at the current frame.  The movie can be resumed by calling resumeMovie().

• void playMovie(void);

  Plays the move once.

• void playMovieLooping(void);

Plays the movie continuously, restarting from the beginning once the end is reached.

• void replaceMovie(const char *fileName);

Replaces the movie with a new AVI or MPEG.  If the movie was playing, it will be stopped.

Parameters

fileName

The name of an AVI (.avi) or MPEG (.mpg) file to load into the CK_Movie object.

• void resumeMovie(void);

Resumes the movie from it's paused state. 

• void setClipped(void); (not necessary in v1.02 or higher)

Tells the CK_Movie that the movie could be clipped or occluded.  If this function is not called, and the movie IS clipped or occluded, the clipping or occlusion will not be displayed properly.

• void setFrameDelay(int millisec);

Sets the time delay between each frame of the movie.

Parameters

millisec

The time delay in milliseconds between each frame of the movie.

• void setMovable(void); (not necessary in v1.02 or higher)

Tells the CK_Movie that it's position on the screen may change.  If this function is not called, the movie will remain positioned where it first appears on the screen.

• void showFirstFrame(void);

Renders the first frame of the movie and then pauses it.  The movie can be resumed by calling resumeMovie().

• void stopMovie(void);

Stops the movie.  This is different from pausing because when a movie is paused, the current frame will still be showing, whereas a stopped movie will not be showing anything.