|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--quicktime.QTObject | +--quicktime.std.movies.media.UserData
The UserData class implements the corresponding data structure of the Movie Toolbox. This structure specifies the user data list for an operation. You obtain a user data list identifier by calling the GetMovieUserData, GetTrackUserData, or GetMediaUserData functions (described on page 2-231 of Inside Macintosh: QuickTime, page 2-232 of Inside Macintosh: QuickTime, and page 2-233 of Inside Macintosh: QuickTime, respectively).
Fields inherited from interface quicktime.jdirect.QuickTimeLib |
JDirect_MacOSX, libraryInstance, name |
Constructor Summary | |
UserData()
This constructor creates a UserData object. |
|
UserData(QTHandle handle)
This constructor creates a UserData object from a handle that is in the standard user data storage format. |
Method Summary | |
void |
addData(QTHandleRef data,
int udType)
This method allows your application to add an item to a user data list. |
void |
addText(QTHandleRef data,
int udType,
int index,
int itlRegionTag)
This method allows your application to place language-tagged text into an item in a user data list. |
void |
addText(java.lang.String dataStr,
int udType,
int index,
int itlRegionTag)
This method allows your application to place language-tagged text into an item in a user data list. |
int |
countType(int udType)
This method allows you to determine the number of items of a given type in a user data list. |
static UserData |
fromGraphicsExporter(GraphicsExporter ge)
This method allows your application to obtain access to a GraphicsExporter user data list. |
static UserData |
fromMedia(Media m)
This method allows your application to obtain access to a media's user data list. |
static UserData |
fromMovie(Movie m)
This method allows your application to obtain access to a movie's user data list. |
static UserData |
fromSequenceGrabber(SequenceGrabber sg)
Retrieves the current settings of all channels used by the sequence grabber. |
static UserData |
fromSGChannel(SGChannel chan)
Retrieves the current settings of the SequenceGrabber channel. |
static UserData |
fromTrack(Track t)
This method allows your application to obtain access to a track's user data list. |
QTHandle |
getData(int udType,
int index)
This method returns a specified user data item. |
QTPointer |
getDataItem(int dataSize,
int udType,
int index)
This method returns a specified user data item. |
int |
getNextType(int udType)
This method allows you to retrieve the next user data type in a specified user data list. |
QTHandle |
getText(int udType,
int index,
short itlRegionTag)
Deprecated. since QTJava 4, see getTextAsString |
java.lang.String |
getTextAsString(int udType,
int index,
int itlRegionTag)
This method allows your application to retrieve language-tagged text from an item in a user data list. |
QTHandle |
putIntoHandle()
This method returns a handle which contains a publicly parseable form of the user data. |
void |
removeData(int udType,
int index)
This method removes an item from a user data list. |
void |
removeText(int udType,
int index,
int itlRegionTag)
This method allows your application to remove language-tagged text from an item in a user data list. |
void |
setDataItem(QTPointerRef data,
int udType,
int index)
This method allows your application to set an item in a user data list. |
Methods inherited from class quicktime.QTObject |
disposeQTObject, equals, ID, toString |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public UserData() throws StdQTException
public UserData(QTHandle handle) throws StdQTException
handle
- Specifies the handle for the user data to be constructed.Method Detail |
public static UserData fromGraphicsExporter(GraphicsExporter ge) throws StdQTException
GraphicsExporter.getMetaData()
public static UserData fromMovie(Movie m) throws StdQTException
Movie.getUserData()
public static UserData fromSequenceGrabber(SequenceGrabber sg) throws StdQTException
SequenceGrabber.getSettings()
public static UserData fromSGChannel(SGChannel chan) throws StdQTException
ud
- Specifies a user data list with configuration information for the sequence grabber.SGChannel.getSettings()
public static UserData fromTrack(Track t) throws StdQTException
Track.getUserData()
public static UserData fromMedia(Media m) throws StdQTException
Media.getUserData()
public QTHandle putIntoHandle() throws QTException
public QTHandle getData(int udType, int index) throws QTException
udType
- Specifies the item's type value.index
- Specifies the item's index value.public void addData(QTHandleRef data, int udType) throws StdQTException
data
- Specifies the handle to the data to be added to the user data list.udType
- Specifies the item's type value.public void removeData(int udType, int index) throws StdQTException
udType
- Specifies the item's type value.index
- Specifies the item's index value.public int countType(int udType) throws StdQTException
udType
- Specifies the type.public int getNextType(int udType) throws StdQTException
udType
- Specifies a user data type.public QTPointer getDataItem(int dataSize, int udType, int index) throws QTException
dataSize
- Specifies the size of the data.udType
- Specifies the item's type value.index
- Specifies the item's index value.public void setDataItem(QTPointerRef data, int udType, int index) throws StdQTException
data
- Specifies the pointer to the data item to be set in a user data list.udType
- Specifies the type value assigned to the new item.index
- Specifies the item's index value.public void addText(QTHandleRef data, int udType, int index, int itlRegionTag) throws StdQTException
data
- Specifies the handle to the data to be added to the user data list.udType
- Specifies the type that is to be assigned to the new item.index
- Specifies the item to which the text is to be added.itlRegionTag
- Specifies the region code of the text to be added.public void addText(java.lang.String dataStr, int udType, int index, int itlRegionTag) throws StdQTException
data
- Specifies the handle to the data to be added to the user data list.udType
- Specifies the type that is to be assigned to the new item.index
- Specifies the item to which the text is to be added.itlRegionTag
- Specifies the region code of the text to be added.public QTHandle getText(int udType, int index, short itlRegionTag) throws QTException
udType
- Specifies the item's type value.index
- Specifies the item's index value.itlRegionTag
- Specifies the language code of the text to be retrieved.public java.lang.String getTextAsString(int udType, int index, int itlRegionTag) throws QTException
udType
- Specifies the item's type value.index
- Specifies the item's index value.itlRegionTag
- Specifies the language code of the text to be retrieved.public void removeText(int udType, int index, int itlRegionTag) throws StdQTException
udType
- Specifies the item's type value.index
- Specifies the item's index value.itlRegionTag
- Specifies the language code of the text to be removed.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |