NuguCapability::IAudioPlayerDisplayListener Class Reference

audioplayer's display listener interface More...

#include <audio_player_interface.hh>

Inheritance diagram for NuguCapability::IAudioPlayerDisplayListener:

Collaboration diagram for NuguCapability::IAudioPlayerDisplayListener:

Public Member Functions
virtual bool	hideLyrics (const std::string &id)=0
	Request to the user to hide the lyrics page. More...
virtual bool	requestLyricsPageAvailable (const std::string &id, bool &visible)=0
	SDK request information about device's lyrics page available. More...
virtual bool	showLyrics (const std::string &id)=0
	Request to the user to show the lyrics page. More...
virtual void	updateMetaData (const std::string &id, const std::string &json_payload)=0
	Request to update metadata the current display. More...
Public Member Functions inherited from NuguCapability::IDisplayListener
virtual bool	clearDisplay (const std::string &id, bool unconditionally, bool has_next)=0
	The SDK will ask you to delete the rendered display on the display according to the service context maintenance policy. More...
virtual void	controlDisplay (const std::string &id, ControlType type, ControlDirection direction)=0
	Request to control the display with type and direction. More...
virtual void	renderDisplay (const std::string &id, const std::string &type, const std::string &json_payload, const std::string &dialog_id)=0
	Request rendering by passing metadata so that the device with the display can draw on the screen. More...
virtual void	updateDisplay (const std::string &id, const std::string &json_payload)=0
	Request to update the current display. More...
Public Member Functions inherited from NuguClientKit::ICapabilityListener
virtual ICapabilityInterface *	getCapabilityHandler ()
	Get capability interface object. More...
virtual void	setCapabilityHandler (ICapabilityInterface *handler)
	Set capability interface object. More...

Detailed Description

audioplayer's display listener interface

See also

IAudioPlayerHandler

Member Function Documentation

requestLyricsPageAvailable()

virtual bool NuguCapability::IAudioPlayerDisplayListener::requestLyricsPageAvailable ( const std::string &  id, bool &  visible  )

pure virtual

SDK request information about device's lyrics page available.

Parameters

[in]	id	display template id
[out]	visible	show lyrics page visible

Returns

return device's lyrics page available

showLyrics()

virtual bool NuguCapability::IAudioPlayerDisplayListener::showLyrics ( const std::string &  id )

pure virtual

Request to the user to show the lyrics page.

Parameters

[in]

id

display template id

Returns

return true if show lyrics success, otherwise false.

hideLyrics()

virtual bool NuguCapability::IAudioPlayerDisplayListener::hideLyrics ( const std::string &  id )

pure virtual

Request to the user to hide the lyrics page.

Parameters

[in]

id

display template id

Returns

return true if hide lyrics success, otherwise false.

updateMetaData()

virtual void NuguCapability::IAudioPlayerDisplayListener::updateMetaData ( const std::string &  id, const std::string &  json_payload  )

pure virtual

Request to update metadata the current display.

Parameters

[in]	id	display template id
[in]	json_payload	template in json format for display

---

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

• audio_player_interface.hh