This is the AudioLan dedicated audio remote controller's interface. More...

Inheritance diagram for CPNS::IAudioLanRemoteController:

Collaboration diagram for CPNS::IAudioLanRemoteController:

Public Member Functions
virtual void	RegisterNotificationHandler (CPNS::IAudioLanRemoteController_NotificationHandler *const pHandler)=0
	Register an AudioLan Remote notification handler. More...

virtual void	UnregisterNotificationHandler (CPNS::IAudioLanRemoteController_NotificationHandler *const pHandler)=0
	Unregister an AudioLan Remote notification handler. More...

virtual void	Refresh ()=0
	Request a full refresh of remote device list. More...

virtual CPNS::ISelectorItemList *	GetSourceStreamList ()=0
	Returns a selector item list containing all the source streams currently present in the network, without restriction. More...

virtual int	GetRemoteDeviceCount ()=0
	Get the number of available audio remote devices. More...

virtual CPNS::IAudioLanRemoteDevice *	GetAcquiredRemoteDevice (CPNS::uint16 const wIndex)=0

virtual CPNS::AudioLanSourceStream	GetSourceStreamFromName (CPNS::char8 const *const utf8SourceStreamName)=0
	Get source stream description from its name. More...

virtual CPNS::AudioLanSourceStreamChannel	GetSourceStreamChannelFromNameAndIndex (CPNS::char8 const *const utf8SourceStreamName, CPNS::uint16 const wChannelIndex)=0
	Get source stream channel description from the source name and the channel index (0 based). More...

virtual CPNS::boolean	SearchCompatibleTargetRemoteDevices (CPNS::char8 const *const utf8sourceStreamName)=0
	Reply done through the CPNS::IAudioLanRemoteController_NotificationHandler::OnAudioLanRemoteController_SearchCompatibleTargetRemoteDevicesReply notification. More...

virtual CPNS::Enums::Errors	ClearConnectionsFrom (CPNS::char8 const *const utf8SourceStreamName, CPNS::uint16 const wSourceChannelIndex)=0

virtual CPNS::boolean	IsSourceListen (CPNS::char8 const *const utf8SourceStreamName, CPNS::uint16 const wChannelIndex)=0

virtual CPNS::boolean	EnterLinkMode ()=0

virtual void	LeaveLinkMode ()=0
	Leave link mode and prevent new link mode during 2 seconds. More...

virtual void	SetLinkSource (CPNS::char8 const *const utf8SourceStreamName, CPNS::uint16 const wSourceStreamChannelIndex)=0

virtual void	PreventLinkTimeout ()=0

Public Member Functions inherited from CPNS::IObject
virtual CPNS::ICHAI *	GetCHAI ()=0
	Get a pointer to the CHAI hosting this object. More...

virtual void	RegisterObjectNotificationHandler (CPNS::IObject_NotificationHandler *const pHandler)=0
	Register an Object's notification handler. More...

virtual void	UnregisterObjectNotificationHandler (CPNS::IObject_NotificationHandler *const pHandler)=0
	Unregister an Object's notification handler. More...

virtual CPNS::Enums::ObjectTypes	GetObjectType () const =0
	Get the object type. More...

virtual CPNS::uint32	GetHandle () const =0
	Get a unique handle to the object if this object is handled by the trashcan. More...

virtual void	SetUserDataPtr (void const *const pData)=0
	Set a custom user ptr data. More...

virtual void *	GetUserDataPtr () const =0
	Get custom user ptr data. More...

virtual void	SetUserDataUInt32 (const CPNS::uint32 dwData)=0
	Set a custom user uint32 data. More...

virtual CPNS::uint32	GetUserDataUInt32 () const =0
	Get custom user uint32 data. More...

Detailed Description

This is the AudioLan dedicated audio remote controller's interface.

Member Function Documentation

virtual CPNS::IAudioLanRemoteDevice* CPNS::IAudioLanRemoteController::GetAcquiredRemoteDevice ( CPNS::uint16 const wIndex )

pure virtual

Returns: An acquired AudioLan remote device pointer.

virtual int CPNS::IAudioLanRemoteController::GetRemoteDeviceCount ( )

pure virtual

Get the number of available audio remote devices.

virtual CPNS::AudioLanSourceStreamChannel CPNS::IAudioLanRemoteController::GetSourceStreamChannelFromNameAndIndex	(	CPNS::char8 const *const	utf8SourceStreamName,
		CPNS::uint16 const	wChannelIndex
	)

pure virtual

Get source stream channel description from the source name and the channel index (0 based).

virtual CPNS::AudioLanSourceStream CPNS::IAudioLanRemoteController::GetSourceStreamFromName ( CPNS::char8 const *const utf8SourceStreamName )

pure virtual

Get source stream description from its name.

virtual CPNS::ISelectorItemList* CPNS::IAudioLanRemoteController::GetSourceStreamList ( )

pure virtual

Returns a selector item list containing all the source streams currently present in the network, without restriction.

virtual void CPNS::IAudioLanRemoteController::LeaveLinkMode ( )

pure virtual

Leave link mode and prevent new link mode during 2 seconds.

virtual void CPNS::IAudioLanRemoteController::Refresh ( )

pure virtual

Request a full refresh of remote device list.

virtual void CPNS::IAudioLanRemoteController::RegisterNotificationHandler ( CPNS::IAudioLanRemoteController_NotificationHandler *const pHandler )

pure virtual

Register an AudioLan Remote notification handler.

Parameters

[in] pHandler Pointer to the application object implementing IAudioLanRemote_NotificationHandler . If pHandler is NULL, clear all registered handlers.

virtual CPNS::boolean CPNS::IAudioLanRemoteController::SearchCompatibleTargetRemoteDevices ( CPNS::char8 const *const utf8sourceStreamName )

pure virtual

Reply done through the CPNS::IAudioLanRemoteController_NotificationHandler::OnAudioLanRemoteController_SearchCompatibleTargetRemoteDevicesReply notification.

Only one search can be performed at a time. Calling this method cancels previous search still running.

Parameters

utf8sourceStreamName Source stream name

Returns: TRUE if the search is initiated.

virtual void CPNS::IAudioLanRemoteController::UnregisterNotificationHandler ( CPNS::IAudioLanRemoteController_NotificationHandler *const pHandler )

pure virtual

Unregister an AudioLan Remote notification handler.

Parameters

[in] pHandler Pointer to the application object implementing IAudioLanRemote_NotificationHandler . If pHandler is NULL, clear all registered handlers.

Public Member Functions

Detailed Description

Member Function Documentation