Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CDVDStateSerializer Class Reference

Auxiliar class to serialize/deserialize the dvd state (into/from XML) More...

#include <DVDStateSerializer.h>

Public Member Functions

 CDVDStateSerializer ()=default
 Default constructor.
 
 ~CDVDStateSerializer ()=default
 Default destructor.
 
bool XMLToDVDState (DVDState &state, const std::string &xmlstate)
 Provided the state in xml format, fills a DVDState struct representing the DVD state and returns the success status of the operation.
 
bool DVDStateToXML (std::string &xmlstate, const DVDState &state)
 Provided the DVDState struct of the current playing dvd, serializes the struct to XML.
 

Detailed Description

Auxiliar class to serialize/deserialize the dvd state (into/from XML)

Constructor & Destructor Documentation

◆ CDVDStateSerializer()

CDVDStateSerializer::CDVDStateSerializer ( )
default

Default constructor.

◆ ~CDVDStateSerializer()

CDVDStateSerializer::~CDVDStateSerializer ( )
default

Default destructor.

Member Function Documentation

◆ DVDStateToXML()

bool CDVDStateSerializer::DVDStateToXML ( std::string & xmlstate,
const DVDState & state )

Provided the DVDState struct of the current playing dvd, serializes the struct to XML.

Parameters
[in,out]xmlstatea string describing the dvd state (XML)
statethe DVD state struct
Returns
true if it was possible to serialize the struct into XML, false otherwise

◆ XMLToDVDState()

bool CDVDStateSerializer::XMLToDVDState ( DVDState & state,
const std::string & xmlstate )

Provided the state in xml format, fills a DVDState struct representing the DVD state and returns the success status of the operation.

Parameters
[in,out]statethe DVD state struct to be filled
xmlstatea string describing the dvd state (XML)
Returns
true if it was possible to fill the state struct based on the XML content, false otherwise

The documentation for this class was generated from the following files: