You.i Engine
CYIAbstractVideoPlayer::HeadphoneJackInterface Class Referenceabstract

Detailed Description

Interface containing functionality related to the headphone jack on the device which the application is running on.

Player implementations which support responding to headphone jack events implement this interface and return a pointer to the instance via GetHeadphoneJackInterface.

#include <player/YiAbstractVideoPlayer.h>

Public Member Functions

virtual ~HeadphoneJackInterface ()=default
 
virtual void EnablePauseOnHeadphonesUnplugged (bool enabled)=0
 
virtual bool IsPausingOnHeadphonesUnplugged () const =0
 

Constructor & Destructor Documentation

◆ ~HeadphoneJackInterface()

virtual CYIAbstractVideoPlayer::HeadphoneJackInterface::~HeadphoneJackInterface ( )
virtualdefault

Member Function Documentation

◆ EnablePauseOnHeadphonesUnplugged()

virtual void CYIAbstractVideoPlayer::HeadphoneJackInterface::EnablePauseOnHeadphonesUnplugged ( bool  enabled)
pure virtual

Enables or disables automatic pausing when headphones are unplugged from the device. When enabled is true the player will pause when headphones are unplugged from the headphone jack.

◆ IsPausingOnHeadphonesUnplugged()

virtual bool CYIAbstractVideoPlayer::HeadphoneJackInterface::IsPausingOnHeadphonesUnplugged ( ) const
pure virtual

Returns true if the player will pause when headphones are unplugged from the headphone jack. By default pausing is disabled on all player implementations provided by You.i Engine.


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