Framework | Frameworks/QuickTime.framework |
Declared in | Movies.h |
QuickTime movies and movie tracks have properties that an application can manage, including embedded metadata and sample tables that determine what, how, and when the movie will present its data.
QTCopyMediaMetaData
QTCopyMovieMetaData
QTCopyTrackMetaData
QTMetaDataAddItem
QTMetaDataGetItemProperty
QTMetaDataGetItemPropertyInfo
QTMetaDataGetItemValue
QTMetaDataGetNextItem
QTMetaDataGetProperty
QTMetaDataGetPropertyInfo
QTMetaDataRelease
QTMetaDataRemoveItem
QTMetaDataRemoveItemsWithKey
QTMetaDataRetain
QTMetaDataSetItem
QTMetaDataSetItemProperty
QTMetaDataSetProperty
QTSampleTableAddSampleDescription
QTSampleTableAddSampleReferences
QTSampleTableCopySampleDescription
QTSampleTableCreateMutable
QTSampleTableCreateMutableCopy
QTSampleTableGetDataOffset
QTSampleTableGetDataSizePerSample
QTSampleTableGetDecodeDuration
QTSampleTableGetDisplayOffset
QTSampleTableGetNextAttributeChange
QTSampleTableGetNumberOfSamples
QTSampleTableGetProperty
QTSampleTableGetPropertyInfo
QTSampleTableGetSampleDescriptionID
QTSampleTableGetSampleFlags
QTSampleTableGetTimeScale
QTSampleTableGetTypeID
QTSampleTableRelease
QTSampleTableReplaceRange
QTSampleTableRetain
QTSampleTableSetProperty
QTSampleTableSetTimeScale
DisposeQTTrackPropertyListenerUPP
InvokeQTTrackPropertyListenerUPP
MusicMediaGetIndexedTunePlayer
NewQTTrackPropertyListenerUPP
QTAddMoviePropertyListener
QTAddTrackPropertyListener
QTGetMovieProperty
QTGetMoviePropertyInfo
QTGetTrackProperty
QTGetTrackPropertyInfo
QTRemoveMoviePropertyListener
QTRemoveTrackPropertyListener
QTSetMovieProperty
QTSetTrackProperty
DisposeQTBandwidthNotificationUPP
Deprecated in Mac OS X v10.4
NewQTBandwidthNotificationUPP
Deprecated in Mac OS X v10.4
QTBandwidthRelease
Deprecated in Mac OS X v10.4
QTBandwidthRequest
Deprecated in Mac OS X v10.4
QTBandwidthRequestForTimeBase
Deprecated in Mac OS X v10.4
QTScheduledBandwidthRelease
Deprecated in Mac OS X v10.4
QTScheduledBandwidthRequest
Deprecated in Mac OS X v10.4
Disposes a track property listener UPP.
void DisposeQTTrackPropertyListenerUPP ( QTTrackPropertyListenerUPP userUPP );
A QTTrackPropertyListenerUPP
pointer. See Universal Procedure Pointers in the QuickTime API Reference for more information.
Movies.h
Invokes the specified property listener of a track.
void InvokeQTTrackPropertyListenerUPP ( Track inTrack, QTPropertyClass inPropClass, QTPropertyID inPropID, void *inUserData, QTTrackPropertyListenerUPP userUPP );
The track of this operation.
A property class.
A property ID.
A pointer to user data that will be passed to the callback.
A QTTrackPropertyListenerUPP
pointer.
Movies.h
Undocumented
ComponentResult MusicMediaGetIndexedTunePlayer ( ComponentInstance ti, long sampleDescIndex, ComponentInstance *tp );
Undocumented
Undocumented
A pointer to a tune player component instance.
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
Creates a new callback to monitor a track property.
QTTrackPropertyListenerUPP NewQTTrackPropertyListenerUPP ( QTTrackPropertyListenerProcPtr userRoutine );
A pointer to a QTTrackPropertyListenerProcPtr
callback.
A new UPP; see Universal Procedure Pointers in the QuickTime API Reference.
This routine creates a new callback to monitor a track property.
Movies.h
Installs a callback to monitor a movie property.
OSErr QTAddMoviePropertyListener ( Movie inMovie, QTPropertyClass inPropClass, QTPropertyID inPropID, QTMoviePropertyListenerUPP inListenerProc, void *inUserData );
The movie for this operation. Your application obtains this movie identifier from such functions as NewMovie
, NewMovieFromFile
, and NewMovieFromHandle
.
A property class.
A property ID.
A Universal Procedure Pointer to a QTMoviePropertyListenerProc
callback.
A pointer to user data that will be passed to the callback.
See Error Codes
in the QuickTime API Reference. Returns noErr
if there is no error.
Introduced in QuickTime 6.4.
Movies.h
Installs a callback to monitor a track property.
OSErr QTAddTrackPropertyListener ( Track inTrack, QTPropertyClass inPropClass, QTPropertyID inPropID, QTTrackPropertyListenerUPP inListenerProc, void *inUserData );
The track for this operation.
A property class.
A property ID.
A Universal Procedure Pointer to a QTTrackPropertyListenerProc
callback.
A pointer to user data that will be passed to the callback.
An error code. Returns noErr
if there is no error.
This routine installs a callback to monitor a track property.
Movies.h
Retains a media's metadata object and returns it.
OSStatus QTCopyMediaMetaData ( Media inMedia, QTMetaDataRef *outMetaData );
The media for this operation. You obtain this media identifier from such functions as NewTrackMedia
and GetTrackMedia
.
A pointer to an opaque metadata object wrapper associated with the media passed in inMedia
.
Returns invalidMedia
if the media passed in inMedia
is invalid, or noErr
if there is no error.
This function returns the metadata object associated with a media. The object has retain/release semantics. It has already been retained before returning, but you should call QTMetaDataRelease
when you are done. Because the media can be disposed of at any time, the QTMetaDataRef
may be valid when the media no longer exists. In this case, the function will fail with a kQTMetaDataInvalidMetaDataErr
error.
Movies.h
Retains a movie's metadata object and returns it.
OSStatus QTCopyMovieMetaData ( Movie inMovie, QTMetaDataRef *outMetaData );
The movie for this operation. Your application obtains this movie identifier from such functions as NewMovie
, NewMovieFromProperties
, NewMovieFromFile
, and NewMovieFromHandle
.
A pointer to an opaque metadata object wrapper associated with the movie passed in inMovie
.
Returns invalidMovie
if the movie passed in inMovie
is invalid, or noErr
if there is no error.
This function returns the metadata object associated with a movie. The object has retain/release semantics. It has already been retained before returning, but you should call QTMetaDataRelease
when you are done. Because the movie can be disposed of at any time, the QTMetaDataRef
may be valid when the movie no longer exists. In this case, the function will fail with a kQTMetaDataInvalidMetaDataErr
error.
Movies.h
Retains a track's metadata object and returns it.
OSStatus QTCopyTrackMetaData ( Track inTrack, QTMetaDataRef *outMetaData );
A track identifier, which your application obtains from such functions as NewMovieTrack
and GetMovieTrack
.
A pointer to an opaque metadata object wrapper associated with the track passed in inTrack
.
Returns invalidMedia
if the track passed in inTrack
is invalid, or noErr
if there is no error.
This function returns the metadata object associated with a track. The object has retain/release semantics. It has already been retained before returning, but you should call QTMetaDataRelease
when you are done. Because the track can be disposed of at any time, the QTMetaDataRef
may be valid when the track no longer exists. In this case, the function will fail with a kQTMetaDataInvalidMetaDataErr
error.
Movies.h
Returns the value of a specific movie property.
OSErr QTGetMovieProperty ( Movie inMovie, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, QTPropertyValuePtr outPropValueAddress, ByteCount *outPropValueSizeUsed );
The movie for this operation. Your application obtains this movie identifier from such functions as NewMovie
, NewMovieFromFile
, and NewMovieFromHandle
.
A property class.
A property ID.
The size of the buffer allocated to hold the property value.
A pointer to the buffer allocated to hold the property value.
On return, the actual size of the value written to the buffer.
See Error Codes
in the QuickTime API Reference. Returns noErr
if there is no error.
Introduced in QuickTime 6.4.
Movies.h
Returns information about the properties of a movie.
OSErr QTGetMoviePropertyInfo ( Movie inMovie, QTPropertyClass inPropClass, QTPropertyID inPropID, QTPropertyValueType *outPropType, ByteCount *outPropValueSize, UInt32 *outPropertyFlags );
The movie for this operation. Your application obtains this movie identifier from such functions as NewMovie
, NewMovieFromFile
, and NewMovieFromHandle
.
A property class.
A property ID.
A pointer to memory allocated to hold the property
type on return.
A pointer to memory allocated to hold the size of the property value on return.
A pointer to memory allocated to hold property flags on return.
See Error Codes
in the QuickTime API Reference. Returns noErr
if there is no error.
Introduced in QuickTime 6.4.
Movies.h
Returns the value of a specific track property.
OSErr QTGetTrackProperty ( Track inTrack, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, QTPropertyValuePtr outPropValueAddress, ByteCount *outPropValueSizeUsed );
The track for this operation.
A property class.
A property ID.
The size of the buffer allocated to hold the property value.
A pointer to the buffer allocated to hold the property value.
On return, the actual size of the value written to the buffer.
An error code. Returns noErr
if there is no error.
This routine returns the value of a specific track property.
Movies.h
Returns information about the properties of a track.
OSErr QTGetTrackPropertyInfo ( Track inTrack, QTPropertyClass inPropClass, QTPropertyID inPropID, QTPropertyValueType *outPropType, ByteCount *outPropValueSize, UInt32 *outPropertyFlags );
The track for this operation.
A property class.
A property ID.
A pointer to memory allocated to hold the property
type on return.
A pointer to memory allocated to hold the size of the property value on return.
A pointer to memory allocated to hold property flags on return.
An error code. Returns noErr
if there is no error.
This routine returns information about the properties of a track.
Movies.h
Adds an inline metadata item to the metadata storage format.
OSStatus QTMetaDataAddItem ( QTMetaDataRef inMetaData, QTMetaDataStorageFormat inMetaDataFormat, QTMetaDataKeyFormat inKeyFormat, const UInt8 *inKeyPtr, ByteCount inKeySize, const UInt8 *inValuePtr, ByteCount inValueSize, UInt32 inDataType, QTMetaDataItem *outItem );
The metadata object for this operation.
The metadata storage format used by the object passed in inMetaData
. The format may be UserData
storage, iTunes metadata storage, or QuickTime metadata storage. Not all objects will include all forms of storage, and other storage formats may appear in the future. You cannot pass kQTMetaDataStorageFormatWildcard
to target all storage formats.
The format of the key.
A pointer to the key of the item to be fetched next. You may pass NULL in this parameter if you are not interested in any specific key.
The size of the key in bytes.
A pointer to the value to be added. This can be NULL if inValueSize
is 0.
The size of inValuePtr
in bytes. Pass 0 if you want to add an item with no value.
A data type from the following list: kQTMetaDataTypeBinary
= 0, kQTMetaDataTypeUTF8 = 1, kQTMetaDataTypeUTF16BE = 2, kQTMetaDataTypeMacEncodedText
= 3, kQTMetaDataTypeSignedIntegerBE
= 21, kQTMetaDataTypeUnsignedIntegerBE
= 22, kQTMetaDataTypeFloat32BE = 23, kQTMetaDataTypeFloat64BE = 24With kQTMetaDataTypeSignedIntegerBE
and kQTMetaDataTypeUnsignedIntegerBE
, the size of the integer is determined by the value size.
On return, a pointer to an opaque, unique UInt64 identifier of the newly added item. Your application can use this to identify the metadata item within a metadata object for other metadata functions. You may pass NULL if you are not interested in the identifier of the newly added item. This identifier does not need to be disposed of.
Returns kQTMetaDataInvalidMetaDataErr
if the metadata object or its reference is invalid, kQTMetaDataInvalidStorageFormatErr
if the metatada storage format is invalid, kQTMetaDataInvalidKeyErr
if the key or its format is invalid, or noErr
if there is no error. See Metadata Error Codes
.
The data type of the metadata item is assumed to be binary.
Movies.h
Returns a property of a metadata item.
OSStatus QTMetaDataGetItemProperty ( QTMetaDataRef inMetaData, QTMetaDataItem inItem, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, QTPropertyValuePtr outPropValueAddress, ByteCount *outPropValueSizeUsed );
The metadata object for this operation.
The opaque, unique UInt64 identifier of the metadata item for this operation. Your application obtains this item identifier from such functions as QTMetaDataAddItem
and QTMetaDataGetNextItem
.
The class of the property being asked about.
The ID of the property being asked about.
Size
of the buffer allocated to receive the property value.
A pointer to the buffer allocated to receive the item's property value.
On return, the actual size of buffer space used.
Returns kQTMetaDataInvalidMetaDataErr
if the metadata object or its reference is invalid, kQTMetaDataInvalidItemErr
if the metatada item ID is invalid, errPropNotSupported
if the metatada object does not support the property being asked about, buffersTooSmall
if the allocated buffer is too small to hold the property, or noErr
if there is no error. See Metadata Error Codes
.
Movies.h
Returns information about a property of a metadata item.
OSStatus QTMetaDataGetItemPropertyInfo ( QTMetaDataRef inMetaData, QTMetaDataItem inItem, QTPropertyClass inPropClass, QTPropertyID inPropID, QTPropertyValueType *outPropType, ByteCount *outPropValueSize, UInt32 *outPropFlags );
The metadata object for this operation.
The opaque, unique UInt64 identifier of the metadata item for this operation. Your application obtains this item identifier from such functions as QTMetaDataAddItem
and QTMetaDataGetNextItem
.
The class of the property being asked about.
The ID of the property being asked about.
A pointer to the type of the returned property's value.
A pointer to the size of the returned property's value.
On return, a pointer to flags representing the requested information about the item's property.
Returns kQTMetaDataInvalidMetaDataErr
if the metadata object or its reference is invalid, kQTMetaDataInvalidItemErr
if the metatada item ID is invalid, errPropNotSupported
if the metatada object does not support the item property being asked about, or noErr
if there is no error. See Metadata Error Codes
.
Movies.h
Returns the value of a metadata item from an item identifier.
OSStatus QTMetaDataGetItemValue ( QTMetaDataRef inMetaData, QTMetaDataItem inItem, UInt8 *outValuePtr, ByteCount inValueSize, ByteCount *outActualSize );
The metadata object for this operation.
The opaque, unique UInt64 identifier of the metadata item for this operation. Your application can obtain this item identifier from such functions as QTMetaDataAddItem
.
A pointer to the first value of the item. You may pass NULL in this parameter if you just want to find out the size of the buffer needed.
The number of bytes in the outValuePtr
buffer. You may pass 0 if you just want to find out the size of the buffer needed.
The actual size of the value
if this parameter is not NULL.
Returns kQTMetaDataInvalidMetaDataErr
if the metadata object or its reference is invalid, kQTMetaDataInvalidItemErr
if the metatada item ID is invalid, or noErr
if there is no error. See Metadata Error Codes
.
You can use this function to get the value of a metadata item that has a known item identifier.
Movies.h
Returns the next metadata item corresponding to a specified key.
OSStatus QTMetaDataGetNextItem ( QTMetaDataRef inMetaData, QTMetaDataStorageFormat inMetaDataFormat, QTMetaDataItem inCurrentItem, QTMetaDataKeyFormat inKeyFormat, const UInt8 *inKeyPtr, ByteCount inKeySize, QTMetaDataItem *outNextItem );
The metadata object for this operation.
The metadata storage format used by the object passed in inMetaData
. The format may be UserData
storage, iTunes metadata storage, or QuickTime metadata storage. Not all objects will include all forms of storage, and other storage formats may appear in the future. Pass kQTMetaDataStorageFormatWildcard
to target all storage formats.
The opaque, unique UInt64 identifier of the current metadata item to start the search. Your application obtains this item identifier from such functions as QTMetaDataAddItem
.
The format of the key.
A pointer to the key of the item to be fetched next. You may pass NULL in this parameter if you are not interested in any specific key.
The size of the key in bytes.
The ID of the next metadata item after the item specified by inCurrentItem
that has the specified key.
Returns kQTMetaDataInvalidMetaDataErr
if the metadata object or its reference is invalid, kQTMetaDataInvalidItemErr
if the metatada item ID is invalid, kQTMetaDataInvalidStorageFormatErr
if the metatada storage format is invalid, kQTMetaDataInvalidKeyErr
if the key or its format is invalid, kQTMetaDataNoMoreItemErr
if the last item has been fetched, or noErr
if there is no error. See Metadata Error Codes
.
If the item designated by inCurrentItem
is kQTMetaDataItemUninitialized
, the function returns the first item with the specified key in the storage format. If it refers to a valid item in the storage format, the function will return the next item with the key after the item designated by inCurrentItem
.
Movies.h
Returns a property of a metadata object.
OSStatus QTMetaDataGetProperty ( QTMetaDataRef inMetaData, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, QTPropertyValuePtr outPropValueAddress, ByteCount *outPropValueSizeUsed );
The metadata object for this operation.
The class of the property being asked about.
The ID of the property being asked about.
Size
of the buffer allocated to receive the property value.
A pointer to the buffer allocated to receive the property value.
On return, the actual size of buffer space used.
Returns kQTMetaDataInvalidMetaDataErr
if the metadata object or its reference is invalid, errPropNotSupported
if the metatada object does not support the property being asked about, buffersTooSmall
if the allocated buffer is too small to hold the property, or noErr
if there is no error. See Metadata Error Codes
.
Movies.h
Returns information about a property of a metadata object.
OSStatus QTMetaDataGetPropertyInfo ( QTMetaDataRef inMetaData, QTPropertyClass inPropClass, QTPropertyID inPropID, QTPropertyValueType *outPropType, ByteCount *outPropValueSize, UInt32 *outPropFlags );
The metadata object for this operation.
The class of the property being asked about.
The ID of the property being asked about.
A pointer to the type of the returned property's value.
A pointer to the size of the returned property's value.
On return, a pointer to flags representing the requested information about the property.
Returns kQTMetaDataInvalidMetaDataErr
if the metadata object or its reference is invalid, errPropNotSupported
if the metatada object does not support the property being asked about, or noErr
if there is no error. See Metadata Error Codes
.
Movies.h
Decrements the retain count of a metadata object.
void QTMetaDataRelease ( QTMetaDataRef inMetaData );
This function releases a metadata object by decrementing its reference count. When the count becomes 0 the memory allocated to the object is freed and the object is destroyed. If you retain a metadata object you are responsible for releasing it when you no longer need it.
Movies.h
Removes a metadata item from a storage format.
OSStatus QTMetaDataRemoveItem ( QTMetaDataRef inMetaData, QTMetaDataItem inItem );
The metadata object for this operation.
The opaque, unique UInt64 identifier of the metadata item for this operation. Your application obtains this item identifier from such functions as QTMetaDataAddItem
and QTMetaDataGetNextItem
.
Returns kQTMetaDataInvalidMetaDataErr
if the metadata object or its reference is invalid, kQTMetaDataInvalidItemErr
if the metatada item ID is invalid, or noErr
if there is no error. See Metadata Error Codes
.
Movies.h
Removes metadata items with a specific key from the storage format.
OSStatus QTMetaDataRemoveItemsWithKey ( QTMetaDataRef inMetaData, QTMetaDataStorageFormat inMetaDataFormat, QTMetaDataKeyFormat inKeyFormat, const UInt8 *inKeyPtr, ByteCount inKeySize );
The metadata object for this operation.
The metadata storage format used by the object passed in inMetaData
. The format may be UserData
storage, iTunes metadata storage, or QuickTime metadata storage. Not all objects will include all forms of storage, and other storage formats may appear in the future. You can pass kQTMetaDataStorageFormatWildcard
to target all storage formats.
The format of the key.
A pointer to the key of the item to be removed. You may pass NULL in this parameter if you want to remove all items.
The size of the key in bytes.
Returns kQTMetaDataInvalidMetaDataErr
if the metadata object or its reference is invalid, kQTMetaDataInvalidStorageFormatErr
if the metatada storage format is invalid, kQTMetaDataInvalidKeyErr
if the key or its format is invalid, or noErr
if there is no error. See Metadata Error Codes
.
Movies.h
Increments the retain count of a metadata object.
QTMetaDataRef QTMetaDataRetain ( QTMetaDataRef inMetaData );
A metadata object that you want to retain.
If successful, returns a metadata object that is the same as that passed in inMetaData
.
This function retains a metadata object by incrementing its reference count. You should retain every metadata object when you receive it from elsewhere and you want it to persist. If you retain a metadata object you are responsible for releasing it by calling QTMetaDataRelease
.
Movies.h
Sets the value of the metadata item from the item identifier.
OSStatus QTMetaDataSetItem ( QTMetaDataRef inMetaData, QTMetaDataItem inItem, UInt8 *inValuePtr, ByteCount inValueSize, UInt32 inDataType );
The metadata object for this operation.
The opaque, unique UInt64 identifier of the metadata item for this operation. Your application obtains this item identifier from such functions as QTMetaDataAddItem
and QTMetaDataGetNextItem
.
A pointer to the value to be set. This can be NULL if inValueSize
is 0.
The size of inValuePtr
in bytes. Pass 0 if you want to set an item with no value.
A data type from the following list: kQTMetaDataTypeBinary
= 0, kQTMetaDataTypeUTF8 = 1, kQTMetaDataTypeUTF16BE = 2, kQTMetaDataTypeMacEncodedText
= 3, kQTMetaDataTypeSignedIntegerBE
= 21, kQTMetaDataTypeUnsignedIntegerBE
= 22, kQTMetaDataTypeFloat32BE = 23, kQTMetaDataTypeFloat64BE = 24With kQTMetaDataTypeSignedIntegerBE
and kQTMetaDataTypeUnsignedIntegerBE
, the size of the integer is determined by the value size.
Returns kQTMetaDataInvalidMetaDataErr
if the metadata object or its reference is invalid, kQTMetaDataInvalidItemErr
if the metatada item ID is invalid, or noErr
if there is no error. See Metadata Error Codes
.
You can use this function to set the value of the metadata item with a given item identifier. You can set an item with an empty value by passing 0 in inValueSize
.
Movies.h
Sets a property of a metadata item.
OSStatus QTMetaDataSetItemProperty ( QTMetaDataRef inMetaData, QTMetaDataItem inItem, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, ConstQTPropertyValuePtr inPropValueAddress );
The metadata object for this operation.
The opaque, unique UInt64 identifier of the metadata item for this operation. Your application obtains this item identifier from such functions as QTMetaDataAddItem
and QTMetaDataGetNextItem
.
The class of the property being set.
The ID of the property being set.
Size
of the buffer containing the property value being set.
A pointer to the buffer containing the item property value being set.
Returns kQTMetaDataInvalidMetaDataErr
if the metadata object or its reference is invalid, kQTMetaDataInvalidItemErr
if the metatada item ID is invalid, errPropNotSupported
if the metatada object does not support the property being set, qtReadOnlyErr
if the property being set is read-only, or noErr
if there is no error. See Metadata Error Codes
.
Movies.h
Sets a property of a metadata object.
OSStatus QTMetaDataSetProperty ( QTMetaDataRef inMetaData, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, ConstQTPropertyValuePtr inPropValueAddress );
The metadata object for this operation.
The class of the property being set.
The ID of the property being set.
Size
of the buffer containing the property value being set.
A pointer to the buffer containing the property value being set.
Returns kQTMetaDataInvalidMetaDataErr
if the metadata object or its reference is invalid, errPropNotSupported
if the metatada object does not support the property being set, qtReadOnlyErr
if the property being set is read-only, or noErr
if there is no error. See Metadata Error Codes
.
Movies.h
Removes a movie property monitoring callback.
OSErr QTRemoveMoviePropertyListener ( Movie inMovie, QTPropertyClass inPropClass, QTPropertyID inPropID, QTMoviePropertyListenerUPP inListenerProc, void *inUserData );
The movie for this operation. Your application obtains this movie identifier from such functions as NewMovie
, NewMovieFromFile
, and NewMovieFromHandle
.
A property class.
A property ID.
A Universal Procedure Pointer to a QTMoviePropertyListenerProc
callback.
User data to be passed to the callback.
See Error Codes
in the QuickTime API Reference. Returns noErr
if there is no error.
Introduced in QuickTime 6.4.
Movies.h
Removes a track property monitoring callback
OSErr QTRemoveTrackPropertyListener ( Track inTrack, QTPropertyClass inPropClass, QTPropertyID inPropID, QTTrackPropertyListenerUPP inListenerProc, void *inUserData );
The track for this operation.
A property class.
A property ID.
A Universal Procedure Pointer to a QTTrackPropertyListenerProc
callback.
User data to be passed to the callback.
An error code. Returns noErr
if there is no error.
This routine removes a track property monitoring callback.
Movies.h
Adds a sample description to a sample table, returning a sample description ID that can be used to refer to it.
OSStatus QTSampleTableAddSampleDescription ( QTMutableSampleTableRef sampleTable, SampleDescriptionHandle sampleDescriptionH, long mediaSampleDescriptionIndex, QTSampleDescriptionID *sampleDescriptionIDOut );
A reference to an opaque sample table object.
A handle to a SampleDescription
structure. QuickTime will make its own copy of this handle.
The sample description index of this sample description in a media. Pass 0 for sample descriptions you add to sample tables, to indicate that this was not retrieved from a media.
A pointer to a variable to receive a sample description ID.
An error code. Returns noErr
if there is no error.
You can use the returned sample description ID when adding samples to the sample table.
Movies.h
Adds sample references to a sample table.
OSStatus QTSampleTableAddSampleReferences ( QTMutableSampleTableRef sampleTable, SInt64 dataOffset, ByteCount dataSizePerSample, TimeValue64 decodeDurationPerSample, TimeValue64 displayOffset, SInt64 numberOfSamples, MediaSampleFlags sampleFlags, QTSampleDescriptionID sampleDescriptionID, SInt64 *newSampleNumOut );
A reference to an opaque sample table object.
A 64-bit signed integer that specifies the offset at which the first sample begins.
The number of bytes of data per sample. You must pass the data size per sample, not the total size of all the samples as with some other APIs.
A 64-bit time value that specifies the decode duration of each sample.
A 64-bit time value that specifies the offset from decode time to display time of each sample. If the decode times and display times are the same, pass 0.
A 64-bit signed integer, which must be greater than 0, that specifies the number of samples.
Flags that indicate the sync status of all samples: mediaSampleNotSync
If set to 1, indicates that the sample to be added is not a sync sample. Set this flag to 0 if the sample is a sync sample. mediaSampleShadowSync
If set to 1, the sample is a shadow sync sample. See these constants:
mediaSampleNotSync
mediaSampleShadowSync
The ID of a sample description that has been added to the sample table with QTSampleTableAddSampleDescription
.
A 64-bit signed integer that points to a variable to receive the sample number of the first sample that was added. Pass NULL if you don't want this information.
An error code. Returns noErr
if there is no error.
Movies.h
Retrieves a sample description from a sample table.
OSStatus QTSampleTableCopySampleDescription ( QTSampleTableRef sampleTable, QTSampleDescriptionID sampleDescriptionID, long *mediaSampleDescriptionIndexOut, SampleDescriptionHandle *sampleDescriptionHOut );
A reference to an opaque sample table object.
The sample description ID.
A pointer to a variable to receive a media sample description index. If the sample description came from a media, this is the index that could be passed to GetMediaSampleDescription
to retrieve the same sample description handle. The index will be 0 if the sample description did not come directly from a media. Pass NULL if you do not want to receive this information.
A pointer to a variable to receive a newly allocated sample description handle. Pass NULL if you do not want one. The caller is responsible for disposing the returned sample description handle using DisposeHandle
.
An error code. Returns noErr
if there is no error.
Movies.h
Creates a new, empty sample table.
OSStatus QTSampleTableCreateMutable ( CFAllocatorRef allocator, TimeScale timescale, void *hints, QTMutableSampleTableRef *newSampleTable );
The allocator to use for the new sample table.
A long integer that represents the timescale to use for durations and display offsets.
Reserved; pass NULL.
A pointer to a variable that receives a new reference to an opaque sample table object.
An error code. Returns memFullErr
if it could not allocate memory, paramErr
if the time scale is not positive or newSampleTable
is NULL, or noErr
if there is no error.
The newly created sample table contains no sample references. When sample references are added, their durations and display offsets are interpreted according to the sample table's current timescale.
Movies.h
Copies a sample table.
OSStatus QTSampleTableCreateMutableCopy ( CFAllocatorRef allocator, QTSampleTableRef sampleTable, void *hints, QTMutableSampleTableRef *newSampleTable );
The allocator to use for the new sample table.
A reference to an opaque sample table object to copy.
Reserved; set to NULL.
A pointer to a variable that receives a reference to an opaque sample table object.
An error code. Returns memFullErr
if it could not allocate memory, paramErr
if the time scale is not positive or newSampleTable
is NULL, or noErr
if there is no error.
All the sample references and sample descriptions in the sample table are copied.
Movies.h
Returns the data offset of a sample.
SInt64 QTSampleTableGetDataOffset ( QTSampleTableRef sampleTable, SInt64 sampleNum );
A reference to an opaque sample table object.
A 64-bit signed integer that represents a sample number. The first sample's number is 1.
A 64-bit signed integer that represents the offset to the sample. Returns 0 if sampleTable
is NULL or if the sample number is out of range.
Movies.h
Returns the data size of a sample.
ByteCount QTSampleTableGetDataSizePerSample ( QTSampleTableRef sampleTable, SInt64 sampleNum );
A reference to an opaque sample table object.
A 64-bit signed integer that represents the sample number. The first sample's number is 1.
The size of the sample in bytes. Returns 0 if sampleTable
is NULL or if the sample number is out of range.
Movies.h
Returns the decode duration of a sample.
TimeValue64 QTSampleTableGetDecodeDuration ( QTSampleTableRef sampleTable, SInt64 sampleNum );
A reference to an opaque sample table object.
A 64-bit signed integer that represents the sample number. The first sample's number is 1.
A 64-bit time value that represents the decode duration of the sample. Returns 0 if sampleTable
is NULL or if the sample number is out of range.
Movies.h
Returns the offset from decode time to display time of a sample.
TimeValue64 QTSampleTableGetDisplayOffset ( QTSampleTableRef sampleTable, SInt64 sampleNum );
A reference to an opaque sample table object.
A 64-bit signed integer that represents the sample number. The first sample's number is 1.
A 64-bit time value that represents the offset from decode time to display time of the sample. Returns 0 if sampleTable
is NULL or if the sample number is out of range.
Movies.h
Finds the next sample number at which one or more of a set of given sample attributes change.
OSStatus QTSampleTableGetNextAttributeChange ( QTSampleTableRef sampleTable, SInt64 startSampleNum, QTSampleTableAttribute attributeMask, SInt64 *sampleNumOut );
A reference to an opaque sample table object.
A 64-bit signed integer that contains the sample number to start searching from.
An unsigned 32-bit integer that contains flags indicating which kinds of attribute changes to search for: kQTSampleTableAttribute_DiscontiguousData
= 1L << 0 Set this flag to find the first sample number num
such that samples num-1 and num
are not adjacent; that is, dataOffset
of num-1 + dataSize
of num-1 != dataOffset
of num
. kQTSampleTableAttribute_DataSizePerSampleChange
= 1L << 1 Set this flag to find the first sample with data size per sample different from that of the starting sample. kQTSampleTableAttribute_DecodeDurationChange
= 1L << 2 Set this flag to find the first sample with decode duration different from that of the starting sample. kQTSampleTableAttribute_DisplayOffsetChange
= 1L << 3 Set this flag to find the first sample with display offset different from that of the starting sample. kQTSampleTableAttribute_SampleDescriptionIDChange
= 1L << 4 Set this flag to find the first sample with sample description ID different from that of the starting sample. kQTSampleTableAttribute_SampleFlagsChange
= 1L << 5 Set this flag to find the first sample with any media sample flags different from those of the starting sample. kQTSampleTableAnyAttributeChange
= 0 If no flags are set, find the first sample with any attribute different from the starting sample. See these constants:
kQTSampleTableAttribute_DiscontiguousData
kQTSampleTableAttribute_DataSizePerSampleChange
kQTSampleTableAttribute_DecodeDurationChange
kQTSampleTableAttribute_DisplayOffsetChange
kQTSampleTableAttribute_SampleDescriptionIDChange
kQTSampleTableAttribute_SampleFlagsChange
kQTSampleTableAnyAttributeChange
A 64-bit signed integer that points to a variable to receive the next sample number after startSampleNum
at which any of the requested attributes change. If no attribute changes are found, this variable is set to 0.
An error code. Returns noErr
if there is no error.
Movies.h
Returns the number of samples in a sample table.
SInt64 QTSampleTableGetNumberOfSamples ( QTSampleTableRef sampleTable );
A reference to an opaque sample table object.
A 64-bit signed integer that contains the number of samples, or 0 if sampleTable
is NULL.
Movies.h
Returns the value of a specific sample table property.
OSStatus QTSampleTableGetProperty ( QTSampleTableRef sampleTable, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, QTPropertyValuePtr outPropValueAddress, ByteCount *outPropValueSizeUsed );
A reference to an opaque sample table object.
Pass the following constant to define the property class: kQTPropertyClass_SampleTable
= 'qtst'
Property of a sample table. See these constants:
kQTPropertyClass_SampleTable
Pass one of these constants to define the property ID: kQTSampleTablePropertyID_TotalDecodeDuration
= 'tded'
The total decode duration of all samples in the sample table. Read-only. kQTSampleTablePropertyID_MinDisplayOffset
= '<ddd' The least display offset in the table. Negative offsets are less than positive offsets. Read-only. kQTSampleTablePropertyID_MaxDisplayOffset
= '>ddd' The greatest display offset in the table. Positive offsets are greater than negative offsets. Read-only. kQTSampleTablePropertyID_MinRelativeDisplayTime
= '<dis' The least display time of all samples in the table, relative to the decode time of the first sample in the table. Read-only. kQTSampleTablePropertyID_MaxRelativeDisplayTime
= '>dis' The greatest display time of all samples in the table, relative to the decode time of the first sample in the table. Read-only. See these constants:
kQTSampleTablePropertyID_TotalDecodeDuration
kQTSampleTablePropertyID_MinDisplayOffset
kQTSampleTablePropertyID_MaxDisplayOffset
kQTSampleTablePropertyID_MinRelativeDisplayTime
kQTSampleTablePropertyID_MaxRelativeDisplayTime
The size of the buffer allocated to receive the property value.
A pointer to the buffer allocated to receive the property value.
On return, the actual size of the property value written to the buffer.
An error code. Returns noErr
if there is no error.
Movies.h
Returns information about the properties of a sample table.
OSStatus QTSampleTableGetPropertyInfo ( QTSampleTableRef sampleTable, QTPropertyClass inPropClass, QTPropertyID inPropID, QTPropertyValueType *outPropType, ByteCount *outPropValueSize, UInt32 *outPropertyFlags );
A reference to an opaque sample table object.
Pass the following constant to define the property class: kQTPropertyClass_SampleTable
= 'qtst'
Property of a sample table. See these constants:
kQTPropertyClass_SampleTable
Pass one of these constants to define the property ID: kQTSampleTablePropertyID_TotalDecodeDuration
= 'tded'
The total decode duration of all samples in the sample table. Read-only. kQTSampleTablePropertyID_MinDisplayOffset
= '<ddd' The least display offset in the table. Negative offsets are less than positive offsets. Read-only. kQTSampleTablePropertyID_MaxDisplayOffset
= '>ddd' The greatest display offset in the table. Positive offsets are greater than negative offsets. Read-only. kQTSampleTablePropertyID_MinRelativeDisplayTime
= '<dis' The least display time of all samples in the table, relative to the decode time of the first sample in the table. Read-only. kQTSampleTablePropertyID_MaxRelativeDisplayTime
= '>dis' The greatest display time of all samples in the table, relative to the decode time of the first sample in the table. Read-only. See these constants:
kQTSampleTablePropertyID_TotalDecodeDuration
kQTSampleTablePropertyID_MinDisplayOffset
kQTSampleTablePropertyID_MaxDisplayOffset
kQTSampleTablePropertyID_MinRelativeDisplayTime
kQTSampleTablePropertyID_MaxRelativeDisplayTime
A pointer to memory allocated to hold the property
type on return: Pass NULL if you do not want this information.
A pointer to memory allocated to hold the size of the property value on return. Pass NULL if you do not want this information.
A pointer to memory allocated to hold property flags on return. Pass NULL if you do not want this information.
An error code. Returns noErr
if there is no error.
Movies.h
Returns the sample description ID of a sample.
QTSampleDescriptionID QTSampleTableGetSampleDescriptionID ( QTSampleTableRef sampleTable, SInt64 sampleNum );
A reference to an opaque sample table object.
A 64-bit signed integer that represents the sample number. The first sample's number is 1.
The sample's sample description ID. Returns 0 if sampleTable
is NULL or if the sample number is out of range.
Movies.h
Returns the media sample flags of a sample.
MediaSampleFlags QTSampleTableGetSampleFlags ( QTSampleTableRef sampleTable, SInt64 sampleNum );
A reference to an opaque sample table object.
A 64-bit signed integer that represents the sample number. The first sample's number is 1.
A constant that describes characteristics of the sample (see below). Returns 0 if sampleTable
is NULL or if the sample number is out of range.
This function can return one or more of the following constants:
Movies.h
Returns the timescale of a sample table.
TimeScale QTSampleTableGetTimeScale ( QTSampleTableRef sampleTable );
A reference to an opaque sample table object.
A long integer that represents the sample's time scale, or 0 if sampleTable
is NULL.
Movies.h
Returns the CFTypeID value for the current sample table.
CFTypeID QTSampleTableGetTypeID ( void );
A CFTypeID
value.
You could use this to test whether a CFTypeRef
that was extracted from a CF container such as a CFArray
is a QTSampleTableRef
.
Movies.h
Decrements the retain count of a sample table.
void QTSampleTableRelease ( QTSampleTableRef sampleTable );
A reference to an opaque sample table object. If you pass NULL in this parameter, nothing happens.
If the retain count decreases to zero, the sample table is disposed.
Movies.h
Replaces a range of samples in a sample table with a range of samples from another sample table.
OSStatus QTSampleTableReplaceRange ( QTMutableSampleTableRef destSampleTable, SInt64 destStartingSampleNum, SInt64 destSampleCount, QTSampleTableRef sourceSampleTable, SInt64 sourceStartingSampleNum, SInt64 sourceSampleCount );
A reference to an opaque sample table object to be modified.
A 64-bit signed integer that represents the first sample number in destSampleTable
to be replaced or deleted, or the sample number at which samples should be inserted.
A 64-bit signed integer that represents the number of samples to be removed from destSampleTable
. Pass 0 to insert samples without removing samples.
A reference to an opaque sample table object from which samples should be copied, or NULL to delete samples.
A 64-bit signed integer that represents the first sample number to be copied. This parameter is ignored when deleting samples.
A 64-bit signed integer that represents the number of samples which should be copied. Pass 0 to delete samples.
An error code. Returns noErr
if there is no error.
This function removes destSampleCount
samples from destSampleTable
starting with destStartingSampleNum
, and then inserts sourceSampleCount
samples from sourceSampleTable
starting with sourceStartingSampleNum
where the removed samples were. Sample descriptions will be copied if necessary and new sample description IDs defined. This function can also be used to delete a range of samples, or to insert samples without removing any.
Movies.h
Increments the retain count of a sample table.
QTSampleTableRef QTSampleTableRetain ( QTSampleTableRef sampleTable );
A reference to an opaque sample table object. If you pass NULL in this parameter, nothing happens.
A pointer to the OpaqueQTSampleTable
structure that is returned for your convenience, or NULL if the function fails.
Movies.h
Sets the value of a specific sample table property.
OSStatus QTSampleTableSetProperty ( QTSampleTableRef sampleTable, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, ConstQTPropertyValuePtr inPropValueAddress );
A reference to an opaque sample table object.
Pass the following constant to define the property class: kQTPropertyClass_SampleTable
= 'qtst'
Property of a sample table. See these constants:
kQTPropertyClass_SampleTable
Pass one of these constants to define the property ID: kQTSampleTablePropertyID_TotalDecodeDuration
= 'tded'
The total decode duration of all samples in the sample table. Read-only. kQTSampleTablePropertyID_MinDisplayOffset
= '<ddd' The least display offset in the table. Negative offsets are less than positive offsets. Read-only. kQTSampleTablePropertyID_MaxDisplayOffset
= '>ddd' The greatest display offset in the table. Positive offsets are greater than negative offsets. Read-only. kQTSampleTablePropertyID_MinRelativeDisplayTime
= '<dis' The least display time of all samples in the table, relative to the decode time of the first sample in the table. Read-only. kQTSampleTablePropertyID_MaxRelativeDisplayTime
= '>dis' The greatest display time of all samples in the table, relative to the decode time of the first sample in the table. Read-only. See these constants:
kQTSampleTablePropertyID_TotalDecodeDuration
kQTSampleTablePropertyID_MinDisplayOffset
kQTSampleTablePropertyID_MaxDisplayOffset
kQTSampleTablePropertyID_MinRelativeDisplayTime
kQTSampleTablePropertyID_MaxRelativeDisplayTime
Pass the size of the property value.
Pass a const
void pointer to the property value.
An error code. Returns noErr
if there is no error.
Movies.h
Changes the timescale of a sample table.
OSStatus QTSampleTableSetTimeScale ( QTMutableSampleTableRef sampleTable, TimeScale newTimeScale );
A reference to an opaque sample table object.
A long integer whose value is the time scale to be set.
An error code. Returns paramErr
if the time scale is not positive or sampleTable
is NULL, or noErr
if there is no error.
The durations and display offsets of all the sample references in the sample table are scaled from the old timescale to the new timescale. No durations are scaled to a value less than 1. Display offsets are adjusted to avoid display time collisions.
Movies.h
Sets the value of a specific movie property.
OSErr QTSetMovieProperty ( Movie inMovie, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, ConstQTPropertyValuePtr inPropValueAddress );
The movie for this operation. Your application obtains this movie identifier from such functions as NewMovie
, NewMovieFromFile
, and NewMovieFromHandle
.
A property class.
A property ID.
The size of the property value.
A pointer to the the property value.
See Error Codes
in the QuickTime API Reference. Returns noErr
if there is no error.
Introduced in QuickTime 6.4.
Movies.h
Sets the value of a specific track property.
OSErr QTSetTrackProperty ( Track inTrack, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, ConstQTPropertyValuePtr inPropValueAddress );
The track for this operation.
A property class.
A property ID.
The size of the property value.
A pointer to the the property value.
An error code. Returns noErr
if there is no error.
This routine sets the value of a specific track property.
Movies.h
Undocumented
typedef OSErr (*QTBandwidthNotificationProcPtr) (long flags, void *reserved, void *refcon);
If you name your function MyQTBandwidthNotificationProc
, you would declare it this way:
OSErr MyQTBandwidthNotificationProc ( long flags, void *reserved, void *refcon );
Undocumented
Reserved.
Pointer to 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.
See Error Codes
. Your callback should return noErr
if there is no error.
Movies.h
Represents a type used by the Movie Properties API.
typedef STACK_UPP_TYPE(QTBandwidthNotificationProcPtr) QTBandwidthNotificationUPP;
Movies.h
Represents a type used by the Movie Properties API.
typedef struct OpaqueQTBandwidthReference * QTBandwidthReference;
Movies.h
Represents a type used by the Movie Properties API.
typedef QTScheduledBandwidthRecord * QTScheduledBandwidthPtr;
Movies.h
Provides information to the QTScheduledBandwidthRequest function.
struct QTScheduledBandwidthRecord { long recordSize; long priority; long dataRate; CompTimeValue startTime; CompTimeValue duration; TimeScale scale; TimeBase base; };
recordSize
The number of bytes in this structure.
priority
Undocumented
dataRate
The data rate.
startTime
The bandwidth usage start time.
duration
Duration
of bandwidth usage, or 0 if unknown.
scale
The timescale of the duration
field.
base
The time base.
Movies.h
Represents a type used by the Movie Properties API.
typedef struct OpaqueQTScheduledBandwidthReference * QTScheduledBandwidthReference;
Movies.h
Constants grouped with kQTPropertyClass_SampleTable.
enum { /* * Property class for sample tables. */ kQTPropertyClass_SampleTable = 'qtst', /* * The total decode duration of all samples in the sample table. * Read-only. */ kQTSampleTablePropertyID_TotalDecodeDuration = 'tded', /* TimeValue64, Read */ /* * The least display offset in the table. (-50 is a lesser offset * than 20.) Read-only. */ kQTSampleTablePropertyID_MinDisplayOffset = '<ddd', /* TimeValue64, Read */ /* * The greatest display offset in the table. (20 is a greater offset * than -50.) Read-only. */ kQTSampleTablePropertyID_MaxDisplayOffset = '>ddd', /* TimeValue64, Read */ /* * The least display time of all samples in the table, relative to * the decode time of the first sample in the table. Read-only. */ kQTSampleTablePropertyID_MinRelativeDisplayTime = '<dis', /* TimeValue64, Read */ /* * The greatest display time of all samples in the table, relative to * the decode time of the first sample in the table. Read-only. */ kQTSampleTablePropertyID_MaxRelativeDisplayTime = '>dis' /* TimeValue64, Read */ };
Movies.h
Constants passed to QTSampleTableGetNextAttributeChange.
enum { /* * Set this flag to find first num such that samples num-1 and num * are not adjacent, ie, dataOffset of num-1 + dataSize of num-1 != * dataOffset of num */ kQTSampleTableAttribute_DiscontiguousData = 1L << 0, /* * Set this flag to find the first sample with data size per sample * different from that of the starting sample. */ kQTSampleTableAttribute_DataSizePerSampleChange = 1L << 1, /* * Set this flag to find the first sample with decode duration * different from that of the starting sample. */ kQTSampleTableAttribute_DecodeDurationChange = 1L << 2, /* * Set this flag to find the first sample with display offset * different from that of the starting sample. */ kQTSampleTableAttribute_DisplayOffsetChange = 1L << 3, /* * Set this flag to find the first sample with sample description ID * different from that of the starting sample. */ kQTSampleTableAttribute_SampleDescriptionIDChange = 1L << 4, /* * Set this flag to find the first sample with any media sample flags * different from those of the starting sample. */ kQTSampleTableAttribute_SampleFlagsChange = 1L << 5, /* * If no flags are set, find the first sample with any attribute * different from the starting sample. */ kQTSampleTableAnyAttributeChange = 0 };
Movies.h
Constants passed to QTSampleTableGetSampleFlags.
enum { mediaSampleNotSync = 1 << 0, /* sample is not a sync sample (eg. is frame differenced */ mediaSampleShadowSync = 1 << 1, /* sample is a shadow sync */ mediaSampleDroppable = 1 << 27, /* sample is not required to be decoded for later samples to be decoded properly */ mediaSamplePartialSync = 1 << 16, /* sample is a partial sync (e.g., I frame after open GOP) */ mediaSampleHasRedundantCoding = 1 << 24, /* sample is known to contain redundant coding */ mediaSampleHasNoRedundantCoding = 1 << 25, /* sample is known not to contain redundant coding */ mediaSampleIsDependedOnByOthers = 1 << 26, /* one or more other samples depend upon the decode of this sample */ mediaSampleIsNotDependedOnByOthers = 1 << 27, /* synonym for mediaSampleDroppable */ mediaSampleDependsOnOthers = 1 << 28, /* sample's decode depends upon decode of other samples */ mediaSampleDoesNotDependOnOthers = 1 << 29, /* sample's decode does not depend upon decode of other samples */ mediaSampleEarlierDisplayTimesAllowed = 1 << 30 /* samples later in decode order may have earlier display times */ };
mediaSampleNotSync
Returned for frame-differenced video sample data.
Available in Mac OS X v10.0 and later.
Declared in Movies.h
.
Movies.h
© 2006 Apple Computer, Inc. All Rights Reserved. (Last updated: 2006-05-23)