KODI::PLAYLIST::CPlayList Class Reference

#include <PlayList.h>

Inheritance diagram for KODI::PLAYLIST::CPlayList:

Public Member Functions
	CPlayList (Id id=Id::TYPE_NONE)
virtual	~CPlayList (void)=default
virtual bool	Load (const std::string &strFileName)
virtual bool	LoadData (std::istream &stream)
virtual bool	LoadData (const std::string &strData)
virtual void	Save (const std::string &strFileName) const
void	Add (const CPlayList &playlist)
void	Add (const std::shared_ptr< CFileItem > &pItem)
void	Add (const CFileItemList &items)
void	Insert (const CPlayList &playlist, int iPosition=-1)
void	Insert (const CFileItemList &items, int iPosition=-1)
void	Insert (const std::shared_ptr< CFileItem > &item, int iPosition=-1)
int	FindOrder (int iOrder) const
const std::string &	GetName () const
void	Remove (const std::string &strFileName)
void	Remove (int position)
bool	Swap (int position1, int position2)
bool	Expand (int position)
void	Clear ()
int	size () const
int	RemoveDVDItems ()
const std::shared_ptr< CFileItem >	operator[] (int iItem) const
std::shared_ptr< CFileItem >	operator[] (int iItem)
void	Shuffle (int iPosition=0)
void	UnShuffle ()
bool	IsShuffled () const
void	SetPlayed (bool bPlayed)
bool	WasPlayed () const
void	SetUnPlayable (int iItem)
int	GetPlayable () const
void	UpdateItem (const CFileItem *item)
const std::string &	ResolveURL (const std::shared_ptr< CFileItem > &item) const

Protected Types
typedef std::vector< std::shared_ptr< CFileItem > >::iterator	ivecItems

Protected Attributes
Id	m_id
std::string	m_strPlayListName
std::string	m_strBasePath
int	m_iPlayableItems
bool	m_bShuffled
bool	m_bWasPlayed
std::vector< std::shared_ptr< CFileItem > >	m_vecItems

Member Typedef Documentation

ivecItems

typedef std::vector<std::shared_ptr<CFileItem>>::iterator KODI::PLAYLIST::CPlayList::ivecItems

protected

Constructor & Destructor Documentation

CPlayList()

KODI::PLAYLIST::CPlayList::CPlayList ( Id id = Id::TYPE_NONE )

explicit

~CPlayList()

virtual KODI::PLAYLIST::CPlayList::~CPlayList ( void )

virtualdefault

Member Function Documentation

Add() [1/3]

void KODI::PLAYLIST::CPlayList::Add

(

const CFileItemList &

items

)

Add() [2/3]

void KODI::PLAYLIST::CPlayList::Add

(

const CPlayList &

playlist

)

Add() [3/3]

void KODI::PLAYLIST::CPlayList::Add

(

const std::shared_ptr< CFileItem > &

pItem

)

Clear()

void KODI::PLAYLIST::CPlayList::Clear

(

)

Expand()

bool KODI::PLAYLIST::CPlayList::Expand

(

int

position

)

FindOrder()

int KODI::PLAYLIST::CPlayList::FindOrder

(

int

iOrder

)

const

GetName()

const std::string & KODI::PLAYLIST::CPlayList::GetName

(

)

const

GetPlayable()

int KODI::PLAYLIST::CPlayList::GetPlayable ( ) const

inline

Insert() [1/3]

void KODI::PLAYLIST::CPlayList::Insert	(	const CFileItemList &	items,
		int	iPosition = -1 )

Insert() [2/3]

void KODI::PLAYLIST::CPlayList::Insert	(	const CPlayList &	playlist,
		int	iPosition = -1 )

Insert() [3/3]

void KODI::PLAYLIST::CPlayList::Insert	(	const std::shared_ptr< CFileItem > &	item,
		int	iPosition = -1 )

IsShuffled()

bool KODI::PLAYLIST::CPlayList::IsShuffled ( ) const

inline

Load()

bool KODI::PLAYLIST::CPlayList::Load ( const std::string & strFileName )

virtual

Reimplemented in KODI::PLAYLIST::CPlayListM3U, KODI::PLAYLIST::CPlayListPLS, KODI::PLAYLIST::CPlayListURL, KODI::PLAYLIST::CPlayListXML, and KODI::PLAYLIST::CPlayListXSPF.

LoadData() [1/2]

bool KODI::PLAYLIST::CPlayList::LoadData ( const std::string & strData )

virtual

LoadData() [2/2]

bool KODI::PLAYLIST::CPlayList::LoadData ( std::istream & stream )

virtual

Reimplemented in KODI::PLAYLIST::CPlayListASX, KODI::PLAYLIST::CPlayListB4S, KODI::PLAYLIST::CPlayListRAM, and KODI::PLAYLIST::CPlayListWPL.

operator[]() [1/2]

std::shared_ptr< CFileItem > KODI::PLAYLIST::CPlayList::operator[]

(

int

iItem

)

operator[]() [2/2]

const std::shared_ptr< CFileItem > KODI::PLAYLIST::CPlayList::operator[]

(

int

iItem

)

const

Remove() [1/2]

void KODI::PLAYLIST::CPlayList::Remove

(

const std::string &

strFileName

)

Remove() [2/2]

void KODI::PLAYLIST::CPlayList::Remove

(

int

position

)

RemoveDVDItems()

int KODI::PLAYLIST::CPlayList::RemoveDVDItems

(

)

ResolveURL()

const std::string & KODI::PLAYLIST::CPlayList::ResolveURL

(

const std::shared_ptr< CFileItem > &

item

)

const

Save()

virtual void KODI::PLAYLIST::CPlayList::Save ( const std::string & strFileName ) const

inlinevirtual

Reimplemented in KODI::PLAYLIST::CPlayListB4S, KODI::PLAYLIST::CPlayListM3U, KODI::PLAYLIST::CPlayListPLS, KODI::PLAYLIST::CPlayListWPL, and KODI::PLAYLIST::CPlayListXML.

SetPlayed()

void KODI::PLAYLIST::CPlayList::SetPlayed ( bool bPlayed )

inline

SetUnPlayable()

void KODI::PLAYLIST::CPlayList::SetUnPlayable

(

int

iItem

)

Shuffle()

void KODI::PLAYLIST::CPlayList::Shuffle

(

int

iPosition = 0

)

size()

int KODI::PLAYLIST::CPlayList::size

(

)

const

Swap()

bool KODI::PLAYLIST::CPlayList::Swap	(	int	position1,
		int	position2 )

UnShuffle()

void KODI::PLAYLIST::CPlayList::UnShuffle

(

)

UpdateItem()

void KODI::PLAYLIST::CPlayList::UpdateItem

(

const CFileItem *

item

)

WasPlayed()

bool KODI::PLAYLIST::CPlayList::WasPlayed ( ) const

inline

Member Data Documentation

m_bShuffled

bool KODI::PLAYLIST::CPlayList::m_bShuffled

protected

m_bWasPlayed

bool KODI::PLAYLIST::CPlayList::m_bWasPlayed

protected

m_id

Id KODI::PLAYLIST::CPlayList::m_id

protected

m_iPlayableItems

int KODI::PLAYLIST::CPlayList::m_iPlayableItems

protected

m_strBasePath

std::string KODI::PLAYLIST::CPlayList::m_strBasePath

protected

m_strPlayListName

std::string KODI::PLAYLIST::CPlayList::m_strPlayListName

protected

m_vecItems

std::vector<std::shared_ptr<CFileItem> > KODI::PLAYLIST::CPlayList::m_vecItems

protected

---

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

• playlists/PlayList.h
• playlists/PlayList.cpp