MythTV  master
Public Slots | Signals | Public Member Functions | Protected Attributes | List of all members
TVPlaybackState Class Reference

Tracks current playback state, as signalled by the player, and requests changes to the current state. More...

#include <tvplaybackstate.h>

Inheritance diagram for TVPlaybackState:
Inheritance graph
[legend]
Collaboration diagram for TVPlaybackState:
Collaboration graph
[legend]

Public Slots

void OverlayStateChanged (MythOverlayState OverlayState)
 
void AudioPlayerStateChanged (const MythAudioPlayerState &AudioPlayerState)
 
void AudioStateChanged (const MythAudioState &AudioState)
 
void CaptionsStateChanged (MythCaptionsState CaptionsState)
 
void VideoBoundsStateChanged (const MythVideoBoundsState &VideoBoundsState)
 
void VideoColourStateChanged (const MythVideoColourState &ColourState)
 
void VisualiserStateChanged (const MythVisualiserState &VisualiserState)
 
void EditorStateChanged (const MythEditorState &EditorState)
 

Signals

void InitialisePlayerState ()
 
void UpdateBookmark (bool Clear=false)
 
void IsOSDVisible (bool &Visible)
 
void ChangeOSDPositionUpdates (bool Enable)
 
void ChangeOSDDebug ()
 
void ChangeOSDText (const QString &Window, const InfoMap &Map, OSDTimeout Timeout)
 
void ChangeOSDDialog (const MythOSDDialogData &Data)
 
void ChangeOSDMessage (const QString &Message)
 
void DialogQuit ()
 
void HideAll (bool KeepSubs=true, MythScreenType *Except=nullptr, bool DropNotification=false)
 
void ReinitAudio ()
 
void ResetAudio ()
 
void PauseAudioUntilReady ()
 
void ChangeMuteState (bool CycleChannels=false)
 
void ChangeVolume (bool Direction, int Volume)
 
void ChangeUpmix (bool Enable, bool Toggle=false)
 
void ChangeAudioOffset (std::chrono::milliseconds Delta, std::chrono::milliseconds Value=-9999ms)
 
void SetTrack (uint Type, uint TrackNo)
 
void ChangeTrack (uint Type, int Direction)
 
void ChangeAllowForcedSubtitles (bool Allow)
 
void ToggleCaptions ()
 
void ToggleCaptionsByType (uint Type)
 
void SetCaptionsEnabled (bool Enable, bool UpdateOSD=true)
 
void DisableCaptions (uint Mode, bool UpdateOSD=true)
 
void EnableCaptions (uint Mode, bool UpdateOSD=true)
 
void ChangeCaptionTrack (int Direction)
 
void ResetCaptions ()
 
void EnableTeletext (int Page=0x100)
 
void ResetTeletext ()
 
void SetTeletextPage (uint Page)
 
void HandleTeletextAction (const QString &Action, bool &Handled)
 
void RestartITV (uint Chanid, uint Cardid, bool IsLiveTV)
 
void HandleITVAction (const QString &Action, bool &Handled)
 
void AdjustSubtitleZoom (int Delta)
 
void AdjustSubtitleDelay (std::chrono::milliseconds Delta)
 
void RequestEmbedding (bool Embed, const QRect &Rect={}, const QStringList &Data={})
 
void EmbedPlayback (bool Embed, const QRect &Rect={})
 
void ResizeScreenForVideo (QSize Size={})
 
void WindowResized (const QSize &Size)
 
void ChangeStereoOverride (StereoscopicMode Mode)
 
void ChangePictureAttribute (PictureAttribute Attribute, bool Direction, int Value)
 
void ToggleDetectLetterBox ()
 
void ChangeAdjustFill (AdjustFillMode FillMode=kAdjustFill_Toggle)
 
void ChangeAspectOverride (AspectOverrideMode AspectMode=kAspect_Toggle)
 
void ChangeZoom (ZoomDirection Zoom)
 
void ToggleMoveBottomLine ()
 
void SaveBottomLine ()
 
void EnableVisualiser (bool Enable, bool Toggle=false, const QString &Name=QString())
 
void GoToMenu (const QString &Menu)
 
void GoToDVDProgram (bool Direction)
 
void EnableEdit ()
 
void DisableEdit (int HowToSave)
 
void RefreshEditorState (bool CheckSaved=false)
 

Public Member Functions

 TVPlaybackState ()=default
 

Protected Attributes

MythOverlayState m_overlayState { }
 
MythAudioPlayerState m_audioPlayerState { }
 
MythAudioState m_audioState { }
 
MythCaptionsState m_captionsState { }
 
MythVideoBoundsState m_videoBoundsState { }
 
MythVideoColourState m_videoColourState { }
 
MythVisualiserState m_visualiserState { }
 
MythEditorState m_editorState { }
 

Detailed Description

Tracks current playback state, as signalled by the player, and requests changes to the current state.

Requesting player state changes is, by necessity, granular. Corresponding feedback of new state is however signalled in small, functionally similar/associated groups of state. This is to minimise the complexity of the API.

Note
The TV and player objects both operate within the main thread. As such all signalling should be synchronous and hence the state should always be current.
Do not trigger additional code when state updates are received - as this may lead to a feedback loop and/or recursion.

Definition at line 12 of file tvplaybackstate.h.

Constructor & Destructor Documentation

◆ TVPlaybackState()

TVPlaybackState::TVPlaybackState ( )
default

Member Function Documentation

◆ InitialisePlayerState

void TVPlaybackState::InitialisePlayerState ( )
signal

◆ UpdateBookmark

void TVPlaybackState::UpdateBookmark ( bool  Clear = false)
signal

◆ IsOSDVisible

void TVPlaybackState::IsOSDVisible ( bool Visible)
signal

Referenced by TV::ActiveHandleAction(), and OSD::OSD().

◆ ChangeOSDPositionUpdates

void TVPlaybackState::ChangeOSDPositionUpdates ( bool  Enable)
signal

◆ ChangeOSDDebug

void TVPlaybackState::ChangeOSDDebug ( )
signal

◆ ChangeOSDText

void TVPlaybackState::ChangeOSDText ( const QString &  Window,
const InfoMap Map,
OSDTimeout  Timeout 
)
signal

◆ ChangeOSDDialog

void TVPlaybackState::ChangeOSDDialog ( const MythOSDDialogData Data)
signal

◆ ChangeOSDMessage

void TVPlaybackState::ChangeOSDMessage ( const QString &  Message)
signal

◆ DialogQuit

void TVPlaybackState::DialogQuit ( )
signal

◆ HideAll

void TVPlaybackState::HideAll ( bool  KeepSubs = true,
MythScreenType Except = nullptr,
bool  DropNotification = false 
)
signal

◆ ReinitAudio

void TVPlaybackState::ReinitAudio ( )
signal

◆ ResetAudio

void TVPlaybackState::ResetAudio ( )
signal

◆ PauseAudioUntilReady

void TVPlaybackState::PauseAudioUntilReady ( )
signal

◆ ChangeMuteState

void TVPlaybackState::ChangeMuteState ( bool  CycleChannels = false)
signal

◆ ChangeVolume

void TVPlaybackState::ChangeVolume ( bool  Direction,
int  Volume 
)
signal

◆ ChangeUpmix

void TVPlaybackState::ChangeUpmix ( bool  Enable,
bool  Toggle = false 
)
signal

◆ ChangeAudioOffset

void TVPlaybackState::ChangeAudioOffset ( std::chrono::milliseconds  Delta,
std::chrono::milliseconds  Value = -9999ms 
)
signal

◆ SetTrack

void TVPlaybackState::SetTrack ( uint  Type,
uint  TrackNo 
)
signal

◆ ChangeTrack

void TVPlaybackState::ChangeTrack ( uint  Type,
int  Direction 
)
signal

◆ ChangeAllowForcedSubtitles

void TVPlaybackState::ChangeAllowForcedSubtitles ( bool  Allow)
signal

◆ ToggleCaptions

void TVPlaybackState::ToggleCaptions ( )
signal

◆ ToggleCaptionsByType

void TVPlaybackState::ToggleCaptionsByType ( uint  Type)
signal

◆ SetCaptionsEnabled

void TVPlaybackState::SetCaptionsEnabled ( bool  Enable,
bool  UpdateOSD = true 
)
signal

◆ DisableCaptions

void TVPlaybackState::DisableCaptions ( uint  Mode,
bool  UpdateOSD = true 
)
signal

◆ EnableCaptions

void TVPlaybackState::EnableCaptions ( uint  Mode,
bool  UpdateOSD = true 
)
signal

◆ ChangeCaptionTrack

void TVPlaybackState::ChangeCaptionTrack ( int  Direction)
signal

◆ ResetCaptions

void TVPlaybackState::ResetCaptions ( )
signal

◆ EnableTeletext

void TVPlaybackState::EnableTeletext ( int  Page = 0x100)
signal

◆ ResetTeletext

void TVPlaybackState::ResetTeletext ( )
signal

◆ SetTeletextPage

void TVPlaybackState::SetTeletextPage ( uint  Page)
signal

◆ HandleTeletextAction

void TVPlaybackState::HandleTeletextAction ( const QString &  Action,
bool Handled 
)
signal

◆ RestartITV

void TVPlaybackState::RestartITV ( uint  Chanid,
uint  Cardid,
bool  IsLiveTV 
)
signal

◆ HandleITVAction

void TVPlaybackState::HandleITVAction ( const QString &  Action,
bool Handled 
)
signal

◆ AdjustSubtitleZoom

void TVPlaybackState::AdjustSubtitleZoom ( int  Delta)
signal

◆ AdjustSubtitleDelay

void TVPlaybackState::AdjustSubtitleDelay ( std::chrono::milliseconds  Delta)
signal

◆ RequestEmbedding

void TVPlaybackState::RequestEmbedding ( bool  Embed,
const QRect &  Rect = {},
const QStringList &  Data = {} 
)
signal

◆ EmbedPlayback

void TVPlaybackState::EmbedPlayback ( bool  Embed,
const QRect &  Rect = {} 
)
signal

◆ ResizeScreenForVideo

void TVPlaybackState::ResizeScreenForVideo ( QSize  Size = {})
signal

◆ WindowResized

void TVPlaybackState::WindowResized ( const QSize &  Size)
signal

◆ ChangeStereoOverride

void TVPlaybackState::ChangeStereoOverride ( StereoscopicMode  Mode)
signal

◆ ChangePictureAttribute

void TVPlaybackState::ChangePictureAttribute ( PictureAttribute  Attribute,
bool  Direction,
int  Value 
)
signal

◆ ToggleDetectLetterBox

void TVPlaybackState::ToggleDetectLetterBox ( )
signal

◆ ChangeAdjustFill

void TVPlaybackState::ChangeAdjustFill ( AdjustFillMode  FillMode = kAdjustFill_Toggle)
signal

◆ ChangeAspectOverride

void TVPlaybackState::ChangeAspectOverride ( AspectOverrideMode  AspectMode = kAspect_Toggle)
signal

◆ ChangeZoom

void TVPlaybackState::ChangeZoom ( ZoomDirection  Zoom)
signal

◆ ToggleMoveBottomLine

void TVPlaybackState::ToggleMoveBottomLine ( )
signal

◆ SaveBottomLine

void TVPlaybackState::SaveBottomLine ( )
signal

◆ EnableVisualiser

void TVPlaybackState::EnableVisualiser ( bool  Enable,
bool  Toggle = false,
const QString &  Name = QString() 
)
signal

◆ GoToMenu

void TVPlaybackState::GoToMenu ( const QString &  Menu)
signal

◆ GoToDVDProgram

void TVPlaybackState::GoToDVDProgram ( bool  Direction)
signal

◆ EnableEdit

void TVPlaybackState::EnableEdit ( )
signal

◆ DisableEdit

void TVPlaybackState::DisableEdit ( int  HowToSave)
signal

◆ RefreshEditorState

void TVPlaybackState::RefreshEditorState ( bool  CheckSaved = false)
signal

◆ OverlayStateChanged

void TVPlaybackState::OverlayStateChanged ( MythOverlayState  OverlayState)
slot

Definition at line 18 of file tvplaybackstate.cpp.

Referenced by MythPlayerOverlayUI::MythPlayerOverlayUI().

◆ AudioPlayerStateChanged

void TVPlaybackState::AudioPlayerStateChanged ( const MythAudioPlayerState AudioPlayerState)
slot

Definition at line 23 of file tvplaybackstate.cpp.

Referenced by MythPlayerAudioUI::MythPlayerAudioUI().

◆ AudioStateChanged

void TVPlaybackState::AudioStateChanged ( const MythAudioState AudioState)
slot

Definition at line 28 of file tvplaybackstate.cpp.

Referenced by MythPlayerAudioUI::MythPlayerAudioUI().

◆ CaptionsStateChanged

void TVPlaybackState::CaptionsStateChanged ( MythCaptionsState  CaptionsState)
slot

Definition at line 33 of file tvplaybackstate.cpp.

Referenced by MythPlayerCaptionsUI::MythPlayerCaptionsUI().

◆ VideoBoundsStateChanged

void TVPlaybackState::VideoBoundsStateChanged ( const MythVideoBoundsState VideoBoundsState)
slot

Definition at line 38 of file tvplaybackstate.cpp.

Referenced by MythPlayerVideoUI::InitVideo().

◆ VideoColourStateChanged

void TVPlaybackState::VideoColourStateChanged ( const MythVideoColourState ColourState)
slot

Definition at line 43 of file tvplaybackstate.cpp.

Referenced by MythPlayerVideoUI::InitVideo().

◆ VisualiserStateChanged

void TVPlaybackState::VisualiserStateChanged ( const MythVisualiserState VisualiserState)
slot

Definition at line 48 of file tvplaybackstate.cpp.

Referenced by MythPlayerVisualiserUI::MythPlayerVisualiserUI().

◆ EditorStateChanged

void TVPlaybackState::EditorStateChanged ( const MythEditorState EditorState)
slot

Definition at line 53 of file tvplaybackstate.cpp.

Referenced by MythPlayerEditorUI::MythPlayerEditorUI().

Member Data Documentation

◆ m_overlayState

MythOverlayState TVPlaybackState::m_overlayState { }
protected

◆ m_audioPlayerState

MythAudioPlayerState TVPlaybackState::m_audioPlayerState { }
protected

Definition at line 104 of file tvplaybackstate.h.

Referenced by AudioPlayerStateChanged().

◆ m_audioState

MythAudioState TVPlaybackState::m_audioState { }
protected

◆ m_captionsState

MythCaptionsState TVPlaybackState::m_captionsState { }
protected

◆ m_videoBoundsState

MythVideoBoundsState TVPlaybackState::m_videoBoundsState { }
protected

◆ m_videoColourState

MythVideoColourState TVPlaybackState::m_videoColourState { }
protected

◆ m_visualiserState

MythVisualiserState TVPlaybackState::m_visualiserState { }
protected

◆ m_editorState

MythEditorState TVPlaybackState::m_editorState { }
protected

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