CYIClosedCaptionsStatusBridge Class Reference

Detailed Description

A bridge which reports operating system closed captions settings.

Can be used to query whether closed captions are enabled in the operating system settings, additionally provides notifications for changes to these settings. This bridge is available on mobile platforms.

#include <platform/YiClosedCaptionsStatusBridge.h>

Public Member Functions
virtual	~CYIClosedCaptionsStatusBridge ()
virtual bool	GetClosedCaptionsStatus () const =0
virtual void	StartObservingStatusChanges ()=0
virtual void	StopObservingStatusChanges ()=0

Public Attributes
CYISignal< bool >	ClosedCaptionsStatusChanged

Constructor & Destructor Documentation

virtual CYIClosedCaptionsStatusBridge::~CYIClosedCaptionsStatusBridge ( )

inlinevirtual

Member Function Documentation

virtual bool CYIClosedCaptionsStatusBridge::GetClosedCaptionsStatus ( ) const

pure virtual

Returns true if the operating system settings for closed captioning are set to enabled.

virtual void CYIClosedCaptionsStatusBridge::StartObservingStatusChanges ( )

pure virtual

Starts observing the operating system closed captioning settings. CYIClosedCaptionsStatusBridge::ClosedCaptionsStatusChanged will be emitted only while status changes are being observed.

Current status should be queried using CYIClosedCaptionsStatusBridge::GetClosedCaptionsStatus.

See also

GetClosedCaptionsStatus

virtual void CYIClosedCaptionsStatusBridge::StopObservingStatusChanges ( )

pure virtual

Stops observing the operating system closed captioning settings. CYIClosedCaptionsStatusBridge::ClosedCaptionsStatusChanged will be emitted only while status changes are being observed.

Current status should be queried using CYIClosedCaptionsStatusBridge::GetClosedCaptionsStatus.

See also

GetClosedCaptionsStatus

Member Data Documentation

CYISignal<bool> CYIClosedCaptionsStatusBridge::ClosedCaptionsStatusChanged

Emitted when closed captions operating system settings have changed.

---

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

• platform/YiClosedCaptionsStatusBridge.h