quicktime.streaming
Class PushDataParams

java.lang.Object
  |
  +--quicktime.QTObject
        |
        +--quicktime.util.QTPointerRef
              |
              +--quicktime.util.QTPointer
                    |
                    +--quicktime.streaming.PushDataParams
All Implemented Interfaces:
java.lang.Cloneable, InterfaceLib, PrimitivesLib, QuickTimeLib, SharedLibrary, com.apple.jdirect.SharedLibrary

public final class PushDataParams
extends QTPointer

This class provides a representation the native QTSPushDataParams structure that provides settings for pushing data from the Sourcer When configuring the Sourcer for use with Push Data, you may send arbitrary data. You need to provide a sample descripion and a data pointer. The time stamp is optional. If you do not provide this time stamp, the current time will be used.


Field Summary
static int kNativeSize
          This is the size of this class
 
Fields inherited from interface quicktime.jdirect.QuickTimeLib
JDirect_MacOSX, libraryInstance, name
 
Constructor Summary
PushDataParams(int vers, SampleDescription sampleDesc, int seed, long time, long duration, QTPointer data)
          Constructs an PushDataParams object based on the native QTSPushDataParams structure
PushDataParams(int vers, SampleDescription sampleDesc, int seed, QTPointer data)
          Constructs an PushDataParams object based on the native QTSPushDataParams structure
 
Method Summary
 QTPointer getDataPtr()
          Gets the push data
 long getDuration()
          Get duration of the push data
 int getFlags()
          Gets the flags
 SampleDescription getSampleDescription()
          Get the sample description of the push data
 int getSampleDescSeed()
          Get sample description seed of the push data
 long getSampleTime()
          Get sample time of the push data
 int getVersion()
          Gets the version of the push data params object
 void setDataPtr(QTPointer data)
          Sets the push data
 void setDuration(long duration)
          Set duration of the push data
 void setFlags(int flags)
          Sets the flags of the push data object
 void setSampleDescription(SampleDescription sampleDesc)
          Set the sample description of the push data
 void setSampleDescSeed(int seed)
          Set sample description seed of the push data
 void setSampleTime(long time)
          Set sample time of the push data
 void setVersion(int vers)
          Sets the version of the push data params object
 java.lang.String toString()
          Returns a string representation of this object.
 
Methods inherited from class quicktime.util.QTPointer
clone, concatenate, fromEncodedImage, fromGraphicsExporter, fromSCData, setSize
 
Methods inherited from class quicktime.util.QTPointerRef
copyFromArray, copyFromArray, copyFromArray, copyFromArray, copyFromArray, copyFromArray, copyFromArray, copyToArray, copyToArray, copyToArray, copyToArray, copyToArray, copyToArray, copyToArray, getBytes, getSize
 
Methods inherited from class quicktime.QTObject
disposeQTObject, equals, ID
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

kNativeSize

public static final int kNativeSize
This is the size of this class
Constructor Detail

PushDataParams

public PushDataParams(int vers,
                      SampleDescription sampleDesc,
                      int seed,
                      long time,
                      long duration,
                      QTPointer data)
               throws QTException
Constructs an PushDataParams object based on the native QTSPushDataParams structure
Parameters:
vers - version of the params structure

PushDataParams

public PushDataParams(int vers,
                      SampleDescription sampleDesc,
                      int seed,
                      QTPointer data)
               throws QTException
Constructs an PushDataParams object based on the native QTSPushDataParams structure
Parameters:
vers - version of the params structure
Method Detail

setVersion

public void setVersion(int vers)
Sets the version of the push data params object
Parameters:
vers - version

getVersion

public int getVersion()
Gets the version of the push data params object
Returns:
version

setFlags

public void setFlags(int flags)
Sets the flags of the push data object
Parameters:
flags - sourcer callback flags

getFlags

public int getFlags()
Gets the flags

setSampleDescription

public void setSampleDescription(SampleDescription sampleDesc)
Set the sample description of the push data
Parameters:
sampleDesc - sample description

getSampleDescription

public SampleDescription getSampleDescription()
Get the sample description of the push data
Returns:
sample description

setSampleDescSeed

public void setSampleDescSeed(int seed)
Set sample description seed of the push data
Parameters:
seed - sample description seed

getSampleDescSeed

public int getSampleDescSeed()
Get sample description seed of the push data
Returns:
sample description seed

setSampleTime

public void setSampleTime(long time)
Set sample time of the push data
Parameters:
time - sample time NOTE: This function automatically adds kQTSPushDataFlag_SampleTimeIsValid to the flags

getSampleTime

public long getSampleTime()
Get sample time of the push data
Returns:
sample time

setDuration

public void setDuration(long duration)
Set duration of the push data
Parameters:
duration - duration NOTE: This function automatically adds kQTSPushDataFlag_DurationIsValid to the flags

getDuration

public long getDuration()
Get duration of the push data
Returns:
duration

setDataPtr

public void setDataPtr(QTPointer data)
Sets the push data
Parameters:
data - push data

getDataPtr

public QTPointer getDataPtr()
Gets the push data
Returns:
data

toString

public java.lang.String toString()
Returns a string representation of this object.
Overrides:
toString in class QTPointerRef
Returns:
a String