<ZDKAudioEventsHandler> Protocol Reference

Inheritance diagram for <ZDKAudioEventsHandler>:

Instance Methods
(void)	- onInputLevelChange:level:
	Notify upon input volume level changed. More...
(void)	- onOutputLevelChange:level:
	Notify upon output volume level changed. More...
(void)	- onRingLevelChange:level:
	Notify upon Ringing volume level changed. More...
(void)	- onEnergyLevelChange:outLevel:
	Notify upon input/output sound energy level changed. More...
(void)	- onDeviceStateChange:deviceState:
	Notify upon audio device changed its state. More...
(void)	- onDeviceError:deviceState:
	An error occurred with an audio device. More...
(void)	- onDeviceOpenError:
	An error occurred when trying to open an audio device. More...
(NSString *)	- handlesDescription
Instance Methods inherited from <ZDKEventHandle>
(long int)	- eventHandle
(NSString *)	- handlesDescription

Method Documentation

handlesDescription

- (NSString *) handlesDescription

optional

Reimplemented from <ZDKEventHandle>.

onDeviceError:deviceState:

- (void) onDeviceError: (id< ZDKAudioDevice >)  audioDevice deviceState: (ZDKAudioDeviceState)  deviceState

optional

An error occurred with an audio device.

An error occurred, usually when attempting to open a device. This is an error coming from the OS API. Audio configuration diagnostic or actual user action is recommended.

Parameters

[in]	audioDevice	The audio device
[in]	deviceState	Audio device state

See also

ZDKAudioDevice, AudioDeviceState

onDeviceOpenError:

- (void) onDeviceOpenError: (NSArray *)  deviceList

optional

An error occurred when trying to open an audio device.

An error occurred when attempting to open an audio device or an internal processing stream. Audio configuration diagnostic or actual user action is recommended.

Parameters

[in]

deviceList

A list of the devices which failed to open

See also

ZDKAudioDevice

onDeviceStateChange:deviceState:

- (void) onDeviceStateChange: (id< ZDKAudioDevice >)  audioDevice deviceState: (ZDKAudioDeviceState)  deviceState

optional

Notify upon audio device changed its state.

Parameters

[in]	audioDevice	The audio device
[in]	deviceState	Audio device state

See also

ZDKAudioDevice, AudioDeviceState

onEnergyLevelChange:outLevel:

- (void) onEnergyLevelChange: (double)  inLevel outLevel: (double)  outLevel

optional

Notify upon input/output sound energy level changed.

This callback is fired when the audio subsystem detects a change in the sound energy levels for the input (microphone) and/or output (speaker) measured in dBm0.

The sound energy density is measured one and only when there is opened audio device - e.g. during a call or while playing a sound!

Parameters

[in]	inLevel	Input/microphone energy level in dBm0
[in]	outLevel	Output/speaker energy level in dBm0

onInputLevelChange:level:

- (void) onInputLevelChange: (id< ZDKAudioDevice >)  audioDevice level: (double)  level

optional

Notify upon input volume level changed.

This callback is fired when the audio subsystem detects a change in the input volume settings caused by external factors (for example the user changing the input device volume from the system mixer).

The rate of this callback is controlled by the delta setting configured by zdkAudioEndpointControl::AudioDeltaLevel().

Parameters

[in]	audioDevice	The audio device
[in]	level	Input level from 0.0 (silent) to 1.0 (full volume)

See also

ZDKAudioDevice

onOutputLevelChange:level:

- (void) onOutputLevelChange: (id< ZDKAudioDevice >)  audioDevice level: (double)  level

optional

Notify upon output volume level changed.

This callback is fired when the audio subsystem detects a change in the output volume settings caused by external factors (for example the user changing the output device volume from the system mixer).

The rate of this callback is controlled by the delta setting configured by zdkAudioEndpointControl::AudioDeltaLevel().

Parameters

[in]	audioDevice	The audio device
[in]	level	Output level from 0.0 (silent) to 1.0 (full volume)

See also

ZDKAudioDevice

onRingLevelChange:level:

- (void) onRingLevelChange: (id< ZDKAudioDevice >)  audioDevice level: (double)  level

optional

Notify upon Ringing volume level changed.

This callback is fired when the audio subsystem detects a change in the Ringing volume settings caused by external factors (for example the user changing the ring device volume from the system mixer).

The rate of this callback is controlled by the delta setting configured by zdkAudioEndpointControl::AudioDeltaLevel().

Parameters

[in]	audioDevice	The audio device
[in]	level	Ringing level from 0.0 (silent) to 1.0 (full volume)

See also

ZDKAudioDevice

---

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

• EventHandlers/ZDKAudioEventsHandler.h