xbmc/pvr/guilib/PVRGUIActionsPlayback.h

   1 /*
   2  *  Copyright (C) 2016-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include "pvr/IPVRComponent.h"
  12 #include "pvr/settings/PVRSettings.h"
  13 #include "utils/ContentUtils.h"
  14
  15 #include <string>
  16
  17 class CFileItem;
  18
  19 namespace PVR
  20 {
  21 enum PlaybackType
  22 {
  23   PlaybackTypeAny = 0,
  24   PlaybackTypeTV,
  25   PlaybackTypeRadio
  26 };
  27
  28 class CPVRGUIActionsPlayback : public IPVRComponent
  29 {
  30 public:
  31   CPVRGUIActionsPlayback();
  32   ~CPVRGUIActionsPlayback() override = default;
  33
  34   /*!
  35    * @brief Resume a previously not completely played recording.
  36    * @param item containing a recording or an epg tag.
  37    * @param bFallbackToPlay controls whether playback of the recording should be started at the
  38    * beginning ig no resume data are available.
  39    * @return true on success, false otherwise.
  40    */
  41   bool ResumePlayRecording(const CFileItem& item, bool bFallbackToPlay) const;
  42
  43   /*!
  44    * @brief Play recording.
  45    * @param item containing a recording or an epg tag.
  46    * @param bCheckResume controls resume check.
  47    * @return true on success, false otherwise.
  48    */
  49   bool PlayRecording(const CFileItem& item, bool bCheckResume) const;
  50
  51   /*!
  52    * @brief Play a recording folder.
  53    * @param item containing a recording folder.
  54    * @param bCheckResume controls resume check.
  55    * @return true on success, false otherwise.
  56    */
  57   bool PlayRecordingFolder(const CFileItem& item, bool bCheckResume) const;
  58
  59   /*!
  60    * @brief Play EPG tag.
  61    * @param item containing an epg tag.
  62    * @param mode playback mode.
  63    * @return true on success, false otherwise.
  64    */
  65   bool PlayEpgTag(
  66       const CFileItem& item,
  67       ContentUtils::PlayMode mode = ContentUtils::PlayMode::CHECK_AUTO_PLAY_NEXT_ITEM) const;
  68
  69   /*!
  70    * @brief Switch channel.
  71    * @param item containing a channel or an epg tag.
  72    * @param bCheckResume controls resume check in case a recording for the current epg event is
  73    * present.
  74    * @return true on success, false otherwise.
  75    */
  76   bool SwitchToChannel(const CFileItem& item, bool bCheckResume) const;
  77
  78   /*!
  79    * @brief Playback the given file item.
  80    * @param item containing a channel or a recording.
  81    * @return True if the item could be played, false otherwise.
  82    */
  83   bool PlayMedia(const CFileItem& item) const;
  84
  85   /*!
  86    * @brief Start playback of the last played channel, and if there is none, play first channel in
  87    * the current channelgroup.
  88    * @param type The type of playback to be started (any, radio, tv). See PlaybackType enum
  89    * @return True if playback was started, false otherwise.
  90    */
  91   bool SwitchToChannel(PlaybackType type) const;
  92
  93   /*!
  94    * @brief Plays the last played channel or the first channel of TV or Radio on startup.
  95    * @return True if playback was started, false otherwise.
  96    */
  97   bool PlayChannelOnStartup() const;
  98
  99   /*!
 100    * @brief Seek to the start of the next epg event in timeshift buffer, relative to the currently
 101    * playing event. If there is no next event, seek to the end of the currently playing event (to
 102    * the 'live' position).
 103    */
 104   void SeekForward();
 105
 106   /*!
 107    * @brief Seek to the start of the previous epg event in timeshift buffer, relative to the
 108    * currently playing event or if there is no previous event or if playback time is greater than
 109    * given threshold, seek to the start of the playing event.
 110    * @param iThreshold the value in seconds to trigger seek to start of current event instead of
 111    * start of previous event.
 112    */
 113   void SeekBackward(unsigned int iThreshold);
 114
 115 private:
 116   CPVRGUIActionsPlayback(const CPVRGUIActionsPlayback&) = delete;
 117   CPVRGUIActionsPlayback const& operator=(CPVRGUIActionsPlayback const&) = delete;
 118
 119   /*!
 120    * @brief Check whether resume play is possible for a given item, display "resume from ..."/"play
 121    * from start" context menu in case.
 122    * @param item containing a recording or an epg tag.
 123    * @return true, to play/resume the item, false otherwise.
 124    */
 125   bool CheckResumeRecording(const CFileItem& item) const;
 126
 127   /*!
 128    * @brief Check "play minimized" settings value and switch to fullscreen if not set.
 129    * @param bFullscreen switch to fullscreen or set windowed playback.
 130    */
 131   void CheckAndSwitchToFullscreen(bool bFullscreen) const;
 132
 133   CPVRSettings m_settings;
 134 };
 135
 136 namespace GUI
 137 {
 138 // pretty scope and name
 139 using Playback = CPVRGUIActionsPlayback;
 140 } // namespace GUI
 141
 142 } // namespace PVR