Phonon::AddonInterface
#include <phonon/AddonInterface>
Public Types | |
enum | AngleCommand { availableAngles , angle , setAngle } |
enum | AudioChannelCommand { availableAudioChannels , currentAudioChannel , setCurrentAudioChannel } |
enum | ChapterCommand { availableChapters , chapter , setChapter } |
enum | Interface { NavigationInterface = 1 , ChapterInterface = 2 , AngleInterface = 3 , TitleInterface = 4 , SubtitleInterface = 5 , AudioChannelInterface = 6 } |
enum | NavigationCommand { availableMenus , setMenu } |
enum | SubtitleCommand { availableSubtitles , currentSubtitle , setCurrentSubtitle , setCurrentSubtitleFile , subtitleAutodetect , setSubtitleAutodetect , subtitleEncoding , setSubtitleEncoding , subtitleFont , setSubtitleFont } |
enum | TitleCommand { availableTitles , title , setTitle , autoplayTitles , setAutoplayTitles } |
Public Member Functions | |
virtual bool | hasInterface (Interface iface) const =0 |
virtual QVariant | interfaceCall (Interface iface, int command, const QList< QVariant > &arguments=QList< QVariant >())=0 |
Detailed Description
Interface for Menu, Chapter, Angle and Title/Track control.
Definition at line 42 of file addoninterface.h.
Member Enumeration Documentation
◆ AngleCommand
Enumerator | |
---|---|
availableAngles |
|
angle |
|
setAngle | Sets the current angle to the first |
Definition at line 70 of file addoninterface.h.
◆ AudioChannelCommand
Enumerator | |
---|---|
availableAudioChannels |
|
currentAudioChannel |
|
setCurrentAudioChannel | Sets the current audio channel to the first |
Definition at line 105 of file addoninterface.h.
◆ ChapterCommand
Enumerator | |
---|---|
availableChapters |
|
chapter |
|
setChapter | Sets the current chapter to the first |
Definition at line 63 of file addoninterface.h.
◆ Interface
Definition at line 47 of file addoninterface.h.
◆ NavigationCommand
Enumerator | |
---|---|
availableMenus |
|
setMenu | Sets the current menu to the first |
Definition at line 56 of file addoninterface.h.
◆ SubtitleCommand
Enumerator | |
---|---|
availableSubtitles |
|
currentSubtitle |
|
setCurrentSubtitle | Sets the current subtitle to the first |
setCurrentSubtitleFile | Sets the current subtitle to the first QUrl.
|
subtitleAutodetect |
|
setSubtitleAutodetect | Sets/Unsets subtitles autodetection.
|
subtitleEncoding |
|
subtitleFont | Sets the current encoding used to render subtitles.
|
setSubtitleFont | Sets the current font used to render subtitles.
|
Definition at line 87 of file addoninterface.h.
◆ TitleCommand
Enumerator | |
---|---|
availableTitles |
|
title |
|
setTitle | Sets the current title to the first |
autoplayTitles |
|
setAutoplayTitles | Sets autoplay to |
Definition at line 77 of file addoninterface.h.
Constructor & Destructor Documentation
◆ ~AddonInterface()
|
inlinevirtual |
Definition at line 45 of file addoninterface.h.
Member Function Documentation
◆ hasInterface()
|
pure virtual |
Queries whether the backend supports a specific interface.
- Parameters
-
iface The interface to query support information about
- Returns
true
when the backend supports the interface,false
otherwise
◆ interfaceCall()
|
pure virtual |
Calls an interface on the backend.
- Parameters
-
iface The interface to call. command The command the interface shall execute. This can be any value of the Command enumeration associated with the command. The backend casts this appropriately. arguments The arguments for the command. This list can contain a QVariant supported format + additions specific to Phonon. The content entirely depends on the command (e.g. a getter may simply use an empty list).
- Returns
QVariant
, as with the arguments this can be anything ranging from an empty QVariant to custom types used within Phonon
Setting the chapter of a Media could be done like this:
Handling such a request in the backend is done as follows:
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 18 2024 12:18:23 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.