PrimoBurner(tm) for C++  4.6
CD, DVD and Blu-ray Software Development Kit
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Pages
CDSession Class Referenceabstract

The CDSession interface defines the layout (the TOC) of a CD session. More...

#include <PrimoBurnerAPI.h>

Inherits Reference.

Public Member Functions

virtual int32_t length () const =0
 The GetLength method returns the length of the session in blocks. More...
 
virtual const char * mcn () const =0
 Gets the Media Catalog Number (MCN) also known as the Uniform Product Code(UPC) of the disc.
 
virtual CDSessionnextSession () const =0
 Returns a pointer to the next CD session object. More...
 
virtual RawTocTrackrawPoint (RawPoint::Enum point) const =0
 Gets raw point data. More...
 
virtual void setMcn (const char *mcn)=0
 Set the Media Catalog Number (MCN) of the disc. More...
 
virtual void setNextSession (CDSession *nextSession)=0
 The setNextSession method is used to specify the CDSession object for the next session. More...
 
virtual bool_t setRawPoint (RawPoint::Enum point, RawTocTrack *rawTocTrack)=0
 Sets raw point data to be used during the recording of the lead-in of a CD. More...
 
virtual void setType (SessionType::Enum sessionType)=0
 The SetType method sets the type of the session. More...
 
virtual CDTrackListtracks () const =0
 Gets the list of tracks in the session.
 
virtual SessionType::Enum type () const =0
 The GetType method retrieves the type of a session. More...
 
- Public Member Functions inherited from Reference
virtual int32_t release () const =0
 Releases the instance. More...
 
virtual int32_t retain () const =0
 Retains the instance. More...
 
virtual int32_t retainCount () const =0
 Returns the current reference count. More...
 

Detailed Description

The CDSession interface defines the layout (the TOC) of a CD session.

See Also
CDTrack

Member Function Documentation

virtual int32_t length ( ) const
pure virtual

The GetLength method returns the length of the session in blocks.

That is the total length of all tracks including the pre-gaps and the post-gaps.

This is a convenience method. The return value is always the post-gap end of the last track + 1.

Returns
number of blocks
virtual CDSession* nextSession ( ) const
pure virtual

Returns a pointer to the next CD session object.

Returns
A pointer to CDSession object. To avoid memory leaks the application must call the CDSession::release() method to delete the returned session object after using it. If no next session is present the method returns NULL.
virtual RawTocTrack* rawPoint ( RawPoint::Enum  point) const
pure virtual

Gets raw point data.

Parameters
point[in] raw point number.
Returns
A pointer to a RawTocTrack object.
See Also
setRawPoint
RawPoint::Enum
virtual void setMcn ( const char *  mcn)
pure virtual

Set the Media Catalog Number (MCN) of the disc.

The MCN must be 13 characters in length. If less than 13 characters are used the MCN is padded with '0' (ASCI 0x30) characters up to length 13. Set the MCN to empty string to prevent the recording of a media catalog number.

Parameters
mcn[in] the MCN that should be recorded to the disc.
virtual void setNextSession ( CDSession nextSession)
pure virtual

The setNextSession method is used to specify the CDSession object for the next session.

This method should be used to burn multi-session CDs in RAW mode only. Next session object is ignored when a write method other than WriteMethod::FullRawDao, WriteMethod::RawDao and WriteMethod::RawDao2352 is used with the Device::startCDSession method.

Parameters
nextSession[in] a pointer to CDSession object of the next session
virtual bool_t setRawPoint ( RawPoint::Enum  point,
RawTocTrack rawTocTrack 
)
pure virtual

Sets raw point data to be used during the recording of the lead-in of a CD.

The points are used only when the session type is ST_RAW and are ignored for all other session types.

Parameters
point[in] point number. See the RawPoin::Enum enumeration.
rawTocTrack[in] pointer to a RawTocTrack object that contains the raw point data. Set this parameter to NULL to indicate that the point should not be used in the session.
Returns
0 The specific raw point is not supported or rawTocTrack is not valid.
1 Success
See Also
RawPoint::Enum
virtual void setType ( SessionType::Enum  sessionType)
pure virtual

The SetType method sets the type of the session.

The possible values are defined in ESessionType enumeration.

Parameters
sessionTypeThe session type.
See Also
SessionType::Enum
CDSession::type
virtual SessionType::Enum type ( ) const
pure virtual

The GetType method retrieves the type of a session.

Returns
The session type. The valid session types are listed in ESessionType enumeration.
See Also
SessionType::Enum
CDSession::setType