net.rim.device.api.media.control
Interface AudioPathControl

All Superinterfaces:
Control

public interface AudioPathControl
extends Control

AudioPathControl provides access to changing the audio path on media streams.

Since:
JDE 4.2.0

Field Summary
static int AUDIO_PATH_BLUETOOTH
          Audio Path is Bluetooth SCO such as a paired Bluetooth enabled device, for example, a Bluetooth car kit.
static int AUDIO_PATH_BLUETOOTH_A2DP
          Audio Path is for a paired Bluetooth enabled device such as a Bluetooth stereo headset for listening to music.
static int AUDIO_PATH_HANDSET
          Audio Path is the earpiece on the BlackBerry device.
static int AUDIO_PATH_HANDSFREE
          Audio Path is the speakerphone on the BlackBerry device.
static int AUDIO_PATH_HEADSET
          Audio Path is the BlackBerry Hands-free Headset.
static int AUDIO_PATH_HEADSET_HANDSFREE
          Audio Path is the speakerphone on the BlackBerry device and the BlackBerry Hands-free Headset.
 
Method Summary
 int getAudioPath()
          Returns the current audio path.
 void setAudioPath(int newPath)
          Requests a change from the current audio path to the given audio path.
 

Field Detail

AUDIO_PATH_BLUETOOTH

public static final int AUDIO_PATH_BLUETOOTH
Audio Path is Bluetooth SCO such as a paired Bluetooth enabled device, for example, a Bluetooth car kit.
Since:
JDE 4.2.0

AUDIO_PATH_BLUETOOTH_A2DP

public static final int AUDIO_PATH_BLUETOOTH_A2DP
Audio Path is for a paired Bluetooth enabled device such as a Bluetooth stereo headset for listening to music.
Since:
JDE 4.3.0

AUDIO_PATH_HANDSET

public static final int AUDIO_PATH_HANDSET
Audio Path is the earpiece on the BlackBerry device.
Since:
JDE 4.2.0

AUDIO_PATH_HANDSFREE

public static final int AUDIO_PATH_HANDSFREE
Audio Path is the speakerphone on the BlackBerry device.
Since:
JDE 4.2.0

AUDIO_PATH_HEADSET

public static final int AUDIO_PATH_HEADSET
Audio Path is the BlackBerry Hands-free Headset.
Since:
JDE 4.2.0

AUDIO_PATH_HEADSET_HANDSFREE

public static final int AUDIO_PATH_HEADSET_HANDSFREE
Audio Path is the speakerphone on the BlackBerry device and the BlackBerry Hands-free Headset.
Since:
JDE 4.2.0
Method Detail

getAudioPath

public int getAudioPath()
Returns the current audio path.
Returns:
an enumerated integer representing the current audio path one of the AUDIO_PATH_ values.
Since:
JDE 4.2.0

setAudioPath

public void setAudioPath(int newPath)
                  throws MediaException,
                         IllegalArgumentException
Requests a change from the current audio path to the given audio path. The audio path may not be changed if the media stream does not have priority in changing the audio path. (eg. if a phone call is active)
Parameters:
newPath - The audio path to switch to; one of the AUDIO_PATH_ values.
Throws:
MediaException - if the change is not allowed.
IllegalArgumentException - if the newPath parameter is invalid.
Since:
JDE 4.2.0



Copyright 1999-2008 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.