8.3. Various functions

Various other PVR stream related functions
These apply to all other groups in inputstream and are therefore declared as several. More...

Functions
virtual bool	kodi::addon::CInstancePVRClient::CanPauseStream ()
	Check if the backend support pausing the currently playing stream.
virtual bool	kodi::addon::CInstancePVRClient::CanSeekStream ()
	Check if the backend supports seeking for the currently playing stream.
virtual void	kodi::addon::CInstancePVRClient::PauseStream (bool paused)
	Notify the pvr addon that Kodi (un)paused the currently playing stream.
virtual bool	kodi::addon::CInstancePVRClient::IsRealTimeStream ()
	Check for real-time streaming.
virtual PVR_ERROR	kodi::addon::CInstancePVRClient::GetStreamTimes (kodi::addon::PVRStreamTimes &times)
	Get stream times.
virtual PVR_ERROR	kodi::addon::CInstancePVRClient::GetStreamReadChunkSize (int &chunksize)
	Obtain the chunk size to use when reading streams.

Detailed Description

Various other PVR stream related functions
These apply to all other groups in inputstream and are therefore declared as several.

---

Various stream parts in interface:
Copy this to your project and extend with your parts or leave functions complete away where not used or supported.

Function Documentation

CanPauseStream()

virtual bool kodi::addon::CInstancePVRClient::CanPauseStream ( )

inlinevirtual

Check if the backend support pausing the currently playing stream.

This will enable/disable the pause button in Kodi based on the return value.

Returns

false if the PVR addon/backend does not support pausing, true if possible

CanSeekStream()

virtual bool kodi::addon::CInstancePVRClient::CanSeekStream ( )

inlinevirtual

Check if the backend supports seeking for the currently playing stream.

This will enable/disable the rewind/forward buttons in Kodi based on the return value.

Returns

false if the PVR addon/backend does not support seeking, true if possible

GetStreamReadChunkSize()

virtual PVR_ERROR kodi::addon::CInstancePVRClient::GetStreamReadChunkSize ( int & chunksize )

inlinevirtual

Obtain the chunk size to use when reading streams.

Parameters

[out]

chunksize

must be filled with the chunk size in bytes.

Returns

PVR_ERROR_NO_ERROR if the chunk size has been fetched successfully.

Remarks

Optional, and only used if not reading from demuxer (=> DemuxRead) and PVRCapabilities::SetSupportsRecordings() is true (=> ReadRecordedStream) or PVRCapabilities::SetHandlesInputStream() is true (=> ReadLiveStream).

GetStreamTimes()

virtual PVR_ERROR kodi::addon::CInstancePVRClient::GetStreamTimes ( kodi::addon::PVRStreamTimes & times )

inlinevirtual

Get stream times.

Parameters

[out]

times

A pointer to the data to be filled by the implementation.

Returns

PVR_ERROR_NO_ERROR on success.

IsRealTimeStream()

virtual bool kodi::addon::CInstancePVRClient::IsRealTimeStream ( )

inlinevirtual

Check for real-time streaming.

Returns

true if current stream is real-time

PauseStream()

virtual void kodi::addon::CInstancePVRClient::PauseStream ( bool paused )

inlinevirtual

Notify the pvr addon that Kodi (un)paused the currently playing stream.

Parameters

[in]

paused

To inform by true is paused and with false playing