Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKStreamICM

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
All Implemented Interfaces:
DKConstant, DKConstantICM, dkDataObjectBase, DKMessageId, DKMessageIdICM, dkXDO, dkXDOBase, com.ibm.mm.sdk.internal.PRMConstantICM, java.io.Serializable
Direct Known Subclasses:
DKVideoStreamICM

public class DKStreamICM
extends DKLobICM
implements java.io.Serializable

The DKStreamICM class represents streamable resource objects in Content Manager. A resource object consists of a content stored in a Resource Manager and the meta-data describing this content stored in the Library Server of Content Manager.
DKStreamICM is a subclass of dkResource and DKLobICM, therefore inherits the properties of a resource object defined by these classes.
This class extends its superclasses with properties and behaviors specific for streamable large objects, which include:

NOTE :
This class represents a generic streamable object. For video stream objects the video specific subclass, DKVideoStream should be used.

See Also:
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
DKStreamICM()
          The default constructor for streamable resource objects.
DKStreamICM(dkDatastore ds)
          Constructs a streamable resource object associated with the given datastore.
DKStreamICM(DKStreamICM aDKStreamICM)
          The copy constructor for this object.
 
Method Summary
 void addFrom()
          Adds or stores a streamable resource from a third party source, to the Resource Manager and the Content Manager persistent store.
The information describing the external source, such as hostname, userId, password, protocol, and port number, must be set prior to calling this method.
The store of the content 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 store a streamable resource from a third party source, described by the parameters, to the Resource Manager and Content Manager persistent store.
The store of the content takes place synchronously.
 void addFromAsync()
          Adds or store a streamable resource asynchronously 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.
 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 store a streamable resource asynchronously from a third party source, described by the parameters, to the Resource Manager and Content Manager persistent store.
 java.lang.String getPlayStart()
          Gets the play start time of this stream.
 java.lang.String getPlayStop()
          Gets the play stop time value of this stream.
 java.lang.String getStreamAccessMode()
          Gets the access mode for retrieving this stream as set in the Content Manager Library Server.
 int getStreamBitrate()
          Gets the recommended bit rate for this stream as set in the Content Manager Library Server.
 int getStreamCopyRate()
          Gets the copy rate in number of bits per second at which this resource is stored as set in the Content Manager Library Server.
 int getStreamDuration()
          Gets the duration to play the stream clip, in seconds, as set in the Content Manager Library Server.
 java.lang.String getStreamExtObjectName()
          Gets the external object name of this stream as set in the Content Manager Library Server.
 java.lang.String getStreamFormat()
          Gets the stream format or the streaming type of this stream as set in the Content Manager Library Server.
 int getStreamFrameDuration()
          Gets the stream duration in number of frames for streaming this object as set in the Content Manager Library Server.
 int getStreamFrameRate()
          Gets the number of frame per second recommended for streaming this object as set in the Content Manager Library Server.
 int getStreamInvalidCommands()
          Gets the stream invalid commands value as set in the Content Manager Library Server.
 java.lang.String getStreamMediaResolution()
          Gets the resolution of this streamable object as set in the Content Manager Library Server.
 java.lang.String getStreamMediaStandard()
          Gets the media standard of this streamable object as set in the Content Manager Library Server.
 int getStreamMediaState()
          Gets the stream media state value as set in the Content Manager Library Server.
 java.lang.String getStreamMediaType()
          Gets the media type or file format for this streamable object as set in the Content Manager Library Server.
 int getStreamNumUsers()
          Gets the maximum number of concurrent users allowed to stream this object as set in the Content Manager Library Server.
 byte[] play()
          This method is used to obtain meta data for establishing an asynchronous streaming of streamable content between a streaming server and a player.
 void retrieveTo()
          Retrieves the content and meta-data of the streamable 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 of content takes place synchronously.
 void retrieveToAsync()
          Asynchronously retrieves the content and meta-data of the streamable resource stored in the Resource Manager and the 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.
 void setPlayStart(java.lang.String starttime)
          Sets the time to start streaming this content object.
 void setPlayStop(java.lang.String stoptime)
          Sets the time to stop streaming this content object.
 void setStreamAccessMode(java.lang.String mode)
          Sets into the Content Manager Library Server, the access mode for retrieving this stream.
The access mode is either SHARED or EXCLUSIVE.
 void setStreamBitrate(int bitrate)
          Sets into the Content Manager Library Server, the information regarding the total multiplexed bitrate of the stream object being stored.
 void setStreamCopyRate(int copyrate)
          Sets into the Content Manager Library Server, the copy rate in number of bits per second at which this resource is transferred from or to persistent store.
 void setStreamDuration(int duration)
          Sets into the Content Manager Library Server, the information regarding the duration of this stream, in seconds.
The duration information is optional.
 void setStreamExtObjectName(java.lang.String extobjname)
          Sets into the Content Manager Library Server, the external object name for this streamable resource.
 void setStreamFormat(java.lang.String streamformat)
          Sets into the Content Manager Library Server, the streaming type of this object.
 void setStreamFrameDuration(int framedur)
          Sets into the Content Manager Library Server, the stream duration in number of frames.
 void setStreamFrameRate(int framerate)
          Sets into the Content Manager Library Server, the number of frame per second recommended (usually this is the actual frame rate multiplied by 100) for streaming this object.
 void setStreamGroup(java.lang.String group)
          Sets the asset group name to store this stream into in the Video Charger.
The group name is alphanumeric up to 120 characters length.
 void setStreamInvalidCommands(int mediainvcmds)
          Sets into the Content Manager Library Server, the information regarding the media invalid commands as a media player control mask for a stream item.
 void setStreamMediaResolution(java.lang.String mediares)
          Sets into the Content Manager Library Server, the media resolution property of this stream object.
The value is alphanumeric, and can be up to 16 characters, for example, SIF(default), HHR, CCIR601 etc.
 void setStreamMediaStandard(java.lang.String mediastd)
          Sets into the Content Manager Library Server, the media standard information for this stream.
The media standard could be NTSC(default)or PAL.
 void setStreamMediaState(int mediastate)
          Sets into the Content Manager Library Server, the information regarding the Media State for a stream clip.
 void setStreamMediaType(java.lang.String mediatype)
          Sets into the Content Manager Library Server, the media type or file format property for this object.
 void setStreamNumUsers(int numusers)
          Sets into the Content Manager Library Server, the maximum number of concurrent users allowed to stream this object.
 void updateFrom()
          Updates the content and meta-data of the streamable 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, must be set prior to calling this method.
The updating of the content takes place synchronously.
 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 resource stored in the Resource Manager and the Content Manager persistent store from a third party content source identified by the supplied parameters.
The update of the content takes place synchronously.
 void updateFromAsync()
          Asynchronously updates the content and meta-data of the streamable resource stored in the Resource Manager and the 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, must be set prior to calling this method.
 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 resource stored in the Resource Manager and the Content Manager persistent store from a third party content source identified by the supplied parameters.
 
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

DKStreamICM

public DKStreamICM()
            throws DKUsageError,
                   java.lang.Exception
The default constructor for streamable resource objects.
Throws:
DKUsageError - if datastore type is invalid.
java.lang.Exception - on errors.

DKStreamICM

public DKStreamICM(dkDatastore ds)
            throws DKUsageError,
                   java.lang.Exception
Constructs a streamable resource object associated with the given datastore.
Parameters:
ds - the associated datastore, a DKDatastoreICM object.
Throws:
DKUsageError - if datastore type is invalid.
java.lang.Exception - on errors.

DKStreamICM

public DKStreamICM(DKStreamICM aDKStreamICM)
            throws DKException,
                   java.lang.Exception
The copy constructor for this object.
Parameters:
aDKStreamICM - an instance of DKStreamICM object 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 resource from a third party source, to the Resource Manager and the Content Manager persistent store.
The information describing the external source, such as hostname, userId, password, protocol, and port number, must be set prior to calling this method.
The store of the content takes place synchronously.
Overrides:
addFrom in class DKLobICM
Throws:
DKException - on errors
java.lang.Exception - on errors
See Also:
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 store a streamable resource from a third party source, described by the parameters, to the Resource Manager and Content Manager persistent store.
The store of the content takes place synchronously.
Overrides:
addFrom in class DKLobICM
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 of the file containing the content to be stored. By default
option - see DKDatastoreICM.addObject(dkDataObject, int) the file is expected to be in the current login directory.
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
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 store a streamable resource asynchronously from a third party source, described by the parameters, to the Resource Manager and Content Manager persistent store.
Overrides:
addFromAsync in class DKLobICM
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 of the file containing the content to be stored. 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:
DKLobICM.addFromAsync()

addFromAsync

public void addFromAsync()
                  throws DKException,
                         java.lang.Exception
Adds or store a streamable resource asynchronously 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.
Overrides:
addFromAsync in class DKLobICM
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKLobICM.addFromAsync()

updateFrom

public void updateFrom()
                throws DKException,
                       java.lang.Exception
Updates the content and meta-data of the streamable 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, must be set prior to calling this method.
The updating of the content takes place synchronously.
Overrides:
updateFrom in class DKLobICM
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKLobICM.updateFrom()

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 resource stored in the Resource Manager and the Content Manager persistent store from a third party content source identified by the supplied parameters.
The update of the content takes place synchronously.
Overrides:
updateFrom in class DKLobICM
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 of the file containing the content to be stored. 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:
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 resource stored in the Resource Manager and the Content Manager persistent store from a third party content source identified by the supplied parameters.
Overrides:
updateFromAsync in class DKLobICM
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 of the file containing the content to be stored. 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:
DKLobICM.updateFromAsync()

updateFromAsync

public void updateFromAsync()
                     throws DKException,
                            java.lang.Exception
Asynchronously updates the content and meta-data of the streamable resource stored in the Resource Manager and the 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, must be set prior to calling this method.
Overrides:
updateFromAsync in class DKLobICM
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKLobICM.updateFromAsync()

retrieveTo

public void retrieveTo()
                throws DKException,
                       java.lang.Exception
Retrieves the content and meta-data of the streamable 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 of content takes place synchronously.
Overrides:
retrieveTo in class DKLobICM
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKLobICM.retrieveTo()

retrieveToAsync

public void retrieveToAsync()
                     throws DKException,
                            java.lang.Exception
Asynchronously retrieves the content and meta-data of the streamable resource stored in the Resource Manager and the 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.
Overrides:
retrieveToAsync in class DKLobICM
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
DKLobICM.retrieveToAsync()

play

public byte[] play()
            throws DKException,
                   java.lang.Exception
This method is used to obtain meta data for establishing an asynchronous streaming of streamable content between a streaming server and a player. This request along with the necessary parameters is passed to the CM Resource Manager, which retrieves this meta data from the streaming server. This meta data can be passed to a player to establish the stream session.
If the start and stop time for the content to stream is not specified, the entire content will be streamed.
Returns:
a byte array containing the stream session meta data information.
Throws:
DKException - on errors.
java.lang.Exception - on errors.
See Also:
setPlayStart(java.lang.String), setPlayStop(java.lang.String)

setStreamBitrate

public void setStreamBitrate(int bitrate)
Sets into the Content Manager Library Server, the information regarding the total multiplexed bitrate of the stream object being stored. Specifying of the bitrate is optional.
The bitrate is expressed in K bits per second.
Parameters:
bitrate - the bitrate value.

setStreamDuration

public void setStreamDuration(int duration)
Sets into the Content Manager Library Server, the information regarding the duration of this stream, in seconds.
The duration information is optional.
Parameters:
duration - the duration in seconds.

setStreamMediaState

public void setStreamMediaState(int mediastate)
Sets into the Content Manager Library Server, the information regarding the Media State for a stream clip. The media state can be any information regarding the state of the media e.g. Pending, Complete etc.. Specifying this is optional.
Parameters:
mediastate - the mediastate.

setStreamExtObjectName

public void setStreamExtObjectName(java.lang.String extobjname)
Sets into the Content Manager Library Server, the external object name for this streamable resource. An external object name is a string identifier assigned as the external name for this object.
If the external object name is not specified, the Content Manager will assign one by default.For Content Manager managed stores, this is always automatically assigned.
Parameters:
extobjname - the external object name.

setStreamFrameRate

public void setStreamFrameRate(int framerate)
Sets into the Content Manager Library Server, the number of frame per second recommended (usually this is the actual frame rate multiplied by 100) for streaming this object. Specifying the frame rate is optional.
Parameters:
framerate - the framerate per second.

setStreamFormat

public void setStreamFormat(java.lang.String streamformat)
Sets into the Content Manager Library Server, the streaming type of this object. The type could be SYSTEM(default), PROGRAM or TRANSPORT. Specifying this is optional.
Parameters:
streamformat - the streaming type of video file.

setStreamFrameDuration

public void setStreamFrameDuration(int framedur)
Sets into the Content Manager Library Server, the stream duration in number of frames.
Parameters:
frameduration - the stream duration in number of frames.

setStreamCopyRate

public void setStreamCopyRate(int copyrate)
Sets into the Content Manager Library Server, the copy rate in number of bits per second at which this resource is transferred from or to persistent store. Specifying this is optional.
Parameters:
copyrate - the copy rate in bits per second.

setStreamNumUsers

public void setStreamNumUsers(int numusers)
Sets into the Content Manager Library Server, the maximum number of concurrent users allowed to stream this object. Specifying this is optional.
Parameters:
numusers - the number of concurrent users.

setStreamMediaType

public void setStreamMediaType(java.lang.String mediatype)
Sets into the Content Manager Library Server, the media type or file format property for this object. File format could be MPEG1(default), MPEG2, AVI, WAV, LBR, QT etc. Specifying this is optional.
Parameters:
mediatype - the media type.

setStreamMediaResolution

public void setStreamMediaResolution(java.lang.String mediares)
Sets into the Content Manager Library Server, the media resolution property of this stream object.
The value is alphanumeric, and can be up to 16 characters, for example, SIF(default), HHR, CCIR601 etc. Specifying this is optional.
Parameters:
mediaresolution - the media resolution.

setStreamMediaStandard

public void setStreamMediaStandard(java.lang.String mediastd)
Sets into the Content Manager Library Server, the media standard information for this stream.
The media standard could be NTSC(default)or PAL.
Parameters:
mediastandard - the media standard.

setStreamInvalidCommands

public void setStreamInvalidCommands(int mediainvcmds)
Sets into the Content Manager Library Server, the information regarding the media invalid commands as a media player control mask for a stream item. Specifying this is optional.
Parameters:
mediainvcmd - the media invalid commands.

setStreamAccessMode

public void setStreamAccessMode(java.lang.String mode)
Sets into the Content Manager Library Server, the access mode for retrieving this stream.
The access mode is either SHARED or EXCLUSIVE. Specifying this is optional, the default is SHARED.
Parameters:
mode - the access mode, the value can be either SHARED or EXCLUSIVE.

setStreamGroup

public void setStreamGroup(java.lang.String group)
Sets the asset group name to store this stream into in the Video Charger.
The group name is alphanumeric up to 120 characters length. It is optional, the default is AG.
The asset group if specified here, must exist in the Video Charger.
Parameters:
group - the name of the group to store this stream into.

setPlayStart

public void setPlayStart(java.lang.String starttime)
Sets the time to start streaming this content object. It is an offset from the beginning of the stream. The format is hh:mm:ss:ff.
If not specified or if set to 00:00:00:00, the content is streamed from the beginning. This method is usually used in conjunction with the stop time (See setPlayStop(java.lang.String)).
Parameters:
starttime - the time to start playing the content.

setPlayStop

public void setPlayStop(java.lang.String stoptime)
Sets the time to stop streaming this content object. It is an offset from the start time of playing the stream. The format is hh:mm:ss:ff.
If not specified or if set to 00:00:00:00, the content is streamed from the beginning. This method is usually used in conjunction with the start time (See setPlayStart(java.lang.String)).
Parameters:
stoptime - the time to stop playing the content.

getStreamBitrate

public int getStreamBitrate()
Gets the recommended bit rate for this stream as set in the Content Manager Library Server.
Returns:
the bit rate in integer.
See Also:
setStreamBitrate(int)

getStreamDuration

public int getStreamDuration()
Gets the duration to play the stream clip, in seconds, as set in the Content Manager Library Server.
Returns:
the duration to play the clip.
See Also:
setStreamDuration(int)

getStreamMediaState

public int getStreamMediaState()
Gets the stream media state value as set in the Content Manager Library Server.
Returns:
the media state of this stream.
See Also:
setStreamMediaState(int)

getStreamExtObjectName

public java.lang.String getStreamExtObjectName()
Gets the external object name of this stream as set in the Content Manager Library Server.
Returns:
the external object name.
See Also:
setStreamExtObjectName(java.lang.String)

getStreamFrameRate

public int getStreamFrameRate()
Gets the number of frame per second recommended for streaming this object as set in the Content Manager Library Server.
Returns:
the frame rate.
See Also:
setStreamFrameRate(int)

getStreamFrameDuration

public int getStreamFrameDuration()
Gets the stream duration in number of frames for streaming this object as set in the Content Manager Library Server.
Returns:
int frameduration.
See Also:
setStreamFrameDuration(int)

getStreamFormat

public java.lang.String getStreamFormat()
Gets the stream format or the streaming type of this stream as set in the Content Manager Library Server. The value could be one of SYSTEM, PROGRAM, or TRANSPORT.
Returns:
the stream format.
See Also:
setStreamFormat(java.lang.String)

getStreamCopyRate

public int getStreamCopyRate()
Gets the copy rate in number of bits per second at which this resource is stored as set in the Content Manager Library Server.
Returns:
the copy rate, in bits per second.
See Also:
setStreamCopyRate(int)

getStreamNumUsers

public int getStreamNumUsers()
Gets the maximum number of concurrent users allowed to stream this object as set in the Content Manager Library Server.
Returns:
the maximum number of concurrent users.
See Also:
setStreamNumUsers(int)

getStreamMediaType

public java.lang.String getStreamMediaType()
Gets the media type or file format for this streamable object as set in the Content Manager Library Server. The file format could be MPEG1, MPEG2, AVI, etc.
Returns:
the media type, a string.
See Also:
setStreamMediaType(java.lang.String)

getStreamMediaResolution

public java.lang.String getStreamMediaResolution()
Gets the resolution of this streamable object as set in the Content Manager Library Server.
Returns:
the media resolution, a string.
See Also:
setStreamMediaResolution(java.lang.String)

getStreamMediaStandard

public java.lang.String getStreamMediaStandard()
Gets the media standard of this streamable object as set in the Content Manager Library Server. The standard could be NTSC, PAL, etc.
Returns:
the media standard, a string.
See Also:
setStreamMediaStandard(java.lang.String)

getStreamInvalidCommands

public int getStreamInvalidCommands()
Gets the stream invalid commands value as set in the Content Manager Library Server.
Returns:
the invalid commands, an integer.
See Also:
setStreamInvalidCommands(int)

getStreamAccessMode

public java.lang.String getStreamAccessMode()
Gets the access mode for retrieving this stream as set in the Content Manager Library Server. The access mode is either SHARED or EXCLUSIVE.
Returns:
mode the access mode.
See Also:
(java.lang.String)

getPlayStart

public java.lang.String getPlayStart()
Gets the play start time of this stream.
Returns:
the start time, the format is hh:mm:ss:ff.
See Also:
setPlayStart(java.lang.String)

getPlayStop

public java.lang.String getPlayStop()
Gets the play stop time value of this stream.
Returns:
the stoptime, the format is hh:mm:ss:ff.
See Also:
setPlayStop(java.lang.String).

EIP Java APIs

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