Audio Service
[Mobile Services]

Detailed Description

This service groups the Audio functions.


Data Structures

struct  _AlpMblAudioDeviceList
struct  _AlpMblAudioVolumeRange

Defines

#define ALP_MBL_AUDIO_NOTIFICATION_CONNECTION_STATUS_CHANGE   ((AlpMblNotificationId) 1)
 The connecttion status of an audio device has changed.
#define ALP_MBL_AUDIO_NOTIFICATION_DEVICE_LIST_CHANGE   ((AlpMblNotificationId) 4)
 The list of devices has changed.
#define ALP_MBL_AUDIO_NOTIFICATION_MUTE_STATUS_CHANGE   ((AlpMblNotificationId) 3)
 The mute status of the device has changed.
#define ALP_MBL_AUDIO_NOTIFICATION_VOLUME_CHANGE   ((AlpMblNotificationId) 2)
 The volume level of the connected audio has changed.
#define AUDIO_DEVICE_BLUETOOTH   "Bluetooth"
 Bluetooth audio device type.
#define AUDIO_DEVICE_FILTER_ALL   0x00FF
 All audio device filter, connected or not connected device.
#define AUDIO_DEVICE_FILTER_ALL_CONNECTED   0x10FF
 All audio device filter, but only connected device.
#define AUDIO_DEVICE_FILTER_BLUETOOTH   0x0002
 Bluetooth audio device filter, connected or not connected device.
#define AUDIO_DEVICE_FILTER_BLUETOOTH_CONNECTED   0x1002
 Bluetooth audio device filter, but only connected device.
#define AUDIO_DEVICE_FILTER_INTERNAL   0x0001
 Filter for audio device search Internal audio device filter, connected or not connected device.
#define AUDIO_DEVICE_FILTER_INTERNAL_CONNETED   0x1001
 Internal audio device filter, but only connected device.
#define AUDIO_DEVICE_INTERNAL   "Internal"
 Type of audio device Internal audio device type.

Typedefs

typedef void(* AlpMblAudioConnectionStatusChangeCallbackPtr )(void *iUserDataP, AlpMblAudioDevice iAudioDevice, bool iConnectedF)
typedef char AlpMblAudioDevice [128]
typedef _AlpMblAudioDeviceList AlpMblAudioDeviceList
typedef void(* AlpMblAudioDeviceListChangeCallbackPtr )(void *iUserDataP, AlpMblAudioDeviceList iAudioDeviceList)
typedef unsigned short AlpMblAudioFilter
typedef void(* AlpMblAudioMuteStatusChangeCallbackPtr )(void *iUserDataP, bool iMuteStatus)
typedef unsigned short AlpMblAudioVolume
typedef void(* AlpMblAudioVolumeChangeCallbackPtr )(void *iUserDataP, AlpMblAudioVolume iVolume)
typedef _AlpMblAudioVolumeRange AlpMblAudioVolumeRange

Functions

alp_status_t alp_mbl_audio_get_connected_device (AlpMblAudioDevice *oAudioDeviceP)
alp_status_t alp_mbl_audio_get_devices (AlpMblAudioFilter iFilter, AlpMblAudioDeviceList *oAudioDeviceListP)
alp_status_t alp_mbl_audio_get_mute_status (bool *oMuteStatusP)
alp_status_t alp_mbl_audio_get_preferred_device (AlpMblAudioDevice *oAudioDeviceP)
alp_status_t alp_mbl_audio_get_volume (AlpMblAudioVolume *oVolumeP)
alp_status_t alp_mbl_audio_get_volume_range (AlpMblAudioVolumeRange *oVolumeRangeP)
alp_status_t alp_mbl_audio_set_connected_device (AlpMblAudioDevice iAudioDevice)
alp_status_t alp_mbl_audio_set_mute_status (bool iMuteStatus)
alp_status_t alp_mbl_audio_set_preferred_device (AlpMblAudioDevice iAudioDevice)
alp_status_t alp_mbl_audio_set_volume (AlpMblAudioVolume iVolume)

Define Documentation

#define ALP_MBL_AUDIO_NOTIFICATION_CONNECTION_STATUS_CHANGE   ((AlpMblNotificationId) 1)
 

The connecttion status of an audio device has changed.

#define ALP_MBL_AUDIO_NOTIFICATION_DEVICE_LIST_CHANGE   ((AlpMblNotificationId) 4)
 

The list of devices has changed.

#define ALP_MBL_AUDIO_NOTIFICATION_MUTE_STATUS_CHANGE   ((AlpMblNotificationId) 3)
 

The mute status of the device has changed.

#define ALP_MBL_AUDIO_NOTIFICATION_VOLUME_CHANGE   ((AlpMblNotificationId) 2)
 

The volume level of the connected audio has changed.

#define AUDIO_DEVICE_BLUETOOTH   "Bluetooth"
 

Bluetooth audio device type.

#define AUDIO_DEVICE_FILTER_ALL   0x00FF
 

All audio device filter, connected or not connected device.

#define AUDIO_DEVICE_FILTER_ALL_CONNECTED   0x10FF
 

All audio device filter, but only connected device.

#define AUDIO_DEVICE_FILTER_BLUETOOTH   0x0002
 

Bluetooth audio device filter, connected or not connected device.

#define AUDIO_DEVICE_FILTER_BLUETOOTH_CONNECTED   0x1002
 

Bluetooth audio device filter, but only connected device.

#define AUDIO_DEVICE_FILTER_INTERNAL   0x0001
 

Filter for audio device search Internal audio device filter, connected or not connected device.

#define AUDIO_DEVICE_FILTER_INTERNAL_CONNETED   0x1001
 

Internal audio device filter, but only connected device.

#define AUDIO_DEVICE_INTERNAL   "Internal"
 

Type of audio device Internal audio device type.

Typedef Documentation

typedef void(* AlpMblAudioConnectionStatusChangeCallbackPtr)(void *iUserDataP, AlpMblAudioDevice iAudioDevice, bool iConnectedF)
 

Callback prototype for ALP_MBL_AUDIO_NOTIFICATION_CONNECTION_STATUS_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.

typedef char AlpMblAudioDevice[128]
 

typedef struct _AlpMblAudioDeviceList AlpMblAudioDeviceList
 

typedef void(* AlpMblAudioDeviceListChangeCallbackPtr)(void *iUserDataP, AlpMblAudioDeviceList iAudioDeviceList)
 

Callback prototype for ALP_MBL_AUDIO_NOTIFICATION_DEVICE_LIST_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.
[in] iAudioDeviceList - List of audio devices. You have to free iAudioDeviceList.audioDeviceP when you have done with it using alp_mbl_free();

typedef unsigned short AlpMblAudioFilter
 

typedef void(* AlpMblAudioMuteStatusChangeCallbackPtr)(void *iUserDataP, bool iMuteStatus)
 

Callback prototype for ALP_MBL_AUDIO_NOTIFICATION_MUTE_STATUS_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.

typedef unsigned short AlpMblAudioVolume
 

typedef void(* AlpMblAudioVolumeChangeCallbackPtr)(void *iUserDataP, AlpMblAudioVolume iVolume)
 

Callback prototype for ALP_MBL_AUDIO_NOTIFICATION_VOLUME_CHANGE notification.

Parameters:
[in] iUserDataP - A pointer to user data info, given with the alp_mbl_add_observers() function call.

typedef struct _AlpMblAudioVolumeRange AlpMblAudioVolumeRange
 

Function Documentation

alp_status_t alp_mbl_audio_get_connected_device (  AlpMblAudioDevice *  oAudioDeviceP  ) 
 

Returns the name of an audio device if one is connected, else the error ALP_STATUS_MBL_AUDIO_NO_CONNECTED_DEVICE.

Parameters:
[out] oAudioDeviceP - A pointer to a AlpMblAudioDevice that will be the connected audio device upon return.
Returns:
ALP_STATUS_OK - The connected audio device has been retrieved successfuly.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_AUDIO_NO_CONNECTED_DEVICE - There is no audio device connected

alp_status_t alp_mbl_audio_get_devices (  AlpMblAudioFilter  iFilter,
AlpMblAudioDeviceList *  oAudioDeviceListP
) 
 

Gets the available audio devices.

Parameters:
[in] iFilter - A filter for audio devices. See defines AUDIO_DEVICE_FILTER_XXX.
[out] oAudioDeviceListP - A pointer to a AlpMblAudioDeviceList that will contains the audio device list upon return. It will be the responsability of the application to free this memory using the alp_mbl_free() API.
Returns:
ALP_STATUS_OK - The available audio devices have been retrieved successfuly.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

alp_status_t alp_mbl_audio_get_mute_status (  bool *  oMuteStatusP  ) 
 

Returns the mute status: true if the sound is mute, false if it's unmute.

Parameters:
[out] oMuteStatusP - A pointer to a bool that will be the mute status upon return.
Returns:
ALP_STATUS_OK - The connected audio device has been retrieved successfuly.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

alp_status_t alp_mbl_audio_get_preferred_device (  AlpMblAudioDevice *  oAudioDeviceP  ) 
 

Gets the preferred audio device.

Parameters:
[out] oAudioDeviceP - A pointer to a AlpMblAudioDevice that will be the preferred audio device upon return.
Returns:
ALP_STATUS_OK - The preferred audio has been retrieved successfuly.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

alp_status_t alp_mbl_audio_get_volume (  AlpMblAudioVolume *  oVolumeP  ) 
 

Returns the current volume of the connected device.

Parameters:
[out] oVolumeP - A pointer to a AlpMblAudioVolume that will contains the volume upon return.
Returns:
ALP_STATUS_OK - The current volume device has been retrieved successfuly.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_AUDIO_NO_CONNECTED_DEVICE - There is no audio device connected

alp_status_t alp_mbl_audio_get_volume_range (  AlpMblAudioVolumeRange *  oVolumeRangeP  ) 
 

Returns the volume range of the connected device.

Parameters:
[out] oVolumeRangeP - A pointer to a AlpMblAudioVolumeRange that will contains the volume range upon return.
Returns:
ALP_STATUS_OK - The volume range has been retrieved successfuly.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_AUDIO_NO_CONNECTED_DEVICE - There is no audio device connected

alp_status_t alp_mbl_audio_set_connected_device (  AlpMblAudioDevice  iAudioDevice  ) 
 

Connect an audio device.

Parameters:
[in] iAudioDevice - An AlpMblAudioDevice that is the audio device to connected.
Returns:
ALP_STATUS_OK - The audio device has been connected successfuly.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_INVALID_OBJECT - There is no call, so we cannot connect a device.

ALP_STATUS_MBL_INVALID_PARAMETER - The given device is not a valid one.

alp_status_t alp_mbl_audio_set_mute_status (  bool  iMuteStatus  ) 
 

Set the mute status.

Parameters:
[in] iMuteStatus - True to mute the audio, or false to unmute the audio.
Returns:
ALP_STATUS_OK - The audio device has been connected successfuly.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

alp_status_t alp_mbl_audio_set_preferred_device (  AlpMblAudioDevice  iAudioDevice  ) 
 

Sets the preferred audio device.

Parameters:
[in] iAudioDevice - The preferred audio device to set.
Returns:
ALP_STATUS_OK - The preferred audio has been set successfuly.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

alp_status_t alp_mbl_audio_set_volume (  AlpMblAudioVolume  iVolume  ) 
 

Sets the current volume of the connected device.

Parameters:
[in] iVolume - A AlpMblAudioVolume that contains the volume to set.
Returns:
ALP_STATUS_OK - The current volume device has been retrieved successfuly.

ALP_STATUS_MBL_IPC_ERROR - Communication problem between library and server.

ALP_STATUS_MBL_MEMORY_ERROR - System is out of enough memory.

ALP_STATUS_MBL_AUDIO_NO_CONNECTED_DEVICE - There is no audio device connected

ALP_STATUS_MBL_INVALID_PARAMETER - The required volume is out of range

Generated on Wed Jul 30 07:06:42 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.