CDDB Component
Introduction
User Guide
Object Model
Technical ReferenceCode Example
Download
Buy a License
Other Volto Components
|
| Objects | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CDX This object provides methods and properties to retrieve and submit CDDB data and to configure various parameters required for CDDB server access. The following table describes the object's methods:
The following table describes the object's properties:
CD This object provides properties to retrieve data about one specific CD. Multiple CD objects may exist in the CDX.CDs collection which is created by calling the CDX.GetData method. The following table describes the object's properties:
Track This object provides properties to retrieve data about one specific CD track. Multiple Track objects may exist in the CD.Tracks collection which is created by calling the CDX.GetData method. The following table describes the object's properties:
Site This object provides properties to retrieve data about one specific CDDB database site. Multiple Site objects may exist in the CDX.Sites collection which is created the first time that the collection property is read. The following table describes the object's properties:
|
| Methods | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
AppSettings Sets the application name and version that will be sent when accessing a CDDB server. Syntax object.AppSettings AppName, AppVersion The AppSettings method has the following parts:
Note: This method is overridden in unregistered evaluation components. The application name will always be set to the default value of VOLTOCDX and the application version will be set to the version of the VoltoCDX component. GetData Gets CDDB data from a CDDB server or from a locally stored CDDB database file. If successful, the CDs collection property will contain one more more CD objects representing matching database records. Syntax object.GetData GetMode, ModeParam [,CDDBid] [,LocalDBdir] The GetData method has the following parts:
Note: When using the modeCDLocal or modGenreCDDBID modes, only a single CD object will be returned. Several CD objects may be returned When using the modeCD and modeQueryString modes as the CDDB database can contain several entries corresponding to the same query string, each entry having a different genre. The CDs.Count property indicates the number of returned objects (or matching records). Examples: This code segment demonstrates each of the GetData modes. In the first example, only basic timing information is retrieved for the CD in drive "E" - no CDDB query is made. The next example shows how to make a CDDB query for the CD. Example 3 shows a CDDB query made using the CDDB query string that was retrieved in the first example. The last example demonstrates how to make a CDDB query using the CDDBid and genre of the first CD record retrieved in the second example:
dim myCD as CD
dim QueryString as string
dim CDDBid as string
dim Genre as string
'-- Ex 1: Local data for CD in drive E
objCDX.GetData modeCDLocal, "E"
set myCD = objCDX.CDs(1)
QueryString = myCD.QueryString
CDDBid = myCD.CDDBid
'-- Ex 2: Query for CD in drive E
objCDX.GetData modeCD, "E"
set myCD = objCDX.CDs(1)
Genre = myCD.Genre
'-- Ex 3: Query using query string
objCDX.GetData modeQueryString, QueryString
'-- Ex 4: Query using Genre and CDDBid
objCDX.GetData modeGenreCDDBID, Genre, CDDBid
ProductLicense Unlocks full component functionality when a valid Serial Number and License Key pair is given. The Serial Number and License Key, together with a license file, are provided when purchasing a license for this component. Returns a boolean value - true if a valid Serial Number and License Key were entered, or false otherwise. Syntax object.ProductLicense (SerialNo, LicenseKey) The ProductLicense method has the following parts:
Remarks Call this method once only, immediately after creating the object, in order to unlock full component functionality. If you do not make a successful call to this method, then only restricted, evaluation mode functionality will be available. Note that the license file provided to licensed users must be present in the same directory as that in which the component has been installed. This file must also be distributed with compiled applications and copied to the appropriate directory by the application's setup utility. ServerSettings Sets the network parameters required to make a connection to a CDDB server. You need only call this method if you do not wish to use the default settings (described below), or if you are using a proxy server. Syntax object.ServerSettings Server [,Port] [,Timeout] [,ProxyServer] [,ProxyPort] [,ProxyUserName] [,ProxyPassword] The ServerSettings method has the following parts:
SubmitData Submits CDDB data to a CDDB server. Syntax object.SubmitData cdData [,SubmitMode] [,Comments] [,Message] The SubmitData method has the following parts:
Notes: This method does not return a status. The status of the submission (accepted or rejected) will be given in an email sent by the CDDB server to the submitting user. It is therefore essential that this email address be specified using the CDX.UserSettings method prior to calling the SubmitData method. Furthermore an error will be raised if any of the following required data is missing: CD title, CD genre, CD track data (at least 1 track including a title and frame offset), frame offsets for CD tracks, CD length, CDDB server address, user's email address. UserSettings Sets the user name, email and host name that will be sent when accessing a CDDB server. Note that the email address must be set before calling the CDX.SubmitData method. Syntax object.UserSettings Email [,UserName] [,Host] The UserSettings method has the following parts:
|
| Properties | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Address Returns a string value containing any additional addressing information needed to access the CDDB server. For example, for HTTP protocol servers, this would be the path to the CDDB server CGI script. This field will be "-" if no additional addressing information is needed. Syntax object.Address The Address property has the following parts:
Artist Returns or sets a string value containing a CD's artist name. The artist name is not always provided by the CDDB server, so this value may be null following a query. Syntax object.Artist [= name] The Artist property has the following parts:
CDDBid Returns or sets a string value containing a CD's unique id code. This property is usually generated automatically or retrieved from the CDDB server. Syntax object.CDDBid [= id] The CDDBid property has the following parts:
CDs Returns or sets a collection of CD objects where each CD object represents one CDDB database record for a CD. Syntax object.CDs [= collection] The CDs property has the following parts:
Description Returns a string value containing a short description of the geographical location of a CDDB site. Syntax object.Description The Description property has the following parts:
Drives Returns a collection of string values containing all valid CD drive letters. Syntax object.Drives The Drives property has the following parts:
ExtdGenre Returns or sets a string value containing an extended free text description of a CD's genre. This data is optional in CDDB databases, so the property may be set to null following a query. Syntax object.ExtdGenre [= text] The ExtdGenre property has the following parts:
ExtdInfo Returns or sets a string value containing an extended free text description of a CD or track. This data is optional in CDDB databases, so the property may be set to null following a query. Syntax object.ExtdInfo [= text] The ExtdInfo property has the following parts:
FrameOffset Returns or sets a long value containing the frame offset for a track. Syntax object.FrameOffset [= offset] The FrameOffset property has the following parts:
FullTitle Returns or sets a string value containing the title of the CD. The property contains both the CD title and the artist name. Artist name data is optional in CDDB databases, so the property may be contain only the title. Syntax object.FullTitle [= title] The FullTitle property has the following parts:
Genre Returns or sets a string value containing the CD's genre name. Syntax object.Genre [= name] The Genre property has the following parts:
Note: The genre name must be one of the valid CDDB genre names. A list of these names can be obtained from the CDX.Genres collection. Genres Returns a collection of string values containing all valid CD genres. The first time that this property is read, VoltoCDX will retrieve the genre list from the CDDB server specified using the CDX.ServerSettings method. Syntax object.Genres The Genres property has the following parts:
Latitude Returns a string value containing the latitude of a CDDB site. The format is as follows: CDDD.MM Where "C" is the compass direction (N, S), "DDD" is the degrees, and "MM" is the minutes. Syntax object.Latitude The Latitude property has the following parts:
Length Returns or sets a long value containing the length in seconds of a CD or track. Syntax object.Length [= seconds] The Length property has the following parts:
LengthMS Returns a string value containing the length in minutes and seconds of a CD or track. The format is MM:SS. Syntax object.LengthMS The LengthMS property has the following parts:
Longitude Returns a string value containing the longitude of a CDDB site. The format is as follows: CDDD.MM Where "C" is the compass direction (E, W), "DDD" is the degrees, and "MM" is the minutes. Syntax object.Longitude The Longitude property has the following parts:
Port Returns a long value containing the port number at which the server resides on a CDDB site. Syntax object.Port The Port property has the following parts:
Position Returns or sets a long value containing the position value for a track. Syntax object.Position [= position] The Position property has the following parts:
ProductVersion Returns a string value containing the version of the VoltoCDX component. Syntax object.ProductVersion The ProductVersion property has the following parts:
Protocol Returns a string value containing the transfer protocol used to access a CDDB site. This is either cddp or http. Syntax object.Protocol The Protocol property has the following parts:
QueryString Returns a string value containing a query string that identifies a specific CD when making queries to the CDDB database. This value is generated automatically when calling the CDX.GetData method and may be stored and used on a later occasion to query the CDDB database directly, without the need for the original audio CD to be present in the CD drive. See the description of the CDX.GetData method for information on how to do this. Syntax object.QueryString The QueryString property has the following parts:
Revision Returns or sets a long value containing the revision number of the CDDB database record for a CD. An application may typically retrieve a CD record, modify certain properties and then increment this value before resubmitting the data to the CDDB server. Syntax object.Revision [= number] The Revision property has the following parts:
Site Returns a string value containing the internet address of the CDDB site. Syntax object.Site The Site property has the following parts:
Sites Returns a collection of Site objects representing all valid CDDB servers. The first time that this property is read, VoltoCDX will retrieve the site list from the CDDB server specified using the CDX.ServerSettings method. Syntax object.Sites The Sites property has the following parts:
Status Returns a string value containing the HTTP status code returned following the last access to the CDDB server. Syntax object.Status The Status property has the following parts:
The following list shows some common return values:
Title Returns or sets a string value containing the title of a CD or track. In the case of a CD title, the value does not include the artist name (if existing). Syntax object.Title [= title] The Title property has the following parts:
Tracks Returns or sets a collection of Track objects where each Track object represents one track on a CD. Syntax object.Tracks [= collection] The Tracks property has the following parts:
XcmdFile Returns a string value containing a raw CDDB database record for a CD. Such records may be stored locally and used for future local off-line CDDB queries for example. Syntax object.XcmdFile The XcmdFile property has the following parts:
Note: This property is always set to null in unregistered evaluation components. Year Returns or sets a string value containing the publication year of a CD. This data is optional in CDDB databases, so the property may be set to null following a query. Syntax object.Year [= year] The Year property has the following parts:
|
| Errors | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Various errors may be raised when accessing a CDDB site. Error constants
are available as CDXErrorConstants and valid values are:
|