Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKVideoStreamICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractDataObjectBase
        |
        +--com.ibm.mm.sdk.common.dkDataObject
              |
              +--com.ibm.mm.sdk.common.DKDDOBase
                    |
                    +--com.ibm.mm.sdk.common.DKDDO
                          |
                          +--com.ibm.mm.sdk.common.dkResource
                                |
                                +--com.ibm.mm.sdk.common.DKLobICM
                                      |
                                      +--com.ibm.mm.sdk.common.DKStreamICM
                                            |
                                            +--com.ibm.mm.sdk.common.DKVideoStreamICM
All Implemented Interfaces:
DKConstant, DKConstantICM, dkDataObjectBase, DKMessageId, DKMessageIdICM, dkXDO, dkXDOBase, com.ibm.mm.sdk.internal.PRMConstantICM, java.io.Serializable

public class DKVideoStreamICM
extends DKStreamICM

DKVideoStreamICM : This class represents a video stream resource objects.
A resource object consists of a content stored in a Resource Manager and the meta-data describing this content. The meta-data is stored in the Library Server of Content Manager. The content of a video stream object is stored in a streaming server Resource Manager, which in this case is the IBM Video Charger server.
Since the content of a video stream object is usually large, persistent operations such as add, retrieve, and update usually are done via a third party server using a standard protocol like ftp. Sessions to stream out the Content between the video server and video player directly, can be initiated after retrieving related meta data, with the help of this class. DKVideoStreamICM inherits most of its methods from DKStreamICM class, which represents generic streamable objects.

See Also:
DKStreamICM, DKLobICM, Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.internal.PRMConstantICM
background, badrequest, BOUNDARYTAG, COLON, CONTENTTYPE, CRLF, DK_ICM_BLOBTABLE, DK_ICM_FSEXPORT, DK_ICM_FTPROOT, DK_ICM_HTTPROOT, DK_ICM_LBOS_AREA, DK_ICM_LBOS_DRIVE, DK_ICM_LBOS_SUBPATH, DK_ICM_NONNORMALMEDIA, DK_ICM_NORMALMEDIA, DK_ICM_RMVERSION, DK_ICM_STAGING_AREA, DK_ICM_STAGING_DRIVE, DK_ICM_STAGING_SUBPATH, DK_ICM_TABLECOLLECTION, DK_ICM_TABLECOLLECTIONNAME, DK_ICM_VOL_FREESPACE, DK_ICM_VOL_LOGICALNAME, DK_ICM_VOL_MOUNTPOINT, DK_ICM_VOL_PATH, DK_ICM_VOL_SIZE, DK_ICM_VOL_STATUS, DK_ICM_VOL_STATUS_ASSIGNED, DK_ICM_VOL_STATUS_OVERFLOW, DK_ICM_VOL_VOLUMEID, eoh, expire, FORMDATACOLLECTION, FORMDATAFILENAME, FORMDATAOBJNAME, FORMDATAORDER, FORMDATAREPTYPE, FORMDATARESNUM, FORMDATAVERSID, GBYTE, ICM_DEFAULTCOLLECTION, ICM_DEFAULTCOLLECTIONID, ICM_DEFAULTREPTYPE, ICM_RESOURCETYPE_BASE, ICM_RESOURCETYPE_CONTAINER, ICM_RESOURCETYPE_STREAM, ICM_RESOURCETYPE_TEXT, ICM_RESOURCETYPE_VIDEO, ICM_RESOURCETYPE_XML, ICMADMIN, ICMCACHE, ICMCACHERETRIEVE, ICMCATALOG, ICMCHANGESMS, ICMCHANGESMSINFO, ICMCREATE, ICMCREATEENTITY, ICMDEBUG, ICMDELETE, ICMDELETEENTITY, ICMENDTRANS, ICMFSEXPORT, ICMFTPEXPORT, ICMHTTPEXPORT, ICMIMPORTFROMFS, ICMIMPORTFROMWEB, ICMKEYFLUSH, ICMLIST, ICMLISTDEVMGR, ICMLISTMGTCLASSES, ICMLISTSMSINFO, ICMLISTSTGCLASSES, ICMLISTSTGGROUPS, ICMLISTVOLUMES, ICMMIDTIERCREATE, ICMMIDTIERDELETE, ICMMIDTIERRETRIEVE, ICMMIDTIERSTOREFROMASYNC, ICMMIDTIERSTOREFROMFTP, ICMMIDTIERUPDATE, ICMORDER, ICMPLAY, ICMQUERY, ICMQUERYENTITY, ICMREPLACE, ICMREPLACEFROM, ICMREPLACEFROMASYNC, ICMREPLICATE, ICMRETRIEVE, ICMRETRIEVEASYNC, ICMRETRIEVETO, ICMRETRIEVETOASYNC, ICMRETRIEVETOOLD, ICMRM_DELETE_FAILED, ICMRM_DELETE_OK, ICMRM_OPT_RETRIEVAL_ACTION, ICMRM_REPLACE_FAILED, ICMRM_REPLACE_OK, ICMRM_RETRIEVAL_GET_IT, ICMRM_RETRIEVAL_GET_IT_PREFETCH, ICMRM_RETRIEVAL_NO_MOUNT, ICMRM_RETRIEVAL_NO_MOUNT_PREFETCH, ICMRM_RETRIEVAL_STAGE_IT, ICMRM_RETRIEVAL_STAGE_IT_PREFETCH, ICMRM_RETRIEVE_FAILED, ICMRM_RETRIEVE_OK, ICMRM_STAGE_FAILED, ICMRM_STAGE_OK, ICMRM_STORE_FAILED, ICMRM_STORE_OK, ICMRM_UPDATE_FAILED, ICMRM_UPDATE_OK, ICMRMBITRATE, ICMRMCACHETYPE, ICMRMCOLLECTION, ICMRMCOMMIT, ICMRMCONTENTDISPOSITION, ICMRMCONTENTLENGTH, ICMRMCONTENTRANGE, ICMRMCONTENTTYPE, ICMRMCREATEDATE, ICMRMDURATION, ICMRMFILELENGTH, ICMRMFILELIST, ICMRMFILENAME, ICMRMFILEPATH, ICMRMFUNCTION, ICMRMGROUP, ICMRMHOSTNAME, ICMRMITEMID, ICMRMLIBNAME, ICMRMMODE, ICMRMNAME, ICMRMOBJNAME, ICMRMOFFLINE, ICMRMORDER, ICMRMPASSWORD, ICMRMPORT, ICMRMPROTOCOL, ICMRMRCLIST, ICMRMREFERENCEDATE, ICMRMREPTYPE, ICMRMRESNUM, ICMRMRETENTION, ICMRMROLLBACK, ICMRMSERVERPORT, ICMRMSTARTTIME, ICMRMSTOPTIME, ICMRMSTREAMMODE, ICMRMTARGETCOLLECTION, ICMRMTOKEN, ICMRMTXID, ICMRMUPDATEDATE, ICMRMURL, ICMRMUSER, ICMRMUSERID, ICMRMVERSID, ICMRMVERSION, ICMSMSLOGOFF, ICMSMSLOGON, ICMSTORE, ICMSTORECACHE, ICMSTOREFROM, ICMSTOREFROMASYNC, ICMSTOREFROMASYNCOLD, ICMSTOREFROMBROWSER, ICMSTOREFROMFTP, ICMSTOREFROMOLD, ICMSTOREFROMWEB, ICMSTREAMADMIN, ICMSTREAMDELIVERYSERVICES, ICMSTREAMIMPORTSERVICES, ICMTABLECOLLECTIONID, ICMUPDATE, ICMUPDATEENTITY, ICMUPDATEFROMBROWSER, ICMUPDATEFROMFS, ICMUPDATEFROMWEB, ICMVIEW, ID, KBYTE, MAXBLOBSIZE, MBYTE, METHOD_CONNECT, METHOD_COPY, METHOD_DELETE, METHOD_GET, METHOD_HEAD, METHOD_LOCK, METHOD_MKCOL, METHOD_MOVE, METHOD_OPTIONS, METHOD_POST, METHOD_PROPFIND, METHOD_PROPPATCH, METHOD_PUT, METHOD_TRACE, METHOD_UNLOCK, MIMETYPE, notfound, OBJARCHIVED, OBJDELETEPENDING, OBJDISCARDED, OBJSTAGED, OBJSTOREPENDING, OBJUPDATED, ok, SEMICOLON, TENMB, TENMEG, TWOMEG
 
Constructor Summary
DKVideoStreamICM()
          The default constructor for video stream objects.
DKVideoStreamICM(dkDatastore ds)
          Constructs a video stream object associated with the given datastore.
DKVideoStreamICM(DKVideoStreamICM aDKVideoStreamICM)
          The copy constructor for this object.
 
Method Summary
 void addFrom()
          Adds or stores a streamable video resource from a third party source to the Resource Manager and Content Manager persistent store.
The information describing the third party source, such as hostname, userId, password, protocol, and port number must be set prior to calling this method.
The content store takes place synchronously.
 void addFrom(java.lang.String hostname, java.lang.String userid, java.lang.String passwd, java.lang.String protocol, int port, java.lang.String filename, int option)
          Adds or stores a streamable video resource from a third party source, described by the parameters, to the Resource Manager and Content Manager persistent store.
This method is also used for storing a video resource to a Video Charger.
The content store takes place synchronously.
 void addFromAsync()
          Adds or stores a streamable video resource asynchronously from a third party source to the Resource Manager and Content Manager persistent store.
The content is retrieved directly from the third party source.
The information describing the third party source, such as hostname, userId, password, protocol, and port number, needs to be set prior to calling this method.
This method is also used for storing a video resource to a Video Charger.
 void addFromAsync(java.lang.String hostname, java.lang.String userid, java.lang.String passwd, java.lang.String protocol, int port, java.lang.String filename, int option)
          Adds or stores a streamable video resource asynchronously from a third party source, described by the parameters, to the Resource Manager and Content Manager persistent store.
This method is also used for storing a video resource to a Video Charger.
During the uploading process, the resource status is set to "Load Pending", thus preventing any further operations on this resource item until the process is completed.
 byte[] play()
          This method is used for an asynchronous streaming of audio/video content from a Video Charger to a specified player.
 void retrieveTo()
          Retrieves the content and meta-data of the streamable video resource stored in the Resource Manager and Content Manager persistent store to a third party destination.
The information describing the third party destination, such as hostname, userId, password, protocol, and port number, must be set prior to calling this method.
The retrieval takes place synchronously.
This method can also be used for retrieving a video resource from a Video Charger.
 void retrieveToAsync()
          Asynchronously retrieves the content and meta-data of the streamable video resource stored in the Resource Manager and Content Manager persistent store to a third party destination.
The information describing the third party destination, such as hostname, userId, password, protocol, and port number, prior to calling this method.
This method can be used for retrieving a video resource from a Video Charger.
 void updateFrom()
          Updates the content and meta-data of the streamable video resource stored in the Resource Manager and Content Manager persistent store from a third party content source.
The information describing the third party source, such as hostname, userId, password, protocol, and port number, need to be set prior to calling this method.
The update of the content takes place synchronously.
This method is also used for updating a video resource into a Video Charger.
 void updateFrom(java.lang.String hostname, java.lang.String userid, java.lang.String passwd, java.lang.String protocol, int port, java.lang.String filename, int option)
          Updates the content and meta-data of the streamable video resource stored in the Resource Manager and Content Manager persistent store from a third party content source identified by the supplied parameters.
The content update takes place synchronously.
This method is also used for updating a video resource into a Video Charger.
 void updateFromAsync()
          Asynchronously updates the content and meta-data of the streamable video resource stored in the Resource Manager and Content Manager persistent store from a third party content source.
The information describing the third party source, such as hostname, userId, password, protocol, and port number, needs to be set prior to calling this method.
This method is also used for updating a video resource into a Video Charger.
During the uploading process, the resource status is set to "Load Pending", thus preventing any further operations on this resource item until the process is completed.
 void updateFromAsync(java.lang.String hostname, java.lang.String userid, java.lang.String passwd, java.lang.String protocol, int port, java.lang.String filename, int option)
          Asynchronously updates the content and meta-data of the streamable video resource stored in the Resource Manager and Content Manager persistent store from a third party content source identified by the supplied parameters.
This method is also used for updating a video resource into a Video Charger.
During the uploading process, the resource status is set to "Load Pending", thus preventing any further operations on this resource item until the process is completed.
 
Methods inherited from class com.ibm.mm.sdk.common.DKStreamICM
getPlayStart, getPlayStop, getStreamAccessMode, getStreamBitrate, getStreamCopyRate, getStreamDuration, getStreamExtObjectName, getStreamFormat, getStreamFrameDuration, getStreamFrameRate, getStreamInvalidCommands, getStreamMediaResolution, getStreamMediaStandard, getStreamMediaState, getStreamMediaType, getStreamNumUsers, setPlayStart, setPlayStop, setStreamAccessMode, setStreamBitrate, setStreamCopyRate, setStreamDuration, setStreamExtObjectName, setStreamFormat, setStreamFrameDuration, setStreamFrameRate, setStreamGroup, setStreamInvalidCommands, setStreamMediaResolution, setStreamMediaStandard, setStreamMediaState, setStreamMediaType, setStreamNumUsers
 
Methods inherited from class com.ibm.mm.sdk.common.DKLobICM
add, add, add, add, add, add, addExtension, addFrom, addReplicaInfo, addReplicaInfo, addRMInfo, addURLInfo, catalogContent, changeSMSInfo, changeSMSInfo, changeStorage, compareData, copyData, del, del, equals, getAffiliatedType, getContent, getContentToClientFile, getContentURL, getContentURL, getCreatedTimestamp, getExtension, getHttpStoreMethod, getInputContentlength, getInputCreatedate, getInputFilelist, getInputFilename, getInputFilepath, getInputProtocol, getInputRetention, getInputStream, getItemId, getMimeType, getName, getNewVersion, getOpenHandler, getOption, getOrgFileName, getPartNumber, getReferencedTimestamp, getResourceName, getRMName, getSize, getSMSCollName, getThirdPartyHostname, getThirdPartyPassword, getThirdPartyPort, getThirdPartyStore, getThirdPartyUserid, getToken, getUpdateDate, getUpdatedTimestamp, getUser, getVersionNumber, isContentChanged, isNull, isOpenSynchronous, isSet, length, loadDataFromFile, open, open, querySMSInfo, removeExtension, retrieve, retrieve, retrieve, retrieve, retrieve, setAffiliatedType, setClassOpenHandler, setContent, setContentChanged, setContentFromClientFile, setDatastore, setExtension, setHttpStoreMethod, setInputContentlength, setInputCreatedate, setInputFilelist, setInputFilename, setInputFilepath, setInputProtocol, setInputRetention, setInstanceOpenHandler, setMimeType, setName, setNewVersion, setNull, setOption, setOrgFileName, setPartNumber, setResourceName, setRMName, setSemanticType, setSMSCollName, setThirdPartyHostname, setThirdPartyPassword, setThirdPartyPort, setThirdPartyStore, setThirdPartyUserid, setUpdateDate, size, update, update, update, update, update, update, updateFrom, updateFromAsync
 
Methods inherited from class com.ibm.mm.sdk.common.dkResource
cloneSkeleton, getClassName, getContentType, getRank, notEqual, protocol, setClassName, setContentType, setRank
 
Methods inherited from class com.ibm.mm.sdk.common.DKDDO
add, del, del, fromXML, fromXML, getDatastore, retrieve, toXML, update
 
Methods inherited from class com.ibm.mm.sdk.common.DKDDOBase
addData, addData, addData, addDataProperty, addDataProperty, addDataProperty, addProperty, addProperty, addProperty, dataCount, dataId, dataId, dataIdsByNameSpace, dataNameSpaceCount, dataPropertyCount, dataPropertyId, getData, getDataByName, getDataByName, getDataName, getDataNameSpace, getDataProperty, getDataPropertyByName, getDataPropertyByName, getDataPropertyByName, getDataPropertyName, getObjectType, getProperty, getPropertyByName, getPropertyName, isDataPropertySet, isDataSet, isNull, isPropertySet, propertyCount, propertyId, setData, setDataName, setDataName, setDataNameSpace, setDataProperty, setDataPropertyName, setNull, setObjectType, setProperty, setPropertyName, updatable
 
Methods inherited from class com.ibm.mm.sdk.common.dkDataObject
getPid, getPidObject, setPid, setPidObject
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDataObjectBase
getParent, getRootObject, setParent, setRootObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.mm.sdk.common.dkXDO
datastore, getDatastore, getPid, getPidObject, setPid, setPidObject
 
Methods inherited from interface com.ibm.mm.sdk.common.dkDataObjectBase
getObjectType, getParent, getRootObject, setParent, setRootObject
 

Constructor Detail

DKVideoStreamICM

public DKVideoStreamICM()
                 throws DKException,
                        java.lang.Exception
The default constructor for video stream objects.
Throws:
DKException - on invalid datastore type.
java.lang.Exception - on errors.

DKVideoStreamICM

public DKVideoStreamICM(dkDatastore ds)
                 throws DKUsageError,
                        java.lang.Exception
Constructs a video stream object associated with the given datastore.
Parameters:
ds - the associated datastore,a DKDatastoreICM object.
Throws:
DKUsageError - on errors.
java.lang.Exception - on errors.

DKVideoStreamICM

public DKVideoStreamICM(DKVideoStreamICM aDKVideoStreamICM)
                 throws DKException,
                        java.lang.Exception
The copy constructor for this object.
Parameters:
aDKVideoStreamICM - an instance of DKVideoStreamICM to copy from.
Throws:
DKException - on errors.
java.lang.Exception - on errors.
Method Detail

addFrom

public void addFrom()
             throws DKException,
                    java.lang.Exception
Adds or stores a streamable video resource from a third party source to the Resource Manager and Content Manager persistent store.
The information describing the third party source, such as hostname, userId, password, protocol, and port number must be set prior to calling this method.
The content store takes place synchronously.
Overrides:
addFrom in class DKStreamICM
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKStreamICM.addFrom(), DKLobICM.addFrom()

addFrom

public void addFrom(java.lang.String hostname,
                    java.lang.String userid,
                    java.lang.String passwd,
                    java.lang.String protocol,
                    int port,
                    java.lang.String filename,
                    int option)
             throws DKException,
                    java.lang.Exception
Adds or stores a streamable video resource from a third party source, described by the parameters, to the Resource Manager and Content Manager persistent store.
This method is also used for storing a video resource to a Video Charger.
The content store takes place synchronously.
Overrides:
addFrom in class DKStreamICM
Parameters:
hostname - the name of the host where the content is located.
userid - the user id to use on the host for retrieving the content.
password - the password for this user id.
protocol - the name of the protocol for transferring the content e.g. ftp.
port - the port number, by which the host can be reached using the specified protocol.
filename - a fully qualified path and name of the content file. By default the file is expected to be in the current login directory.
option - see DKDatastoreICM.addObject(dkDataObject, int)
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKStreamICM.addFrom(), DKLobICM.addFrom()

addFromAsync

public void addFromAsync(java.lang.String hostname,
                         java.lang.String userid,
                         java.lang.String passwd,
                         java.lang.String protocol,
                         int port,
                         java.lang.String filename,
                         int option)
                  throws DKException,
                         java.lang.Exception
Adds or stores a streamable video resource asynchronously from a third party source, described by the parameters, to the Resource Manager and Content Manager persistent store.
This method is also used for storing a video resource to a Video Charger.
During the uploading process, the resource status is set to "Load Pending", thus preventing any further operations on this resource item until the process is completed.
Overrides:
addFromAsync in class DKStreamICM
Parameters:
hostname - the name of the host where the content is located.
userid - the user id to use on the host for retrieving the content.
password - the password for this user id.
protocol - the name of the protocol for transferring the content e.g. ftp.
port - the port number, by which the host can be reached using the specified protocol.
filename - a fully qualified path and name of the content file. By default the file is expected to be in the current login directory.
option - see DKDatastoreICM.addObject(dkDataObject, int)
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKStreamICM.addFromAsync(), DKLobICM.addFromAsync()

addFromAsync

public void addFromAsync()
                  throws DKException,
                         java.lang.Exception
Adds or stores a streamable video resource asynchronously from a third party source to the Resource Manager and Content Manager persistent store.
The content is retrieved directly from the third party source.
The information describing the third party source, such as hostname, userId, password, protocol, and port number, needs to be set prior to calling this method.
This method is also used for storing a video resource to a Video Charger.
During the uploading process, the resource status is set to "Load Pending", thus preventing any further operations on this resource item until the process is completed.
Overrides:
addFromAsync in class DKStreamICM
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKStreamICM.addFromAsync(), DKLobICM.addFromAsync()

updateFrom

public void updateFrom(java.lang.String hostname,
                       java.lang.String userid,
                       java.lang.String passwd,
                       java.lang.String protocol,
                       int port,
                       java.lang.String filename,
                       int option)
                throws DKException,
                       java.lang.Exception
Updates the content and meta-data of the streamable video resource stored in the Resource Manager and Content Manager persistent store from a third party content source identified by the supplied parameters.
The content update takes place synchronously.
This method is also used for updating a video resource into a Video Charger.
Overrides:
updateFrom in class DKStreamICM
Parameters:
hostname - the name of the host where the content is located.
userid - the user id to use on the host for retrieving the content.
password - the password for this user id.
protocol - the name of the protocol for transferring the content e.g. ftp.
port - the port number, by which the host can be reached using the specified protocol.
filename - a fully qualified path and name of the content file. By default the file is expected to be in the current login directory.
option - see DKDatastoreICM.updateObject(dkDataObject, int)
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKStreamICM.updateFrom(), DKLobICM.updateFrom()

updateFrom

public void updateFrom()
                throws DKException,
                       java.lang.Exception
Updates the content and meta-data of the streamable video resource stored in the Resource Manager and Content Manager persistent store from a third party content source.
The information describing the third party source, such as hostname, userId, password, protocol, and port number, need to be set prior to calling this method.
The update of the content takes place synchronously.
This method is also used for updating a video resource into a Video Charger.
Overrides:
updateFrom in class DKStreamICM
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKStreamICM.updateFrom(), DKLobICM.updateFrom()

updateFromAsync

public void updateFromAsync(java.lang.String hostname,
                            java.lang.String userid,
                            java.lang.String passwd,
                            java.lang.String protocol,
                            int port,
                            java.lang.String filename,
                            int option)
                     throws DKException,
                            java.lang.Exception
Asynchronously updates the content and meta-data of the streamable video resource stored in the Resource Manager and Content Manager persistent store from a third party content source identified by the supplied parameters.
This method is also used for updating a video resource into a Video Charger.
During the uploading process, the resource status is set to "Load Pending", thus preventing any further operations on this resource item until the process is completed.
Overrides:
updateFromAsync in class DKStreamICM
Parameters:
hostname - the name of the host where the content is located.
userid - the user id to use on the host for retrieving the content.
password - the password for this user id.
protocol - the name of the protocol for transferring the content e.g. ftp.
port - the port number, by which the host can be reached using the specified protocol.
filename - a fully qualified path and name of the content file. By default the file is expected to be in the current login directory.
option - see DKDatastoreICM.updateObject(dkDataObject, int)
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKStreamICM.updateFromAsync(), DKLobICM.updateFromAsync()

updateFromAsync

public void updateFromAsync()
                     throws DKException,
                            java.lang.Exception
Asynchronously updates the content and meta-data of the streamable video resource stored in the Resource Manager and Content Manager persistent store from a third party content source.
The information describing the third party source, such as hostname, userId, password, protocol, and port number, needs to be set prior to calling this method.
This method is also used for updating a video resource into a Video Charger.
During the uploading process, the resource status is set to "Load Pending", thus preventing any further operations on this resource item until the process is completed.
Overrides:
updateFromAsync in class DKStreamICM
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKStreamICM.updateFromAsync(), DKLobICM.updateFromAsync()

retrieveTo

public void retrieveTo()
                throws DKException,
                       java.lang.Exception
Retrieves the content and meta-data of the streamable video resource stored in the Resource Manager and Content Manager persistent store to a third party destination.
The information describing the third party destination, such as hostname, userId, password, protocol, and port number, must be set prior to calling this method.
The retrieval takes place synchronously.
This method can also be used for retrieving a video resource from a Video Charger.
Overrides:
retrieveTo in class DKStreamICM
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKStreamICM.retrieveTo(), DKLobICM.retrieveTo()

retrieveToAsync

public void retrieveToAsync()
                     throws DKException,
                            java.lang.Exception
Asynchronously retrieves the content and meta-data of the streamable video resource stored in the Resource Manager and Content Manager persistent store to a third party destination.
The information describing the third party destination, such as hostname, userId, password, protocol, and port number, prior to calling this method.
This method can be used for retrieving a video resource from a Video Charger.
Overrides:
retrieveToAsync in class DKStreamICM
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKStreamICM.retrieveToAsync(), DKLobICM.retrieveToAsync()

play

public byte[] play()
            throws DKException,
                   java.lang.Exception
This method is used for an asynchronous streaming of audio/video content from a Video Charger to a specified player. This request along with the necessary parameters is passed to the CM Resource Manager, which on behalf of the end user will contact the Video Charger. The Video Charger will return the meta data information relating to the streaming session and this infomation can be passed to the player to initiate the playing of the content.
The meta data returned from the Video Charger is in IVS format. If the start and stop time for the content to stream is not specified, the entire content will be streamed.
Overrides:
play in class DKStreamICM
Returns:
a byte array containing the stream session information in IVS format.
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKStreamICM#retrieveStreamInfo(), DKStreamICM.setPlayStart(java.lang.String), DKStreamICM.setPlayStop(java.lang.String)

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.