|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
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:
DKLobICM
, Serialized FormFields 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.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.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 |
public DKStreamICM() throws DKUsageError, java.lang.Exception
DKUsageError
- if datastore type is invalid.java.lang.Exception
- on errors.public DKStreamICM(dkDatastore ds) throws DKUsageError, java.lang.Exception
ds
- the associated datastore, a DKDatastoreICM object.DKUsageError
- if datastore type is invalid.java.lang.Exception
- on errors.public DKStreamICM(DKStreamICM aDKStreamICM) throws DKException, java.lang.Exception
aDKStreamICM
- an instance of DKStreamICM object to copy from.DKException
- on errors.java.lang.Exception
- on errors.Method Detail |
public void addFrom() throws DKException, java.lang.Exception
addFrom
in class DKLobICM
DKException
- on errorsjava.lang.Exception
- on errorsDKLobICM.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
addFrom
in class DKLobICM
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 defaultoption
- see DKDatastoreICM.addObject(dkDataObject, int)
the file is expected to be in the current login directory.DKException
- on errors.java.lang.Exception
- on errors.DKLobICM.addFrom()
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
addFromAsync
in class DKLobICM
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)
DKException
- on errors.java.lang.Exception
- on errors.DKLobICM.addFromAsync()
public void addFromAsync() throws DKException, java.lang.Exception
addFromAsync
in class DKLobICM
DKException
- on errors.java.lang.Exception
- on errors.DKLobICM.addFromAsync()
public void updateFrom() throws DKException, java.lang.Exception
updateFrom
in class DKLobICM
DKException
- on errors.java.lang.Exception
- on errors.DKLobICM.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
updateFrom
in class DKLobICM
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)
DKException
- on errors.java.lang.Exception
- on errors.DKLobICM.updateFrom()
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
updateFromAsync
in class DKLobICM
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)
DKException
- on errors.java.lang.Exception
- on errors.DKLobICM.updateFromAsync()
public void updateFromAsync() throws DKException, java.lang.Exception
updateFromAsync
in class DKLobICM
DKException
- on errors.java.lang.Exception
- on errors.DKLobICM.updateFromAsync()
public void retrieveTo() throws DKException, java.lang.Exception
retrieveTo
in class DKLobICM
DKException
- on errors.java.lang.Exception
- on errors.DKLobICM.retrieveTo()
public void retrieveToAsync() throws DKException, java.lang.Exception
retrieveToAsync
in class DKLobICM
DKException
- on errors.java.lang.Exception
- on errors.DKLobICM.retrieveToAsync()
public byte[] play() throws DKException, java.lang.Exception
DKException
- on errors.java.lang.Exception
- on errors.setPlayStart(java.lang.String)
,
setPlayStop(java.lang.String)
public void setStreamBitrate(int bitrate)
bitrate
- the bitrate value.public void setStreamDuration(int duration)
duration
- the duration in seconds.public void setStreamMediaState(int mediastate)
mediastate
- the mediastate.public void setStreamExtObjectName(java.lang.String extobjname)
extobjname
- the external object name.public void setStreamFrameRate(int framerate)
framerate
- the framerate per second.public void setStreamFormat(java.lang.String streamformat)
streamformat
- the streaming type of video file.public void setStreamFrameDuration(int framedur)
frameduration
- the stream duration in number of frames.public void setStreamCopyRate(int copyrate)
copyrate
- the copy rate in bits per second.public void setStreamNumUsers(int numusers)
numusers
- the number of concurrent users.public void setStreamMediaType(java.lang.String mediatype)
mediatype
- the media type.public void setStreamMediaResolution(java.lang.String mediares)
mediaresolution
- the media resolution.public void setStreamMediaStandard(java.lang.String mediastd)
mediastandard
- the media standard.public void setStreamInvalidCommands(int mediainvcmds)
mediainvcmd
- the media invalid commands.public void setStreamAccessMode(java.lang.String mode)
mode
- the access mode, the value can be either SHARED or EXCLUSIVE.public void setStreamGroup(java.lang.String group)
group
- the name of the group to store this stream into.public void setPlayStart(java.lang.String starttime)
setPlayStop(java.lang.String)
).starttime
- the time to start playing the content.public void setPlayStop(java.lang.String stoptime)
setPlayStart(java.lang.String)
).stoptime
- the time to stop playing the content.public int getStreamBitrate()
setStreamBitrate(int)
public int getStreamDuration()
setStreamDuration(int)
public int getStreamMediaState()
setStreamMediaState(int)
public java.lang.String getStreamExtObjectName()
setStreamExtObjectName(java.lang.String)
public int getStreamFrameRate()
setStreamFrameRate(int)
public int getStreamFrameDuration()
setStreamFrameDuration(int)
public java.lang.String getStreamFormat()
setStreamFormat(java.lang.String)
public int getStreamCopyRate()
setStreamCopyRate(int)
public int getStreamNumUsers()
setStreamNumUsers(int)
public java.lang.String getStreamMediaType()
setStreamMediaType(java.lang.String)
public java.lang.String getStreamMediaResolution()
setStreamMediaResolution(java.lang.String)
public java.lang.String getStreamMediaStandard()
setStreamMediaStandard(java.lang.String)
public int getStreamInvalidCommands()
setStreamInvalidCommands(int)
public java.lang.String getStreamAccessMode()
(java.lang.String)
public java.lang.String getPlayStart()
setPlayStart(java.lang.String)
public java.lang.String getPlayStop()
setPlayStop(java.lang.String).
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |