Next Page > Hide TOC

QTMovie Class Reference

Overview

The QTMovie class represents both a QuickTime movie and a movie controller. A movie is a collection of playable and editable media content. It describes the sources and types of the media in that collection and their spatial and temporal organization. These collections may be used for presentation (such as playback on the screen) or for the organization of media for processing (such as composition and transcoding to a different compression type). The collection may be as simple as a single file that plays at its natural size for its intrinsic duration, or it may be very complex (with multiple sources of content, rich composition rules, interactivity, and a variety of contingencies).

Just as a QuickTime movie contains a set of tracks, each of which defines the type, the segments, and the ordering of the media data it presents, a QTMovie object is associated with instances of the QTTrack class. In turn, a QTTrack object is associated with a single QTMedia object.

A QTMovie object can be initialized from a file, from a resource specified by a URL, from a block of memory, from a pasteboard, or from an existing QuickTime movie.

Once a QTMovie object has been initialized, it will typically be used in combination with a QTMovieView for playback.

An exception, QTMovieUneditableException, is raised whenever the client attempts to directly or indirectly edit a QTMovie object that is not currently set as editable (for instance, by calling appendSelectionFromMovie: on an uneditable movie).

Tasks

Determining If a Movie Can Be Initialized

• + canInitWithFile:
• + canInitWithURL:
• + canInitWithPasteboard:
• + canInitWithDataReference:
• – initWithPasteboard:error:

Getting a List of Supported File Types

• + movieFileTypes:
• + movieTypesWithOptions:
• + movieUnfilteredFileTypes
• + movieUnfilteredPasteboardTypes

Creating a Movie

• + movie
• + movieNamed:error:
• + movieWithData:error:
• + movieWithURL:error:
• + movieWithPasteboard:error:
• + movieWithFile:error:
• + movieWithDataReference:error:
• + movieWithQuickTimeMovie:disposeWhenDone:error:
• + movieWithAttributes:error:

Controlling Movie Playback

• – autoplay
• – play
• – stop
• – gotoBeginning
• – gotoEnd
• – gotoNextSelectionPoint
• – gotoPreviousSelectionPoint
• – gotoPosterFrame
• – setCurrentTime:
• – stepForward
• – stepBackward

Managing Threaded Operations of Movie Objects

• + enterQTKitOnThread
• + enterQTKitOnThreadDisablingThreadSafetyProtection
• + exitQTKitOnThread
• – attachToCurrentThread
• – detachFromCurrentThread

Initializing a QTMovie

• – initWithFile:error:
• – initWithURL:error:
• – initWithData:error:
• – initWithDataReference:error:
• – initWithMovie:timeRange:error:
• – initWithQuickTimeMovie:disposeWhenDone:error:
• – initWithAttributes:error:

Getting Information About a Movie and Its Chapters

• – hasChapters
• – chapterCount
• – chapters
• – addChapters
• – removeChapters
• – startTimeOfChapter:
• – chapterIndexForTime:

Inspecting Movie Properties

• – duration
• – currentTime
• – rate
• – volume
• – muted
• – movieWithTimeRange:error:
• – attributeForKey:
• – movieAttributes

Managing QTMovie Idling States

• – setIdling:
• – isIdling

Setting QTMovie Properties

• – setRate:
• – setVolume:
• – setMuted:

Setting Movie Attributes

• – setAttribute:forKey:
• – setMovieAttributes:

Supporting Aperture Modes

• – generateApertureModeDimensions
• – removeApertureModeDimensions

Getting and Setting Selection Times

• – selectionStart
• – selectionEnd
• – selectionDuration
• – setSelection:

Getting Movie Tracks

• – tracks
• – tracksOfMediaType:

Getting Movie Images

• – posterImage
• – currentFrameImage
• – frameImageAtTime:
• – frameImageAtTime:withAttributes:error:

Storing Movie Data

• – initToWritableDataReference:error:
• – initToWritableFile:error:
• – initToWritableData:error:
• – movieFormatRepresentation
• – writeToFile:withAttributes:
• – writeToFile:withAttributes:error:

Editing a Movie

• – replaceSelectionWithSelectionFromMovie:
• – appendSelectionFromMovie:
• – insertSegmentOfMovie:timeRange:atTime:
• – insertSegmentOfMovie:fromRange:scaledToRange:
• – insertEmptySegmentAt:
• – deleteSegment:
• – scaleSegment:newDuration:
• – addImage:forDuration:withAttributes:

Saving a Movie

• – canUpdateMovieFile
• – updateMovieFile

Getting QTMovie Primitives

• – quickTimeMovie
• – quickTimeMovieController

Getting and Setting QTMovie Delegates

• – delegate
• – setDelegate:
• – externalMovie:  delegate method
• – movieShouldTask:  delegate method
• – movie:shouldContinueOperation:withPhase:atPercent:withAttributes:  delegate method
• – movie:linkToURL:  delegate method

Class Methods

canInitWithDataReference:

Returns YES if the specified data reference can be used to initialize a QTMovie object.

+ (BOOL)canInitWithDataReference:(QTDataReference*)dataReference

Availability

• Available in Mac OS X v10.3 and later.

Declared In

canInitWithFile:

Returns YES if the contents of the specified file can be used to initialize a QTMovie object.

+ (BOOL)canInitWithFile:(NSString *)fileName

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTAudioExtractionPanel
• QTKitAdvancedDocument
• QTKitFrameStepper
• QTKitImport
• QTKitPlayer

Declared In

canInitWithPasteboard:

Returns YES if the contents of the specified pasteboard can be used to initialize a QTMovie object.

+ (BOOL)canInitWithPasteboard:(NSPasteboard *)pasteboard

Availability

• Available in Mac OS X v10.3 and later.

Declared In

canInitWithURL:

Returns YES if the contents of the specified URL can be used to initialize a QTMovie object.

+ (BOOL)canInitWithURL:(NSURL *)url

Availability

• Available in Mac OS X v10.3 and later.

Declared In

enterQTKitOnThread

Performs any QuickTime-specific initialization for the current (non-main) thread; must be paired with a call to exitQTKitOnThread.

+ (void)enterQTKitOnThread

Availability

• Mac OS X v10.5 and later.

Declared In

enterQTKitOnThreadDisablingThreadSafetyProtection

Performs any QuickTime-specific initialization for the current (non-main) thread, allowing non-threadsafe components; must be paired with a call to exitQTKitOnThread.

+ (void)enterQTKitOnThreadDisablingThreadSafetyProtection

Availability

• Mac OS X v10.5 and later.

Related Sample Code

• QTKitThreadedExport

Declared In

exitQTKitOnThread

Performs any QuickTime-specific shut-down for the current (non-main) thread; must be paired with a call to enterQTKitOnThread or enterQTKitOnThreadDisablingThreadSafetyProtection.

+ (void)exitQTKitOnThread

Availability

• Mac OS X v10.5 and later.

Related Sample Code

• QTKitThreadedExport

Declared In

movie

Creates an empty QTMovie object.

+ (id)movie

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTAudioExtractionPanel
• QTKitImport
• QTKitMovieShuffler
• QTKitPlayer

Declared In

movieFileTypes:

Returns an array of file types that can be opened as QuickTime movies.

+ (NSArray *)movieFileTypes:(QTMovieTypeOptions)types

Discussion

Passing zero as the options parameter returns an array of all the common file types that QuickTime can open in place on the current system. This array includes the file type .mov and .mqv, and any files types that can be opened using a movie importer that does not need to write data into a new file while performing the import. This array excludes any file types for still images and any file types that require an aggressive movie importer (for instance, the movie importer for text files). The following values can be used to include some or all of the file types that are normally excluded:

enum {

    QTIncludeStillImageTypes  =  1 << 0,

    QTIncludeTranslatableTypes =  1 << 1,

    QTIncludeAggressiveTypes =  1 << 2,

    QTIncludeCommonTypes = 0,

    QTIncludeAllTypes = 0xffff

} QTMovieFileTypeOptions;

Related Sample Code

• LiveVideoMixer2
• LiveVideoMixer3
• QTKitAdvancedDocument

Declared In

movieNamed:error:

Creates a QTMovie object initialized with the data from the QuickTime movie of the specified name in the application’s bundle.

+ (id)movieNamed:(NSString *)name error:(NSError **)errorPtr

Discussion

If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• CALayerEssentials

Declared In

movieTypesWithOptions:

Returns an array of UTIs that QuickTime can open.

+ (NSArray *)movieTypesWithOptions:(QTMovieFileTypeOptions)types

Discussion

This method gets an array of NSString objects that specify the uniform type identifiers (UTIs) for types of files that QuickTime can open. The types parameter is interpreted just like the types parameter to + (NSArray *)movieFileTypes:(QTMovieFileTypeOptions)types.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

movieUnfilteredFileTypes

Returns an array of file types that can be used to initialize a QTMovie object.

+ (NSArray *)movieUnfilteredFileTypes

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTCoreImage101
• QTCoreVideo103
• QTCoreVideo202
• QTKitMovieFrameImage
• QTKitMovieShuffler

Declared In

movieUnfilteredPasteboardTypes

Returns an array of pasteboard types that can be used to initialize a QTMovie object.

+ (NSArray *)movieUnfilteredPasteboardTypes

Availability

• Available in Mac OS X v10.3 and later.

Declared In

movieWithAttributes:error:

Creates a QTMovie object initialized with the attributes specified in attributes.

+ (id)movieWithAttributes:(NSDictionary *)attributes error:(NSError **)errorPtr

Discussion

If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

A new QTMovie object is created using the specified attributes. There are three types of attributes that can be included in this dictionary:

• Attributes that specify the location of the movie data

• Attributes that specify how the movie is to be instantiated

• Attributes that specify playback characteristics of the movie or other properties of the QTMovie object

The following is a list of the keys that specify the location of the movie data; at least one of these must occur in the dictionary. If more than one occurs, the first one in the dictionary is used.

The following is a list of the keys that specify movie instantiation options; none of these keys is required. If a key is missing, the specified default value is used.

The following is a list of the new keys that specify movie playback characteristics or other properties of the QTMovie object; most other existing movie attributes can be included as well.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

movieWithData:error:

Creates a QTMovie object initialized with the data specified by data.

+ (id)movieWithData:(NSData *)data error:(NSError **)errorPtr

Discussion

If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTKitCreateMovie
• QTKitFrameStepper
• QTKitImport

Declared In

movieWithDataReference:error:

Creates a QTMovie object intitalized with the data specified by the data reference dataReference.

+ (id)movieWithDataReference:(QTDataReference *)dataReference error:(NSError **)errorPtr

Discussion

If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

movieWithFile:error:

Creates a QTMovie object initialized with the data in the file specified by the name fileName.

+ (id)movieWithFile:(NSString *)fileName error:(NSError **)errorPtr

Discussion

The fileName is assumed to be a full path name for a file.

If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTAudioExtractionPanel
• QTKitCommandLine
• QTKitMovieFrameImage
• QTKitPlayer
• SillyFrequencyLevels

Declared In

movieWithPasteboard:error:

Creates a QTMovie object initialized with the contents of the pasteboard specified by pasteboard.

+ (id)movieWithPasteboard:(NSPasteboard *)pasteboard error:(NSError **)errorPtr

Discussion

These contents can be a QuickTime movie (of type Movie), a file path, or data of type QTMoviePasteboardType.

If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

movieWithQuickTimeMovie:disposeWhenDone:error:

Creates a QTMovie object initialized with the data from an existing QuickTime movie movie.

+ (id)movieWithQuickTimeMovie:(Movie)movie disposeWhenDone:(BOOL)dispose error:(NSError **)errorPtr

Discussion

The dispose parameter (a BOOL) indicates whether the QTKit should call DisposeMovie on the specified movie when the QTMovie object is deallocated. Passing YES effectively transfers “ownership” of the Movie to the QTKit. (Note that most applications will probably want to pass YES; passing NO means that the application wants to call DisposeMovie itself, perhaps so that it can operate on a Movie after it has been disassociated with a QTMovie object.)

If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Note that command-line tools that pass NO for the disposeWhenDone parameter must make sure to release the active autorelease pool before calling DisposeMovie on the specified QuickTime movie. Failure to do this may result in a crash. Tools that need to call DisposeMovie before releasing the main autorelease pool can create another autorelease pool associated with the movie.

Availability

• Available in Mac OS X v10.3 and later.
• Not available to 64-bit applications.

Related Sample Code

• QTKitCreateMovie

Declared In

movieWithURL:error:

Creates a QTMovie object initialized with the data in the URL specified by url.

+ (id)movieWithURL:(NSURL *)url error:(NSError **)errorPtr

Discussion

If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTAudioExtractionPanel
• QTKitCreateMovie
• QTKitFrameStepper
• QTKitPlayer
• QTMetadataEditor

Declared In

Instance Methods

addChapters

Adds chapters to the receiver using the information specified in the chapters array. 

- (void)addChapters:(NSArray *)chapters withAttributes:(NSDictionary *)attributes error:(NSError **)errorPtr

Discussion

Each array element is an NSDictionary containing key-value pairs. Currently two keys are defined for this dictionary, QTMovieChapterName and QTMovieChapterStartTime. The value for the QTMovieChapterName key is an NSString object that is the chapter name. The value for the QTMovieChapterStartTime key is an NSValue object that wraps a QTTime structure that indicates the start time of the chapter. The receiving QTMovie object must be editable or an exception will be raised.

The attributes dictionary specifies additional attributes for the chapters. Currently only one key is recognized for this dictionary, QTMovieChapterTargetTrackAttribute, which specifies the QTTrack in the receiver that is the target of the chapters; if none is specified, this method uses first video track in movie. If no video track is in the movie, this method uses the first audio track in the movie. If no audio track is in the movie, this method uses the first track in the movie. If an error occurs and errorPtr is non-NULL, then an NSError object is returned in that location.

Availability

• Mac OS X v10.5 and later.

addImage:forDuration:withAttributes:

Adds an image for the specified duration to the receiver, using attributes specified in the attributes dictionary.

- (void)addImage:(NSImage *)image forDuration:(QTTime)duration withAttributes:(NSDictionary *)attributes

Discussion

Keys in the dictionary can be QTAddImageCodecType to select a codec type and QTAddImageCodecQuality to select a quality. Qualities are expected to be specified as NSNumbers, using the codec values like codecNormalQuality. (See ImageCompression.h for the complete list.) The attributes dictionary can also contain a value for the QTTrackTimeScaleAttribute key, which is used as the time scale of the new track, should one need to be created. The default time scale for a new track is 600.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• WritableFileDemo

Declared In

appendSelectionFromMovie:

Appends to a QTMovie the current selection in movie.

- (void)appendSelectionFromMovie:(id)movie

Discussion

If the movie is not editable, this method raises an exception.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

attachToCurrentThread

Attaches the receiver to the current thread; returns YES if successful, NO otherwise.

- (BOOL)attachToCurrentThread

Availability

• Mac OS X v10.5 and later.

Related Sample Code

• QTKitThreadedExport

Declared In

attributeForKey:

Returns the current value of the movie attribute attributeKey.

- (id)attributeForKey:(NSString *)attributeKey

Discussion

A list of supported movie attributes and their acceptable values can be found in the “Constants” section.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTCoreVideo201
• QTKitAdvancedDocument
• QTKitFrameStepper
• QTKitMovieShuffler
• QTKitTimeCode

Declared In

autoplay

Sets a movie to start playing when a sufficient amount of media data is available.

- (void)autoplay

Discussion

The autoplay method configures a QTMovie object to begin playing as soon as enough data is available that the playback can continue uninterrupted to the end of the movie. This is most useful for movies being loaded from a remote URL or from an extremely slow local device. For movies stored on most local devices, this method has the same effect as the -[QTMovie play] method.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

canUpdateMovieFile

Indicates whether a movie file can be updated with changes made to the movie object.

- (BOOL)canUpdateMovieFile

Discussion

This method returns NO if any of the following conditions are true:

• The movie is not associated with a file.

• The movie is not savable (has 'nsav' user data set to 1).

• The movie file is not writable.

• The movie file does not contain a movie atom (indicating that the movie was imported from a non-movie format).

Otherwise, the method returns YES.

Using this method, an application can check first to see if the movie file can be updated; if not, it can prompt the user for a new name and location of a file in which to save the updated movie.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

chapterCount

Returns the number of chapters in the receiver, or 0 if there are no chapters.

- (NSInteger)chapterCount

Availability

• Mac OS X v10.5 and later.

Declared In

chapterIndexForTime:

Returns the 0-based index of the chapter that contains the specified movie time.

- (NSInteger)chapterIndexForTime:(QTTime)time

Availability

• Mac OS X v10.5 and later.

Declared In

chapters

Returns an NSArray containing information about the chapters in the receiver.

- (NSArray *)chapters

Discussion

Each array element is an NSDictionary containing key-value pairs. Currently two keys are defined for this dictionary, QTMovieChapterName and QTMovieChapterStartTime. The value for the QTMovieChapterName key is an NSString object that is the chapter name. The value for the QTMovieChapterStartTime key is an NSValue object that wraps a QTTime structure that indicates the start time of the chapter.

Availability

• Mac OS X v10.5 and later.

Declared In

currentFrameImage

Returns an NSImage for the frame at the current time in a QTMovie.

- (NSImage *)currentFrameImage

Availability

• Available in Mac OS X v10.3 and later.

See Also

• – frameImageAtTime:
• – posterImage

Declared In

currentTime

Returns the current time of a QTMovie object as a structure of type QTTime.

- (QTTime)currentTime

Availability

• Available in Mac OS X v10.3 and later.

Declared In

delegate

Returns the delegate of a QTMovie object.

- (id)delegate

Availability

• Available in Mac OS X v10.3 and later.

Declared In

deleteSegment:

Deletes from a QTMovie the segment delimited by segment.

- (void)deleteSegment:(QTTimeRange)segment

Discussion

If the movie is not editable, this method raises an exception.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTKitCommandLine

Declared In

detachFromCurrentThread

Detaches the receiver from the current thread; returns YES if successful, NO otherwise.

- (BOOL)detachFromCurrentThread

Discussion

These methods allow applications to manage QTMovie objects on non-main threads. Before any QTKit operations can be performed on a secondary thread, either enterQTKitOnThread or enterQTKitOnThreadDisablingThreadSafetyProtection must be called, and exitQTKitOnThread must be called before exiting the thread. A QTMovie object can be migrated from one thread to another by first calling detachFromCurrentThread on the first thread and then attachToCurrentThread on the second thread.

Availability

• Mac OS X v10.5 and later.

Related Sample Code

• QTKitThreadedExport

Declared In

duration

Returns the duration of a QTMovie object as a structure of type QTTime.

- (QTTime)duration

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTKitCreateMovie
• QTKitMovieShuffler
• QTKitTimeCode

Declared In

frameImageAtTime:

Returns an NSImage for the frame at the time time in a QTMovie.

- (NSImage *)frameImageAtTime:(QTTime)time

Availability

• Available in Mac OS X v10.3 and later.

See Also

• – currentFrameImage
• – posterImage

Declared In

frameImageAtTime:withAttributes:error:

Returns an NSImage*, CIImage*, CGImageRef, CVPixelBufferRef, or CVOpenGLTextureRef for the movie image at the specified time

- (void *)frameImageAtTime:(QTTime)time withAttributes:(NSDictionary *)attributes error:(NSError **)errorPtr

Discussion

if an error occurs and the desired type of image cannot be created, then this returns nil and sets errorPtr to an NSError * describing the error. The dictionary of attributes can contain these keys:

• QTMovieFrameImageSize

• QTMovieFrameImageType

• QTMovieFrameImageRepresentationsType

• QTMovieFrameImageOpenGLContext

• QTMovieFrameImagePixelFormat

• QTMovieFrameImageInterlaced

• QTMovieFrameImageHighQuality

• QTMovieFrameImageSingleField

Availability

• Available in Mac OS X v10.5 and later.

Declared In

generateApertureModeDimensions

Adds information to a QTMovie needed to support aperture modes for tracks created with applications and/or versions of QuickTime that did not support aperture mode dimensions.

- (void)generateApertureModeDimensions

Discussion

If the image descriptions in video tracks lack tags describing clean aperture and pixel aspect ratio information, the media data is scanned to see if the correct values can be divined and attached. Then the aperture mode dimensions are calculated and set. Afterwards, the QTTrackHasApertureModeDimensionsAttribute property will be set to YES for those tracks. Tracks that do not support aperture modes are not changed.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

gotoBeginning

Repositions the play position to the beginning of the movie.

- (void)gotoBeginning

Discussion

If the movie is playing, the movie continues playing from the new position.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

gotoEnd

Repositions the play position to the end of the movie.

- (void)gotoEnd

Discussion

If the movie is playing in one of the looping modes, the movie continues playing accordingly; otherwise, play stops.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

gotoNextSelectionPoint

Repositions the movie to the next selection point.

- (void)gotoNextSelectionPoint

Availability

• Available in Mac OS X v10.3 and later.

Declared In

gotoPosterFrame

Repositions the play position to the movie’s poster time.

- (void)gotoPosterFrame

Discussion

If no poster time is defined, the movie jumps to the beginning. If the movie is playing, the movie continues playing from the new position.

gotoPreviousSelectionPoint

Repositions the movie to the previous selection point.

- (void)gotoPreviousSelectionPoint

Availability

• Available in Mac OS X v10.3 and later.

Declared In

hasChapters

Returns YES if the receiver has chapters, NO otherwise.

- (BOOL)hasChapters

Availability

• Mac OS X v10.5 and later.

Declared In

initToWritableData:error:

Useful for directly passing filenames and data objects. The QTMovie returned by this method is editable.

- (id)initToWritableData:(NSMutableData *)data error:(NSError **)errorPtr

Discussion

These methods––initToWritableDataReference:error:, initToWritableFile:error: and initToWritableData:error:––create an empty, writable storage container to which media data can be added (for example, using the QTMovie addImage method). The methods return QTMovie objects associated with those containers.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

initToWritableDataReference:error:

Creates a new storage container at the location specified by dataReference and returns a QTMovie object that has that container as its default data reference.

- (id)initToWritableDataReference:(QTDataReference *)dataReference error:(NSError **)errorPtr

Availability

• Available in Mac OS X v10.5 and later.

Declared In

initToWritableFile:error:

Useful for directly passing filenames and data objects. The QTMovie returned by this method is editable.

- (id)initToWritableFile:(NSString *)filename error:(NSError **)errorPtr

Availability

• Available in Mac OS X v10.5 and later.

Related Sample Code

• QTKitCreateMovie
• WritableFileDemo

Declared In

initWithAttributes:error:

Initializes a QTMovie object with the attributes specified in attributes.

- (id)initWithAttributes:(NSDictionary *)attributes error:(NSError **)errorPtr

Discussion

If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

A new QTMovie object is created using the specified attributes. There are three types of attributes that can be included in this dictionary:

• Attributes that specify the location of the movie data

• Attributes that specify how the movie is to be instantiated

• Attributes that specify playback characteristics of the movie or other properties of the QTMovie object

The following is a list of the keys that specify the location of the movie data; at least one of these must occur in the dictionary. If more than one occurs, the first one in the dictionary is used.

The following is a list of the keys that specify movie instantiation options; none of these keys is required. If a key is missing, the specified default value is used.

The following is a list of the new keys that specify movie playback characteristics or other properties of the QTMovie object; most other existing movie attributes can be included as well.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTKitAdvancedDocument

Declared In

initWithData:error:

Initializes a QTMovie object with the data specified by data.

- (id)initWithData:(NSData *)data error:(NSError **)errorPtr

Discussion

If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

initWithDataReference:error:

Initializes a QTMovie object with the data reference setting specified by dataReference.

- (id)initWithDataReference:(QTDataReference *)dataReference error:(NSError **)errorPtr

Discussion

If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

initWithFile:error:

Initializes a QTMovie object with the data in the file specified by the name fileName.

- (id)initWithFile:(NSString *)fileName error:(NSError **)errorPtr

Discussion

The fileName is assumed to be a full path name for a file. If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Note that alias files should not be passed into this method; the client application is responsible for resolving aliases before handing them to QTKit methods.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTCoreImage101
• QTKitButtonTester
• QTKitMovieShuffler
• QTQuartzPlayer
• ViewController

Declared In

initWithMovie:timeRange:error:

Initializes a QTMovie object with some or all of the data from an existing QTMovie object movie.

- (id)initWithMovie:(QTMovie *)movie timeRange:(QTTimeRange)range error:(NSError **)errorPtr

Discussion

The section of data used is delimited by the range range. If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

initWithPasteboard:error:

Initializes a QTMovie object with the contents of the pasteboard specified by pasteboard.

- (id)initWithPasteboard:(NSPasteboard *)pasteboard error:(NSError **)errorPtr

Discussion

These contents can be a QuickTime movie (of type Movie), a file path, or data of type QTMoviePasteBoardType. If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

initWithQuickTimeMovie:disposeWhenDone:error:

Initializes a QTMovie object with the data from an existing QuickTime movie movie.

- (id)initWithQuickTimeMovie:(Movie)movie disposeWhenDone:(BOOL)dispose error:(NSError **)errorPtr

Discussion

This is the designated initializer for the QTMovie class. The dispose parameter (a BOOL) indicates whether the QTKit should call DisposeMovie on the specified movie when the QTMovie object is deallocated. Passing YES effectively transfers “ownership” of the Movie to the QTKit. (Note that most applications will probably want to pass YES; passing NO means that the application wants to call DisposeMovie itself, perhaps so that it can operate on a Movie after it has been disassociated from a QTMovie object.)

If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Availability

• Available in Mac OS X v10.3 and later.
• Not available to 64-bit applications.

Declared In

initWithURL:error:

Initializes a QTMovie object with the data in the URL specified by url.

- (id)initWithURL:(NSURL *)url error:(NSError **)errorPtr

Discussion

If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTKitFrameStepper

Declared In

insertEmptySegmentAt:

inserts into a QTMovie an empty segment delimited by the range range.

- (void)insertEmptySegmentAt:(QTTimeRange)range

Discussion

If the movie is not editable, this method raises an exception.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

insertSegmentOfMovie:fromRange:scaledToRange:

Inserts the specified segment from the movie into the receiver, scaled to the range dstRange.

- (void)insertSegmentOfMovie:(QTMovie *)movie fromRange:(QTTimeRange)srcRange scaledToRange:(QTTimeRange)dstRange

Discussion

This is essentially an Add Scaled operation on a movie. If the movie is not editable, this method raises an exception.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

insertSegmentOfMovie:timeRange:atTime:

Inserts into a QTMovie at time time the selection in movie delimited by the time range range.

- (void)insertSegmentOfMovie:(QTMovie *)movie timeRange:(QTTimeRange)range atTime:(QTTime)time

Discussion

If the movie is not editable, this method raises an exception.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTKitMovieShuffler

Declared In

isIdling

Returns the current idling state of a QTMovie object.

- (BOOL)isIdling

Discussion

This method allows you to manage the idling state of a QTMovie object, that is, whether it is being tasked. Note that movies attached to a background thread should not be idled; if they are idled, unexpected behavior can result.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

movieAttributes

Returns a dictionary containing the current values of all defined movie attributes.

- (NSDictionary *)movieAttributes

Discussion

A list of supported movie attributes and their acceptable values can be found in the “Constants” section.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

movieFormatRepresentation

Returns the movie’s data in an NSData object.

- (NSData *)movieFormatRepresentation

Availability

• Available in Mac OS X v10.3 and later.

See Also

• – writeToFile:withAttributes:

Related Sample Code

• QTMetadataEditor

Declared In

movieWithTimeRange:error:

Returns a QTMovie object whose data is the data in the specified time range.

- (id)movieWithTimeRange:(QTTimeRange)range error:(NSError **)errorPtr

Discussion

If a QTMovie object cannot be created, an NSError object is returned in the location pointed to by errorPtr. Pass NIL if you do not want an NSError object returned.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

muted

Returns the movie’s mute setting.

- (BOOL)muted

Availability

• Available in Mac OS X v10.3 and later.

Declared In

play

Plays the movie.

- (void)play

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• TrackFormatDemo
• VideoViewer

Declared In

posterImage

Returns an NSImage for the poster frame of a QTMovie.

- (NSImage *)posterImage

Availability

• Available in Mac OS X v10.3 and later.

See Also

• – currentFrameImage,
• – frameImageAtTime:

Related Sample Code

• QTKitMovieShuffler

Declared In

quickTimeMovie

Returns the QuickTime movie associated with a QTMovie object.

- (Movie)quickTimeMovie

Availability

• Available in Mac OS X v10.3 and later.
• Not available to 64-bit applications.

See Also

• – quickTimeMovieController

Related Sample Code

• QTCoreVideo103
• QTCoreVideo201
• QTCoreVideo202
• QTKitTimeCode
• VideoViewer

Declared In

quickTimeMovieController

Returns the QuickTime movie controller associated with a QTMovie object.

- (MovieController)quickTimeMovieController

Availability

• Available in Mac OS X v10.3 and later.
• Not available to 64-bit applications.

See Also

• – quickTimeMovie

Related Sample Code

• QTKitMovieShuffler

Declared In

rate

Returns the current rate of a QTMovie object.

- (float)rate

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTKitMovieShuffler

Declared In

removeApertureModeDimensions

Removes aperture mode dimension information from a movie's tracks.

- (void)removeApertureModeDimensions

Discussion

This method does not attempt to modify sample descriptions, so it may not completely reverse the effects of generateApertureModeDimensions. It sets the QTMovieHasApertureModeDimensionsAttribute property to NO.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

removeChapters

 Removes any existing chapters from the receiver.

- (BOOL)removeChapters

Discussion

Returns YES if either the receiver had no chapters or the chapters were successfully removed from the receiver. Returns NO if the chapters could not for some reason be removed from the receiver. The receiving QTMovie object must be editable or an exception will be raised.

Availability

• Mac OS X v10.5 and later.

Declared In

replaceSelectionWithSelectionFromMovie:

Replaces the current selection in a QTMovie with the current selection in movie.

- (void)replaceSelectionWithSelectionFromMovie:(id)movie

Discussion

If the movie is not editable, this method raises an exception.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

scaleSegment:newDuration:

Scales the QTMovie segment delimited by the segment segment so that it will have the new duration newDuration.

- (void)scaleSegment:(QTTimeRange)segment newDuration:(QTTime)newDuration

Discussion

If the movie is not editable, this method raises an exception.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

selectionDuration

Returns the duration of the movie’s current selection as a QTTime structure.

- (QTTime)selectionDuration

Availability

• Available in Mac OS X v10.3 and later.

Declared In

selectionEnd

Returns the end point of the movie’s current selection as a QTTime structure.

- (QTTime)selectionEnd

Availability

• Available in Mac OS X v10.3 and later.

Declared In

selectionStart

Returns the start time of the movie’s current selection as a QTTime structure.

- (QTTime)selectionStart

Availability

• Available in Mac OS X v10.3 and later.

Declared In

setAttribute:forKey:

Set the movie attribute attributeKey to the value specified by the value parameter.

- (void)setAttribute:(id)value forKey:(NS String *)attributeKey

Discussion

A list of supported movie attributes and their acceptable values can be found in the “Constants” section.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTCoreVideo103
• QTCoreVideo202
• QTKitCommandLine
• QTKitMovieShuffler
• ViewController

Declared In

setCurrentTime:

Sets the movie’s current time setting to time.

- (void)setCurrentTime:(QTTime)time

Availability

• Available in Mac OS X v10.3 and later.

Declared In

setDelegate:

Sets the movie’s delegate to delegate.

- (void)setDelegate:(id)delegate

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTKitProgressTester

Declared In

setIdling:

Sets the movie to idle YES or not to idle NO.

- (void)setIdling:(BOOL)state

Discussion

This method allows you to manage the idling state of a QTMovie object, that is, whether it is being tasked. Note that movies attached to a background thread should not be idled; if they are idled, unexpected behavior can result.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

setMovieAttributes:

Set the movie attributes using the key-value pairs specified in the dictionary attributes.

- (void)setMovieAttributes:(NSDictionary *)attributes

Discussion

A list of supported movie attributes and their acceptable values can be found in the “Constants” section.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

setMuted:

Sets the movie’s mute setting to mute.

- (void)setMuted:(BOOL)mute

Discussion

Note that this does not affect the volume.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

setRate:

Sets the movie’s rate to rate.

- (void)setRate:(float)rate

Discussion

For instance, 0.0 is stop, 1.0 is playback at normal speed, 2.0 is twice normal speed, and so on.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTCoreVideo102
• QTCoreVideo103
• QTCoreVideo201
• QTCoreVideo202
• QTCoreVideo301

Declared In

setSelection:

Sets the movie’s selection to selection.

- (void)setSelection:(QTTimeRange)selection

Availability

• Available in Mac OS X v10.3 and later.

Declared In

setVolume:

Sets the movie’s volume to volume.

- (void)setVolume:(float)volume

Discussion

Note that this does not affect the movie’s stored settings.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

startTimeOfChapter:

Returns a QTTime structure that is the start time of the chapter having the specified 0-based index in the list of chapters.

- (QTTime)startTimeOfChapter:(NSInteger)chapterIndex

Availability

• Mac OS X v10.5 and later.

Declared In

stepBackward

Sets the movie backward a single frame.

- (void)stepBackward

Availability

• Available in Mac OS X v10.3 and later.

Declared In

stepForward

Sets the movie forward a single frame.

- (void)stepForward

Availability

• Available in Mac OS X v10.3 and later.

Declared In

stop

Stops the movie playing.

- (void)stop

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTAudioExtractionPanel
• QTKitMovieShuffler
• QTKitPlayer

Declared In

tracks

Returns an array of QTTrack objects associated with the receiver.

- (NSArray *)tracks

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTMetadataEditor
• TrackFormatDemo

Declared In

tracksOfMediaType:

Returns an array of tracks with the specified media type.

- (NSArray *)tracksOfMediaType:(NSString *)type

Discussion

The type parameter should be one of the media types defined by constants in QTMedia.h beginning with "QTMediaType", for instance, QTMediaTypeVideo.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTKitTimeCode

Declared In

updateMovieFile

Updates the movie file of a QTMovie.

- (BOOL)updateMovieFile

Discussion

Returns YES if the update succeeds and NO otherwise.

Availability

• Available in Mac OS X v10.3 and later.

Related Sample Code

• QTKitCommandLine
• QTMetadataEditor
• WritableFileDemo

Declared In

volume

Returns the movie’s volume as a scalar value of type float.

- (float)volume

Discussion

The valid range is 0.0 to 1.0.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

writeToFile:withAttributes:

Returns YES if the movie file was successfully created and NO otherwise.

- (BOOL)writeToFile:(NSString *)fileNamewithAttributes :(NSDictionary *)attributes

Discussion

This method returns YES if the movie file was successfully created and NO otherwise. NO will also be returned if the load state of the target is less than QTMovieLoadStateComplete, in which case no attempt is made to write the QTMovie into a file. If the dictionary attributes contains an object whose key is QTMovieFlatten, then the movie is flattened into the specified file. If the dictionary attributes contains an object whose key is QTMovieExport, then the movie is exported into the specified file using a movie exporter whose type is specified by the value of the key QTMovieExportType. The value associated with the QTMovieExportSettings key should be an object of type NSData that contains an atom container of movie export settings.

Availability

• Available in Mac OS X v10.3 and later.

See Also

• – movieFormatRepresentation

Related Sample Code

• QTKitCommandLine
• QTKitMovieShuffler
• QTKitProgressTester
• QTKitThreadedExport

Declared In

writeToFile:withAttributes:error:

Returns an NSError object if an error occurs and if errorPtr is non-NULL.

- (BOOL)writeToFile:(NSString *)fileName withAttributes:(NSDictionary *)attributes error:(NSError **)errorPtr

Discussion

The method operates exactly like the existing QTMovie writeToFile:withAttributes method.

Availability

• Available in Mac OS X v10.5 and later.

See Also

• – movieFormatRepresentation

Declared In

Delegate Methods

externalMovie:

This method is called, if implemented by a QTMovie delegate object, when an external movie needs to be found (usually for a wired action targeted at an external movie).

- (QTMovie *)externalMovie:(NSDictionary *)dictionary

Discussion

The keys for the dictionary in this delegate method are: QTMovieTargetIDNotificationParameter and QTMovieTargetNameNotificationParameter. The QTMovieTargetIDNotificationParameter key indicates that the delegate should return a QTMovie object that has the specified movie ID. The QTMovieTargetNameNotificationParameter key indicates that the delegate should return a QTMovie object that has the specified movie name.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

movie:linkToURL:

Called to handle the mcAction mcActionLinkToURL.

- (BOOL)movie:(QTMovie *)movielinkToURL :(NSURL *)url

Discussion

Most applications will not need to install a delegate to handle this.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

movie:shouldContinueOperation:withPhase:atPercent:withAttributes:

If implemented, this method is called periodically during lengthy operations (such as exporting a movie).

- (BOOL)movie:(QTMovie *)movieshouldContinueOperation :(NSString *)opwithPhase :(QTMovieOperationPhase)phaseatPercent :(NSNumber *)percentwithAttributes :(NSDictionary *)attributes

Discussion

A delegate can implement this method. The op string is a localized string that indicates what the operation is. The phase indicates whether the operation is just beginning, ending, or is at a certain percentage of completion. If the phase is QTMovieOperationUpdatePercentPhase, then the percent parameter indicates the percentage of the operation completed. The attributes dictionary may be NIL; if not NIL, it is the same dictionary passed to a QTMovie method that caused the lengthy operation (for example, the attributes dictionary passed to writeToFile). The constants for this method are defined as follows:

typedef enum {

    QTMovieOperationBeginPhase = movieProgressOpen,

    QTMovieOperationUpdatePercentPhase = movieProgressUpdatePercent,

    QTMovieOperationEndPhase = movieProgressClose

}

Availability

• Available in Mac OS X v10.3 and later.

Declared In

movieShouldTask:

If a QTMovie object has a delegate and that delegate implements this method, that method will be called before QTKit performs the standard idle processing on a movie.

- (BOOL)movieShouldTask:(id)movie

Discussion

The delegate can cancel that normal processing by returning YES.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

Constants

The following constants specify the movie attributes that you can get and set using the movieAttributes and setMovieAttributes methods. To get or set a single attribute, use attributeForKey or setAttribute.

enum {
  QTMovieLoadStateError = -1L,  // an error occurred while loading the movie
  QTMovieLoadStateLoading = 1000, // the movie is loading
  QTMovieLoadStateLoaded = 2000, // the movie atom has loaded; it's safe to query movie properties
  QTMovieLoadStatePlayable = 10000, // the movie has loaded enough media data to begin playing
  QTMovieLoadStatePlaythroughOK = 20000, // the movie has loaded enough media data to play through to the end
  QTMovieLoadStateComplete = 100000L // the movie has loaded completely
};

The following constants specify items in dictionaries passed to QTMovie notifications and delegate methods.

The following constants are dictionary keys that you can use to specify movie attributes, using the writeToFile method.

The following constants are dictionary keys that you can use to specify movie attributes, using the addImage method.

The following is a dictionary of attributes can contain these keys, using the frameImageAtTime:withAttributes:error: method.

The following constants are data locators that you can use to specify movie attributes, using the movieWithAttributes and initWithAttributes methods.

The following constants are movie instantiation options that you can use to specify movie attributes, using the movieWithAttributes and initWithAttributes methods.

These constants allow applications to get information about a movie and its chapters, and to navigate within a movie by chapters. Since chapters are a reasonably common feature of movies and podcasts, QTKit enables developers to create them.

Notifications

QTMovieApertureModeDidChangeNotification

Issued when the aperture mode of the target QTMovie object changes.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieChapterDidChangeNotification

Issued when the chapter associated with QTMovie changes.

This notification contains no information in the userInfo dictionary.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieChapterListDidChangeNotification

Issued when the chapter list associated with QTMovie changes.

This notification contains no information in the userInfo dictionary.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieCloseWindowRequestNotification

Sent when a request is made to close the movie’s window.

This notification contains no information in the userInfo dictionary.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieDidEndNotification

Sent when the movie is “done” or at its end.

This notification contains no userInfo parameters. It is equivalent to the standard player controller’s mcActionMovieFinished action.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieEditabilityDidChangeNotification

Sent when the editable state of a movie has changed.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieEditedNotification

Sent when a movie has been edited.

This notification contains no userInfo dictionary.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieEnterFullScreenRequestNotification

Sent when a request is made to play back a movie in full screen mode.

This notification contains no information in the userInfo dictionary.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieExitFullScreenRequestNotification

Sent when a request is made to play back a movie in normal windowed mode.

This notification contains no information in the userInfo dictionary.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieLoadStateDidChangeNotification

Sent when the load state of a movie has changed.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieLoopModeDidChangeNotification

Sent when a change is made in a movie’s looping mode.

This notification contains no information in the userInfo dictionary.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieMessageStringPostedNotification

Sent when a movie message has been received by the movie controller.

Movie messages can be sent to an application by wired actions (for instance, a wired sprite) or by code that issues the mcActionShowMessageString movie controller action. The userInfo dictionary contains a single entry whose value is of type NSString, which is the movie message.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieRateDidChangeNotification

Sent when the rate of a movie has changed.

The userInfo dictionary contains a single entry whose value is of type NSNumber that represents a float, which is the new rate.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieSelectionDidChangeNotification

Sent when the selection of a movie has changed.

This notification contains no userInfo dictionary.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieSizeDidChangeNotification

Sent when the size of a movie has changed.

This notification contains no userInfo dictionary.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieStatusStringPostedNotification

Status messages can be sent by QuickTime’s streaming components or by any code that wants to display a message in the movie controller bar status area.

The userInfo dictionary contains a single entry whose value is of type NSString, which is the status message.

The following are keys (notification parameters) for userInfo items for the QTMovieStatusStringPostedNotification notification QTMovieStatusCodeNotificationParameter and QTMovieStatusStringNotificationParameter.

A status string notification can indicate an error (in which case QTMovieStatusCodeNotificationParameter will have a value), or it can contain a string (in which case QTMovieStatusStringNotificationParameter will have a value). For more information, see mcActionShowStatusString.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieTimeDidChangeNotification

Sent when the time in a movie has changed to a value other than what it would be during normal playback.

The QTMovieTimeDidChangeNotification is fired whenever the movie time changes to a time other than what it would be during normal playback. So, for example, this notification is not fired every frame.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

QTMovieVolumeDidChangeNotification

Sent when the volume of a movie has changed.

Availability

• Available in Mac OS X v10.3 and later.

Declared In

Next Page > Hide TOC