Collaboration diagram for Myth::WSAPI:

[legend]

Data Structures
class	Query

Public Member Functions
	WSAPI (const std::string &server, unsigned port, const std::string &securityPin)
WSAPI &	WithAuthorization (const std::string &user, const std::string &password)
WSAPI &	WithSSL (bool yesno)
unsigned	CheckService ()
WSServiceVersion_t	CheckService (WSServiceId_t id)
void	InvalidateService ()
std::string	GetServerHostName ()
std::string	GetBaseURL ()
VersionPtr	GetVersion ()
std::string	ResolveHostName (const std::string &hostname)
bool	LoginUser ()
	GET Myth/LoginUser From v36.
SettingPtr	GetHostSetting (const std::string &key, const std::string &hostname)
	GET Myth/GetSetting.
SettingPtr	GetSetting (const std::string &key, bool myhost)
	GET Myth/GetSetting.
SettingMapPtr	GetHostSettings (const std::string &hostname)
	GET Myth/GetSetting.
SettingMapPtr	GetSettings (bool myhost)
	GET Myth/GetSetting.
bool	PutSetting (const std::string &key, const std::string &value, bool myhost)
	POST Myth/PutSetting.
CaptureCardListPtr	GetCaptureCardList ()
	GET Capture/GetCaptureCardList.
VideoSourceListPtr	GetVideoSourceList ()
	GET Channel/GetVideoSourceList.
ChannelListPtr	GetChannelList (uint32_t sourceid, bool onlyVisible=true)
	GET Channel/GetChannelInfoList.
ChannelPtr	GetChannel (uint32_t chanid)
	GET Channel/GetChannelInfo.
ProgramMapPtr	GetProgramGuide (uint32_t chanid, time_t starttime, time_t endtime)
	GET Guide/GetProgramGuide for the given channel.
std::map< uint32_t, ProgramMapPtr >	GetProgramGuide (time_t starttime, time_t endtime)
	GET Guide/GetProgramGuide.
ProgramListPtr	GetRecordedList (unsigned n=0, bool descending=false)
	GET Dvr/GetRecordedList.
ProgramPtr	GetRecorded (uint32_t chanid, time_t recstartts)
	GET Dvr/GetRecorded.
ProgramPtr	GetRecorded (uint32_t recordedid)
	GET Dvr/GetRecorded.
bool	UpdateRecordedWatchedStatus (uint32_t chanid, time_t recstartts, bool watched)
	POST Dvr/UpdateRecordedWatchedStatus.
bool	UpdateRecordedWatchedStatus (uint32_t recordedid, bool watched)
	POST Dvr/UpdateRecordedWatchedStatus.
bool	DeleteRecording (uint32_t chanid, time_t recstartts, bool forceDelete=false, bool allowRerecord=false)
	POST Dvr/DeleteRecording.
bool	DeleteRecording (uint32_t recordedid, bool forceDelete=false, bool allowRerecord=false)
	POST Dvr/DeleteRecording.
bool	UnDeleteRecording (uint32_t chanid, time_t recstartts)
	POST Dvr/UnDeleteRecording.
bool	UnDeleteRecording (uint32_t recordedid)
	POST Dvr/UnDeleteRecording.
RecordScheduleListPtr	GetRecordScheduleList ()
	GET Dvr/GetRecordScheduleList.
RecordSchedulePtr	GetRecordSchedule (uint32_t recordid)
	GET Dvr/GetRecordSchedule.
bool	AddRecordSchedule (RecordSchedule &record)
	POST Dvr/AddRecordSchedule.
bool	UpdateRecordSchedule (RecordSchedule &record)
	POST Dvr/UpdateRecordSchedule.
bool	DisableRecordSchedule (uint32_t recordid)
	POST Dvr/DisableRecordSchedule.
bool	EnableRecordSchedule (uint32_t recordid)
	POST Dvr/EnableRecordSchedule.
bool	RemoveRecordSchedule (uint32_t recordid)
	POST Dvr/RemoveRecordSchedule.
ProgramListPtr	GetUpcomingList ()
	GET Dvr/GetUpcomingList.
ProgramListPtr	GetConflictList ()
	GET Dvr/GetConflictList.
ProgramListPtr	GetExpiringList ()
	GET Dvr/GetExpiringList.
StringListPtr	GetRecGroupList ()
	GET Dvr/GetRecGroupList.
WSStreamPtr	GetFile (const std::string &filename, const std::string &sgname)
	GET Content/GetFile.
WSStreamPtr	GetChannelIcon (uint32_t chanid, unsigned width=0, unsigned height=0)
	GET Guide/GetChannelIcon.
std::string	GetChannelIconUrl (uint32_t chanid, unsigned width=0, unsigned height=0)
	Returns URL for channel icon.
WSStreamPtr	GetPreviewImage (uint32_t chanid, time_t recstartts, unsigned width=0, unsigned height=0)
	GET Content/GetPreviewImage.
std::string	GetPreviewImageUrl (uint32_t chanid, time_t recstartts, unsigned width=0, unsigned height=0)
	Returns URL for preview image.
WSStreamPtr	GetRecordingArtwork (const std::string &type, const std::string &inetref, uint16_t season, unsigned width=0, unsigned height=0)
	GET Content/GetRecordingArtwork.
std::string	GetRecordingArtworkUrl (const std::string &type, const std::string &inetref, uint16_t season, unsigned width=0, unsigned height=0)
	Returns URL for recording artwork.
ArtworkListPtr	GetRecordingArtworkList (uint32_t chanid, time_t recstartts)
	GET Content/GetRecordingArtworkList.
MarkListPtr	GetRecordedCommBreak (uint32_t recordedid, int unit)
	GET Dvr/GetRecordedCommBreak.
MarkListPtr	GetRecordedCutList (uint32_t recordedid, int unit)
	GET Dvr/GetRecordedCutList.
bool	SetSavedBookmark (uint32_t recordedid, int unit, int64_t value)
	POST Dvr/SetSavedBookmark.
int64_t	GetSavedBookmark (uint32_t recordedid, int unit)
	GET Dvr/GetSavedBookmark.

Private Member Functions
	WSAPI (const WSAPI &)
WSAPI &	operator= (const WSAPI &)
bool	InitWSAPI ()
bool	GetServiceVersion (WSServiceId_t id, WSServiceVersion_t &version)
bool	CheckServerHostName2_0 ()
bool	CheckVersion2_0 ()
SettingPtr	GetSetting2_0 (const std::string &key, const std::string &hostname)
SettingPtr	GetSetting5_0 (const std::string &key, const std::string &hostname)
SettingMapPtr	GetSettings2_0 (const std::string &hostname)
SettingMapPtr	GetSettings5_0 (const std::string &hostname)
bool	PutSetting2_0 (const std::string &key, const std::string &value, bool myhost)
CaptureCardListPtr	GetCaptureCardList1_4 ()
VideoSourceListPtr	GetVideoSourceList1_2 ()
ChannelListPtr	GetChannelList1_2 (uint32_t sourceid, bool onlyVisible)
ChannelListPtr	GetChannelList1_5 (uint32_t sourceid, bool onlyVisible)
ChannelPtr	GetChannel1_2 (uint32_t chanid)
std::map< uint32_t, ProgramMapPtr >	GetProgramGuide1_0 (time_t starttime, time_t endtime)
ProgramMapPtr	GetProgramGuide1_0 (uint32_t chanid, time_t starttime, time_t endtime)
std::map< uint32_t, ProgramMapPtr >	GetProgramGuide2_2 (time_t starttime, time_t endtime)
ProgramMapPtr	GetProgramList2_2 (uint32_t chanid, time_t starttime, time_t endtime)
ProgramListPtr	GetRecordedList1_5 (unsigned n, bool descending)
ProgramPtr	GetRecorded1_5 (uint32_t chanid, time_t recstartts)
ProgramPtr	GetRecorded6_0 (uint32_t recordedid)
bool	DeleteRecording2_1 (uint32_t chanid, time_t recstartts, bool forceDelete, bool allowRerecord)
bool	DeleteRecording6_0 (uint32_t recordedid, bool forceDelete, bool allowRerecord)
bool	UnDeleteRecording2_1 (uint32_t chanid, time_t recstartts)
bool	UnDeleteRecording6_0 (uint32_t recordedid)
bool	UpdateRecordedWatchedStatus4_5 (uint32_t chanid, time_t recstartts, bool watched)
bool	UpdateRecordedWatchedStatus6_0 (uint32_t recordedid, bool watched)
MarkListPtr	GetRecordedCommBreak6_1 (uint32_t recordedid, int unit)
MarkListPtr	GetRecordedCutList6_1 (uint32_t recordedid, int unit)
bool	SetSavedBookmark6_2 (uint32_t recordedid, int unit, int64_t value)
int64_t	GetSavedBookmark6_2 (uint32_t recordedid, int unit)
RecordScheduleListPtr	GetRecordScheduleList1_5 ()
RecordSchedulePtr	GetRecordSchedule1_5 (uint32_t recordid)
bool	AddRecordSchedule1_5 (RecordSchedule &record)
bool	AddRecordSchedule1_7 (RecordSchedule &record)
bool	UpdateRecordSchedule1_7 (RecordSchedule &record)
bool	DisableRecordSchedule1_5 (uint32_t recordid)
bool	EnableRecordSchedule1_5 (uint32_t recordid)
bool	RemoveRecordSchedule1_5 (uint32_t recordid)
ProgramListPtr	GetUpcomingList1_5 ()
ProgramListPtr	GetUpcomingList2_2 ()
ProgramListPtr	GetConflictList1_5 ()
ProgramListPtr	GetExpiringList1_5 ()
StringListPtr	GetRecGroupList1_5 ()
WSStreamPtr	GetFile1_32 (const std::string &filename, const std::string &sgname)
WSStreamPtr	GetChannelIcon1_32 (uint32_t chanid, unsigned width, unsigned height)
std::string	GetChannelIconUrl1_32 (uint32_t chanid, unsigned width, unsigned height)
WSStreamPtr	GetPreviewImage1_32 (uint32_t chanid, time_t recstartts, unsigned width, unsigned height)
std::string	GetPreviewImageUrl1_32 (uint32_t chanid, time_t recstartts, unsigned width, unsigned height)
WSStreamPtr	GetRecordingArtwork1_32 (const std::string &type, const std::string &inetref, uint16_t season, unsigned width, unsigned height)
std::string	GetRecordingArtworkUrl1_32 (const std::string &type, const std::string &inetref, uint16_t season, unsigned width, unsigned height)
ArtworkListPtr	GetRecordingArtworkList1_32 (uint32_t chanid, time_t recstartts)

Private Attributes
OS::Mutex *	m_mutex
std::string	m_server
unsigned	m_port
bool	m_ssl
std::string	m_securityPin
std::string	m_authUser
std::string	m_authPassword
std::string	m_authToken
bool	m_checked
Version	m_version
std::string	m_serverHostName
WSServiceVersion_t	m_serviceVersion [WS_INVALID+1]
std::map< std::string, std::string >	m_namedCache

Detailed Description

Definition at line 60 of file mythwsapi.h.

Constructor & Destructor Documentation

◆ WSAPI()

WSAPI::WSAPI	(	const std::string &	server,
		unsigned	port,
		const std::string &	securityPin )

Definition at line 63 of file mythwsapi.cpp.

◆ ~WSAPI()

WSAPI::~WSAPI ( )

Definition at line 76 of file mythwsapi.cpp.

Member Function Documentation

◆ AddRecordSchedule()

bool Myth::WSAPI::AddRecordSchedule ( RecordSchedule & record )

inline

POST Dvr/AddRecordSchedule.

Definition at line 301 of file mythwsapi.h.

◆ AddRecordSchedule1_5()

bool WSAPI::AddRecordSchedule1_5 ( RecordSchedule & record )

private

Definition at line 2007 of file mythwsapi.cpp.

◆ AddRecordSchedule1_7()

bool WSAPI::AddRecordSchedule1_7 ( RecordSchedule & record )

private

Definition at line 2096 of file mythwsapi.cpp.

◆ CheckServerHostName2_0()

bool WSAPI::CheckServerHostName2_0 ( )

private

Definition at line 223 of file mythwsapi.cpp.

◆ CheckService() [1/2]

unsigned WSAPI::CheckService ( )

Definition at line 291 of file mythwsapi.cpp.

◆ CheckService() [2/2]

WSServiceVersion_t WSAPI::CheckService ( WSServiceId_t id )

Definition at line 299 of file mythwsapi.cpp.

◆ CheckVersion2_0()

bool WSAPI::CheckVersion2_0 ( )

private

Definition at line 253 of file mythwsapi.cpp.

◆ DeleteRecording() [1/2]

bool Myth::WSAPI::DeleteRecording	(	uint32_t	chanid,
		time_t	recstartts,
		bool	forceDelete = false,
		bool	allowRerecord = false )

inline

POST Dvr/DeleteRecording.

Definition at line 241 of file mythwsapi.h.

◆ DeleteRecording() [2/2]

bool Myth::WSAPI::DeleteRecording	(	uint32_t	recordedid,
		bool	forceDelete = false,
		bool	allowRerecord = false )

inline

POST Dvr/DeleteRecording.

Definition at line 251 of file mythwsapi.h.

◆ DeleteRecording2_1()

bool WSAPI::DeleteRecording2_1	(	uint32_t	chanid,
		time_t	recstartts,
		bool	forceDelete,
		bool	allowRerecord )

private

Definition at line 1491 of file mythwsapi.cpp.

◆ DeleteRecording6_0()

bool WSAPI::DeleteRecording6_0	(	uint32_t	recordedid,
		bool	forceDelete,
		bool	allowRerecord )

private

Definition at line 1526 of file mythwsapi.cpp.

◆ DisableRecordSchedule()

bool Myth::WSAPI::DisableRecordSchedule ( uint32_t recordid )

inline

POST Dvr/DisableRecordSchedule.

Definition at line 322 of file mythwsapi.h.

◆ DisableRecordSchedule1_5()

bool WSAPI::DisableRecordSchedule1_5 ( uint32_t recordid )

private

Definition at line 2280 of file mythwsapi.cpp.

◆ EnableRecordSchedule()

bool Myth::WSAPI::EnableRecordSchedule ( uint32_t recordid )

inline

POST Dvr/EnableRecordSchedule.

Definition at line 332 of file mythwsapi.h.

◆ EnableRecordSchedule1_5()

bool WSAPI::EnableRecordSchedule1_5 ( uint32_t recordid )

private

Definition at line 2313 of file mythwsapi.cpp.

◆ GetBaseURL()

std::string WSAPI::GetBaseURL ( )

Definition at line 318 of file mythwsapi.cpp.

◆ GetCaptureCardList()

CaptureCardListPtr Myth::WSAPI::GetCaptureCardList ( )

inline

GET Capture/GetCaptureCardList.

Definition at line 128 of file mythwsapi.h.

◆ GetCaptureCardList1_4()

CaptureCardListPtr WSAPI::GetCaptureCardList1_4 ( )

private

Definition at line 630 of file mythwsapi.cpp.

◆ GetChannel()

ChannelPtr Myth::WSAPI::GetChannel ( uint32_t chanid )

inline

GET Channel/GetChannelInfo.

Definition at line 159 of file mythwsapi.h.

◆ GetChannel1_2()

ChannelPtr WSAPI::GetChannel1_2 ( uint32_t chanid )

private

Definition at line 877 of file mythwsapi.cpp.

◆ GetChannelIcon()

WSStreamPtr Myth::WSAPI::GetChannelIcon	(	uint32_t	chanid,
		unsigned	width = 0,
		unsigned	height = 0 )

inline

GET Guide/GetChannelIcon.

Definition at line 403 of file mythwsapi.h.

◆ GetChannelIcon1_32()

WSStreamPtr WSAPI::GetChannelIcon1_32	(	uint32_t	chanid,
		unsigned	width,
		unsigned	height )

private

Definition at line 2698 of file mythwsapi.cpp.

◆ GetChannelIconUrl()

std::string Myth::WSAPI::GetChannelIconUrl	(	uint32_t	chanid,
		unsigned	width = 0,
		unsigned	height = 0 )

inline

Returns URL for channel icon.

Definition at line 413 of file mythwsapi.h.

◆ GetChannelIconUrl1_32()

std::string WSAPI::GetChannelIconUrl1_32	(	uint32_t	chanid,
		unsigned	width,
		unsigned	height )

private

Definition at line 2729 of file mythwsapi.cpp.

◆ GetChannelList()

ChannelListPtr Myth::WSAPI::GetChannelList	(	uint32_t	sourceid,
		bool	onlyVisible = true )

inline

GET Channel/GetChannelInfoList.

Definition at line 148 of file mythwsapi.h.

◆ GetChannelList1_2()

ChannelListPtr WSAPI::GetChannelList1_2	(	uint32_t	sourceid,
		bool	onlyVisible )

private

Definition at line 723 of file mythwsapi.cpp.

◆ GetChannelList1_5()

ChannelListPtr WSAPI::GetChannelList1_5	(	uint32_t	sourceid,
		bool	onlyVisible )

private

Definition at line 798 of file mythwsapi.cpp.

◆ GetConflictList()

ProgramListPtr Myth::WSAPI::GetConflictList ( )

inline

GET Dvr/GetConflictList.

Definition at line 363 of file mythwsapi.h.

◆ GetConflictList1_5()

ProgramListPtr WSAPI::GetConflictList1_5 ( )

private

Definition at line 2474 of file mythwsapi.cpp.

◆ GetExpiringList()

ProgramListPtr Myth::WSAPI::GetExpiringList ( )

inline

GET Dvr/GetExpiringList.

Definition at line 373 of file mythwsapi.h.

◆ GetExpiringList1_5()

ProgramListPtr WSAPI::GetExpiringList1_5 ( )

private

Definition at line 2554 of file mythwsapi.cpp.

◆ GetFile()

WSStreamPtr Myth::WSAPI::GetFile	(	const std::string &	filename,
		const std::string &	sgname )

inline

GET Content/GetFile.

Definition at line 393 of file mythwsapi.h.

◆ GetFile1_32()

WSStreamPtr WSAPI::GetFile1_32	(	const std::string &	filename,
		const std::string &	sgname )

private

Definition at line 2678 of file mythwsapi.cpp.

◆ GetHostSetting()

SettingPtr Myth::WSAPI::GetHostSetting	(	const std::string &	key,
		const std::string &	hostname )

inline

GET Myth/GetSetting.

Definition at line 86 of file mythwsapi.h.

Referenced by GetSetting().

Here is the caller graph for this function:

◆ GetHostSettings()

SettingMapPtr Myth::WSAPI::GetHostSettings ( const std::string & hostname )

inline

GET Myth/GetSetting.

Definition at line 102 of file mythwsapi.h.

Referenced by GetSettings().

Here is the caller graph for this function:

◆ GetPreviewImage()

WSStreamPtr Myth::WSAPI::GetPreviewImage	(	uint32_t	chanid,
		time_t	recstartts,
		unsigned	width = 0,
		unsigned	height = 0 )

inline

GET Content/GetPreviewImage.

Definition at line 423 of file mythwsapi.h.

◆ GetPreviewImage1_32()

WSStreamPtr WSAPI::GetPreviewImage1_32	(	uint32_t	chanid,
		time_t	recstartts,
		unsigned	width,
		unsigned	height )

private

Definition at line 2751 of file mythwsapi.cpp.

◆ GetPreviewImageUrl()

std::string Myth::WSAPI::GetPreviewImageUrl	(	uint32_t	chanid,
		time_t	recstartts,
		unsigned	width = 0,
		unsigned	height = 0 )

inline

Returns URL for preview image.

Definition at line 433 of file mythwsapi.h.

◆ GetPreviewImageUrl1_32()

std::string WSAPI::GetPreviewImageUrl1_32	(	uint32_t	chanid,
		time_t	recstartts,
		unsigned	width,
		unsigned	height )

private

Definition at line 2784 of file mythwsapi.cpp.

◆ GetProgramGuide() [1/2]

std::map< uint32_t, ProgramMapPtr > Myth::WSAPI::GetProgramGuide	(	time_t	starttime,
		time_t	endtime )

inline

GET Guide/GetProgramGuide.

Definition at line 180 of file mythwsapi.h.

◆ GetProgramGuide() [2/2]

ProgramMapPtr Myth::WSAPI::GetProgramGuide	(	uint32_t	chanid,
		time_t	starttime,
		time_t	endtime )

inline

GET Guide/GetProgramGuide for the given channel.

Definition at line 169 of file mythwsapi.h.

◆ GetProgramGuide1_0() [1/2]

std::map< uint32_t, ProgramMapPtr > WSAPI::GetProgramGuide1_0	(	time_t	starttime,
		time_t	endtime )

private

Definition at line 922 of file mythwsapi.cpp.

◆ GetProgramGuide1_0() [2/2]

ProgramMapPtr WSAPI::GetProgramGuide1_0	(	uint32_t	chanid,
		time_t	starttime,
		time_t	endtime )

private

Definition at line 1002 of file mythwsapi.cpp.

◆ GetProgramGuide2_2()

std::map< uint32_t, ProgramMapPtr > WSAPI::GetProgramGuide2_2	(	time_t	starttime,
		time_t	endtime )

private

Definition at line 1084 of file mythwsapi.cpp.

◆ GetProgramList2_2()

ProgramMapPtr WSAPI::GetProgramList2_2	(	uint32_t	chanid,
		time_t	starttime,
		time_t	endtime )

private

Definition at line 1180 of file mythwsapi.cpp.

◆ GetRecGroupList()

StringListPtr Myth::WSAPI::GetRecGroupList ( )

inline

GET Dvr/GetRecGroupList.

Definition at line 383 of file mythwsapi.h.

◆ GetRecGroupList1_5()

StringListPtr WSAPI::GetRecGroupList1_5 ( )

private

Definition at line 2634 of file mythwsapi.cpp.

◆ GetRecorded() [1/2]

ProgramPtr Myth::WSAPI::GetRecorded	(	uint32_t	chanid,
		time_t	recstartts )

inline

GET Dvr/GetRecorded.

Definition at line 201 of file mythwsapi.h.

◆ GetRecorded() [2/2]

ProgramPtr Myth::WSAPI::GetRecorded ( uint32_t recordedid )

inline

GET Dvr/GetRecorded.

Definition at line 211 of file mythwsapi.h.

◆ GetRecorded1_5()

ProgramPtr WSAPI::GetRecorded1_5	(	uint32_t	chanid,
		time_t	recstartts )

private

Definition at line 1367 of file mythwsapi.cpp.

◆ GetRecorded6_0()

ProgramPtr WSAPI::GetRecorded6_0 ( uint32_t recordedid )

private

Definition at line 1430 of file mythwsapi.cpp.

◆ GetRecordedCommBreak()

MarkListPtr Myth::WSAPI::GetRecordedCommBreak	(	uint32_t	recordedid,
		int	unit )

inline

GET Dvr/GetRecordedCommBreak.

Parameters

recordedid
unit	0 = Frame count, 1 = Position, 2 = Duration ms

Returns: MarkListPtr

Definition at line 476 of file mythwsapi.h.

◆ GetRecordedCommBreak6_1()

MarkListPtr WSAPI::GetRecordedCommBreak6_1	(	uint32_t	recordedid,
		int	unit )

private

Definition at line 1689 of file mythwsapi.cpp.

◆ GetRecordedCutList()

MarkListPtr Myth::WSAPI::GetRecordedCutList	(	uint32_t	recordedid,
		int	unit )

inline

GET Dvr/GetRecordedCutList.

Parameters

recordedid
unit	0 = Frame count, 1 = Position, 2 = Duration ms

Returns: MarkListPtr

Definition at line 489 of file mythwsapi.h.

◆ GetRecordedCutList6_1()

MarkListPtr WSAPI::GetRecordedCutList6_1	(	uint32_t	recordedid,
		int	unit )

private

Definition at line 1740 of file mythwsapi.cpp.

◆ GetRecordedList()

ProgramListPtr Myth::WSAPI::GetRecordedList	(	unsigned	n = 0,
		bool	descending = false )

inline

GET Dvr/GetRecordedList.

Definition at line 191 of file mythwsapi.h.

◆ GetRecordedList1_5()

ProgramListPtr WSAPI::GetRecordedList1_5	(	unsigned	n,
		bool	descending )

private

Definition at line 1267 of file mythwsapi.cpp.

◆ GetRecordingArtwork()

WSStreamPtr Myth::WSAPI::GetRecordingArtwork	(	const std::string &	type,
		const std::string &	inetref,
		uint16_t	season,
		unsigned	width = 0,
		unsigned	height = 0 )

inline

GET Content/GetRecordingArtwork.

Definition at line 443 of file mythwsapi.h.

◆ GetRecordingArtwork1_32()

WSStreamPtr WSAPI::GetRecordingArtwork1_32	(	const std::string &	type,
		const std::string &	inetref,
		uint16_t	season,
		unsigned	width,
		unsigned	height )

private

Definition at line 2808 of file mythwsapi.cpp.

◆ GetRecordingArtworkList()

ArtworkListPtr Myth::WSAPI::GetRecordingArtworkList	(	uint32_t	chanid,
		time_t	recstartts )

inline

GET Content/GetRecordingArtworkList.

Definition at line 463 of file mythwsapi.h.

◆ GetRecordingArtworkList1_32()

ArtworkListPtr WSAPI::GetRecordingArtworkList1_32	(	uint32_t	chanid,
		time_t	recstartts )

private

Definition at line 2865 of file mythwsapi.cpp.

◆ GetRecordingArtworkUrl()

std::string Myth::WSAPI::GetRecordingArtworkUrl	(	const std::string &	type,
		const std::string &	inetref,
		uint16_t	season,
		unsigned	width = 0,
		unsigned	height = 0 )

inline

Returns URL for recording artwork.

Definition at line 453 of file mythwsapi.h.

◆ GetRecordingArtworkUrl1_32()

std::string WSAPI::GetRecordingArtworkUrl1_32	(	const std::string &	type,
		const std::string &	inetref,
		uint16_t	season,
		unsigned	width,
		unsigned	height )

private

Definition at line 2841 of file mythwsapi.cpp.

◆ GetRecordSchedule()

RecordSchedulePtr Myth::WSAPI::GetRecordSchedule ( uint32_t recordid )

inline

GET Dvr/GetRecordSchedule.

Definition at line 291 of file mythwsapi.h.

◆ GetRecordSchedule1_5()

RecordSchedulePtr WSAPI::GetRecordSchedule1_5 ( uint32_t recordid )

private

Definition at line 1948 of file mythwsapi.cpp.

◆ GetRecordScheduleList()

RecordScheduleListPtr Myth::WSAPI::GetRecordScheduleList ( )

inline

GET Dvr/GetRecordScheduleList.

Definition at line 281 of file mythwsapi.h.

◆ GetRecordScheduleList1_5()

RecordScheduleListPtr WSAPI::GetRecordScheduleList1_5 ( )

private

Definition at line 1875 of file mythwsapi.cpp.

◆ GetSavedBookmark()

int64_t Myth::WSAPI::GetSavedBookmark	(	uint32_t	recordedid,
		int	unit )

inline

GET Dvr/GetSavedBookmark.

Parameters

recordedid
unit	1 = Position, 2 = Duration ms

Returns: value

Definition at line 517 of file mythwsapi.h.

◆ GetSavedBookmark6_2()

int64_t WSAPI::GetSavedBookmark6_2	(	uint32_t	recordedid,
		int	unit )

private

Definition at line 1828 of file mythwsapi.cpp.

◆ GetServerHostName()

std::string WSAPI::GetServerHostName ( )

Definition at line 313 of file mythwsapi.cpp.

◆ GetServiceVersion()

bool WSAPI::GetServiceVersion	(	WSServiceId_t	id,
		WSServiceVersion_t &	version )

private

< WS_Myth

< WS_Capture

< WS_Channel

< WS_Guide

< WS_Content

< WS_Dvr

< WS_INVALID

Definition at line 180 of file mythwsapi.cpp.

◆ GetSetting()

SettingPtr WSAPI::GetSetting	(	const std::string &	key,
		bool	myhost )

GET Myth/GetSetting.

Definition at line 485 of file mythwsapi.cpp.

References GetHostSetting().

◆ GetSetting2_0()

SettingPtr WSAPI::GetSetting2_0	(	const std::string &	key,
		const std::string &	hostname )

private

Definition at line 404 of file mythwsapi.cpp.

◆ GetSetting5_0()

SettingPtr WSAPI::GetSetting5_0	(	const std::string &	key,
		const std::string &	hostname )

private

Definition at line 449 of file mythwsapi.cpp.

◆ GetSettings()

SettingMapPtr WSAPI::GetSettings ( bool myhost )

GET Myth/GetSetting.

Definition at line 585 of file mythwsapi.cpp.

References GetHostSettings().

◆ GetSettings2_0()

SettingMapPtr WSAPI::GetSettings2_0 ( const std::string & hostname )

private

Definition at line 493 of file mythwsapi.cpp.

◆ GetSettings5_0()

SettingMapPtr WSAPI::GetSettings5_0 ( const std::string & hostname )

private

Definition at line 539 of file mythwsapi.cpp.

◆ GetUpcomingList()

ProgramListPtr Myth::WSAPI::GetUpcomingList ( )

inline

GET Dvr/GetUpcomingList.

Definition at line 352 of file mythwsapi.h.

◆ GetUpcomingList1_5()

ProgramListPtr WSAPI::GetUpcomingList1_5 ( )

private

Definition at line 2379 of file mythwsapi.cpp.

◆ GetUpcomingList2_2()

ProgramListPtr WSAPI::GetUpcomingList2_2 ( )

private

Definition at line 2393 of file mythwsapi.cpp.

◆ GetVersion()

VersionPtr WSAPI::GetVersion ( )

Definition at line 333 of file mythwsapi.cpp.

◆ GetVideoSourceList()

VideoSourceListPtr Myth::WSAPI::GetVideoSourceList ( )

inline

GET Channel/GetVideoSourceList.

Definition at line 138 of file mythwsapi.h.

◆ GetVideoSourceList1_2()

VideoSourceListPtr WSAPI::GetVideoSourceList1_2 ( )

private

Definition at line 679 of file mythwsapi.cpp.

◆ InitWSAPI()

bool WSAPI::InitWSAPI ( )

private

Definition at line 144 of file mythwsapi.cpp.

◆ InvalidateService()

void WSAPI::InvalidateService ( )

Definition at line 307 of file mythwsapi.cpp.

◆ LoginUser()

bool WSAPI::LoginUser ( )

GET Myth/LoginUser From v36.

Definition at line 369 of file mythwsapi.cpp.

◆ PutSetting()

bool Myth::WSAPI::PutSetting	(	const std::string &	key,
		const std::string &	value,
		bool	myhost )

inline

POST Myth/PutSetting.

Definition at line 118 of file mythwsapi.h.

◆ PutSetting2_0()

bool WSAPI::PutSetting2_0	(	const std::string &	key,
		const std::string &	value,
		bool	myhost )

private

Definition at line 593 of file mythwsapi.cpp.

◆ RemoveRecordSchedule()

bool Myth::WSAPI::RemoveRecordSchedule ( uint32_t recordid )

inline

POST Dvr/RemoveRecordSchedule.

Definition at line 342 of file mythwsapi.h.

◆ RemoveRecordSchedule1_5()

bool WSAPI::RemoveRecordSchedule1_5 ( uint32_t recordid )

private

Definition at line 2346 of file mythwsapi.cpp.

◆ ResolveHostName()

std::string WSAPI::ResolveHostName ( const std::string & hostname )

Definition at line 338 of file mythwsapi.cpp.

◆ SetSavedBookmark()

bool Myth::WSAPI::SetSavedBookmark	(	uint32_t	recordedid,
		int	unit,
		int64_t	value )

inline

POST Dvr/SetSavedBookmark.

Parameters

recordedid
unit	1 = Position, 2 = Duration ms
value	of mark

Returns: boolean

Definition at line 503 of file mythwsapi.h.

◆ SetSavedBookmark6_2()

bool WSAPI::SetSavedBookmark6_2	(	uint32_t	recordedid,
		int	unit,
		int64_t	value )

private

Definition at line 1791 of file mythwsapi.cpp.

◆ UnDeleteRecording() [1/2]

bool Myth::WSAPI::UnDeleteRecording	(	uint32_t	chanid,
		time_t	recstartts )

inline

POST Dvr/UnDeleteRecording.

Definition at line 261 of file mythwsapi.h.

◆ UnDeleteRecording() [2/2]

bool Myth::WSAPI::UnDeleteRecording ( uint32_t recordedid )

inline

POST Dvr/UnDeleteRecording.

Definition at line 271 of file mythwsapi.h.

◆ UnDeleteRecording2_1()

bool WSAPI::UnDeleteRecording2_1	(	uint32_t	chanid,
		time_t	recstartts )

private

Definition at line 1559 of file mythwsapi.cpp.

◆ UnDeleteRecording6_0()

bool WSAPI::UnDeleteRecording6_0 ( uint32_t recordedid )

private

Definition at line 1592 of file mythwsapi.cpp.

◆ UpdateRecordedWatchedStatus() [1/2]

bool Myth::WSAPI::UpdateRecordedWatchedStatus	(	uint32_t	chanid,
		time_t	recstartts,
		bool	watched )

inline

POST Dvr/UpdateRecordedWatchedStatus.

Definition at line 221 of file mythwsapi.h.

◆ UpdateRecordedWatchedStatus() [2/2]

bool Myth::WSAPI::UpdateRecordedWatchedStatus	(	uint32_t	recordedid,
		bool	watched )

inline

POST Dvr/UpdateRecordedWatchedStatus.

Definition at line 231 of file mythwsapi.h.

◆ UpdateRecordedWatchedStatus4_5()

bool WSAPI::UpdateRecordedWatchedStatus4_5	(	uint32_t	chanid,
		time_t	recstartts,
		bool	watched )

private

Definition at line 1623 of file mythwsapi.cpp.

◆ UpdateRecordedWatchedStatus6_0()

bool WSAPI::UpdateRecordedWatchedStatus6_0	(	uint32_t	recordedid,
		bool	watched )

private

Definition at line 1657 of file mythwsapi.cpp.

◆ UpdateRecordSchedule()

bool Myth::WSAPI::UpdateRecordSchedule ( RecordSchedule & record )

inline

POST Dvr/UpdateRecordSchedule.

Definition at line 312 of file mythwsapi.h.

◆ UpdateRecordSchedule1_7()

bool WSAPI::UpdateRecordSchedule1_7 ( RecordSchedule & record )

private

Definition at line 2189 of file mythwsapi.cpp.

◆ WithAuthorization()

WSAPI & WSAPI::WithAuthorization	(	const std::string &	user,
		const std::string &	password )

Definition at line 81 of file mythwsapi.cpp.

◆ WithSSL()

WSAPI & WSAPI::WithSSL ( bool yesno )

Definition at line 88 of file mythwsapi.cpp.

Field Documentation

◆ m_authPassword

std::string Myth::WSAPI::m_authPassword

private

Definition at line 531 of file mythwsapi.h.

◆ m_authToken

std::string Myth::WSAPI::m_authToken

private

Definition at line 532 of file mythwsapi.h.

◆ m_authUser

std::string Myth::WSAPI::m_authUser

private

Definition at line 530 of file mythwsapi.h.

◆ m_checked

bool Myth::WSAPI::m_checked

private

Definition at line 533 of file mythwsapi.h.

◆ m_mutex

OS::Mutex* Myth::WSAPI::m_mutex

private

Definition at line 525 of file mythwsapi.h.

◆ m_namedCache

std::map<std::string, std::string> Myth::WSAPI::m_namedCache

private

Definition at line 537 of file mythwsapi.h.

◆ m_port

unsigned Myth::WSAPI::m_port

private

Definition at line 527 of file mythwsapi.h.

◆ m_securityPin

std::string Myth::WSAPI::m_securityPin

private

Definition at line 529 of file mythwsapi.h.

◆ m_server

std::string Myth::WSAPI::m_server

private

Definition at line 526 of file mythwsapi.h.

◆ m_serverHostName

std::string Myth::WSAPI::m_serverHostName

private

Definition at line 535 of file mythwsapi.h.

◆ m_serviceVersion

WSServiceVersion_t Myth::WSAPI::m_serviceVersion[WS_INVALID+1]

private

Definition at line 536 of file mythwsapi.h.

◆ m_ssl

bool Myth::WSAPI::m_ssl

private

Definition at line 528 of file mythwsapi.h.

◆ m_version

Version Myth::WSAPI::m_version

private

Definition at line 534 of file mythwsapi.h.

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

/home/jlb/src/janbar/PVR/cppmythlib/cppmyth/src/mythwsapi.h
/home/jlb/src/janbar/PVR/cppmythlib/cppmyth/src/mythwsapi.cpp

Data Structures

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WSAPI()

◆ ~WSAPI()

Member Function Documentation

◆ AddRecordSchedule()

◆ AddRecordSchedule1_5()

◆ AddRecordSchedule1_7()

◆ CheckServerHostName2_0()

◆ CheckService() [1/2]

◆ CheckService() [2/2]

◆ CheckVersion2_0()

◆ DeleteRecording() [1/2]

◆ DeleteRecording() [2/2]

◆ DeleteRecording2_1()

◆ DeleteRecording6_0()

◆ DisableRecordSchedule()

◆ DisableRecordSchedule1_5()

◆ EnableRecordSchedule()

◆ EnableRecordSchedule1_5()

◆ GetBaseURL()

◆ GetCaptureCardList()

◆ GetCaptureCardList1_4()

◆ GetChannel()

◆ GetChannel1_2()

◆ GetChannelIcon()

◆ GetChannelIcon1_32()

◆ GetChannelIconUrl()

◆ GetChannelIconUrl1_32()

◆ GetChannelList()

◆ GetChannelList1_2()

◆ GetChannelList1_5()

◆ GetConflictList()

◆ GetConflictList1_5()

◆ GetExpiringList()

◆ GetExpiringList1_5()

◆ GetFile()

◆ GetFile1_32()

◆ GetHostSetting()

◆ GetHostSettings()

◆ GetPreviewImage()

◆ GetPreviewImage1_32()

◆ GetPreviewImageUrl()

◆ GetPreviewImageUrl1_32()

◆ GetProgramGuide() [1/2]

◆ GetProgramGuide() [2/2]

◆ GetProgramGuide1_0() [1/2]

◆ GetProgramGuide1_0() [2/2]

◆ GetProgramGuide2_2()

◆ GetProgramList2_2()

◆ GetRecGroupList()

◆ GetRecGroupList1_5()

◆ GetRecorded() [1/2]

◆ GetRecorded() [2/2]

◆ GetRecorded1_5()

◆ GetRecorded6_0()

◆ GetRecordedCommBreak()

◆ GetRecordedCommBreak6_1()

◆ GetRecordedCutList()

◆ GetRecordedCutList6_1()

◆ GetRecordedList()

◆ GetRecordedList1_5()

◆ GetRecordingArtwork()

◆ GetRecordingArtwork1_32()

◆ GetRecordingArtworkList()

◆ GetRecordingArtworkList1_32()

◆ GetRecordingArtworkUrl()

◆ GetRecordingArtworkUrl1_32()

◆ GetRecordSchedule()

◆ GetRecordSchedule1_5()

◆ GetRecordScheduleList()

◆ GetRecordScheduleList1_5()

◆ GetSavedBookmark()

◆ GetSavedBookmark6_2()

◆ GetServerHostName()

◆ GetServiceVersion()