Class Information:
| ClassPath: | MEng.System.CQC.Runtime.CQCPLItem |
| Parent ClassPath: | MEng.Object |
| Copyable: | No |
| Final: | Yes |
MEng.System.CQC.Runtime.CQCPLItem represents a standard playlist item as used by a CQC media renderer driver. A media renderer maintains a playlist of items that have been queued up on it, each of which represents an 'item', in CQC media repository parlance. In some cases the playlist may be partly maintained in the target device, but even so the renderer driver needs to maintain the metadata for those queued items so that it can present them upon request by clients. It will have to have some way of keeping its own list in sync with that of the player. In other cases, the renderer driver will hold the list itself and just queue up single songs on the target device as the previous one ends.
So this class provides storage for the standard metadata values that a CQC repository maintains about a media item, and provides getter/setting methods for those values. This class uses some types from the CQCMediaInfo class.
Constructors:
Constructor();
There is just a default constructor available.
Final, Const Methods:
FormatTotalTime([Out] MEng.String ToFill);
The total time value is stored as a time stamp. This method provides a convenient way to get it formatted out into the standard 1m,2s type of format (so many minutes and so many seconds) so that you you don't have to get it out and format it yourself.
GetColArtist() Returns MEng.String;
GetColAspect() Returns MEng.String;
GetColCast() Returns MEng.String;
GetColCookie() Returns MEng.String;
GetColDescr() Returns MEng.String;
GetColLabel() Returns MEng.String;
GetColLeadActor() Returns MEng.String;
GetColName() Returns MEng.String;
GetColRating() Returns MEng.String;
GetColYear() Returns MEng.Card4;
These methods all return one of the collection level pieces of information about the item represented by this playlist item object.
GetItemArtist() Returns MEng.String;
GetItemCookie() Returns MEng.String;
GetItemName() Returns MEng.String;
GetItemSeconds() Returns MEng.Card4;
These methods all return one of the item level pieces of information about the item represented by this playlist item object.
GetLocInfo() Returns MEng.String;
Returns the location information string for this item. The contents of this string is completely arbitrary and is defined by the repository from whence it came. It is assumed you will only pass it to renderers that understand that format.
GetLocType() Returns MEng.System.CQC.Runtime.CQCMediaInfo.CQCMLocTypes;
Returns the location info type, which can provide a clue as to how to interpret the location info.
GetTitleCookie() Returns MEng.String;
GetTitleName() Returns MEng.String;
These methods all return one of the title set level pieces of information about the item represented by this playlist item object.
Final, Non-Const Methods:
SetColArtist([In] MEng.String ToSet);
SetColAspect(In] MEng.String ToSet);
SetColCast(In] MEng.String ToSet);
SetColCookie(In] MEng.String ToSet);
SetColDescr(In] MEng.String ToSet);
SetColLabel(In] MEng.String ToSet);
SetColLeadActor(In] MEng.String ToSet);
SetColName(In] MEng.String ToSet);
SetColRating(In] MEng.String ToSet);
SetColYear(In] MEng.Card4 ToSet);
These methods allow you to set one of the collection level pieces of information about the item represented by this playlist item object.
SetItemArtist([In] MEng.String ToSet);
SetItemCookie(In] MEng.String ToSet);
SetItemName(In] MEng.String ToSet);
SetItemSeconds(In] MEng.Card4 ToSet);
These methods allow you to set one of the item level pieces of information about the item represented by this playlist item object.
SetLocInfo([In] MEng.String ToSet);
Allows you to set the location information for this item. Be sure to set the location type as well.
SetLocType([In] MEng.System.CQC.Runtime.CQCMediaInfo.CQCMLocTypes ToSet)
Allows you to set the location type, so that it indicates the type of location info currently set.