Movie Manager Reference (Legacy)

Framework
Frameworks/QuickTime.framework
Declared in
HIObject.h
MacTypes.h
Movies.h
TextEdit.h

Overview

QuickTime movies have certain overall timing and other presentation characteristics that an application can manage, including the presentation of special kinds of media such as flash media and sprites.

Functions by Task

Controlling Movie Playback

Creating and Disposing of Time Bases

Determining Movie Creation and Modification Time

Disabling Movies and Tracks

Enhancing Movie Playback Performance

Error Functions

Generating Pictures From Movies

High-Level Movie Editing Functions

Initializing the Movie Toolbox

Managing Movie Sprites

Managing Sprite Images Outside a Movie

Managing the Video Frame Playback Rate

Movie Functions

Movie Posters and Movie Previews

Movie Toolbox Clock Support Functions

Movies and Your Event Loop

Preferred Movie Settings

Saving Movies

Text Media Handler Functions

The Sound Description Structure

Time Base Callback Functions

Using the OpenGL Texture Context

Working With Movie Spatial Characteristics

Working With Movie Time

Working With Progress and Cover Functions

Working With Sound Descriptions

Working With Sound Volume

Working With The Idle Manager

Working With Time Base Values

Working With Times

Working With User Data

Working With Wired Sprites

Supporting Functions

Functions

Callbacks

Data Types

ControlPtr

Represents a type used by the Movie Manager API.

typedef ControlRecord * ControlPtr;
Declared In
Movies.h

ControlRef

Represents a type used by the Movie Manager API.

typedef ControlPtr * ControlRef;
Availability
  • Available in OS X v10.0 and later.
Declared In
HIObject.h

QTFloatSingle

Represents a type used by the Movie Manager API.

typedef Float32 QTFloatSingle;
Availability
  • Available in OS X v10.0 and later.
  • Not available to 64-bit applications.
Declared In
Movies.h

QTNewMoviePropertyElement

Stores a movie property for NewMovieFromProperties.

struct QTNewMoviePropertyElement {
   QTPropertyClass       propClass;
   QTPropertyID          propID;
   ByteCount             propValueSize;
   QTPropertyValuePtr    propValueAddress;
   OSStatus              propStatus;
};
Fields
propClass
Discussion

A four-character code designating the class of a movie property. See New Movie Property Codes.

propID
Discussion

The ID of the property.

propValueSize
Discussion

The size in bytes of the property passed in propValueAddress.

propValueAddress
Discussion

A pointer to a movie property. Since the data type is fixed for each element's property class and ID, these is no ambiguity about the data type for its property value.

propStatus
Discussion

Indicates any problems with the property. For example, if a property is not understood by the function it is passed to, this field is set appropriately. See the discussion in NewMovieFromProperties.

Discussion

When you call NewMovieFromProperties, you allocate and own arrays of these elements to pass to it, as well as the property values that each element points to. You are responsible for disposing of all of these memory allocations.

Related Functions
Associated function: NewMovieFromProperties
Declared In
Movies.h

QTRuntimeSpriteDescPtr

Represents a type used by the Movie Manager API.

typedef QTRuntimeSpriteDescStruct * QTRuntimeSpriteDescPtr;
Availability
  • Available in OS X v10.0 and later.
  • Not available to 64-bit applications.
Declared In
Movies.h

QTRuntimeSpriteDescStruct

Provides a sprite description for the SpriteMediaNewSprite function.

QTRuntimeSpriteDescStruct {
long                               version;
QTAtomID                           spriteID;
short                              imageIndex;
MatrixRecord                       matrix;
short                              visible;
short                              layer;
ModifierTrackGraphicsModeRecord    graphicsMode;
QTAtomID                           actionHandlingSpriteID;
};
Fields
version
Discussion

Set to 0.

spriteID
Discussion

The QT atom ID of the sprite atom.

imageIndex
Discussion

The index of the sprite image. This value must be between 1 and the number of available images. You can determine how many images are available by calling SpriteMediaCountImages.

matrix
Discussion

A MatrixRecord structure that defines the sprite's matrix.

visible
Discussion

Undocumented

layer
Discussion

The sprite's layer number.

graphicsMode
Discussion

A ModifierTrackGraphicsModeRecord structure that defines the graphics mode setting for the sprite.

actionHandlingSpriteID
Discussion

Undocumented

Declared In
Movies.h

RegionCode

Represents a type used by the Movie Manager API.

typedef SInt16 RegionCode;
Availability
  • Available in OS X v10.0 and later.
Declared In
MacTypes.h

Style

Represents a type used by the Movie Manager API.

typedef unsigned char Style;
Availability
  • Available in OS X v10.0 and later.
Declared In
MacTypes.h

TEHandle

Represents a type used by the Movie Manager API.

typedef TEPtr * TEHandle;
Availability
  • Available in OS X v10.0 and later.
Declared In
TextEdit.h

TEPtr

Represents a type used by the Movie Manager API.

typedef TERec * TEPtr;
Availability
  • Available in OS X v10.0 and later.
Declared In
TextEdit.h

TextDescriptionHandle

Represents a type used by the Movie Manager API.

typedef TextDescriptionPtr * TextDescriptionHandle;
Availability
  • Available in OS X v10.0 and later.
  • Not available to 64-bit applications.
Declared In
Movies.h

TextDescriptionPtr

Represents a type used by the Movie Manager API.

typedef TextDescription * TextDescriptionPtr;
Availability
  • Available in OS X v10.0 and later.
  • Not available to 64-bit applications.
Declared In
Movies.h

TimeBaseStatus

Represents a type used by the Movie Manager API.

typedef unsigned long TimeBaseStatus;
Availability
  • Available in OS X v10.0 and later.
  • Not available to 64-bit applications.
Declared In
Movies.h

Constants

TextMediaFindNextText Values

Constants passed to TextMediaFindNextText.

enum {
   findTextEdgeOK                = 1 << 0, /* Okay to find text at specified sample time*/
   findTextCaseSensitive         = 1 << 1, /* Case sensitive search*/
   findTextReverseSearch         = 1 << 2, /* Search from sampleTime backwards*/
   findTextWrapAround            = 1 << 3, /* Wrap search when beginning or end of movie is hit*/
   findTextUseOffset             = 1 << 4 /* Begin search at the given character offset into sample rather than edge*/
};
Declared In
Movies.h

QTTextToNativeText Values

Constants passed to QTTextToNativeText.

enum {
   kITextAtomType                = 'itxt',
   kITextStringAtomType          = 'text'
};
Declared In
Movies.h

ITextRemoveString Values

Constants passed to ITextRemoveString.

enum {
   kITextRemoveEverythingBut     = 0 << 1,
   kITextRemoveLeaveSuggestedAlternate = 1 << 1
};
Declared In
Movies.h

CreateMovieControl Values

Constants passed to CreateMovieControl.

enum {
   kMovieControlOptionHideController = (1L << 0),
   kMovieControlOptionLocateTopLeft = (1L << 1),
   kMovieControlOptionEnableEditing = (1L << 2),
   kMovieControlOptionHandleEditingHI = (1L << 3),
   kMovieControlOptionSetKeysEnabled = (1L << 4),
   kMovieControlOptionManuallyIdled = (1L << 5)
};
Declared In
Movies.h

MovieMediaGetCurrentMovieProperty Values

Constants passed to MovieMediaGetCurrentMovieProperty.

enum {
   kMoviePropertyDuration        = 'dura', /* TimeValue **/
   kMoviePropertyTimeScale       = 'tims', /* TimeValue **/
   kMoviePropertyTime            = 'timv', /* TimeValue **/
   kMoviePropertyNaturalBounds   = 'natb', /* Rect **/
   kMoviePropertyMatrix          = 'mtrx', /* Matrix **/
   kMoviePropertyTrackList       = 'tlst' /* long ****/
};
Declared In
Movies.h

EnterMoviesOnThread Values

Constants passed to EnterMoviesOnThread.

enum {
   kQTEnterMoviesFlagDontSetComponentsThreadMode = 1L << 0
};
Declared In
Movies.h

loopTimeBase

Constants grouped with loopTimeBase.

enum {
   loopTimeBase                  = 1,
   palindromeLoopTimeBase        = 2,
   maintainTimeBaseZero          = 4
};
Declared In
Movies.h

SetMovieDrawingCompleteProc Values

Constants passed to SetMovieDrawingCompleteProc.

enum {
   movieDrawingCallWhenChanged   = 0,
   movieDrawingCallAlways        = 1
};
Declared In
Movies.h

timeBaseAfterStopTime

Constants grouped with timeBaseAfterStopTime.

enum {
   timeBaseBeforeStartTime       = 1,
   timeBaseAfterStopTime         = 2,
   timeBaseRateChanging          = 4
};
Declared In
Movies.h