|
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.DKMediaStreamInfoDL
This class defines the properties for Digital Library Video Stream objects.
Constructor Summary | |
DKMediaStreamInfoDL()
Constructs a new DKMediaStreamInfoDL object. |
|
DKMediaStreamInfoDL(DKMediaStreamInfoDL sourceVSDL)
Copy constructor to construct a DKMediaStreamInfoDL object. |
Method Summary | |
java.lang.String |
getMediaAssetGroup()
Gets the video server asset group name. |
int |
getMediaBitRate()
Gets the total multiplexed media bit rate |
int |
getMediaCopyRate()
Gets the copy rate to transfer data. |
int |
getMediaDurFrames()
Gets the media duration in number of frames |
int |
getMediaDurSeconds()
Gets the media duration in seconds |
java.lang.String |
getMediaFormat()
Gets the streaming type of video asset(media object data). |
int |
getMediaFrameRate()
Gets the media frame rate * 100 |
java.lang.String |
getMediaFullFileName()
Gets the fully qualified directory path and file name for the media object data file. |
int |
getMediaInvalidCommands()
Gets invalid commands as video player control mask |
int |
getMediaNumberOfUsers()
Gets the number of media users allowed to stream the media object data concurrently |
int |
getMediaObjectOption()
Gets the object option indicating the media object data is in a single file or multiple files. |
java.lang.String |
getMediaResolution()
Gets the media resolution. |
java.lang.String |
getMediaStandard()
Gets the media standard used. |
int |
getMediaState()
Gets the state of media object. |
java.lang.String |
getMediaTimestamp()
Gets the timestamp when media object is stored. |
java.lang.String |
getMediaType()
Gets the media type describes the file format of a media asset. |
java.lang.String |
getName()
Gets the name of this extension object |
void |
setMediaAssetGroup(java.lang.String name)
Sets the video server asset group name. |
void |
setMediaBitRate(int bitRate)
Sets the total multiplexed media bit rate |
void |
setMediaCopyRate(int copyRate)
Sets the copy rate to transfer data. |
void |
setMediaDurFrames(int frames)
Sets the media duration in number of frames |
void |
setMediaDurSeconds(int seconds)
Sets the media duration in seconds |
void |
setMediaFormat(java.lang.String format)
Sets the streaming type of video asset(media object data). |
void |
setMediaFrameRate(int frameRate)
Sets the media frame rate * 100 |
void |
setMediaFullFileName(java.lang.String fullFileName)
Sets the fully qualified directory path and file name for the media object data file (or control information, not the media object itself). |
void |
setMediaHostName(java.lang.String hostName)
Sets the host name of the machine where the media object data file resides. |
void |
setMediaInvalidCommands(int invalidCommands)
Sets invalid commands for video player control mask |
void |
setMediaNumberOfUsers(int numUsers)
Sets the number of media users allowed to stream the media object data concurrently |
void |
setMediaObjectOption(int objectOption)
Sets the object option indicating the media object data is in a single file or multiple files. |
void |
setMediaPassword(java.lang.String password)
Sets the password for the user Id. |
void |
setMediaResolution(java.lang.String resolution)
Sets the media resolution. |
void |
setMediaStandard(java.lang.String standard)
Sets the media standard used. |
void |
setMediaType(java.lang.String mediaType)
Sets the media type describes the file format of a media asset. |
void |
setMediaUserId(java.lang.String userId)
Sets the user Id that will connect to the host name where the media object data file resides, and to perform the ftp file transfer by video server. |
void |
setName(java.lang.String extName)
Sets the name of this extension object |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKMediaStreamInfoDL()
public DKMediaStreamInfoDL(DKMediaStreamInfoDL sourceVSDL)
sourceVSDL
- a source DKMediaStreamInfoDL objectMethod Detail |
public java.lang.String getName() throws java.lang.Exception
getName
in interface dkExtension
public void setName(java.lang.String extName) throws java.lang.Exception
setName
in interface dkExtension
extName
- name of this extension objectpublic void setMediaFullFileName(java.lang.String fullFileName)
The drive, directory path and file name are a string in the client data space containing up to 128 characters. The Digital Library system does not support the long file names and it must conform to the standard 8:3 format (1 to 8 characters for the file name and 0 to 3 characters for the extension).
fullFileName
- a fully qualified directory path and file namepublic java.lang.String getMediaFullFileName()
public void setMediaObjectOption(int objectOption)
The valid options are:
If set to DK_VS_SINGLE_OBJECT, then the data specified by setMediaFullFileName, which is a single path and file name, will be passed to the object server for FTP processing. If set to DK_VS_LIST_OF_OBJECT_SEGMENTS, then the data specified by setMediaFullFileName, which is a list of object segments and their respective paths, will be passed to the object server for FTP processing.
objectOption
- an option indicating to handle single or multiple objectspublic int getMediaObjectOption()
public void setMediaUserId(java.lang.String userId)
userId
- a user Idpublic void setMediaPassword(java.lang.String password)
password
- a passwordpublic void setMediaHostName(java.lang.String hostName)
The system of the host name may or may not be the same system as Digital Library, and the password and user Id to access Digital Library may not allow video server to direct access the file that resides on the same system as Digital Library.
hostName
- a host namepublic void setMediaCopyRate(int copyRate)
copyRate
- the copy ratepublic int getMediaCopyRate()
public void setMediaInvalidCommands(int invalidCommands)
invalidCommands
- video player control maskpublic int getMediaInvalidCommands()
public void setMediaDurSeconds(int seconds)
seconds
- media duration in secondspublic int getMediaDurSeconds()
public void setMediaDurFrames(int frames)
frames
- media duration in number of framespublic int getMediaDurFrames()
public void setMediaFrameRate(int frameRate)
frameRate
- media frame rate * 100 (e.g. 29.97 = 2997)public int getMediaFrameRate()
public void setMediaBitRate(int bitRate)
bitRate
- total multiplexed media bit ratepublic int getMediaBitRate()
public void setMediaNumberOfUsers(int numUsers)
numUsers
- the number of media users allowedpublic int getMediaNumberOfUsers()
public void setMediaAssetGroup(java.lang.String name)
name
- a video server asset group namepublic java.lang.String getMediaAssetGroup()
public void setMediaType(java.lang.String mediaType)
Currently supported values are: MPEG1, MPEG2, AVI, MOV, WAV, LBR, MJPEG, H263, H273, G723.
mediaType
- a media typepublic java.lang.String getMediaType()
public void setMediaResolution(java.lang.String resolution)
Currently supported values are: SIF, HHR, CCIR601. The values is alphanumeric and maybe up to 16 characters.
resolution
- a media resolutionpublic java.lang.String getMediaResolution()
public void setMediaStandard(java.lang.String standard)
Currently supported values are: NTSC, PAL. This value is alphanumeric and maybe up to 16 characters.
standard
- a media standard usedpublic java.lang.String getMediaStandard()
public void setMediaFormat(java.lang.String format)
Currently supported values are: SYSTEM, PROGRAM, TRANSPORT. This value is alphanumeric and maybe up to 16 characters.
format
- a streaming type of video assetpublic java.lang.String getMediaFormat()
public int getMediaState()
public java.lang.String getMediaTimestamp()
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |