Next Page >

Hide TOC

Movie Controller Reference

Framework	Frameworks/QuickTime.framework
Declared in	HIMovieView.h Movies.h OSTypes.h

Overview

Movie controllers provide a user interface for playing and editing movies, eliminating much of the complexity of working with movies. Movie controllers are implemented in QuickTime as components. This allows customized controllers to be plugged in to QuickTime for use by your application.

Functions by Task

Associating Movies With Controllers

Customizing Event Processing

Editing Movies With a Controller

Getting and Setting Movie Controller Time

Handling Movie Events

Managing Controller Attributes

Movie Controller Action Functions

Working With The Idle Manager

Supporting Functions

Functions

DisposeMCActionFilterUPP

Disposes of a MCActionFilterUPP pointer.

void DisposeMCActionFilterUPP (
   MCActionFilterUPP userUPP
);

Parameters

userUPP: A MCActionFilterUPP pointer. See Universal Procedure Pointers.

Return Value

You can access this function's error returns through GetMoviesError and GetMoviesStickyError.

Version Notes

Introduced in QuickTime 4.1.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

DisposeMCActionFilterWithRefConUPP

Disposes of a MCActionFilterWithRefConUPP pointer.

void DisposeMCActionFilterWithRefConUPP (
   MCActionFilterWithRefConUPP userUPP
);

Parameters

userUPP: A MCActionFilterWithRefConUPP pointer. See Universal Procedure Pointers.

Return Value

You can access this function's error returns through GetMoviesError and GetMoviesStickyError.

Version Notes

Introduced in QuickTime 4.1.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

HIMovieViewChangeAttributes

Changes the views attributes.

OSStatus HIMovieViewChangeAttributes (
   HIViewRef inView,
   OptionBits inAttributesToSet,
   OptionBits inAttributesToClear
);

Parameters

inView: The HIMovieView.
inAttributesToSet: Attributes to set.
inAttributesToClear: Attributes to clear.

Return Value

An error code. Returns noErr if there is no error.

Discussion

Setting an attribute takes precedence over clearing the attribute.

Availability

Available in Mac OS X v10.3 and later.

Declared In

HIMovieView.h

HIMovieViewCreate

Creates an HIMovieView object.

OSStatus HIMovieViewCreate (
   Movie inMovie,
   OptionBits inAttributes,
   HIViewRef *outMovieView
);

Parameters

inMovie: Initial movie to view; may be NULL.
inAttributes: Initial HIMovieView attributes.
outMovieView: Points to variable to receive new HIMovieView.

Return Value

Undocumented.

Discussion

If successful, the created view will have a single retain count.

Availability

Available in Mac OS X v10.3 and later.

Declared In

HIMovieView.h

HIMovieViewGetAttributes

Returns the view's current attributes.

OptionBits HIMovieViewGetAttributes (
   HIViewRef inView
);

Parameters

inView: The HIMovieView.

Return Value

Undocumented.

Discussion

The view's current attributes are returned.

Availability

Available in Mac OS X v10.3 and later.

Declared In

HIMovieView.h

HIMovieViewGetControllerBarSize

Returns the size of the visible movie controller bar.

HISize HIMovieViewGetControllerBarSize (
   HIViewRef inView
);

Parameters

inView: The HIMovieView.

Return Value

Undocumented.

Discussion

The size of the visible movie controller bar is returned.

Availability

Available in Mac OS X v10.3 and later.

Declared In

HIMovieView.h

HIMovieViewGetMovie

Returns the view's current movie.

Movie HIMovieViewGetMovie (
   HIViewRef inView
);

Parameters

inView: The HIMovieView.

Return Value

Undocumented.

Discussion

The view's current movie is returned.

Availability

Available in Mac OS X v10.3 and later.

Declared In

HIMovieView.h

HIMovieViewGetMovieController

Returns the view's current movie controller.

MovieController HIMovieViewGetMovieController (
   HIViewRef inView
);

Parameters

inView: The HIMovieView.

Return Value

Undocumented.

Discussion

The view's current movie controller is returned.

Availability

Available in Mac OS X v10.3 and later.

Declared In

HIMovieView.h

HIMovieViewPause

Pauses the view's current movie.

OSStatus HIMovieViewPause (
   HIViewRef movieView
);

Parameters

movieView: The movie view.

Return Value

An error code. Returns noErr if there is no error.

Discussion

This is a convenience routine to pause the view's current movie. If the movie is already paused, this function does nothing.

Availability

Available in Mac OS X v10.3 and later.

Declared In

HIMovieView.h

HIMovieViewPlay

Plays the view's current movie.

OSStatus HIMovieViewPlay (
   HIViewRef movieView
);

Parameters

movieView: The movie view.

Return Value

An error code. Returns noErr if there is no error.

Discussion

This is a convenience routine to play the view's current movie. If the movie is already playing, this function does nothing.

Availability

Available in Mac OS X v10.3 and later.

Declared In

HIMovieView.h

HIMovieViewSetMovie

Sets the view's current movie.

OSStatus HIMovieViewSetMovie (
   HIViewRef inView,
   Movie inMovie
);

Parameters

inView: The HIMovieView.
inMovie: The new movie to display.

Return Value

An error code. Returns noErr if there is no error.

Discussion

This routine sets the view's current movie.

Availability

Available in Mac OS X v10.3 and later.

Declared In

HIMovieView.h

MCActivate

Lets a controller respond to activate, deactivate, suspend, and resume events.

ComponentResult MCActivate (
   MovieController mc,
   WindowRef w,
   Boolean activate
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
w: A pointer to the window in which the event has occurred.
activate: The nature of the event. Set this parameter to TRUE for activate and resume events. Set it to FALSE for deactivate and suspend events.

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCAddMovieSegment

Undocumented

ComponentResult MCAddMovieSegment (
   MovieController mc,
   Movie srcMovie,
   Boolean scaled
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
srcMovie: The source movie. Your application obtains this movie identifier from such functions as NewMovie, NewMovieFromFile, or NewMovieFromHandle.
scaled: Undocumented

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Version Notes

Introduced in QuickTime 5.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCAdjustCursor

Undocumented

ComponentResult MCAdjustCursor (
   MovieController mc,
   WindowRef w,
   Point where,
   long modifiers
);

Parameters

mc

The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.

w

A pointer to the window in which the cursor is located.

where

The location of the cursor. This value is expressed in the local coordinates of the window specified by the w parameter.

modifiers

The cursor form (see below). See these constants:

kQTCursorOpenHand
kQTCursorClosedHand
kQTCursorPointingHand
kQTCursorRightArrow
kQTCursorLeftArrow
kQTCursorDownArrow
kQTCursorUpArrow
kQTCursorIBeam

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCClear

Removes the current movie selection from the movie associated with a specified controller.

ComponentResult MCClear (
   MovieController mc
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCClick

Lets a controller respond when the user clicks in a movie controller window.

ComponentResult MCClick (
   MovieController mc,
   WindowRef w,
   Point where,
   long when,
   long modifiers
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
w: A pointer to the window in which the event has occurred.
where: The location of the click. This value is expressed in the local coordinates of the window specified by the w parameter. Your application must convert this value from the global coordinates returned in the EventRecord structure.
when: Indicates when the user pressed the mouse button. You obtain this value from the EventRecord structure.
modifiers: Specifies modifier flags for the event. You obtain this value from the EventRecord structure.

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCCopy

Returns a copy of the current movie selection from the movie associated with a specified controller.

Movie MCCopy (
   MovieController mc
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.

Return Value

A copy of the movie.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCCut

Returns a copy of the current movie selection from the movie associated with a specified controller and then removes the current movie selection from the source movie.

Movie MCCut (
   MovieController mc
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.

Return Value

A copy of the current movie selection.

Discussion

Your application is responsible for the returned movie. MCCut returns a movie containing the current selection from the movie associated with the specified controller. If the user has not made a selection, the returned movie reference is set to NIL.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCDoAction

Invokes a movie controller component and makes it perform a specified action.

ComponentResult MCDoAction (
   MovieController mc,
   short action,
   void *params
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
action: The action to be taken. See Movie Controller Actions.
params: A pointer to the parameter data appropriate to the action. See Movie Controller Actions for information about the parameters required for each supported action.

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCDraw

Responds to an update event.

ComponentResult MCDraw (
   MovieController mc,
   WindowRef w
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
w: A pointer to the window in which the update event has occurred.

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCDrawBadge

Displays a controller's badge.

ComponentResult MCDrawBadge (
   MovieController mc,
   RgnHandle movieRgn,
   RgnHandle *badgeRgn
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
movieRgn: The boundary region of the controller's movie.
badgeRgn: A pointer to a region that is to receive information about the location of the badge. The movie controller returns the region where the badge is displayed. If you are not interested in this information, you may set this parameter to NIL. Your application must dispose of this handle.

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Discussion

This function places the badge in an appropriate location based on the location of the controller's movie. MCDrawBadge can be useful in circumstances where you are using a movie controller component but do not want to incur the overhead of having the QuickTime movie in memory all the time. This function allows you to display the badge without having to display the movie. In addition, you can use the badge region to perform mouse-down event testing.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCEnableEditing

Enables and disables editing for a movie controller.

ComponentResult MCEnableEditing (
   MovieController mc,
   Boolean enabled
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
enabled: Specifies whether to enable or disable editing for the controller. Set this parameter to TRUE to enable editing; set it to FALSE to disable editing.

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Discussion

Once editing is enabled for a controller, the user may edit the movie associated with the controller.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCGetClip

Obtains information describing a movie controller's clipping regions.

ComponentResult MCGetClip (
   MovieController mc,
   RgnHandle *theClip,
   RgnHandle *movieClip
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
theClip: A pointer to a field that is to receive a handle to the clipping region of the entire movie controller. You must dispose of this region when you are done with it. If you are not interested in this information, set this parameter to NIL.
movieClip: A pointer to a field that is to receive a handle to the clipping region of the controller's movie. You must dispose of this region when you are done with it. If you are not interested in this information, set this parameter to NIL.

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCGetControllerBoundsRect

Returns a movie controller's boundary rectangle.

ComponentResult MCGetControllerBoundsRect (
   MovieController mc,
   Rect *bounds
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
bounds: A pointer to a Rect structure that is to receive the coordinates of the movie controller's boundary rectangle. If there is insufficient screen space to display the controller, the function may return an empty structure.

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCGetControllerBoundsRgn

Returns the actual region occupied by the controller and its movie.

RgnHandle MCGetControllerBoundsRgn (
   MovieController mc
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.

Return Value

A handle to a MacRegion structure that reflects the size, shape, and location of the controller. Your application must dispose of this structure.

Discussion

As with MCGetControllerBoundsRect, this function returns a region even if the controller is hidden. Some movie controllers may not be rectangular in shape. If the movie is not attached to its controller, the boundary region encloses only the control portion of the controller.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCGetControllerInfo

Determines the current status of a movie controller and its associated movie, for menu highlighting.

ComponentResult MCGetControllerInfo (
   MovieController mc,
   long *someFlags
);

Parameters

mc

The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.

someFlags

A pointer to flags (see below) that specify the current status and capabilities of the controller. More than one flag may be set to 1. See these constants:

mcInfoUndoAvailable
mcInfoCutAvailable
mcInfoCopyAvailable
mcInfoPasteAvailable
mcInfoClearAvailable
mcInfoHasSound
mcInfoIsPlaying
mcInfoIsLooping
mcInfoIsInPalindrome
mcInfoEditingEnabled

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Discussion

You can use the information returned by this function to control your application's menu highlighting.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCGetControllerPort

Returns a movie controller's color graphics port.

CGrafPtr MCGetControllerPort (
   MovieController mc
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.

Return Value

A pointer to the movie controller's CGrafPort structure.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCGetCurrentTime

Obtains the time value represented by the indicator on the movie controller's slider.

TimeValue MCGetCurrentTime (
   MovieController mc,
   TimeScale *scale
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
scale: A pointer to a field that is to receive the time scale for the controller.

Return Value

A time value containing the time shown by the indicator on the movie controller's slider.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCGetDoActionsProc

Retrieves the DoMCActionProc callback attached to a movie controller.

ComponentResult MCGetDoActionsProc (
   MovieController mc,
   DoMCActionUPP *doMCActionProc,
   long *doMCActionRefCon
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
doMCActionProc: A pointer to a DoMCActionProc callback.
doMCActionRefCon: A reference constant that is passed to your callback. This parameter may point to a data structure containing information your function needs.

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Version Notes

Introduced in QuickTime 4.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCGetIndMovie

Lets your application to retrieve the movie reference for a movie that is associated with a movie controller.

Movie MCGetIndMovie (
   MovieController mc,
   short index
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
index: Index for the movie. When set to 0, this call duplicates the action of the previous call to this function.

Return Value

The movie identifier for the movie that is assigned to the specified controller, or NIL if there is no movie assigned to the controller.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCGetInterfaceElement

Gets the interface element of a specified type for a movie controller.

ComponentResult MCGetInterfaceElement (
   MovieController mc,
   MCInterfaceElement whichElement,
   void *element
);

Parameters

mc

The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.

whichElement

A constant (see below) that identifies the interface element type. See these constants:

kMCIEEnabledButtonPicture
kMCIEDisabledButtonPicture
kMCIEDepressedButtonPicture
kMCIEEnabledSizeBoxPicture
kMCIEDisabledSizeBoxPicture
kMCIEEnabledUnavailableButtonPicture
kMCIEDisabledUnavailableButtonPicture
kMCIESoundSlider
kMCIESoundThumb

element

A pointer to the element type.

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCGetMenuString

Retrieves the text string for a movie controller menu command.

ComponentResult MCGetMenuString (
   MovieController mc,
   long modifiers,
   short item,
   Str255 aString
);

Parameters

mc

The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.

modifiers

The current modifiers from the mouse-down or key-down event to which you are responding.

item

One of the movie controller Edit menu constants (see below). See these constants:

mcMenuUndo
mcMenuCut
mcMenuCopy
mcMenuPaste
mcMenuClear

aString

On entry, pass a string of type Str255; on exit, this string is set to the text of the menu item specified by the item parameter.

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Discussion

MCGetMenuString is used by MCSetUpEditMenu.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCGetVisible

Returns a value that indicates whether or not a movie controller is visible.

ComponentResult MCGetVisible (
   MovieController mc
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.

Return Value

If the controller is visible, the function result is set to 1. If the controller is not showing, the function result is set to 0. You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError. See Error Codes.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCGetWindowRgn

Determines the window region that is actually in use by a controller and its movie.

RgnHandle MCGetWindowRgn (
   MovieController mc,
   WindowRef w
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
w: A pointer to the window in which the movie controller and its movie are displayed, if the control portion of the controller is attached to the movie. If the controller is detached and in a separate window from the movie, specify one of the windows.

Return Value

A handle to the MacRegion structure for the window that is actually in use. Your application must dispose of this structure.

Discussion

The region returned by this function contains only the visible portions of the controller and its movie.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCIdle

Performs idle processing for a movie controller.

ComponentResult MCIdle (
   MovieController mc
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCInvalidate

Invalidates a region of a movie controller's display.

ComponentResult MCInvalidate (
   MovieController mc,
   WindowRef w,
   RgnHandle invalidRgn
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
w: A pointer to the window in which the movie controller and its movie are displayed, if the control portion of the controller is attached to the movie. If the controller is detached and in a separate window from the movie, specify one of the windows.
invalidRgn: A handle to a MacRegion structure that defines a region to invalidate.

Return Value

You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError, as well as in the function result. See Error Codes.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCIsControllerAttached

Returns a value that indicates whether a movie controller is attached to its movie.

ComponentResult MCIsControllerAttached (
   MovieController mc
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.

Return Value

If the controller is attached, the returned value is set to 1. If the controller is not attached, the returned value is set to 0. You can access Movie Toolbox error returns through GetMoviesError and GetMoviesStickyError.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCIsEditingEnabled

Determines whether editing is currently enabled for a movie controller.

long MCIsEditingEnabled (
   MovieController mc
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.

Return Value

Returns 1 if editing is enabled; set to 0 if editing is disabled or if the controller component does not support editing.

Discussion

Once editing is enabled for a controller, the user may edit the movie associated with the controller.

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCIsPlayerEvent

Handles all events for a movie controller.

ComponentResult ADD_MEDIA_BASENAME() MCIsPlayerEvent

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from NewMovieController.
e: A pointer to the current EventRecord structure.

Return Value

A long integer indicating whether the movie controller component handled the event. The component sets this long integer to 1 if it handled the event. Your application should then skip the rest of its event loop and wait for the next event. The return value is 0 otherwise. Your application must then handle the event as part of its normal event processing.

Discussion

The movie controller component does everything necessary to support the movie controller and its associated movie. For example, the component calls MoviesTask for each movie. The movie controller component also handles suspend and resume events. It treats suspend events as deactivate requests and resume events as activate requests.

The following sample code shows how to convert Windows messages to Macintosh events and then pass those events to the QuickTime movie controller, using this function:

// MCIsPlayerEvent coding example

// See "Discovering QuickTime," page 240

MovieController   mc;                   // Movie controller for movie

LRESULT CALLBACK WndProc

        (HWND       hwnd,               // Handle to window

         UINT       iMsg,               // Message type

         WPARAM     wParam,             // Message-dependent parameter

         LPARAM     lParam)             // Message-dependent parameter

    MSG             msg;                // Windows message structure

    EventRecord     er;                 // Macintosh event record

    DWORD           dwPos;              // Mouse coordinates of message

    msg.hwnd        =hwnd;             // Window handle

    msg.message     =iMsg;             // Message type

    msg.wParam      =wParam;           // Word-length parameter

    msg.lParam      =lParam;           // Long-word parameter

    msg.time =GetMessageTime();        // Get time of message

    dwPos  =GetMessagePos();           // Get mouse position

    msg.pt.x =LOWORD(dwPos);           // Extract x coordinate

    msg.pt.y =HIWORD(dwPos);           // Extract y coordinate

    WinEventToMacEvent(&msg, &er);      // Convert to event

    MCIsPlayerEvent(mc, &er);           // Pass event to QuickTime

    switch (iMsg) {                     // Dispatch on message type

        . . .       // Handle message according to type

    }  // end switch (iMsg)

}  // end WndProc

Version Notes

Introduced in QuickTime 3 or earlier.

Availability

Available in Mac OS X v10.0 and later.

Declared In

Movies.h

MCKey

Handles keyboard events for a movie controller.

ComponentResult MCKey (
   MovieController mc,
   SInt8 key,
   long modifiers
);

Parameters

mc: The movie controller for the operation. You obtain this identifier from OpenComponent or OpenDefaultComponent, or from