CHAI SDK  Version 1.3
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
CPNS::IAudioLanLocalDevice_NotificationHandler Class Referenceabstract

Notification handler for IAudioLanLocalDevice. More...

Public Member Functions

virtual void OnAudioParameter_FormatModifierValue (CPNS::IAudioLanLocalDevice *const pNotifiedObject, CPNS::uint16 const wNumber, CPNS::uint16 const wValue, CPNS::UTF8String &strValue)=0
 Format a modifier parameter value string. More...
 
virtual void OnAudioParameter_Update (CPNS::IAudioLanLocalDevice *const pNotifiedObject, CPNS::uint16 const wNumber, CPNS::uint16 const wValue)=0
 A parameter hosted by an Audio device has been updated. More...
 
virtual void OnAudioTextParameter_Update (CPNS::IAudioLanLocalDevice *const pNotifiedObject, CPNS::uint16 const wNumber, CPNS::char8 const *const utf8ValueText)=0
 A parameter hosted by an Audio device has been updated. More...
 
virtual void OnAudioParameter_Commit (CPNS::IAudioLanLocalDevice *const pNotifiedObject, CPNS::uint32 const dwGroupID, CPNS::boolean const fApply)=0
 [Apply] or [Cancel] command has been triggered. More...
 
virtual void OnSourceStreamParameter_FormatModifierValue (CPNS::IAudioLanLocalDevice *const pNotifiedObject, CPNS::uint32 const dwStreamID, CPNS::uint16 const wNumber, CPNS::uint16 const wValue, CPNS::UTF8String &strValue)=0
 Format a modifier parameter value string. More...
 
virtual void OnSourceStreamParameter_Update (CPNS::IAudioLanLocalDevice *const pNotifiedObject, CPNS::uint32 const dwStreamID, CPNS::uint16 const wChannelIndex, CPNS::uint16 const wNumber, CPNS::uint16 const wValue)=0
 A parameter hosted by an Audio device has been updated. More...
 
virtual void OnSourceStreamTextParameter_Update (CPNS::IAudioLanLocalDevice *const pNotifiedObject, CPNS::uint32 const dwStreamID, CPNS::uint16 const wChannelIndex, CPNS::uint16 const wNumber, CPNS::char8 const *const utf8Value)=0
 A parameter hosted by an Audio device has been updated. More...
 
virtual void OnSourceStreamParameter_Commit (CPNS::IAudioLanLocalDevice *const pNotifiedObject, CPNS::uint32 const dwStreamID, CPNS::uint32 const dwGroupID, CPNS::boolean const fApply)=0
 [Apply] or [Cancel] command has been triggered. More...
 
virtual void OnOutputChannelParameter_FormatModifierValue (CPNS::IAudioLanLocalDevice *const pNotifiedObject, CPNS::uint16 const wNumber, CPNS::uint16 const wValue, CPNS::UTF8String &strValue)=0
 Format a modifier parameter value string. More...
 
virtual void OnOutputChannelParameter_Update (CPNS::IAudioLanLocalDevice *const pNotifiedObject, CPNS::uint32 const dwOutputChannelID, CPNS::uint16 const wNumber, CPNS::uint16 const wValue, CPNS::char8 const *const utf8ValueText)=0
 A parameter hosted by an Audio device has been updated. More...
 
virtual void OnOutputChannelTextParameter_Update (CPNS::IAudioLanLocalDevice *const pNotifiedObject, CPNS::uint32 const dwOutputChannelID, CPNS::uint16 const wNumber, CPNS::char8 const *const utf8Value)=0
 A parameter hosted by an Audio device has been updated. More...
 
virtual void OnOutputChannelParameter_Commit (CPNS::IAudioLanLocalDevice *const pNotifiedObject, CPNS::uint32 const dwOutputChannelID, CPNS::uint32 const dwGroupID, CPNS::boolean const fApply)=0
 [Apply] or [Cancel] command has been triggered. More...
 
virtual void OnClearConnection (CPNS::IAudioLanLocalDevice *const pNotifiedObject, CPNS::uint32 const dwOutputChannelID)=0
 
virtual void OnSetConnection (CPNS::IAudioLanLocalDevice *const pNotifiedObject, CPNS::uint32 const dwOutputChannelID, CPNS::char8 const *const utf8SourceStreamName, CPNS::uint16 const wChannelIndex)=0
 

Detailed Description

Member Function Documentation

virtual void CPNS::IAudioLanLocalDevice_NotificationHandler::OnAudioParameter_Commit ( CPNS::IAudioLanLocalDevice *const  pNotifiedObject,
CPNS::uint32 const  dwGroupID,
CPNS::boolean const  fApply 
)
pure virtual

[Apply] or [Cancel] command has been triggered.

The application code should get and apply the parameters edit values for the specified category.

Parameters
[in]pNotifiedObjectpointer to the audio device object receiving the message
[in]dwGroupIDthe group application ID
[in]fApplyTRUE to apply changes, FALSE to cancel changes
virtual void CPNS::IAudioLanLocalDevice_NotificationHandler::OnAudioParameter_FormatModifierValue ( CPNS::IAudioLanLocalDevice *const  pNotifiedObject,
CPNS::uint16 const  wNumber,
CPNS::uint16 const  wValue,
CPNS::UTF8String strValue 
)
pure virtual

Format a modifier parameter value string.

These parameters are identified by the message number, which is unique regardless the message type : Modifiers (0x4000 - 0x4FFF), Selectors (0x5000 - 0x5FFF), Text (0x6000 - 0x6FFF).

Parameters
[in]pNotifiedObjectPointer to the audio device object receiving the message
[in]wNumberThe parameter number
[in]wValueRaw value
[out]strValuetext value
virtual void CPNS::IAudioLanLocalDevice_NotificationHandler::OnAudioParameter_Update ( CPNS::IAudioLanLocalDevice *const  pNotifiedObject,
CPNS::uint16 const  wNumber,
CPNS::uint16 const  wValue 
)
pure virtual

A parameter hosted by an Audio device has been updated.

These parameters are identified by the message number, which is unique regardless the message type : Modifiers (0x4000 - 0x4FFF), Selectors (0x5000 - 0x5FFF), Text (0x6000 - 0x6FFF).

Remarks
This method is called only for not Text related parameters!
Parameters
[in]pNotifiedObjectPointer to the audio device object receiving the message
[in]wNumberThe parameter number
[in]wValueNew value
virtual void CPNS::IAudioLanLocalDevice_NotificationHandler::OnAudioTextParameter_Update ( CPNS::IAudioLanLocalDevice *const  pNotifiedObject,
CPNS::uint16 const  wNumber,
CPNS::char8 const *const  utf8ValueText 
)
pure virtual

A parameter hosted by an Audio device has been updated.

These parameters are identified by the message number, which is unique regardless the message type : Modifiers (0x4000 - 0x4FFF), Selectors (0x5000 - 0x5FFF), Text (0x6000 - 0x6FFF).

Remarks
This method is called only for Text related parameters!
Parameters
[in]pNotifiedObjectPointer to the audio device object receiving the message
[in]wNumberThe parameter number
[in]utf8ValueTextNew value
virtual void CPNS::IAudioLanLocalDevice_NotificationHandler::OnOutputChannelParameter_Commit ( CPNS::IAudioLanLocalDevice *const  pNotifiedObject,
CPNS::uint32 const  dwOutputChannelID,
CPNS::uint32 const  dwGroupID,
CPNS::boolean const  fApply 
)
pure virtual

[Apply] or [Cancel] command has been triggered.

The application code should get and apply the parameters edit values for the specified category.

Parameters
[in]pNotifiedObjectPointer to the audio device object receiving the message
[in]dwOutputChannelIDthe output channel application ID
[in]dwGroupIDthe group application ID
[in]fApplyTRUE to apply changes, FALSE to cancel changes
virtual void CPNS::IAudioLanLocalDevice_NotificationHandler::OnOutputChannelParameter_FormatModifierValue ( CPNS::IAudioLanLocalDevice *const  pNotifiedObject,
CPNS::uint16 const  wNumber,
CPNS::uint16 const  wValue,
CPNS::UTF8String strValue 
)
pure virtual

Format a modifier parameter value string.

These parameters are identified by the message number, which is unique regardless the message type : Modifiers (0x4000 - 0x4FFF), Selectors (0x5000 - 0x5FFF), Text (0x6000 - 0x6FFF).

Parameters
[in]pNotifiedObjectPointer to the audio device object receiving the message
[in]wNumberThe parameter number
[in]wValueRaw value
[out]strValuetext value
virtual void CPNS::IAudioLanLocalDevice_NotificationHandler::OnOutputChannelParameter_Update ( CPNS::IAudioLanLocalDevice *const  pNotifiedObject,
CPNS::uint32 const  dwOutputChannelID,
CPNS::uint16 const  wNumber,
CPNS::uint16 const  wValue,
CPNS::char8 const *const  utf8ValueText 
)
pure virtual

A parameter hosted by an Audio device has been updated.

These parameters are identified by the message number, which is unique regardless the message type : Modifiers (0x4000 - 0x4FFF), Selectors (0x5000 - 0x5FFF), Text (0x6000 - 0x6FFF).

Remarks
This method is called only for non-Text related parameters!
Parameters
[in]pNotifiedObjectPointer to the audio device object receiving the message
[in]dwOutputChannelIDthe output channel application ID
[in]wNumberThe parameter number
[in]wValueNew value
[in]utf8ValueTextText value (selector only)
virtual void CPNS::IAudioLanLocalDevice_NotificationHandler::OnOutputChannelTextParameter_Update ( CPNS::IAudioLanLocalDevice *const  pNotifiedObject,
CPNS::uint32 const  dwOutputChannelID,
CPNS::uint16 const  wNumber,
CPNS::char8 const *const  utf8Value 
)
pure virtual

A parameter hosted by an Audio device has been updated.

These parameters are identified by the message number, which is unique regardless the message type : Modifiers (0x4000 - 0x4FFF), Selectors (0x5000 - 0x5FFF), Text (0x6000 - 0x6FFF).

Parameters
[in]pNotifiedObjectPointer to the audio device object receiving the message
[in]dwOutputChannelIDthe output channel application ID
[in]wNumberThe parameter number
[in]utf8ValueNew value
virtual void CPNS::IAudioLanLocalDevice_NotificationHandler::OnSourceStreamParameter_Commit ( CPNS::IAudioLanLocalDevice *const  pNotifiedObject,
CPNS::uint32 const  dwStreamID,
CPNS::uint32 const  dwGroupID,
CPNS::boolean const  fApply 
)
pure virtual

[Apply] or [Cancel] command has been triggered.

The application code should get and apply the parameters edit values for the specified category.

Parameters
[in]pNotifiedObjectPointer to the audio device object receiving the message
[in]dwStreamIDthe stream application ID
[in]dwGroupIDthe group application ID
[in]fApplyTRUE to apply changes, FALSE to cancel changes
virtual void CPNS::IAudioLanLocalDevice_NotificationHandler::OnSourceStreamParameter_FormatModifierValue ( CPNS::IAudioLanLocalDevice *const  pNotifiedObject,
CPNS::uint32 const  dwStreamID,
CPNS::uint16 const  wNumber,
CPNS::uint16 const  wValue,
CPNS::UTF8String strValue 
)
pure virtual

Format a modifier parameter value string.

These parameters are identified by the message number, which is unique regardless the message type : Modifiers (0x4000 - 0x4FFF), Selectors (0x5000 - 0x5FFF), Text (0x6000 - 0x6FFF).

Parameters
[in]pNotifiedObjectPointer to the audio device object receiving the message
[in]dwStreamIDthe stream application ID
[in]wNumberThe parameter number
[in]wValueRaw value
[out]strValuetext value
virtual void CPNS::IAudioLanLocalDevice_NotificationHandler::OnSourceStreamParameter_Update ( CPNS::IAudioLanLocalDevice *const  pNotifiedObject,
CPNS::uint32 const  dwStreamID,
CPNS::uint16 const  wChannelIndex,
CPNS::uint16 const  wNumber,
CPNS::uint16 const  wValue 
)
pure virtual

A parameter hosted by an Audio device has been updated.

These parameters are identified by the message number, which is unique regardless the message type : Modifiers (0x4000 - 0x4FFF), Selectors (0x5000 - 0x5FFF), Text (0x6000 - 0x6FFF).

Remarks
This method is called only for not Text related parameters!
Parameters
[in]pNotifiedObjectPointer to the audio device object receiving the message
[in]dwStreamIDthe stream application ID
[in]wNumberThe parameter number
[in]wValueNew value
virtual void CPNS::IAudioLanLocalDevice_NotificationHandler::OnSourceStreamTextParameter_Update ( CPNS::IAudioLanLocalDevice *const  pNotifiedObject,
CPNS::uint32 const  dwStreamID,
CPNS::uint16 const  wChannelIndex,
CPNS::uint16 const  wNumber,
CPNS::char8 const *const  utf8Value 
)
pure virtual

A parameter hosted by an Audio device has been updated.

These parameters are identified by the message number, which is unique regardless the message type : Modifiers (0x4000 - 0x4FFF), Selectors (0x5000 - 0x5FFF), Text (0x6000 - 0x6FFF).

Parameters
[in]pNotifiedObjectPointer to the audio device object receiving the message
[in]dwStreamIDthe stream application ID
[in]wChannelIndexthe channel index.
[in]wNumberThe parameter number
[in]utf8ValueNew value