mvGetFileFormat(3dm)mvGetFileFormat(3dm)NAME
mvGetFileFormat, mvGetLoopMode, mvGetLoopLimit, mvGetTitle, mvGetComment,
mvGetOptimized, mvSetLoopMode, mvSetLoopLimit, mvSetTitle, mvSetComment -
get and set the properties of a movie
SYNOPSIS
#include <dmedia/moviefile.h>
MVfileformat mvGetFileFormat( MVid movie )
MVloopmode mvGetLoopMode( MVid movie )
int mvGetLoopLimit( MVid movie )
const char* mvGetTitle( MVid movie )
const char* mvGetComment( MVid movie )
DMboolean mvGetOptimized( MVid movie )
DMstatus mvSetLoopMode( MVid movie, MVloopmode mode )
DMstatus mvSetLoopLimit( MVid movie, int limit )
DMstatus mvSetTitle( MVid movie, const char* title )
DMstatus mvSetComment( MVid movie, const char* comment )
DESCRIPTION
All of the data accessed by these functions can also be accessed using
mvGetParams(3dm) and mvSetParams(3dm).
mvGetFileFormat returns the format in which the movie is stored, which
will one of MV_FORMAT_SGI_3 (Silicon Graphics format), MV_FORMAT_QT
(QuickTime (tm) format), MV_FORMAT_MPEG1 (MPEG format), or MV_FORMAT_AVI
(Microsoft AVI format).
mvGetLoopMode gets the default looping mode for the movie. This is used
when the movie plays to determine whether it plays once (MV_LOOP_NONE),
plays repeatly (MV_LOOP_CONTINUOUSLY), or repeatedly plays forward and
the backward (MV_LOOP_SWINGING). mvGetLoopMode returns the current
setting in the movie.
mvGetLoopLimit gets the default number of times the movie will loop if
the loop mode is MV_LOOP_CONTINUOUSLY or MV_LOOP_SWINGING. A value of 0
means that the movie will loop indefinitely.
mvGetTitle return the title string associated with the movie.
mvGetComment returns the comment string associated with the movie. The
Page 1
mvGetFileFormat(3dm)mvGetFileFormat(3dm)
strings returned are owned by the movie library and must not be freed.
If an application needs to keep the returned string, it should be copied.
Note that some file formats support storing the Title/Comment strings for
both the movie and for each track.
mvGetOptimized returns DM_TRUE if the movie is optimized for playback
performance and DM_FALSE if not. Any editing operations on the movie
that read, write, insert, or delete samples (see mvEditByFrame(3dm)) will
disrupt optimization and clear this flag. Creating a movie with
mvOptimize(3dm) results in a movie that is optimized.
mvSetLoopMode, mvSetLoopLimit, mvSetTitle, and mvSetComment store values
in the movie/track parameter list. They return DM_SUCCESS or DM_FAILURE.
NOTES
Note that the title and comment may not be stored in all file formats.
Note that for QuickTime files, the title and comment are written to disk
and read from disk as QuickTime UserData items "(c)nam" and "(c)inf". SGI
applications should always use mvGetTitle/mvSetTitle and
mvGetComment/mvSetComment to access the title/comment, rather than
attempting to directly access the user data atoms.
SEE ALSOmvIntro(3dm), mvCreate(3dm), mvOpen(3dm), mvOptimize(3dm),
mvGetMoviePlayVolume(3dm).
Page 2
