Index

DKMediaStreamInfoDL

Purpose:

The DKMediaStreamInfoDL class defines the properties and other information required by media objects.

Heirarchy:

dkExtension
  dkMediaStreamInfo
    dkMediaStreamInfoDL
 

Class summary:

    class DKMediaStreamInfoDL: public dkMediaStreamInfo
    {
   public:
         
      dkMediaStreamInfoDL();
      dkMediaStreamInfoDL(const DKMediaStreamInfoDL& aAnnot);
      virtual ~DKMediaStreamInfoDL();
      dkMediaStreamInfoDL&  operator=(const DKMediaStreamInfoDL& aVS);
      dkString       getMediaFullFileName() const;
      void           setMediaFullFileName(const char* aFullFileName);
      unsigned long  getMediaObjectOption();
      void           setMediaObjectOption(unsigned long aObjectOption);
      unsigned long  getMediaCopyRate();
      void           setMediaCopyRate(unsigned long aCopyRate);
      unsigned long  getMediaInvalidCommands();
      void           setMediaInvalidCommands(unsigned long invalidCommands);
      unsigned long  getMediaDurSeconds();
      void           setMediaDurSeconds(unsigned long seconds);
      unsigned long  getMediaDurFrames(); 
      void           setMediaDurFrames(unsigned long frames);
      unsigned long  getMediaFrameRate();
      void           setMediaFrameRate(unsigned long aFrameRate);
      unsigned long  getMediaBitRate();
      void           setMediaBitRate(unsigned long aBitRate);
      long           getMediaNumberOfUsers();
      void           setMediaNumberOfUsers(long numUsers);
      dkString       getMediaAssetGroup() const;
      void           setMediaAssetGroup(const char* aGroupName);
      dkString       getMediaType() const;
      void           setMediaType(const char* aMediaType);
      dkString       getMediaResolution() const;
      void           setMediaResolution(const char* aResolution);
      dkString       getMediaStandard() const;
      void           setMediaStandard(const char* aStandard);
      dkString       getMediaFormat() const;
      void           setMediaFormat(const char* aFormat); 
      long           getMediaState();
      dkString       getMediaTimestamp() const;
      unsigned short getMediaClassId();
      void           setMediaHostName(const char* aHostName);
      void           setMediaUserId(const char* aUserId);
      void           setMediaPassword(const char* aPassword);
 
    };
 

Members:

Constructors and destructor
      dkMediaStreamInfoDL();
      dkMediaStreamInfoDL(const DKMediaStreamInfoDL& aAnnot);
      virtual ~DKMediaStreamInfoDL();
 

Member functions

operator=
Assignment operator.
     dkMediaStreamInfoDL& operator= (const DKMediaStreamInfoDL& aVS);
 

getMediaFullFileName
Gets the fully qualified directory path and file name (the control information). If the media object data is stored in a single file, then FullFileName becomes the media object. If the media object data is stored in multiple files, then FullFileName will contain a list of the media object segment files and their respective path names.

      dkString getMediaFullFileName() const;
 

setMediaFullFileName
Sets the fully qualified directory path and file name (the control information). If the media object data is stored in a single file, then FullFileName becomes the media object. If the media object data is stored in multiple files, then FullFileName will contain a list of the media object segment files and their respective path names.

The drive, directory path, and file name are stored as a string in the client data space. This string may contain up to 128 characters. The file name must conform to the standard 8:3 format (1 to 8 characters for the file name and 0 to 3 characters for the extension); the Content Manager datastore does not currently support long file names.

      void setMediaFullFileName(const char* aFullFileName);
 

getMediaObjectOption
Gets the object option that indicates whether the media object data is stored in a single file or in multiple files.
      unsigned long getMediaObjectOption();
 

setMediaObjectOption
Sets the object option that indicates whether the media object data is stored in a single file or in multiple files. The valid values are:
  • DK_VS_SINGLE_OBJECT

    The value of fullFileName that the setMediaFullFileName function specifies will be passed to the object server for FTP processing.

  • DK_VS_LIST_OF_OBJECT_SEGMENTS

    The value of fullFileName that the setMediaFullFileName function specifies will consist of a list of object segments and their respective paths. This information will be passed to the object server for FTP processing.

      void setMediaObjectOption(unsigned long aObjectOption);
 

getMediaCopyRate
Gets the copy rate at which data will be transferred.
      unsigned long getMediaCopyRate();
 

setMediaCopyRate
Sets the copy rate at which data will be transferred.This function is optional.
      void setMediaCopyRate(unsigned long aCopyRate);
 

getMediaInvalidCommands
Gets invalid commands for the video player control mask.
      unsigned long getMediaInvalidCommands();
 

setMediaInvalidCommands
Sets invalid commands for the video player control mask. This function is optional.
      void setMediaInvalidCommands(unsigned long invalidCommands);
 

getMediaDurSeconds
Gets the media duration as a value that equates to the number of seconds.
      unsigned long getMediaDurSeconds();
 

setMediaDurSeconds
Sets the media duration as a value that equates to the number of seconds. This function is optional.
      void setMediaDurSeconds(unsigned long seconds);
 

getMediaDurFrames
Gets the media duration as a value that equates to the number of frames.
      unsigned long getMediaDurFrames();
 

setMediaDurFrames
Sets the media duration as a value that equates to the number of frames. This function is optional.
      void setMediaDurFrames(unsigned long frames);
 

getMediaFrameRate
Gets the media frame rate multiplied by 100. This value is stored at 100 times the actual value. For example, the number 29.97 would be stored as 2997.
      unsigned long getMediaFrameRate();
 

setMediaFrameRate
Sets the media frame rate multiplied by 100. This value should be 100 times the actual value. For example, the number 29.97 would be stored as 2997. This function is optional.
      void setMediaFrameRate(unsigned long aFrameRate);
 

getMediaBitRate
Gets the total multiplexed media bit rate.
      unsigned long getMediaBitRate();
 

setMediaBitRate
Sets the total multiplexed media bit rate. This function is optional.
      void setMediaBitRate(unsigned long aBitRate);
 

getMediaNumberOfUsers
Gets the number of media users allowed to stream the media object data concurrently.
      unsigned long getMediaNumberOfUsers();
 

setMediaNumberOfUsers
Sets the number of media users allowed to stream the media object data concurrently. The default value is 1.
      void setMediaNumberOfUsers(long numUsers);
 

getMediaAssetGroup
Gets the name of the video server asset group. This value is alphanumeric and can be up to 120 characters in length.
      dkString getMediaAssetGroup() const;
 

setMediaAssetGroup
Sets the name of the video server asset group. This value is alphanumeric and can be up to 120 characters in length. The default value is "AG."
      void setMediaAssetGroup(const char* aGroupName);
 

getMediaType
Gets the media type that describes the file format of a media asset (media object data).
      dkString getMediaType() const;
 

setMediaType
Sets the media type that describes the file format of a media asset (media object data). This value is alphanumeric and can be up to 16 characters in length. The currently supported values are:
  • MPEG1 (default value)
  • MPEG2
  • AVI
  • MOV
  • WAV
  • LBR
  • MJPEG
  • H263
  • H273
  • G723

      void setMediaType(const char* aMediaType);
 

getMediaResolution
Gets the media resolution.
      dkString getMediaResolution() const;
 

setMediaResolution
Sets the media resolution. This value is alphanumeric and can be up to 16 characters in length. The currently supported values are:
  • SIF (default value)
  • HHR
  • CCIR601

      void setMediaResolution(const char* aResolution);
 

getMediaStandard
Gets the media standard that is currently being used.
      dkString getMediaStandard() const;
 

setMediaStandard
Sets the media standard. This value is alphanumeric and can be up to 16 characters in length. The currently supported values are:
  • NTSC (default value)
  • PAL

      void setMediaStandard(const char* aStandard);
 

getMediaFormat
Gets the streaming type of video asset (media object data).
      dkString getMediaFormat() const;
 

setMediaFormat
Sets the streaming type of video asset (media object data). This value is alphanumeric and can be up to 16 characters in length. The currently supported values are:
  • SYSTEM (default value)
  • PROGRAM
  • TRANSPORT

      void setMediaFormat(const char* aFormat;
 

getMediaState
Gets the state of the media object. The valid values are:
  • 1 - pending, load in progress
  • 2 - load completed successfully
  • 3 - load failed

      long getMediaState();
 

getMediaTimestamp
Gets the timestamp when the media object is stored.
      dkString getMediaTimestamp() const;
 

getMediaClassId
Gets the ID of the FRN$MEDIA index class.
      unsigned short getMediaClassId();
 

setMediaHostName
Sets the host name of the machine where the media object data file resides. This machine is not necessarily the same as the Content Manager system. The user ID and password used to access the Content Manager system may not allow the video server to access the files on the system.
      void setMediaHostName(const char* aHostName);
 

setMediaUserId
Sets the user ID that will connect to the host name where the media object data file resides. The user ID will also perform the FTP file transfer over the video server.
      void setMediaUserId(const char* aUserId);
 

setMediaPassword
Sets the password for the user ID, allowing the user ID to perform the FTP file transfer over the video server.
      void setMediaPassword(const char* aPassword);
 

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