CPNS::AudioLanExtension Class Reference

Factory class used to create AudioLan objects. More...

Static Public Member Functions
static CPNS::IAudioLanLocalDevice *	AddAudioLocalDevice (CPNS::ICHAI *const pCHAI, CPNS::uint16 const wModelID, CPNS::uint32 const dwDuplicateNumber, CPNS::Enums::DuplicateModes const duplicateMode, CPNS::boolean const fHidden, CPNS::CombinedExtendedDeviceCapabilities const extDevCaps, CPNS::char8 const *const utf8ModelName)
	Add a new Audio local device to the CHAI. More...
static CPNS::IAudioLanRemoteController *	GetAudioLanRemoteController (CPNS::ICHAI *const pCHAI, CPNS::boolean const fEnableTargetCache)
	Get the AudioLan remote controller object. More...

Detailed Description

Factory class used to create AudioLan objects.

Warning

Any object issued from this class is owned or related the the CHAI used during the creation/get.

Member Function Documentation

static CPNS::IAudioLanLocalDevice* CPNS::AudioLanExtension::AddAudioLocalDevice ( CPNS::ICHAI *const  pCHAI, CPNS::uint16 const  wModelID, CPNS::uint32 const  dwDuplicateNumber, CPNS::Enums::DuplicateModes const  duplicateMode, CPNS::boolean const  fHidden, CPNS::CombinedExtendedDeviceCapabilities const  extDevCaps, CPNS::char8 const *const  utf8ModelName  )

static

Add a new Audio local device to the CHAI.

This device is aimed to host audio-management. The behavior of this device and its children, and the set of available parameters automatically exposed are defined by the selected Audio Mode.

Remarks

The returned pointer is related to an object handled by the CHAI; do not delete it! Using this method in connected mode implies usage of ICHAI::RedeclareAllDevices()

Parameters

[in]	pCHAI	The CHAI managing the new device.
[in]	wModelID	Device model ID code. This argument is not relevant if you provided a SDKKey during the CHAI creation. In this case the modelID is overridden by the one provided in the key.
[in]	dwDuplicateNumber	Preferred duplicate number for DM_Auto mode (might change in case of conflict), or requested number for DM_Fixed mode.
[in]	duplicateMode	Duplicate resolution mode
[in]	fHidden	TRUE if the device is hidden
[in]	extDevCaps	Combination of ExtendedDeviceCapabilities flags
[in]	utf8ModelName	Model name

Returns

a pointer to the new device object, or NULL if the device can't be added (in case of unsolved duplicate conflict, or if bad brand ID)

static CPNS::IAudioLanRemoteController* CPNS::AudioLanExtension::GetAudioLanRemoteController ( CPNS::ICHAI *const  pCHAI, CPNS::boolean const  fEnableTargetCache  )

static

Get the AudioLan remote controller object.

This object is a aimed to remote control audio connections.

Parameters

[in]	pCHAI	The CHAI managing the new device.
[in]	fEnableTargetCache	TRUE to enable caching description data for target side. Source side caching is always enabled.

Returns

a pointer to the remote controller whose lifetime is the same than its related CHAI.