Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKMediaStreamInfoDL

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKMediaStreamInfoDL
All Implemented Interfaces:
dkExtension, dkMediaStreamInfo, java.io.Serializable

public class DKMediaStreamInfoDL
extends java.lang.Object
implements dkMediaStreamInfo, java.io.Serializable

This class defines the properties for Digital Library Video Stream objects.

See Also:
Serialized Form

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

DKMediaStreamInfoDL

public DKMediaStreamInfoDL()
Constructs a new DKMediaStreamInfoDL object.

DKMediaStreamInfoDL

public DKMediaStreamInfoDL(DKMediaStreamInfoDL sourceVSDL)
Copy constructor to construct a DKMediaStreamInfoDL object.
Parameters:
sourceVSDL - a source DKMediaStreamInfoDL object
Method Detail

getName

public java.lang.String getName()
                         throws java.lang.Exception
Gets the name of this extension object
Specified by:
getName in interface dkExtension
Returns:
name of this object

setName

public void setName(java.lang.String extName)
             throws java.lang.Exception
Sets the name of this extension object
Specified by:
setName in interface dkExtension
Parameters:
extName - name of this extension object

setMediaFullFileName

public 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).

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).

Parameters:
fullFileName - a fully qualified directory path and file name

getMediaFullFileName

public java.lang.String getMediaFullFileName()
Gets the fully qualified directory path and file name for the media object data file. (or control information, not the media object itself).
Returns:
the fully qualified directory path and file name

setMediaObjectOption

public void setMediaObjectOption(int objectOption)
Sets the object option indicating the media object data is in a single file or multiple files.

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.

Parameters:
objectOption - an option indicating to handle single or multiple objects

getMediaObjectOption

public int getMediaObjectOption()
Gets the object option indicating the media object data is in a single file or multiple files.
Returns:
the object option

setMediaUserId

public 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.
Parameters:
userId - a user Id

setMediaPassword

public void setMediaPassword(java.lang.String password)
Sets the password for the user Id.
Parameters:
password - a password

setMediaHostName

public void setMediaHostName(java.lang.String hostName)
Sets the host name of the machine where the media object data file resides.

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.

Parameters:
hostName - a host name

setMediaCopyRate

public void setMediaCopyRate(int copyRate)
Sets the copy rate to transfer data.
Parameters:
copyRate - the copy rate

getMediaCopyRate

public int getMediaCopyRate()
Gets the copy rate to transfer data.
Returns:
the copy rate

setMediaInvalidCommands

public void setMediaInvalidCommands(int invalidCommands)
Sets invalid commands for video player control mask
Parameters:
invalidCommands - video player control mask

getMediaInvalidCommands

public int getMediaInvalidCommands()
Gets invalid commands as video player control mask
Returns:
video player control mask

setMediaDurSeconds

public void setMediaDurSeconds(int seconds)
Sets the media duration in seconds
Parameters:
seconds - media duration in seconds

getMediaDurSeconds

public int getMediaDurSeconds()
Gets the media duration in seconds
Returns:
media duration in seconds

setMediaDurFrames

public void setMediaDurFrames(int frames)
Sets the media duration in number of frames
Parameters:
frames - media duration in number of frames

getMediaDurFrames

public int getMediaDurFrames()
Gets the media duration in number of frames
Returns:
media duration in number of frames

setMediaFrameRate

public void setMediaFrameRate(int frameRate)
Sets the media frame rate * 100
Parameters:
frameRate - media frame rate * 100 (e.g. 29.97 = 2997)

getMediaFrameRate

public int getMediaFrameRate()
Gets the media frame rate * 100
Returns:
media frame rate * 100 (e.g. 29.97 = 2997)

setMediaBitRate

public void setMediaBitRate(int bitRate)
Sets the total multiplexed media bit rate
Parameters:
bitRate - total multiplexed media bit rate

getMediaBitRate

public int getMediaBitRate()
Gets the total multiplexed media bit rate
Returns:
the total multiplexed media bit rate

setMediaNumberOfUsers

public void setMediaNumberOfUsers(int numUsers)
Sets the number of media users allowed to stream the media object data concurrently
Parameters:
numUsers - the number of media users allowed

getMediaNumberOfUsers

public int getMediaNumberOfUsers()
Gets the number of media users allowed to stream the media object data concurrently
Returns:
the number of media users allowed

setMediaAssetGroup

public void setMediaAssetGroup(java.lang.String name)
Sets the video server asset group name. This value is alphanumeric and maybe up to 120 characters.
Parameters:
name - a video server asset group name

getMediaAssetGroup

public java.lang.String getMediaAssetGroup()
Gets the video server asset group name.
Returns:
the video server asset group name

setMediaType

public void setMediaType(java.lang.String mediaType)
Sets the media type describes the file format of a media asset.

Currently supported values are: MPEG1, MPEG2, AVI, MOV, WAV, LBR, MJPEG, H263, H273, G723.

Parameters:
mediaType - a media type

getMediaType

public java.lang.String getMediaType()
Gets the media type describes the file format of a media asset.
Returns:
the media type

setMediaResolution

public void setMediaResolution(java.lang.String resolution)
Sets the media resolution.

Currently supported values are: SIF, HHR, CCIR601. The values is alphanumeric and maybe up to 16 characters.

Parameters:
resolution - a media resolution

getMediaResolution

public java.lang.String getMediaResolution()
Gets the media resolution.
Returns:
the media resolution

setMediaStandard

public void setMediaStandard(java.lang.String standard)
Sets the media standard used.

Currently supported values are: NTSC, PAL. This value is alphanumeric and maybe up to 16 characters.

Parameters:
standard - a media standard used

getMediaStandard

public java.lang.String getMediaStandard()
Gets the media standard used.
Returns:
the media standard used

setMediaFormat

public void setMediaFormat(java.lang.String format)
Sets the streaming type of video asset(media object data).

Currently supported values are: SYSTEM, PROGRAM, TRANSPORT. This value is alphanumeric and maybe up to 16 characters.

Parameters:
format - a streaming type of video asset

getMediaFormat

public java.lang.String getMediaFormat()
Gets the streaming type of video asset(media object data).
Returns:
the streaming type of video asset

getMediaState

public int getMediaState()
Gets the state of media object.
Returns:
the state of media object

getMediaTimestamp

public java.lang.String getMediaTimestamp()
Gets the timestamp when media object is stored.
Returns:
the timestamp when media object is stored

EIP Java APIs

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