Mac Developer Library

Developer

Frameworks Framework Reference QuickTime Movie Properties Reference

Options
Deployment Target:

On This Page
Language:

QuickTime Movie Properties Reference

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


Swift

import QuickTime

Objective-C

@import QuickTime;

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.

Functions

  • Retains a media's metadata object and returns it.

    Declaration

    Objective-C

    OSStatus QTCopyMediaMetaData ( Media inMedia, QTMetaDataRef *outMetaData );

    Parameters

    inMedia

    The media for this operation. You obtain this media identifier from such functions as NewTrackMedia and GetTrackMedia.

    outMetaData

    A pointer to an opaque metadata object wrapper associated with the media passed in inMedia.

    Return Value

    Returns invalidMedia if the media passed in inMedia is invalid, or noErr if there is no error.

    Discussion

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Retains a movie's metadata object and returns it.

    Declaration

    Objective-C

    OSStatus QTCopyMovieMetaData ( Movie inMovie, QTMetaDataRef *outMetaData );

    Parameters

    inMovie

    The movie for this operation. Your application obtains this movie identifier from such functions as NewMovie, NewMovieFromProperties, NewMovieFromFile, and NewMovieFromHandle.

    outMetaData

    A pointer to an opaque metadata object wrapper associated with the movie passed in inMovie.

    Return Value

    Returns invalidMovie if the movie passed in inMovie is invalid, or noErr if there is no error.

    Discussion

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Retains a track's metadata object and returns it.

    Declaration

    Objective-C

    OSStatus QTCopyTrackMetaData ( Track inTrack, QTMetaDataRef *outMetaData );

    Parameters

    inTrack

    A track identifier, which your application obtains from such functions as NewMovieTrack and GetMovieTrack.

    outMetaData

    A pointer to an opaque metadata object wrapper associated with the track passed in inTrack.

    Return Value

    Returns invalidMedia if the track passed in inTrack is invalid, or noErr if there is no error.

    Discussion

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Adds an inline metadata item to the metadata storage format.

    Declaration

    Objective-C

    OSStatus QTMetaDataAddItem ( QTMetaDataRef inMetaData, QTMetaDataStorageFormat inMetaDataFormat, QTMetaDataKeyFormat inKeyFormat, const UInt8 *inKeyPtr, ByteCount inKeySize, const UInt8 *inValuePtr, ByteCount inValueSize, UInt32 inDataType, QTMetaDataItem *outItem );

    Parameters

    inMetaData

    The metadata object for this operation.

    inMetaDataFormat

    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.

    inKeyFormat

    The format of the key.

    inKeyPtr

    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.

    inKeySize

    The size of the key in bytes.

    inValuePtr

    A pointer to the value to be added. This can be NULL if inValueSize is 0.

    inValueSize

    The size of inValuePtr in bytes. Pass 0 if you want to add an item with no value.

    inDataType

    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.

    outItem

    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.

    Return Value

    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.

    Discussion

    The data type of the metadata item is assumed to be binary.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns a property of a metadata item.

    Declaration

    Objective-C

    OSStatus QTMetaDataGetItemProperty ( QTMetaDataRef inMetaData, QTMetaDataItem inItem, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, QTPropertyValuePtr outPropValueAddress, ByteCount *outPropValueSizeUsed );

    Parameters

    inMetaData

    The metadata object for this operation.

    inItem

    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.

    inPropClass

    The class of the property being asked about.

    inPropID

    The ID of the property being asked about.

    inPropValueSize

    Size of the buffer allocated to receive the property value.

    outPropValueAddress

    A pointer to the buffer allocated to receive the item's property value.

    outPropValueSizeUsed

    On return, the actual size of buffer space used.

    Return Value

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns information about a property of a metadata item.

    Declaration

    Objective-C

    OSStatus QTMetaDataGetItemPropertyInfo ( QTMetaDataRef inMetaData, QTMetaDataItem inItem, QTPropertyClass inPropClass, QTPropertyID inPropID, QTPropertyValueType *outPropType, ByteCount *outPropValueSize, UInt32 *outPropFlags );

    Parameters

    inMetaData

    The metadata object for this operation.

    inItem

    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.

    inPropClass

    The class of the property being asked about.

    inPropID

    The ID of the property being asked about.

    outPropType

    A pointer to the type of the returned property's value.

    outPropValueSize

    A pointer to the size of the returned property's value.

    outPropFlags

    On return, a pointer to flags representing the requested information about the item's property.

    Return Value

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns the value of a metadata item from an item identifier.

    Declaration

    Objective-C

    OSStatus QTMetaDataGetItemValue ( QTMetaDataRef inMetaData, QTMetaDataItem inItem, UInt8 *outValuePtr, ByteCount inValueSize, ByteCount *outActualSize );

    Parameters

    inMetaData

    The metadata object for this operation.

    inItem

    The opaque, unique UInt64 identifier of the metadata item for this operation. Your application can obtain this item identifier from such functions as QTMetaDataAddItem.

    outValuePtr

    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.

    inValueSize

    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.

    outActualSize

    The actual size of the value if this parameter is not NULL.

    Return Value

    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.

    Discussion

    You can use this function to get the value of a metadata item that has a known item identifier.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns the next metadata item corresponding to a specified key.

    Declaration

    Objective-C

    OSStatus QTMetaDataGetNextItem ( QTMetaDataRef inMetaData, QTMetaDataStorageFormat inMetaDataFormat, QTMetaDataItem inCurrentItem, QTMetaDataKeyFormat inKeyFormat, const UInt8 *inKeyPtr, ByteCount inKeySize, QTMetaDataItem *outNextItem );

    Parameters

    inMetaData

    The metadata object for this operation.

    inMetaDataFormat

    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.

    inCurrentItem

    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.

    inKeyFormat

    The format of the key.

    inKeyPtr

    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.

    inKeySize

    The size of the key in bytes.

    outNextItem

    The ID of the next metadata item after the item specified by inCurrentItem that has the specified key.

    Return Value

    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.

    Discussion

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns a property of a metadata object.

    Declaration

    Objective-C

    OSStatus QTMetaDataGetProperty ( QTMetaDataRef inMetaData, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, QTPropertyValuePtr outPropValueAddress, ByteCount *outPropValueSizeUsed );

    Parameters

    inMetaData

    The metadata object for this operation.

    inPropClass

    The class of the property being asked about.

    inPropID

    The ID of the property being asked about.

    inPropValueSize

    Size of the buffer allocated to receive the property value.

    outPropValueAddress

    A pointer to the buffer allocated to receive the property value.

    outPropValueSizeUsed

    On return, the actual size of buffer space used.

    Return Value

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns information about a property of a metadata object.

    Declaration

    Objective-C

    OSStatus QTMetaDataGetPropertyInfo ( QTMetaDataRef inMetaData, QTPropertyClass inPropClass, QTPropertyID inPropID, QTPropertyValueType *outPropType, ByteCount *outPropValueSize, UInt32 *outPropFlags );

    Parameters

    inMetaData

    The metadata object for this operation.

    inPropClass

    The class of the property being asked about.

    inPropID

    The ID of the property being asked about.

    outPropType

    A pointer to the type of the returned property's value.

    outPropValueSize

    A pointer to the size of the returned property's value.

    outPropFlags

    On return, a pointer to flags representing the requested information about the property.

    Return Value

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Decrements the retain count of a metadata object.

    Declaration

    Objective-C

    void QTMetaDataRelease ( QTMetaDataRef inMetaData );

    Discussion

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Removes a metadata item from a storage format.

    Declaration

    Objective-C

    OSStatus QTMetaDataRemoveItem ( QTMetaDataRef inMetaData, QTMetaDataItem inItem );

    Parameters

    inMetaData

    The metadata object for this operation.

    inItem

    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.

    Return Value

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Removes metadata items with a specific key from the storage format.

    Declaration

    Objective-C

    OSStatus QTMetaDataRemoveItemsWithKey ( QTMetaDataRef inMetaData, QTMetaDataStorageFormat inMetaDataFormat, QTMetaDataKeyFormat inKeyFormat, const UInt8 *inKeyPtr, ByteCount inKeySize );

    Parameters

    inMetaData

    The metadata object for this operation.

    inMetaDataFormat

    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.

    inKeyFormat

    The format of the key.

    inKeyPtr

    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.

    inKeySize

    The size of the key in bytes.

    Return Value

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Increments the retain count of a metadata object.

    Declaration

    Objective-C

    QTMetaDataRef QTMetaDataRetain ( QTMetaDataRef inMetaData );

    Parameters

    inMetaData

    A metadata object that you want to retain.

    Return Value

    If successful, returns a metadata object that is the same as that passed in inMetaData.

    Discussion

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Sets the value of the metadata item from the item identifier.

    Declaration

    Objective-C

    OSStatus QTMetaDataSetItem ( QTMetaDataRef inMetaData, QTMetaDataItem inItem, UInt8 *inValuePtr, ByteCount inValueSize, UInt32 inDataType );

    Parameters

    inMetaData

    The metadata object for this operation.

    inItem

    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.

    inValuePtr

    A pointer to the value to be set. This can be NULL if inValueSize is 0.

    inValueSize

    The size of inValuePtr in bytes. Pass 0 if you want to set an item with no value.

    inDataType

    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.

    Return Value

    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.

    Discussion

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Sets a property of a metadata item.

    Declaration

    Objective-C

    OSStatus QTMetaDataSetItemProperty ( QTMetaDataRef inMetaData, QTMetaDataItem inItem, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, ConstQTPropertyValuePtr inPropValueAddress );

    Parameters

    inMetaData

    The metadata object for this operation.

    inItem

    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.

    inPropClass

    The class of the property being set.

    inPropID

    The ID of the property being set.

    inPropValueSize

    Size of the buffer containing the property value being set.

    inPropValueAddress

    A pointer to the buffer containing the item property value being set.

    Return Value

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Sets a property of a metadata object.

    Declaration

    Objective-C

    OSStatus QTMetaDataSetProperty ( QTMetaDataRef inMetaData, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, ConstQTPropertyValuePtr inPropValueAddress );

    Parameters

    inMetaData

    The metadata object for this operation.

    inPropClass

    The class of the property being set.

    inPropID

    The ID of the property being set.

    inPropValueSize

    Size of the buffer containing the property value being set.

    inPropValueAddress

    A pointer to the buffer containing the property value being set.

    Return Value

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Adds a sample description to a sample table, returning a sample description ID that can be used to refer to it.

    Declaration

    Objective-C

    OSStatus QTSampleTableAddSampleDescription ( QTMutableSampleTableRef sampleTable, SampleDescriptionHandle sampleDescriptionH, long mediaSampleDescriptionIndex, QTSampleDescriptionID *sampleDescriptionIDOut );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    sampleDescriptionH

    A handle to a SampleDescription structure. QuickTime will make its own copy of this handle.

    mediaSampleDescriptionIndex

    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.

    sampleDescriptionIDOut

    A pointer to a variable to receive a sample description ID.

    Return Value

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

    Discussion

    You can use the returned sample description ID when adding samples to the sample table.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Adds sample references to a sample table.

    Declaration

    Objective-C

    OSStatus QTSampleTableAddSampleReferences ( QTMutableSampleTableRef sampleTable, SInt64 dataOffset, ByteCount dataSizePerSample, TimeValue64 decodeDurationPerSample, TimeValue64 displayOffset, SInt64 numberOfSamples, MediaSampleFlags sampleFlags, QTSampleDescriptionID sampleDescriptionID, SInt64 *newSampleNumOut );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    dataOffset

    A 64-bit signed integer that specifies the offset at which the first sample begins.

    dataSizePerSample

    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.

    decodeDurationPerSample

    A 64-bit time value that specifies the decode duration of each sample.

    displayOffset

    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.

    numberOfSamples

    A 64-bit signed integer, which must be greater than 0, that specifies the number of samples.

    sampleFlags

    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

    sampleDescriptionID

    The ID of a sample description that has been added to the sample table with QTSampleTableAddSampleDescription.

    newSampleNumOut

    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.

    Return Value

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

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Retrieves a sample description from a sample table.

    Declaration

    Objective-C

    OSStatus QTSampleTableCopySampleDescription ( QTSampleTableRef sampleTable, QTSampleDescriptionID sampleDescriptionID, long *mediaSampleDescriptionIndexOut, SampleDescriptionHandle *sampleDescriptionHOut );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    sampleDescriptionID

    The sample description ID.

    mediaSampleDescriptionIndexOut

    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.

    sampleDescriptionHOut

    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.

    Return Value

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

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Creates a new, empty sample table.

    Declaration

    Objective-C

    OSStatus QTSampleTableCreateMutable ( CFAllocatorRef allocator, TimeScale timescale, void *hints, QTMutableSampleTableRef *newSampleTable );

    Parameters

    allocator

    The allocator to use for the new sample table.

    timescale

    A long integer that represents the timescale to use for durations and display offsets.

    hints

    Reserved; pass NULL.

    newSampleTable

    A pointer to a variable that receives a new reference to an opaque sample table object.

    Return Value

    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.

    Discussion

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Copies a sample table.

    Declaration

    Objective-C

    OSStatus QTSampleTableCreateMutableCopy ( CFAllocatorRef allocator, QTSampleTableRef sampleTable, void *hints, QTMutableSampleTableRef *newSampleTable );

    Parameters

    allocator

    The allocator to use for the new sample table.

    sampleTable

    A reference to an opaque sample table object to copy.

    hints

    Reserved; set to NULL.

    newSampleTable

    A pointer to a variable that receives a reference to an opaque sample table object.

    Return Value

    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.

    Discussion

    All the sample references and sample descriptions in the sample table are copied.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns the data offset of a sample.

    Declaration

    Objective-C

    SInt64 QTSampleTableGetDataOffset ( QTSampleTableRef sampleTable, SInt64 sampleNum );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    sampleNum

    A 64-bit signed integer that represents a sample number. The first sample's number is 1.

    Return Value

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns the data size of a sample.

    Declaration

    Objective-C

    ByteCount QTSampleTableGetDataSizePerSample ( QTSampleTableRef sampleTable, SInt64 sampleNum );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    sampleNum

    A 64-bit signed integer that represents the sample number. The first sample's number is 1.

    Return Value

    The size of the sample in bytes. Returns 0 if sampleTable is NULL or if the sample number is out of range.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns the decode duration of a sample.

    Declaration

    Objective-C

    TimeValue64 QTSampleTableGetDecodeDuration ( QTSampleTableRef sampleTable, SInt64 sampleNum );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    sampleNum

    A 64-bit signed integer that represents the sample number. The first sample's number is 1.

    Return Value

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns the offset from decode time to display time of a sample.

    Declaration

    Objective-C

    TimeValue64 QTSampleTableGetDisplayOffset ( QTSampleTableRef sampleTable, SInt64 sampleNum );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    sampleNum

    A 64-bit signed integer that represents the sample number. The first sample's number is 1.

    Return Value

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Finds the next sample number at which one or more of a set of given sample attributes change.

    Declaration

    Objective-C

    OSStatus QTSampleTableGetNextAttributeChange ( QTSampleTableRef sampleTable, SInt64 startSampleNum, QTSampleTableAttribute attributeMask, SInt64 *sampleNumOut );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    startSampleNum

    A 64-bit signed integer that contains the sample number to start searching from.

    attributeMask

    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

    sampleNumOut

    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.

    Return Value

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

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns the number of samples in a sample table.

    Declaration

    Objective-C

    SInt64 QTSampleTableGetNumberOfSamples ( QTSampleTableRef sampleTable );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    Return Value

    A 64-bit signed integer that contains the number of samples, or 0 if sampleTable is NULL.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns the value of a specific sample table property.

    Declaration

    Objective-C

    OSStatus QTSampleTableGetProperty ( QTSampleTableRef sampleTable, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, QTPropertyValuePtr outPropValueAddress, ByteCount *outPropValueSizeUsed );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    inPropClass

    Pass the following constant to define the property class: kQTPropertyClass_SampleTable = 'qtst' Property of a sample table. See these constants:

    • kQTPropertyClass_SampleTable

    inPropID

    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

    inPropValueSize

    The size of the buffer allocated to receive the property value.

    outPropValueAddress

    A pointer to the buffer allocated to receive the property value.

    outPropValueSizeUsed

    On return, the actual size of the property value written to the buffer.

    Return Value

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

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns information about the properties of a sample table.

    Declaration

    Objective-C

    OSStatus QTSampleTableGetPropertyInfo ( QTSampleTableRef sampleTable, QTPropertyClass inPropClass, QTPropertyID inPropID, QTPropertyValueType *outPropType, ByteCount *outPropValueSize, UInt32 *outPropertyFlags );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    inPropClass

    Pass the following constant to define the property class: kQTPropertyClass_SampleTable = 'qtst' Property of a sample table. See these constants:

    • kQTPropertyClass_SampleTable

    inPropID

    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

    outPropType

    A pointer to memory allocated to hold the property type on return: Pass NULL if you do not want this information.

    outPropValueSize

    A pointer to memory allocated to hold the size of the property value on return. Pass NULL if you do not want this information.

    outPropertyFlags

    A pointer to memory allocated to hold property flags on return. Pass NULL if you do not want this information.

    Return Value

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

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns the sample description ID of a sample.

    Declaration

    Objective-C

    QTSampleDescriptionID QTSampleTableGetSampleDescriptionID ( QTSampleTableRef sampleTable, SInt64 sampleNum );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    sampleNum

    A 64-bit signed integer that represents the sample number. The first sample's number is 1.

    Return Value

    The sample's sample description ID. Returns 0 if sampleTable is NULL or if the sample number is out of range.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns the media sample flags of a sample.

    Declaration

    Objective-C

    MediaSampleFlags QTSampleTableGetSampleFlags ( QTSampleTableRef sampleTable, SInt64 sampleNum );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    sampleNum

    A 64-bit signed integer that represents the sample number. The first sample's number is 1.

    Return Value

    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.

    Discussion

    This function can return one or more of the following constants:

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns the timescale of a sample table.

    Declaration

    Objective-C

    TimeScale QTSampleTableGetTimeScale ( QTSampleTableRef sampleTable );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    Return Value

    A long integer that represents the sample's time scale, or 0 if sampleTable is NULL.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns the CFTypeID value for the current sample table.

    Declaration

    Objective-C

    CFTypeID QTSampleTableGetTypeID ( void );

    Return Value

    A CFTypeID value.

    Discussion

    You could use this to test whether a CFTypeRef that was extracted from a CF container such as a CFArray is a QTSampleTableRef.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Decrements the retain count of a sample table.

    Declaration

    Objective-C

    void QTSampleTableRelease ( QTSampleTableRef sampleTable );

    Parameters

    sampleTable

    A reference to an opaque sample table object. If you pass NULL in this parameter, nothing happens.

    Discussion

    If the retain count decreases to zero, the sample table is disposed.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Replaces a range of samples in a sample table with a range of samples from another sample table.

    Declaration

    Objective-C

    OSStatus QTSampleTableReplaceRange ( QTMutableSampleTableRef destSampleTable, SInt64 destStartingSampleNum, SInt64 destSampleCount, QTSampleTableRef sourceSampleTable, SInt64 sourceStartingSampleNum, SInt64 sourceSampleCount );

    Parameters

    destSampleTable

    A reference to an opaque sample table object to be modified.

    destStartingSampleNum

    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.

    destSampleCount

    A 64-bit signed integer that represents the number of samples to be removed from destSampleTable. Pass 0 to insert samples without removing samples.

    sourceSampleTable

    A reference to an opaque sample table object from which samples should be copied, or NULL to delete samples.

    sourceStartingSampleNum

    A 64-bit signed integer that represents the first sample number to be copied. This parameter is ignored when deleting samples.

    sourceSampleCount

    A 64-bit signed integer that represents the number of samples which should be copied. Pass 0 to delete samples.

    Return Value

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

    Discussion

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Increments the retain count of a sample table.

    Declaration

    Objective-C

    QTSampleTableRef QTSampleTableRetain ( QTSampleTableRef sampleTable );

    Parameters

    sampleTable

    A reference to an opaque sample table object. If you pass NULL in this parameter, nothing happens.

    Return Value

    A pointer to the OpaqueQTSampleTable structure that is returned for your convenience, or NULL if the function fails.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Sets the value of a specific sample table property.

    Declaration

    Objective-C

    OSStatus QTSampleTableSetProperty ( QTSampleTableRef sampleTable, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, ConstQTPropertyValuePtr inPropValueAddress );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    inPropClass

    Pass the following constant to define the property class: kQTPropertyClass_SampleTable = 'qtst' Property of a sample table. See these constants:

    • kQTPropertyClass_SampleTable

    inPropID

    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

    inPropValueSize

    Pass the size of the property value.

    inPropValueAddress

    Pass a const void pointer to the property value.

    Return Value

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

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Changes the timescale of a sample table.

    Declaration

    Objective-C

    OSStatus QTSampleTableSetTimeScale ( QTMutableSampleTableRef sampleTable, TimeScale newTimeScale );

    Parameters

    sampleTable

    A reference to an opaque sample table object.

    newTimeScale

    A long integer whose value is the time scale to be set.

    Return Value

    An error code. Returns paramErr if the time scale is not positive or sampleTable is NULL, or noErr if there is no error.

    Discussion

    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.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Disposes of a QTBandwidthNotificationUPP pointer.

    Declaration

    Objective-C

    void DisposeQTBandwidthNotificationUPP ( QTBandwidthNotificationUPP userUPP );

    Parameters

    userUPP

    A QTBandwidthNotificationUPP pointer. See Universal Procedure Pointers.

    Return Value

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

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.0 and later.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • Disposes a track property listener UPP.

    Declaration

    Objective-C

    void DisposeQTTrackPropertyListenerUPP ( QTTrackPropertyListenerUPP userUPP );

    Parameters

    userUPP

    A QTTrackPropertyListenerUPP pointer. See Universal Procedure Pointers in the QuickTime API Reference for more information.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Invokes the specified property listener of a track.

    Declaration

    Objective-C

    void InvokeQTTrackPropertyListenerUPP ( Track inTrack, QTPropertyClass inPropClass, QTPropertyID inPropID, void *inUserData, QTTrackPropertyListenerUPP userUPP );

    Parameters

    inTrack

    The track of this operation.

    inPropClass

    A property class.

    inPropID

    A property ID.

    inUserData

    A pointer to user data that will be passed to the callback.

    userUPP

    A QTTrackPropertyListenerUPP pointer.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Undocumented

    Declaration

    Objective-C

    ComponentResult MusicMediaGetIndexedTunePlayer ( ComponentInstance ti, long sampleDescIndex, ComponentInstance *tp );

    Parameters

    ti

    Undocumented

    sampleDescIndex

    Undocumented

    tp

    A pointer to a tune player component instance.

    Return Value

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

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.0 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Allocates a Universal Procedure Pointer for the QTBandwidthNotificationProc callback.

    Declaration

    Objective-C

    QTBandwidthNotificationUPP NewQTBandwidthNotificationUPP ( QTBandwidthNotificationProcPtr userRoutine );

    Parameters

    userRoutine

    A pointer to your application-defined function.

    Return Value

    A new UPP; see Universal Procedure Pointers.

    Discussion

    This function is used with Macintosh PowerPC systems. See Inside Macintosh: PowerPC System Software.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.0 and later.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • Creates a new callback to monitor a track property.

    Declaration

    Objective-C

    QTTrackPropertyListenerUPP NewQTTrackPropertyListenerUPP ( QTTrackPropertyListenerProcPtr userRoutine );

    Parameters

    userRoutine

    A pointer to a QTTrackPropertyListenerProcPtr callback.

    Return Value

    A new UPP; see Universal Procedure Pointers in the QuickTime API Reference.

    Discussion

    This routine creates a new callback to monitor a track property.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Installs a callback to monitor a movie property.

    Declaration

    Objective-C

    OSErr QTAddMoviePropertyListener ( Movie inMovie, QTPropertyClass inPropClass, QTPropertyID inPropID, QTMoviePropertyListenerUPP inListenerProc, void *inUserData );

    Parameters

    inMovie

    The movie for this operation. Your application obtains this movie identifier from such functions as NewMovie, NewMovieFromFile, and NewMovieFromHandle.

    inPropClass

    A property class.

    inPropID

    A property ID.

    inListenerProc

    A Universal Procedure Pointer to a QTMoviePropertyListenerProc callback.

    inUserData

    A pointer to user data that will be passed to the callback.

    Return Value

    See Error Codes in the QuickTime API Reference. Returns noErr if there is no error.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.3 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Installs a callback to monitor a track property.

    Declaration

    Objective-C

    OSErr QTAddTrackPropertyListener ( Track inTrack, QTPropertyClass inPropClass, QTPropertyID inPropID, QTTrackPropertyListenerUPP inListenerProc, void *inUserData );

    Parameters

    inTrack

    The track for this operation.

    inPropClass

    A property class.

    inPropID

    A property ID.

    inListenerProc

    A Universal Procedure Pointer to a QTTrackPropertyListenerProc callback.

    inUserData

    A pointer to user data that will be passed to the callback.

    Return Value

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

    Discussion

    This routine installs a callback to monitor a track property.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Undocumented

    Declaration

    Objective-C

    OSErr QTBandwidthRelease ( QTBandwidthReference bwRef, long flags );

    Parameters

    bwRef

    Undocumented

    flags

    Undocumented

    Return Value

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

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.0 and later.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • Undocumented

    Declaration

    Objective-C

    OSErr QTBandwidthRequest ( long priority, QTBandwidthNotificationUPP callback, const void *refcon, QTBandwidthReference *bwRef, long flags );

    Parameters

    priority

    Undocumented

    callback

    A QTBandwidthNotificationProc callback.

    refcon

    A reference constant to be passed to your callback. Use this parameter to point to a data structure containing any information your function needs.

    bwRef

    Undocumented

    flags

    Undocumented

    Return Value

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

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.0 and later.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • Undocumented

    Declaration

    Objective-C

    OSErr QTBandwidthRequestForTimeBase ( TimeBase tb, long priority, QTBandwidthNotificationUPP callback, const void *refcon, QTBandwidthReference *bwRef, long flags );

    Parameters

    tb

    A time base. Your application obtains this time base identifier from NewTimeBase.

    priority

    Undocumented

    callback

    A QTBandwidthNotificationProc callback.

    refcon

    A reference constant to be passed to your callback. Use this parameter to point to a data structure containing any information your function needs.

    bwRef

    Undocumented

    flags

    Undocumented

    Return Value

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

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.0 and later.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • Returns the value of a specific movie property.

    Declaration

    Objective-C

    OSErr QTGetMovieProperty ( Movie inMovie, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, QTPropertyValuePtr outPropValueAddress, ByteCount *outPropValueSizeUsed );

    Parameters

    inMovie

    The movie for this operation. Your application obtains this movie identifier from such functions as NewMovie, NewMovieFromFile, and NewMovieFromHandle.

    inPropClass

    A property class.

    inPropID

    A property ID.

    inPropValueSize

    The size of the buffer allocated to hold the property value.

    outPropValueAddress

    A pointer to the buffer allocated to hold the property value.

    outPropValueSizeUsed

    On return, the actual size of the value written to the buffer.

    Return Value

    See Error Codes in the QuickTime API Reference. Returns noErr if there is no error.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.3 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns information about the properties of a movie.

    Declaration

    Objective-C

    OSErr QTGetMoviePropertyInfo ( Movie inMovie, QTPropertyClass inPropClass, QTPropertyID inPropID, QTPropertyValueType *outPropType, ByteCount *outPropValueSize, UInt32 *outPropertyFlags );

    Parameters

    inMovie

    The movie for this operation. Your application obtains this movie identifier from such functions as NewMovie, NewMovieFromFile, and NewMovieFromHandle.

    inPropClass

    A property class.

    inPropID

    A property ID.

    outPropType

    A pointer to memory allocated to hold the property type on return.

    outPropValueSize

    A pointer to memory allocated to hold the size of the property value on return.

    outPropertyFlags

    A pointer to memory allocated to hold property flags on return.

    Return Value

    See Error Codes in the QuickTime API Reference. Returns noErr if there is no error.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.3 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns the value of a specific track property.

    Declaration

    Objective-C

    OSErr QTGetTrackProperty ( Track inTrack, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, QTPropertyValuePtr outPropValueAddress, ByteCount *outPropValueSizeUsed );

    Parameters

    inTrack

    The track for this operation.

    inPropClass

    A property class.

    inPropID

    A property ID.

    inPropValueSize

    The size of the buffer allocated to hold the property value.

    outPropValueAddress

    A pointer to the buffer allocated to hold the property value.

    outPropValueSizeUsed

    On return, the actual size of the value written to the buffer.

    Return Value

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

    Discussion

    This routine returns the value of a specific track property.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Returns information about the properties of a track.

    Declaration

    Objective-C

    OSErr QTGetTrackPropertyInfo ( Track inTrack, QTPropertyClass inPropClass, QTPropertyID inPropID, QTPropertyValueType *outPropType, ByteCount *outPropValueSize, UInt32 *outPropertyFlags );

    Parameters

    inTrack

    The track for this operation.

    inPropClass

    A property class.

    inPropID

    A property ID.

    outPropType

    A pointer to memory allocated to hold the property type on return.

    outPropValueSize

    A pointer to memory allocated to hold the size of the property value on return.

    outPropertyFlags

    A pointer to memory allocated to hold property flags on return.

    Return Value

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

    Discussion

    This routine returns information about the properties of a track.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Removes a movie property monitoring callback.

    Declaration

    Objective-C

    OSErr QTRemoveMoviePropertyListener ( Movie inMovie, QTPropertyClass inPropClass, QTPropertyID inPropID, QTMoviePropertyListenerUPP inListenerProc, void *inUserData );

    Parameters

    inMovie

    The movie for this operation. Your application obtains this movie identifier from such functions as NewMovie, NewMovieFromFile, and NewMovieFromHandle.

    inPropClass

    A property class.

    inPropID

    A property ID.

    inListenerProc

    A Universal Procedure Pointer to a QTMoviePropertyListenerProc callback.

    inUserData

    User data to be passed to the callback.

    Return Value

    See Error Codes in the QuickTime API Reference. Returns noErr if there is no error.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.3 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Removes a track property monitoring callback

    Declaration

    Objective-C

    OSErr QTRemoveTrackPropertyListener ( Track inTrack, QTPropertyClass inPropClass, QTPropertyID inPropID, QTTrackPropertyListenerUPP inListenerProc, void *inUserData );

    Parameters

    inTrack

    The track for this operation.

    inPropClass

    A property class.

    inPropID

    A property ID.

    inListenerProc

    A Universal Procedure Pointer to a QTTrackPropertyListenerProc callback.

    inUserData

    User data to be passed to the callback.

    Return Value

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

    Discussion

    This routine removes a track property monitoring callback.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Undocumented

    Declaration

    Objective-C

    OSErr QTScheduledBandwidthRelease ( QTScheduledBandwidthReference sbwRef, long flags );

    Parameters

    sbwRef

    A pointer to an opaque data structure.

    flags

    Undocumented

    Return Value

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

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.0 and later.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • Undocumented

    Declaration

    Objective-C

    OSErr QTScheduledBandwidthRequest ( QTScheduledBandwidthPtr scheduleRec, QTBandwidthNotificationUPP notificationCallback, void *refcon, QTScheduledBandwidthReference *sbwRef, long flags );

    Parameters

    scheduleRec

    A pointer to a QTScheduledBandwidthRecord structure.

    notificationCallback

    A Universal Procedure Pointer that accesses a QTBandwidthNotificationProc callback.

    refcon

    A reference constant to be passed to your callback. Use this parameter to point to a data structure containing any information your function needs.

    sbwRef

    A pointer to an opaque data structure.

    flags

    Undocumented

    Return Value

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

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.0 and later.

    Deprecated in OS X v10.4.

    Not available to 64-bit applications.

  • Sets the value of a specific movie property.

    Declaration

    Objective-C

    OSErr QTSetMovieProperty ( Movie inMovie, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, ConstQTPropertyValuePtr inPropValueAddress );

    Parameters

    inMovie

    The movie for this operation. Your application obtains this movie identifier from such functions as NewMovie, NewMovieFromFile, and NewMovieFromHandle.

    inPropClass

    A property class.

    inPropID

    A property ID.

    inPropValueSize

    The size of the property value.

    inPropValueAddress

    A pointer to the the property value.

    Return Value

    See Error Codes in the QuickTime API Reference. Returns noErr if there is no error.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.3 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

  • Sets the value of a specific track property.

    Declaration

    Objective-C

    OSErr QTSetTrackProperty ( Track inTrack, QTPropertyClass inPropClass, QTPropertyID inPropID, ByteCount inPropValueSize, ConstQTPropertyValuePtr inPropValueAddress );

    Parameters

    inTrack

    The track for this operation.

    inPropClass

    A property class.

    inPropID

    A property ID.

    inPropValueSize

    The size of the property value.

    inPropValueAddress

    A pointer to the the property value.

    Return Value

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

    Discussion

    This routine sets the value of a specific track property.

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.4 and later.

    Deprecated in OS X v10.9.

    Not available to 64-bit applications.

Callbacks

  • Undocumented

    Declaration

    Objective-C

    typedef OSErr (*QTBandwidthNotificationProcPtr) (long flags, void *reserved, void *refcon);

    Parameters

    flags

    Undocumented

    reserved

    Reserved.

    refcon

    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.

    Return Value

    See Error Codes. Your callback should return noErr if there is no error.

Data Types

  • Represents a type used by the Movie Properties API.

    Declaration

    Objective-C

    typedef STACK_UPP_TYPE(QTBandwidthNotificationProcPtr) QTBandwidthNotificationUPP;

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.0 and later.

    Not available to 64-bit applications.

  • Represents a type used by the Movie Properties API.

    Declaration

    Objective-C

    typedef struct OpaqueQTBandwidthReference * QTBandwidthReference;

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.0 and later.

    Not available to 64-bit applications.

  • Represents a type used by the Movie Properties API.

    Declaration

    Objective-C

    typedef QTScheduledBandwidthRecord * QTScheduledBandwidthPtr;

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.0 and later.

    Not available to 64-bit applications.

  • Provides information to the QTScheduledBandwidthRequest function.

    Declaration

    Objective-C

    struct QTScheduledBandwidthRecord { long recordSize; long priority; long dataRate; CompTimeValue startTime; CompTimeValue duration; TimeScale scale; TimeBase base; };

    Fields

    recordSize

    Discussion

    The number of bytes in this structure.

    priority

    Discussion

    Undocumented

    dataRate

    Discussion

    The data rate.

    startTime

    Discussion

    The bandwidth usage start time.

    duration

    Discussion

    Duration of bandwidth usage, or 0 if unknown.

    scale

    Discussion

    The timescale of the duration field.

    base

    Discussion

    The time base.

  • Represents a type used by the Movie Properties API.

    Declaration

    Objective-C

    typedef struct OpaqueQTScheduledBandwidthReference * QTScheduledBandwidthReference;

    Import Statement

    Objective-C

    @import QuickTime;

    Availability

    Available in OS X v10.0 and later.

    Not available to 64-bit applications.

Constants

  • Constants grouped with kQTPropertyClass_SampleTable.

    Declaration

    Objective-C

    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 */ };

  • Constants passed to QTSampleTableGetNextAttributeChange.

    Declaration

    Objective-C

    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 };

  • Constants passed to QTSampleTableGetSampleFlags.

    Declaration

    Swift

    var mediaSampleNotSync: Int { get }

    Objective-C

    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 */ };

    Constants

    • mediaSampleNotSync

      mediaSampleNotSync

      Returned for frame-differenced video sample data.

      Available in OS X v10.0 and later.

      Not available to 64-bit applications.