Framework | Frameworks/QuickTime.framework |
Declared in | HIMovieView.h Movies.h OSTypes.h |
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.
MCClear
MCCopy
MCCut
MCEnableEditing
MCGetMenuString
MCIsEditingEnabled
MCPaste
MCSetUpEditMenu
MCUndo
MCDrawBadge
MCGetClip
MCGetControllerBoundsRect
MCGetControllerBoundsRgn
MCGetControllerPort
MCGetVisible
MCGetWindowRgn
MCIsControllerAttached
MCPositionController
MCSetClip
MCSetControllerAttached
MCSetControllerBoundsRect
MCSetControllerPort
MCSetVisible
DisposeMCActionFilterUPP
DisposeMCActionFilterWithRefConUPP
HIMovieViewChangeAttributes
HIMovieViewCreate
HIMovieViewGetAttributes
HIMovieViewGetControllerBarSize
HIMovieViewGetMovie
HIMovieViewGetMovieController
HIMovieViewPause
HIMovieViewPlay
HIMovieViewSetMovie
MCAddMovieSegment
MCAdjustCursor
MCGetDoActionsProc
MCGetInterfaceElement
MCInvalidate
MCRemoveAllMovies
MCRemoveAMovie
MCRemoveMovie
MCSetActionFilter
MCSetControllerCapabilities
MCTrimMovieSegment
NewMCActionFilterUPP
NewMCActionFilterWithRefConUPP
Disposes of a MCActionFilterUPP pointer.
void DisposeMCActionFilterUPP ( MCActionFilterUPP userUPP );
A MCActionFilterUPP
pointer. See Universal Procedure Pointers
.
You can access this function's error returns through GetMoviesError
and GetMoviesStickyError
.
Introduced in QuickTime 4.1.
Movies.h
Disposes of a MCActionFilterWithRefConUPP pointer.
void DisposeMCActionFilterWithRefConUPP ( MCActionFilterWithRefConUPP userUPP );
A MCActionFilterWithRefConUPP
pointer. See Universal Procedure Pointers
.
You can access this function's error returns through GetMoviesError
and GetMoviesStickyError
.
Introduced in QuickTime 4.1.
Movies.h
Changes the views attributes.
OSStatus HIMovieViewChangeAttributes ( HIViewRef inView, OptionBits inAttributesToSet, OptionBits inAttributesToClear );
The HIMovieView
.
Attributes to set.
Attributes to clear.
An error code. Returns noErr
if there is no error.
Setting an attribute takes precedence over clearing the attribute.
HIMovieView.h
Creates an HIMovieView object.
OSStatus HIMovieViewCreate ( Movie inMovie, OptionBits inAttributes, HIViewRef *outMovieView );
Initial movie to view; may be NULL.
Initial HIMovieView
attributes.
Points to variable to receive new HIMovieView
.
Undocumented.
If successful, the created view will have a single retain count.
HIMovieView.h
Returns the view's current attributes.
OptionBits HIMovieViewGetAttributes ( HIViewRef inView );
The HIMovieView
.
Undocumented.
The view's current attributes are returned.
HIMovieView.h
Returns the size of the visible movie controller bar.
HISize HIMovieViewGetControllerBarSize ( HIViewRef inView );
The HIMovieView
.
Undocumented.
The size of the visible movie controller bar is returned.
HIMovieView.h
Returns the view's current movie.
Movie HIMovieViewGetMovie ( HIViewRef inView );
The HIMovieView
.
Undocumented.
The view's current movie is returned.
HIMovieView.h
Returns the view's current movie controller.
MovieController HIMovieViewGetMovieController ( HIViewRef inView );
The HIMovieView
.
Undocumented.
The view's current movie controller is returned.
HIMovieView.h
Pauses the view's current movie.
OSStatus HIMovieViewPause ( HIViewRef movieView );
The movie view.
An error code. Returns noErr
if there is no error.
This is a convenience routine to pause the view's current movie. If the movie is already paused, this function does nothing.
HIMovieView.h
Plays the view's current movie.
OSStatus HIMovieViewPlay ( HIViewRef movieView );
The movie view.
An error code. Returns noErr
if there is no error.
This is a convenience routine to play the view's current movie. If the movie is already playing, this function does nothing.
HIMovieView.h
Sets the view's current movie.
OSStatus HIMovieViewSetMovie ( HIViewRef inView, Movie inMovie );
The HIMovieView
.
The new movie to display.
An error code. Returns noErr
if there is no error.
This routine sets the view's current movie.
HIMovieView.h
Lets a controller respond to activate, deactivate, suspend, and resume events.
ComponentResult MCActivate ( MovieController mc, WindowRef w, Boolean activate );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A pointer to the window in which the event has occurred.
The nature of the event
. Set this parameter to TRUE for activate and resume events. Set it to FALSE for deactivate and suspend events.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Undocumented
ComponentResult MCAddMovieSegment ( MovieController mc, Movie srcMovie, Boolean scaled );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
The source movie. Your application obtains this movie identifier from such functions as NewMovie
, NewMovieFromFile
, or NewMovieFromHandle
.
Undocumented
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 5.
Movies.h
Undocumented
ComponentResult MCAdjustCursor ( MovieController mc, WindowRef w, Point where, long modifiers );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A pointer to the window in which the cursor is located.
The location of the cursor. This value is expressed in the local coordinates of the window specified by the w
parameter.
The cursor form (see below). See these constants:
kQTCursorOpenHand
kQTCursorClosedHand
kQTCursorPointingHand
kQTCursorRightArrow
kQTCursorLeftArrow
kQTCursorDownArrow
kQTCursorUpArrow
kQTCursorIBeam
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Removes the current movie selection from the movie associated with a specified controller.
ComponentResult MCClear ( MovieController mc );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
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 );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A pointer to the window in which the event has occurred.
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.
Indicates when the user pressed the mouse button. You obtain this value from the EventRecord
structure.
Specifies modifier flags for the event. You obtain this value from the EventRecord
structure.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Returns a copy of the current movie selection from the movie associated with a specified controller.
Movie MCCopy ( MovieController mc );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A copy of the movie.
Introduced in QuickTime 3 or earlier.
Movies.h
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 );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A copy of the current movie selection.
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
.
Introduced in QuickTime 3 or earlier.
Movies.h
Invokes a movie controller component and makes it perform a specified action.
ComponentResult MCDoAction ( MovieController mc, short action, void *params );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
The action to be taken. See Movie Controller Actions
.
A pointer to the parameter data appropriate to the action. See Movie Controller Actions
for information about the parameters required for each supported action.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Responds to an update event.
ComponentResult MCDraw ( MovieController mc, WindowRef w );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A pointer to the window in which the update event has occurred.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Displays a controller's badge.
ComponentResult MCDrawBadge ( MovieController mc, RgnHandle movieRgn, RgnHandle *badgeRgn );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
The boundary region of the controller's movie.
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.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
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.
Introduced in QuickTime 3 or earlier.
Movies.h
Enables and disables editing for a movie controller.
ComponentResult MCEnableEditing ( MovieController mc, Boolean enabled );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
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.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Once editing is enabled for a controller, the user may edit the movie associated with the controller.
Introduced in QuickTime 3 or earlier.
Movies.h
Obtains information describing a movie controller's clipping regions.
ComponentResult MCGetClip ( MovieController mc, RgnHandle *theClip, RgnHandle *movieClip );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
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
.
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
.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Returns a movie controller's boundary rectangle.
ComponentResult MCGetControllerBoundsRect ( MovieController mc, Rect *bounds );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
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.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Returns the actual region occupied by the controller and its movie.
RgnHandle MCGetControllerBoundsRgn ( MovieController mc );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A handle to a MacRegion
structure that reflects the size, shape, and location of the controller. Your application must dispose of this structure.
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.
Introduced in QuickTime 3 or earlier.
Movies.h
Determines the current status of a movie controller and its associated movie, for menu highlighting.
ComponentResult MCGetControllerInfo ( MovieController mc, long *someFlags );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
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
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
You can use the information returned by this function to control your application's menu highlighting.
Introduced in QuickTime 3 or earlier.
Movies.h
Returns a movie controller's color graphics port.
CGrafPtr MCGetControllerPort ( MovieController mc );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A pointer to the movie controller's CGrafPort
structure.
Introduced in QuickTime 3 or earlier.
Movies.h
Obtains the time value represented by the indicator on the movie controller's slider.
TimeValue MCGetCurrentTime ( MovieController mc, TimeScale *scale );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A pointer to a field that is to receive the time scale for the controller.
A time value containing the time shown by the indicator on the movie controller's slider.
Introduced in QuickTime 3 or earlier.
Movies.h
Retrieves the DoMCActionProc callback attached to a movie controller.
ComponentResult MCGetDoActionsProc ( MovieController mc, DoMCActionUPP *doMCActionProc, long *doMCActionRefCon );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A pointer to a DoMCActionProc
callback.
A reference constant that is passed to your callback. This parameter may point to a data structure containing information your function needs.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 4.
Movies.h
Lets your application to retrieve the movie reference for a movie that is associated with a movie controller.
Movie MCGetIndMovie ( MovieController mc, short index );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
Index for the movie. When set to 0, this call duplicates the action of the previous call to this function.
The movie identifier for the movie that is assigned to the specified controller, or NIL
if there is no movie assigned to the controller.
Introduced in QuickTime 3 or earlier.
Movies.h
Gets the interface element of a specified type for a movie controller.
ComponentResult MCGetInterfaceElement ( MovieController mc, MCInterfaceElement whichElement, void *element );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A constant (see below) that identifies the interface element type. See these constants:
kMCIEEnabledButtonPicture
kMCIEDisabledButtonPicture
kMCIEDepressedButtonPicture
kMCIEEnabledSizeBoxPicture
kMCIEDisabledSizeBoxPicture
kMCIEEnabledUnavailableButtonPicture
kMCIEDisabledUnavailableButtonPicture
kMCIESoundSlider
kMCIESoundThumb
A pointer to the element
type.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Retrieves the text string for a movie controller menu command.
ComponentResult MCGetMenuString ( MovieController mc, long modifiers, short item, Str255 aString );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
The current modifiers from the mouse-down or key-down event to which you are responding.
One of the movie controller Edit menu constants (see below). See these constants:
mcMenuUndo
mcMenuCut
mcMenuCopy
mcMenuPaste
mcMenuClear
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.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
MCGetMenuString
is used by MCSetUpEditMenu
.
Introduced in QuickTime 3 or earlier.
Movies.h
Returns a value that indicates whether or not a movie controller is visible.
ComponentResult MCGetVisible ( MovieController mc );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
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
.
Introduced in QuickTime 3 or earlier.
Movies.h
Determines the window region that is actually in use by a controller and its movie.
RgnHandle MCGetWindowRgn ( MovieController mc, WindowRef w );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
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.
A handle to the MacRegion
structure for the window that is actually in use. Your application must dispose of this structure.
The region returned by this function contains only the visible portions of the controller and its movie.
Introduced in QuickTime 3 or earlier.
Movies.h
Performs idle processing for a movie controller.
ComponentResult MCIdle ( MovieController mc );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Invalidates a region of a movie controller's display.
ComponentResult MCInvalidate ( MovieController mc, WindowRef w, RgnHandle invalidRgn );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
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.
A handle to a MacRegion
structure that defines a region to invalidate.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Returns a value that indicates whether a movie controller is attached to its movie.
ComponentResult MCIsControllerAttached ( MovieController mc );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
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
.
Introduced in QuickTime 3 or earlier.
Movies.h
Determines whether editing is currently enabled for a movie controller.
long MCIsEditingEnabled ( MovieController mc );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
Returns 1 if editing is enabled; set to 0 if editing is disabled or if the controller component does not support editing.
Once editing is enabled for a controller, the user may edit the movie associated with the controller.
Introduced in QuickTime 3 or earlier.
Movies.h
Handles all events for a movie controller.
ComponentResult ADD_MEDIA_BASENAME() MCIsPlayerEvent
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A pointer to the current EventRecord
structure.
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.
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 |
Introduced in QuickTime 3 or earlier.
Movies.h
Handles keyboard events for a movie controller.
ComponentResult MCKey ( MovieController mc, SInt8 key, long modifiers );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
The keystroke. You obtain this value from the event structure.
Modifier flags for the event. You obtain this value from the EventRecord
structure.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Informs a movie controller component that your application has used the Movie Toolbox to change the characteristics of its associated movie.
ComponentResult MCMovieChanged ( MovieController mc, Movie m );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
The movie that has been changed.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Associates a specified movie with a movie controller.
ComponentResult MCNewAttachedController ( MovieController mc, Movie theMovie, WindowRef w, Point where );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
The movie to be associated with the movie controller.
A pointer to the window in which the movie is to be displayed. The movie controller component sets the movie's graphics world to match this window. If you set the w
parameter to NIL
, the component uses the current window.
The upper-left corner of the movie within the window specified by the w
parameter. The movie controller component uses the movie's boundary Rect
structure to determine the size of the movie. GetMovieBox
returns this structure.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Inserts a specified movie at the current movie time in the movie associated with a specified controller.
ComponentResult MCPaste ( MovieController mc, Movie srcMovie );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
The movie to be inserted into the current selection in the movie associated with the movie controller specified by the mc
parameter. If you set this parameter to NIL
, the movie controller component retrieves the source movie from the scrap.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Controls the position of a movie and its controller on the computer display.
ComponentResult MCPositionController ( MovieController mc, const Rect *movieRect, const Rect *controllerRect, long someFlags );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A pointer to a Rect
structure that specifies the coordinates of the movie's boundary Rect
structure.
A pointer to a Rect
structure that specifies the coordinates of the controller's boundary Rect
structure. The movie controller component always centers the control portion of the controller inside this rectangle. The movie controller component only uses this parameter when the control portion of the controller is detached from the movie. If you are working with an attached controller, you can set this parameter to NIL
.
Flags (see below) that control how the movie is drawn. If you set these flags to 0, the movie controller component centers the movie in the rectangle specified by movieRect
and scales the movie to fit in that rectangle. See these constants:
mcTopLeftMovie
mcScaleMovieToFit
mcPositionDontInvalidate
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Reports whether a point is in the control area of a movie.
ComponentResult MCPtInController ( MovieController mc, Point thePt, Boolean *inController );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
The point to be checked. This point must be passed in local coordinates to the controller's window. This point is checked only against the movie controller's controls, not the movie itself.
Returns true if the point is in the controller; false if it is not.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
While you could always determine if a point is contained in a movie, using PtInMovie
, the MCPtInController
function allows you to determine if a point is in the control area of a movie.
Introduced in QuickTime 3 or earlier.
Movies.h
Removes all movies associated with a controller.
ComponentResult MCRemoveAllMovies ( MovieController mc );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Removes one movie from a multi-movie controller.
ComponentResult MCRemoveAMovie ( MovieController mc, Movie m );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
The movie for this operation. Your application obtains this movie identifier from such functions as NewMovie
, NewMovieFromFile
, or NewMovieFromHandle
.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Removes a movie from a movie controller.
ComponentResult MCRemoveMovie ( MovieController mc );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Sets the MCActionFilterProc callback for a movie controller.
ComponentResult MCSetActionFilter ( MovieController mc, MCActionFilterUPP blob );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A Universal Procedure Pointer to an MCActionFilterProc
callback.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Establishes an action filter function for a movie controller.
ComponentResult MCSetActionFilterWithRefCon ( MovieController mc, MCActionFilterWithRefConUPP blob, long refCon );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A pointer to your MCActionFilterWithRefConProc
callback. Set this parameter to NIL
to remove an existing callback.
A reference constant value. The movie controller component passes this reference constant to your action filter callback each time it calls it. Use this parameter to point to a data structure containing any information your callback needs.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
The movie controller component calls your action filter function each time the component receives an action for its movie controller. Your filter function is then free to handle the action or to refer it back to the movie controller component. If you refer it back to the movie controller component, the component handles the action.
If your filter function handles an action, you can handle the action in any way you desire. For example, your filter function could change the operation of movie controller buttons. More commonly, applications use the action filter function to monitor actions of the controller. For instance, your filter function might enable you to find out when the user clicks the play button, so that your application can enable appropriate menu selections. Alternatively, you can use the filter function to detect when the user resizes the movie.
Introduced in QuickTime 3 or earlier.
Movies.h
Lets you set a movie controller's clipping region.
ComponentResult MCSetClip ( MovieController mc, RgnHandle theClip, RgnHandle movieClip );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A handle to a region that defines the controller's clipping region. This clipping region affects the entire movie controller and its movie, including the controller's badge and associated controls. Set this parameter to NIL
to clear the controller's clipping region.
A handle to a region that defines the clipping region of the controller's movie. This clipping region affects only the movie and the badge, not the movie controller. Set this parameter to NIL
to clear the movie clipping region.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Lets your application control whether a movie controller is attached to its movie or detached from it.
ComponentResult MCSetControllerAttached ( MovieController mc, Boolean attach );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
The action for this function. Set the attach
parameter to TRUE to cause the controller to be attached to its movie. Set this parameter to FALSE to detach the controller from its movie.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Lets you change the position and size of a movie controller.
ComponentResult MCSetControllerBoundsRect ( MovieController mc, const Rect *bounds );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A pointer to a Rect
structure that contains the new boundary Rect
structure for the movie controller.
See Error Codes
. Returns a value of controllerBoundsNotExact
if the boundary rectangle has been changed but does not correspond to the rectangle you specified. In this case, the new boundary rectangle is always smaller than the requested rectangle. Returns noErr
if there is no error.
Introduced in QuickTime 3 or earlier.
Movies.h
Undocumented
ComponentResult MCSetControllerCapabilities ( MovieController mc, long flags, long flagsMask );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
Undocumented
Undocumented
See Error Codes
. Returns noErr
if there is no error.
Introduced in QuickTime 6.
Movies.h
Lets your application set the graphics port for a movie controller.
ComponentResult MCSetControllerPort ( MovieController mc, CGrafPtr gp );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A pointer to the new graphics port for the movie controller. Set this parameter to NIL
to use the current graphics port.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Movie controller components use MCSetControllerPort
each time you create a new movie controller. Hence, your component must be set to a valid port before creating a new movie controller. You can use this function to place a movie and its associated movie controller in different graphics ports. If you are using an attached controller, both the controller and the movie's graphics ports are changed. If you are using a detached controller, this function changes only the graphics port of the control portion of the controller. You must use SetMovieGWorld
followed by MCMovieChanged
to change other portions.
pascal ComponentResult MCSetControllerPort (MovieController mc, |
CGrafPtr gp); |
The movie controller component may use the foreground and background colors from the graphics port at the time this function is called to colorize the movie controller.
Introduced in QuickTime 3 or earlier.
Movies.h
Lets your application set a controller's duration in the case where a controller does not have a movie associated with it.
ComponentResult MCSetDuration ( MovieController mc, TimeValue duration );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
The new duration for the movie. This duration value must be in the controller's time scale.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Lets a movie controller component report its idling needs.
ComponentResult MCSetIdleManager ( MovieController mc, IdleManager im );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A pointer to an opaque data structure that belongs to the Mac OS Idle Manager. You get this pointer by calling QTIdleManagerOpen
.
See Error Codes
. Returns noErr
if there is no error.
Introduced in QuickTime 6.
Movies.h
Associates a movie with a specified movie controller.
ComponentResult MCSetMovie ( MovieController mc, Movie theMovie, WindowRef movieWindow, Point where );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
The movie to be associated with the movie controller. Set this value to NIL
to remove the movie from the controller.
The window in which the movie is to be displayed. The movie controller component sets the movie's graphics world to match this window. If you set the w
parameter to NIL
, the component uses the current window.
The upper-left corner of the movie within the window specified by the movieWindow
parameter. The movie controller component uses the movie's boundary Rect
structure to determine the size of the movie. GetMovieBox
returns this structure.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Correctly highlights and names the items in your application's Edit menu.
ComponentResult MCSetUpEditMenu ( MovieController mc, long modifiers, MenuRef mh );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
The current modifiers from the mouse-down or key-down event to which you are responding.
A menu handler for your current Edit menu. The first six items in your Edit menu should be the standard editing commands: Undo, a blank line, Cut, Copy, Paste, and Clear.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Lets your application control the visibility of a movie controller.
ComponentResult MCSetVisible ( MovieController mc, Boolean visible );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
Set to TRUE to cause the controller to be visible, or FALSE to make the controller invisible.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Undocumented
ComponentResult MCTrimMovieSegment ( MovieController mc );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 5.
Movies.h
Lets your application discard the effects of the most recent edit operation.
ComponentResult MCUndo ( MovieController mc );
The movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
You can access Movie Toolbox error returns through GetMoviesError
and GetMoviesStickyError
, as well as in the function result. See Error Codes
.
Introduced in QuickTime 3 or earlier.
Movies.h
Allocates a Universal Procedure Pointer for the MCActionFilterProc callback.
MCActionFilterUPP NewMCActionFilterUPP ( MCActionFilterProcPtr userRoutine );
A pointer to your application-defined function.
A new UPP; see Universal Procedure Pointers
.
This function is used with Macintosh PowerPC systems. See Inside Macintosh: PowerPC System Software.
Introduced in QuickTime 4.1. Replaces NewMCActionFilterProc
.
Movies.h
Allocates a Universal Procedure Pointer for the MCActionFilterWithRefConProc callback.
MCActionFilterWithRefConUPP NewMCActionFilterWithRefConUPP ( MCActionFilterWithRefConProcPtr userRoutine );
A pointer to your application-defined function.
A new UPP; see Universal Procedure Pointers
.
This function is used with Macintosh PowerPC systems. See Inside Macintosh: PowerPC System Software.
Introduced in QuickTime 4.1. Replaces NewMCActionFilterWithRefConProc
.
Movies.h
Responds to movie controller actions.
typedef Boolean (*MCActionFilterProcPtr) (MovieController mc, short *action, void *params);
If you name your function MyMCActionFilterProc
, you would declare it this way:
Boolean MyMCActionFilterProc ( MovieController mc, short *action, void *params );
Specifies the movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A movie controller action. For a list of actions, see Chapter 2 of Inside Macintosh: QuickTime Components.
A pointer to a structure, such as QTStatusStringRecord
or ResolvedQTEventSpec
, that passes information to the callback. See Movies.h
.
Undocumented
Movie controller components allow your application to field movie controller actions. You define an MCActionFilterProc
in your application and assign it to a controller by calling the MCSetActionFilterWithRefCon
function.
Movies.h, HIMovieView.h
Responds to movie controller actions with a reference constant.
typedef Boolean (*MCActionFilterWithRefConProcPtr) (MovieController mc, short action, void *params, long refCon);
If you name your function MyMCActionFilterWithRefConProc
, you would declare it this way:
Boolean MyMCActionFilterWithRefConProc ( MovieController mc, short action, void *params, long refCon );
Specifies the movie controller for the operation. You obtain this identifier from OpenComponent
or OpenDefaultComponent
, or from NewMovieController
.
A movie controller action. For a list of actions, see Chapter 2 of Inside Macintosh: QuickTime Components.
A pointer to a structure, such as QTStatusStringRecord
, that passes information to the callback. See Movies.h
.
A reference constant that the client code supplies to your callback. You can use this reference to point to a data structure containing any information your callback needs.
Undocumented
Movies.h, HIMovieView.h
Represents a type used by the Movie Controller API.
typedef STACK_UPP_TYPE(MCActionFilterProcPtr) MCActionFilterUPP;
Movies.h
Represents a type used by the Movie Controller API.
typedef STACK_UPP_TYPE(MCActionFilterWithRefConProcPtr) MCActionFilterWithRefConUPP;
Movies.h
Represents a type used by the Movie Controller API.
typedef unsigned long MCInterfaceElement;
Movies.h
Represents a type used by the Movie Controller API.
typedef UInt32 OptionBits;
OSTypes.h
Constants that represent options for movie controllers.
enum { kMCIEEnabledButtonPicture = 1, kMCIEDisabledButtonPicture = 2, kMCIEDepressedButtonPicture = 3, kMCIEEnabledSizeBoxPicture = 4, kMCIEDisabledSizeBoxPicture = 5, kMCIEEnabledUnavailableButtonPicture = 6, kMCIEDisabledUnavailableButtonPicture = 7, kMCIESoundSlider = 128, kMCIESoundThumb = 129, kMCIEColorTable = 256, kMCIEIsFlatAppearance = 257, kMCIEDoButtonIconsDropOnDepress = 258 }; enum { mcFlagSuppressMovieFrame = 1 << 0, mcFlagSuppressStepButtons = 1 << 1, mcFlagSuppressSpeakerButton = 1 << 2, mcFlagsUseWindowPalette = 1 << 3, mcFlagsDontInvalidate = 1 << 4, mcFlagsUseCustomButton = 1 << 5 }; enum { mcInfoUndoAvailable = 1 << 0, mcInfoCutAvailable = 1 << 1, mcInfoCopyAvailable = 1 << 2, mcInfoPasteAvailable = 1 << 3, mcInfoClearAvailable = 1 << 4, mcInfoHasSound = 1 << 5, mcInfoIsPlaying = 1 << 6, mcInfoIsLooping = 1 << 7, mcInfoIsInPalindrome = 1 << 8, mcInfoEditingEnabled = 1 << 9, mcInfoMovieIsInteractive = 1 << 10 };
kMCIESoundThumb
The indicator on the sound slider.
Available in Mac OS X v10.0 and later.
Declared in Movies.h
.
mcFlagSuppressMovieFrame
If this flag is set to 1, the controller does not display a frame around the movie. By default, this flag is set to 0.
Available in Mac OS X v10.0 and later.
Declared in Movies.h
.
mcFlagSuppressStepButtons
If this flag is set to 1, the controller does not display the step buttons. By default, this flag is set to 0.
Available in Mac OS X v10.0 and later.
Declared in Movies.h
.
mcFlagSuppressSpeakerButton
If this flag is set to 1, the controller does not display the speaker button. By default, this flag is set to 0.
Available in Mac OS X v10.0 and later.
Declared in Movies.h
.
mcFlagsUseWindowPalette
If this flag is set to 1, the movie controller does not manage the window palette. This ensures that a movie's colors are reproduced as accurately as possible. This flag is particularly useful for movies with custom color tables. By default, this flag is set to 0.
Available in Mac OS X v10.0 and later.
Declared in Movies.h
.
Movies.h, HIMovieView.h
Constants passed to MCAdjustCursor.
enum { kQTCursorOpenHand = -19183, kQTCursorClosedHand = -19182, kQTCursorPointingHand = -19181, kQTCursorRightArrow = -19180, kQTCursorLeftArrow = -19179, kQTCursorDownArrow = -19178, kQTCursorUpArrow = -19177, kQTCursorIBeam = -19176 };
Movies.h, HIMovieView.h
Constants passed to MCGetMenuString.
enum { mcMenuUndo = 1, mcMenuCut = 3, mcMenuCopy = 4, mcMenuPaste = 5, mcMenuClear = 6 };
Movies.h, HIMovieView.h
Constants passed to MCPositionController.
enum { mcPositionDontInvalidate = 1 << 5 };
Movies.h, HIMovieView.h
© 2006 Apple Computer, Inc. All Rights Reserved. (Last updated: 2006-05-23)