Pages

API Documentation

• User Documentation
• Developer Documentation
• API Documentation

Search API documentation

On this page

Solid::OpticalDisc Class

This device interface is available on optical discs. More...

• Header: #include <Solid/OpticalDisc>
• CMake: find_package(KF6 REQUIRED COMPONENTS Solid)
target_link_libraries(mytarget PRIVATE KF6::Solid)
• Inherits: Solid::StorageVolume

List of all members, including inherited members

#Public Types

• enum OpticalDisc::ContentType
• enum OpticalDisc::DiscType

#Properties

• [read-only] appendable : bool
• [read-only] availableContent : ContentTypes
• [read-only] blank : bool
• [read-only] capacity : qulonglong
• [read-only] discType : DiscType
• [read-only] rewritable : bool

#Public Functions

• Solid::OpticalDisc::ContentTypes availableContent() const
• qulonglong capacity() const
• Solid::OpticalDisc::DiscType discType() const
• bool isAppendable() const
• bool isBlank() const
• bool isRewritable() const

#Static Public Members

• Solid::DeviceInterface::Type deviceInterfaceType()

#Detailed Description

An optical disc is a volume that can be inserted in CD-R*,DVD*,Blu-Ray,HD-DVD drives.

Commonly used in conjunction with OpticalDrive.

#Member Type Documentation

#enum OpticalDisc::ContentType

flags OpticalDisc::ContentTypes

This enum type defines the type of content available in an optical disc.

Constant	Value
Solid::OpticalDisc::NoContent	0x00
Solid::OpticalDisc::Audio	0x01	A disc containing audio
Solid::OpticalDisc::Data	0x02	A disc containing data
Solid::OpticalDisc::VideoCd	0x04	A Video Compact Disc (VCD)
Solid::OpticalDisc::SuperVideoCd	0x08	A Super Video Compact Disc (SVCD)
Solid::OpticalDisc::VideoDvd	0x10	A Video Digital Versatile Disc (DVD-Video)
Solid::OpticalDisc::VideoBluRay	0x20

The ContentTypes type is a typedef for QFlags<ContentType>. It stores an OR combination of ContentType values.

#enum OpticalDisc::DiscType

This enum type defines the type of optical disc it can be.

Constant	Value	Description
Solid::OpticalDisc::UnknownDiscType	-1	An undetermined disc type
Solid::OpticalDisc::CdRom	0	A Compact Disc Read-Only Memory (CD-ROM)
Solid::OpticalDisc::CdRecordable	1	A Compact Disc Recordable (CD-R)
Solid::OpticalDisc::CdRewritable	2	A Compact Disc ReWritable (CD-RW)
Solid::OpticalDisc::DvdRom	3	A Digital Versatile Disc Read-Only Memory (DVD-ROM)
Solid::OpticalDisc::DvdRam	4	A Digital Versatile Disc Random Access Memory (DVD-RAM)
Solid::OpticalDisc::DvdRecordable	5	A Digital Versatile Disc Recordable (DVD-R)
Solid::OpticalDisc::DvdRewritable	6	A Digital Versatile Disc ReWritable (DVD-RW)
Solid::OpticalDisc::DvdPlusRecordable	7	A Digital Versatile Disc Recordable (DVD+R)
Solid::OpticalDisc::DvdPlusRewritable	8	A Digital Versatile Disc ReWritable (DVD+RW)
Solid::OpticalDisc::DvdPlusRecordableDuallayer	9	A Digital Versatile Disc Recordable Dual-Layer (DVD+R DL)
Solid::OpticalDisc::DvdPlusRewritableDuallayer	10	A Digital Versatile Disc ReWritable Dual-Layer (DVD+RW DL)
Solid::OpticalDisc::BluRayRom	11	A Blu-ray Disc (BD)
Solid::OpticalDisc::BluRayRecordable	12	A Blu-ray Disc Recordable (BD-R)
Solid::OpticalDisc::BluRayRewritable	13	A Blu-ray Disc (BD-RE)
Solid::OpticalDisc::HdDvdRom	14	: A High Density Digital Versatile Disc (HD DVD)
Solid::OpticalDisc::HdDvdRecordable	15	A High Density Digital Versatile Disc Recordable (HD DVD-R)
Solid::OpticalDisc::HdDvdRewritable	16	A High Density Digital Versatile Disc ReWritable (HD DVD-RW)

#Property Documentation

#[read-only] appendable : bool

Access functions:

• bool isAppendable() const

#[read-only] availableContent : ContentTypes

Access functions:

• Solid::OpticalDisc::ContentTypes availableContent() const

#[read-only] blank : bool

Access functions:

• bool isBlank() const

#[read-only] capacity : qulonglong

Access functions:

• qulonglong capacity() const

#[read-only] discType : DiscType

Access functions:

• Solid::OpticalDisc::DiscType discType() const

#[read-only] rewritable : bool

Access functions:

• bool isRewritable() const

#Member Function Documentation

#Solid::OpticalDisc::ContentTypes OpticalDisc::availableContent() const

Returns the flag set indicating the content types this disc contains (audio, video, data...).

Note: Getter function for property availableContent.

See also Solid::OpticalDisc::ContentType

#qulonglong OpticalDisc::capacity() const

Returns the disc capacity in bytes (the maximum size a volume could have on this disc).

Note: Getter function for property capacity.

#[static] Solid::DeviceInterface::Type OpticalDisc::deviceInterfaceType()

Returns the Solid::DeviceInterface::Type of the OpticalDisc device interface.

See also Solid::DeviceInterface::Type

#Solid::OpticalDisc::DiscType OpticalDisc::discType() const

Returns the disc type (cdr, cdrw...).

Note: Getter function for property discType.

#bool OpticalDisc::isAppendable() const

Returns whether it's possible to append additional data to the disc.

Note: Getter function for property appendable.

#bool OpticalDisc::isBlank() const

Returns whether the disc is blank.

Note: Getter function for property blank.

#bool OpticalDisc::isRewritable() const

Indicates if the disc is rewritable (you can write on it several times).

Note: Getter function for property rewritable.