Sound

Detailed Description

This part is describes the sound module of multimedia framework. Sound module provides APIs to implement controlling volume information, changing sound output or input direction.


Enumerations

enum  MMSoundPathType {
  MM_SOUND_PATH_OUT_HFK = 0x00000001, MM_SOUND_PATH_OUT_EARPHONE = 0x00000002, MM_SOUND_PATH_OUT_SPEAKER = 0x00000004, MM_SOUND_PATH_OUT_RECEIVER = 0x00000008,
  MM_SOUND_PATH_OUT_BLUETOOTH = 0x00000010, MM_SOUND_PATH_IN_MIC = 0x00010000, MM_SOUND_PATH_IN_PHONE_MIC = 0x00020000, MM_SOUND_PATH_IN_EARPHONE_MIC = 0x00040000,
  MM_SOUND_PATH_IN_HFK_MIC = 0x00080000, MM_SOUND_PATH_OUT_HFK = 0x00000001, MM_SOUND_PATH_OUT_EARPHONE = 0x00000002, MM_SOUND_PATH_OUT_SPEAKER = 0x00000004,
  MM_SOUND_PATH_OUT_RECEIVER = 0x00000008, MM_SOUND_PATH_OUT_BLUETOOTH = 0x00000010, MM_SOUND_PATH_IN_MIC = 0x00010000, MM_SOUND_PATH_IN_PHONE_MIC = 0x00020000,
  MM_SOUND_PATH_IN_EARPHONE_MIC = 0x00040000, MM_SOUND_PATH_IN_HFK_MIC = 0x00080000
}
enum  MMSoundPathType {
  MM_SOUND_PATH_OUT_HFK = 0x00000001, MM_SOUND_PATH_OUT_EARPHONE = 0x00000002, MM_SOUND_PATH_OUT_SPEAKER = 0x00000004, MM_SOUND_PATH_OUT_RECEIVER = 0x00000008,
  MM_SOUND_PATH_OUT_BLUETOOTH = 0x00000010, MM_SOUND_PATH_IN_MIC = 0x00010000, MM_SOUND_PATH_IN_PHONE_MIC = 0x00020000, MM_SOUND_PATH_IN_EARPHONE_MIC = 0x00040000,
  MM_SOUND_PATH_IN_HFK_MIC = 0x00080000, MM_SOUND_PATH_OUT_HFK = 0x00000001, MM_SOUND_PATH_OUT_EARPHONE = 0x00000002, MM_SOUND_PATH_OUT_SPEAKER = 0x00000004,
  MM_SOUND_PATH_OUT_RECEIVER = 0x00000008, MM_SOUND_PATH_OUT_BLUETOOTH = 0x00000010, MM_SOUND_PATH_IN_MIC = 0x00010000, MM_SOUND_PATH_IN_PHONE_MIC = 0x00020000,
  MM_SOUND_PATH_IN_EARPHONE_MIC = 0x00040000, MM_SOUND_PATH_IN_HFK_MIC = 0x00080000
}

Functions

int MMSoundSetVolume (int volume)
int MMSoundGetVolume (int *vol)
int MMSoundSetMute (bool mute)
int MMSoundIsMute (bool *mute)
int MMSoundGrabPath (int path, int *grab_id)
int MMSoundReleasePath (int grab_id)
int MMSoundSetPath (int path)
int MMSoundGetPath (int *path)

Enumeration Type Documentation

enum MMSoundPathType

Enumerations of audio output path.

Enumerator:
MM_SOUND_PATH_OUT_HFK  Sound path for Hands Free Kit
MM_SOUND_PATH_OUT_EARPHONE  Sound path for Earphone
MM_SOUND_PATH_OUT_SPEAKER  Sound path for Speaker
MM_SOUND_PATH_OUT_RECEIVER  Sound path for Receiver
MM_SOUND_PATH_OUT_BLUETOOTH  Sound path for Bluetooth
MM_SOUND_PATH_IN_MIC  Sound path for Microphone
MM_SOUND_PATH_IN_PHONE_MIC  Sound path for phone
MM_SOUND_PATH_IN_EARPHONE_MIC  Sound path for Earphone mic
MM_SOUND_PATH_IN_HFK_MIC  Sound path for Hands Free Kit mic
MM_SOUND_PATH_OUT_HFK  Sound path for Hands Free Kit
MM_SOUND_PATH_OUT_EARPHONE  Sound path for Earphone
MM_SOUND_PATH_OUT_SPEAKER  Sound path for Speaker
MM_SOUND_PATH_OUT_RECEIVER  Sound path for Receiver
MM_SOUND_PATH_OUT_BLUETOOTH  Sound path for Bluetooth
MM_SOUND_PATH_IN_MIC  Sound path for Microphone
MM_SOUND_PATH_IN_PHONE_MIC  Sound path for phone
MM_SOUND_PATH_IN_EARPHONE_MIC  Sound path for Earphone mic
MM_SOUND_PATH_IN_HFK_MIC  Sound path for Hands Free Kit mic

enum MMSoundPathType

Enumerations of audio output path.

Enumerator:
MM_SOUND_PATH_OUT_HFK  Sound path for Hands Free Kit
MM_SOUND_PATH_OUT_EARPHONE  Sound path for Earphone
MM_SOUND_PATH_OUT_SPEAKER  Sound path for Speaker
MM_SOUND_PATH_OUT_RECEIVER  Sound path for Receiver
MM_SOUND_PATH_OUT_BLUETOOTH  Sound path for Bluetooth
MM_SOUND_PATH_IN_MIC  Sound path for Microphone
MM_SOUND_PATH_IN_PHONE_MIC  Sound path for phone
MM_SOUND_PATH_IN_EARPHONE_MIC  Sound path for Earphone mic
MM_SOUND_PATH_IN_HFK_MIC  Sound path for Hands Free Kit mic
MM_SOUND_PATH_OUT_HFK  Sound path for Hands Free Kit
MM_SOUND_PATH_OUT_EARPHONE  Sound path for Earphone
MM_SOUND_PATH_OUT_SPEAKER  Sound path for Speaker
MM_SOUND_PATH_OUT_RECEIVER  Sound path for Receiver
MM_SOUND_PATH_OUT_BLUETOOTH  Sound path for Bluetooth
MM_SOUND_PATH_IN_MIC  Sound path for Microphone
MM_SOUND_PATH_IN_PHONE_MIC  Sound path for phone
MM_SOUND_PATH_IN_EARPHONE_MIC  Sound path for Earphone mic
MM_SOUND_PATH_IN_HFK_MIC  Sound path for Hands Free Kit mic

Function Documentation

int MMSoundGetPath ( int *  path  ) 

This function retreives current sound device path.

Parameters:
path [out] Current sound device path
Returns:
This function returns zero on success, or negative value with error code.
Remarks:
See also:
MMSoundSetPath

int MMSoundGetVolume ( int *  vol  ) 

This function is to retreive volume of sound device.

Parameters:
vol [out] Current volume level.
Returns:
This function returns zero on success, or negative value with error code.
Remarks:
Volume range is from MM_VOLUME_LEVEL_MIN to MM_VOLUME_LEVEL_MAX which is defined in <mm_types.h>.
See also:
MMSoundSetVolume

int MMSoundGrabPath ( int  path,
int *  grab_id 
)

This function is to grab sound device path.

Parameters:
path [in] Sound device path to grab.
grab_id [out] Grabbed id of sound path
Returns:
This function returns zero on success, or negative value with error code.
Remarks:
See also:
MMSoundReleasePath

int MMSoundIsMute ( bool *  mute  ) 

This function retreives if volume is muted or not.

Parameters:
mute [out] TRUE if volume is muted, or FALSE.
Returns:
This function returns zero on success, or negative value with error code.
Remarks:
See also:
MMSoundSetMute

int MMSoundReleasePath ( int  grab_id  ) 

This function is to release sound device path which is grabbed.

Parameters:
grab_id [in] Grabbed id of sound device path.
Returns:
This function returns zero on success, or negative value with error code.
Remarks:
See also:
MMSoundGrabPath

int MMSoundSetMute ( bool  mute  ) 

This function is to set mute of sound device.

Parameters:
mute [in] Mute.
Returns:
This function returns zero on success, or negative value with error code.
Remarks:
See also:
MMSoundIsMute

int MMSoundSetPath ( int  path  ) 

This function is to set sound device path.

Parameters:
path [in] Sound device path
Returns:
This function returns zero on success, or negative value with error code.
Remarks:
See also:
MMSoundGetPath

int MMSoundSetVolume ( int  volume  ) 

This function is to set volume of sound device.

Parameters:
volume [in] Volume level.
Returns:
This function returns zero on success, or negative value with error code.
Remarks:
Volume range is from MM_VOLUME_LEVEL_MIN to MM_VOLUME_LEVEL_MAX which is defined in <mm_types.h>.
See also:
MMSoundGetVolume

Generated on Mon Mar 31 01:01:00 2008 by  doxygen 1.5.4