Provides an interface for setting the properties of UDF volumes. More...

#include <pb_api.h>

Public Member Functions
virtual const char_t *	abstractFile () const =0
	Gets the content abstract filename that is recorded in the volume descriptors of a UDF image or data track.

virtual UdfAllocDescType::Enum	allocDescType () const =0
	Gets the allocation descriptor type for a UDF volume set previously by setAllocDescType.

virtual const char_t *	copyrightFile () const =0
	Gets the copyright note filename that is recorded in the volume descriptors of a UDF image or data track.

virtual bool_t	protectedContent () const =0
	Gets the value of the protected flag from the UDF Partition Descriptor.

virtual UdfRevision::Enum	revision () const =0
	Gets the version of the UDF file system.

virtual void	setAbstractFile (const char_t *abstractFile)=0
	Sets the file which contains the disc contents abstract.

virtual void	setAllocDescType (UdfAllocDescType::Enum descType)=0
	Sets the allocation descriptor type for a UDF volume.

virtual void	setCopyrightFile (const char_t *copyrightFile)=0
	Sets the file which contains the disc copyright notice.

virtual void	setProtectedContent (bool_t protectedContent)=0
	Sets the protected flag in the UDF Partition Descriptor.

virtual void	setRevision (UdfRevision::Enum revision)=0
	Sets the version of the UDF file system.

virtual void	setTextEncoding (UdfTextEncoding::Enum encoding)=0
	Specifies the text encoding (a.k.a.

virtual void	setVolumeCreationTime (filetime_t filetime)=0
	Sets the volume creation time.

virtual void	setVolumeLabel (const char_t *volumeLabel)=0
	Sets the image volume label.

virtual void	setVolumeSet (const char_t *volumeSet)=0
	Sets the name of the disc set.

virtual UdfTextEncoding::Enum	textEncoding () const =0
	Gets the text encoding setting for a UDF volume.

virtual filetime_t	volumeCreationTime () const =0
	Gets the volume creation time.

virtual const char_t *	volumeLabel () const =0
	Gets the volume label of the data image.

virtual const char_t *	volumeSet () const =0
	Gets the Volume Set name that is recorded in the volume descriptors of an ISO9660 image or data track.

Detailed Description

Provides an interface for setting the properties of UDF volumes.

See also: DataDisc::udfVolumeProps

Member Function Documentation

◆ abstractFile()

virtual const char_t * abstractFile ( ) const

pure virtual

Gets the content abstract filename that is recorded in the volume descriptors of a UDF image or data track.

Returns: A null-terminated string

◆ allocDescType()

virtual UdfAllocDescType::Enum allocDescType ( ) const

pure virtual

Gets the allocation descriptor type for a UDF volume set previously by setAllocDescType.

Returns: A constant from the UdfAllocDescType enumeration. The default is UdfAllocDescType::Long.

◆ copyrightFile()

virtual const char_t * copyrightFile ( ) const

pure virtual

Gets the copyright note filename that is recorded in the volume descriptors of a UDF image or data track.

Returns: A null-terminated string

◆ protectedContent()

virtual bool_t protectedContent ( ) const

pure virtual

Gets the value of the protected flag from the UDF Partition Descriptor.

Returns: TRUE if the UDF partition is protected, FALSE otherwise.

Remarks: The protected content flag is generally ignored but it is required for a conforming DVD-Video image.

◆ revision()

virtual UdfRevision::Enum revision ( ) const

pure virtual

Gets the version of the UDF file system.

Returns: A constant from the UdfRevision enumeration.

◆ setAbstractFile()

virtual void setAbstractFile ( const char_t * abstractFile )

pure virtual

Sets the file which contains the disc contents abstract.

Parameters

abstractFile A filename that follows the 8 + 3 rule The file must be placed in the root directory of the CD. Only capital letters from A to Z, digits from 0 to 9, and the following special characters\: "&!')(=*+,-/\:;><?_. (blank) are allowed.

◆ setAllocDescType()

virtual void setAllocDescType ( UdfAllocDescType::Enum descType )

pure virtual

Sets the allocation descriptor type for a UDF volume.

UDF volumes use long allocation descriptors by default.

Parameters

descType constant from the UdfAllocDescType enumeration.

◆ setCopyrightFile()

virtual void setCopyrightFile ( const char_t * copyrightFile )

pure virtual

Sets the file which contains the disc copyright notice.

Parameters

copyrightFile A filename that follows the 8 + 3 rule. The file must be placed in the root directory of the CD. Only capital letters from A to Z, digits from 0 to 9, and the following special characters\: "&!')(=*+,-/\:;><?_. (blank) are allowed.

◆ setProtectedContent()

virtual void setProtectedContent ( bool_t protectedContent )

pure virtual

Sets the protected flag in the UDF Partition Descriptor.

Must be set to TRUE for DVD-Video discs.

Parameters

protectedContent TRUE if the partition contains protected content, FALSE otherwise.

Remarks: The protected content flag is generally ignored but it is required for a conforming DVD-Video image.

◆ setRevision()

virtual void setRevision ( UdfRevision::Enum revision )

pure virtual

Sets the version of the UDF file system.

Parameters

revision A constant from the UdfRevision enumeration

◆ setTextEncoding()

virtual void setTextEncoding ( UdfTextEncoding::Enum encoding )

pure virtual

Specifies the text encoding (a.k.a.

"Bits per character" or UDF Character Compression) to be used for the directory and file names. UDF volumes use 16-bit Unicode characters by default.

Parameters

encoding A constant from the UdfTextEncoding enumeration.

See also: UdfTextEncoding

◆ setVolumeCreationTime()

virtual void setVolumeCreationTime ( filetime_t filetime )

pure virtual

Sets the volume creation time.

The time must be set as coordinated universal time (UTC), formerly known as Greenwich Mean Time (GMT).

Parameters

filetime On Windows it is specified with a Win32 FILETIME structure. On OS X and Linux it is time_t. The time must be coordinated universal time (UTC), formerly known as Greenwich mean time (GMT).

◆ setVolumeLabel()

virtual void setVolumeLabel ( const char_t * volumeLabel )

pure virtual

Sets the image volume label.

Parameters

volumeLabel The maximum length allowed for the volume label is 32 characters. Only capital letters from A to Z, digits from 0 to 9, and the special characters _ (underscore) are allowed.

◆ setVolumeSet()

virtual void setVolumeSet ( const char_t * volumeSet )

pure virtual

Sets the name of the disc set.

Parameters

volumeSet String with maximum length of 128 characters. Only capital letters from A to Z, digits from 0 to 9, and the special character _ (underscore) are allowed.

Returns: A null-terminated string

◆ textEncoding()

virtual UdfTextEncoding::Enum textEncoding ( ) const

pure virtual

Gets the text encoding setting for a UDF volume.

Returns: A constant from the UdfTextEncoding enumeration.

◆ volumeCreationTime()

virtual filetime_t volumeCreationTime ( ) const

pure virtual

Gets the volume creation time.

The time is returned as coordinated universal time (UTC), formerly known as Greenwich Mean Time (GMT).

Returns: A UTC time value. On Windows it is returned with a Win32 FILETIME structure. On OS X and Linux it is a time_t value.

◆ volumeLabel()

virtual const char_t * volumeLabel ( ) const

pure virtual

Gets the volume label of the data image.

Returns: A null-terminated string

◆ volumeSet()

virtual const char_t * volumeSet ( ) const

pure virtual

Gets the Volume Set name that is recorded in the volume descriptors of an ISO9660 image or data track.

Returns: A null-terminated string

Public Member Functions

Detailed Description

Member Function Documentation

◆ abstractFile()

◆ allocDescType()

◆ copyrightFile()

◆ protectedContent()

◆ revision()

◆ setAbstractFile()

◆ setAllocDescType()

◆ setCopyrightFile()

◆ setProtectedContent()

◆ setRevision()

◆ setTextEncoding()

◆ setVolumeCreationTime()

◆ setVolumeLabel()

◆ setVolumeSet()

◆ textEncoding()

◆ volumeCreationTime()

◆ volumeLabel()

◆ volumeSet()