com.docomo_um.module.net
クラス VoiceController

java.lang.Object
  com.docomo_um.module.net.ModemController
      com.docomo_um.module.net.VoiceController

public abstract class VoiceController
extends ModemController

音声通話制御を表すクラスです。

発信は、createSession(String) を使用してVoiceSession のインスタンスを作成し、作成したインスタンスで音声発信と切断を管理します。
着信は、setModemControllerListener(ModemControllerListener) で登録したリスナの引数として渡されるVoiceSession のインスタンスで音声着信と切断を管理します。

関連項目:

ModemController, VoiceSession

フィールドの概要

static int	ARRIVALCALL_ACTION_ANSWERING 通話中の着信呼動作の一つとして、留守番電話を表します。
static int	ARRIVALCALL_ACTION_CALL_WAIT 通話中の着信呼動作の一つとして、通常着信を表します。
static int	ARRIVALCALL_ACTION_REDIRECT 通話中の着信呼動作の一つとして、転送電話を表します。
static int	ARRIVALCALL_ACTION_REJECT 通話中の着信呼動作の一つとして、着信拒否を表します。
static int	AVAILABLE_FUNCTION_TYPE_CALL_WAIT 音声通話制御の機能の一つとして、コールウェイトを表します。
static int	AVAILABLE_FUNCTION_TYPE_DTMF 音声通話制御の機能の一つとして、DTMF送信を表します。
static int	AVAILABLE_FUNCTION_TYPE_ECHO_CANCELLER 音声通話制御の機能の一つとして、エコーキャンセラを表します。
static int	AVAILABLE_FUNCTION_TYPE_NOISE_CANCELLER 音声通話制御の機能の一つとして、ノイズキャンセラを表します。
static int	AVAILABLE_FUNCTION_TYPE_RECEIVER_VOLUME_CONTROL 音声通話制御の機能の一つとして、受話音量設定を表します。
static int	AVAILABLE_FUNCTION_TYPE_SENDER_VOLUME_CONTROL 音声通話制御の機能の一つとして、送話音量設定を表します。

クラス com.docomo_um.module.net.ModemController から継承されたフィールド

CS_VOICE, OTHER_CALL_WAITING, OTHER_CBS, OTHER_ETWS, OTHER_SMS, OTHER_USSD, PS_IP, PS_PPP, TYPE_CS, TYPE_OTHER, TYPE_PS

メソッドの概要

void	changeHoldStatus() 保留呼を通話呼に変更します。
Session	createSession(java.lang.String destination) 音声通話の接続を表すインスタンスを生成します。
int	getArrivalCallAction() 通話中の着信呼動作のサービスを取得します。
int[]	getAvailableFunction() 音声通話制御がサポートする機能を取得します。
Session	getConnectedSession() 現在音声通話が通話呼のSessionを取得します。
int	getReceiverVolume() 受話音量を取得します。
boolean	isDriveMode() 公共モード(ドライブモード)の有効／無効を取得します。
boolean	isEchoCanceller() エコーキャンセラの有効/無効を取得します。
boolean	isNoiseCanceller() ノイズキャンセラの有効/無効を取得します。
boolean	isSenderVolumeMute() 送話音量ミュートの有効/無効を取得します。
void	setArrivalCallAction(int action) 通話中の着信呼動作のサービスを設定します。
void	setCallWaiting(boolean enable) キャッチホンサービスの有効／無効を設定します。
void	setDriveMode(boolean enable) 公共モード(ドライブモード)の有効／無効を設定します。
void	setEchoCanceller(boolean enabled) エコーキャンセラの有効/無効を設定します。
void	setModemControllerListener(ModemControllerListener listener) リスナを登録します。
void	setNoiseCanceller(boolean enabled) ノイズキャンセラの有効/無効を設定します。
void	setReceiverVolume(int rate) 受話音量を設定します。
void	setSenderVolumeMute(boolean enabled) 送話音量ミュートの有効/無効を設定します。

クラス com.docomo_um.module.net.ModemController から継承されたメソッド

getSupportedFunction

クラス java.lang.Object から継承されたメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait

フィールドの詳細

AVAILABLE_FUNCTION_TYPE_SENDER_VOLUME_CONTROL

public static final int AVAILABLE_FUNCTION_TYPE_SENDER_VOLUME_CONTROL

音声通話制御の機能の一つとして、送話音量設定を表します。

関連項目:

getAvailableFunction(), 定数フィールド値

AVAILABLE_FUNCTION_TYPE_RECEIVER_VOLUME_CONTROL

public static final int AVAILABLE_FUNCTION_TYPE_RECEIVER_VOLUME_CONTROL

音声通話制御の機能の一つとして、受話音量設定を表します。

関連項目:

getAvailableFunction(), 定数フィールド値

AVAILABLE_FUNCTION_TYPE_ECHO_CANCELLER

public static final int AVAILABLE_FUNCTION_TYPE_ECHO_CANCELLER

音声通話制御の機能の一つとして、エコーキャンセラを表します。

関連項目:

getAvailableFunction(), 定数フィールド値

AVAILABLE_FUNCTION_TYPE_NOISE_CANCELLER

public static final int AVAILABLE_FUNCTION_TYPE_NOISE_CANCELLER

音声通話制御の機能の一つとして、ノイズキャンセラを表します。

関連項目:

getAvailableFunction(), 定数フィールド値

AVAILABLE_FUNCTION_TYPE_CALL_WAIT

public static final int AVAILABLE_FUNCTION_TYPE_CALL_WAIT

音声通話制御の機能の一つとして、コールウェイトを表します。

関連項目:

getAvailableFunction(), 定数フィールド値

AVAILABLE_FUNCTION_TYPE_DTMF

public static final int AVAILABLE_FUNCTION_TYPE_DTMF

音声通話制御の機能の一つとして、DTMF送信を表します。

関連項目:

getAvailableFunction(), 定数フィールド値

ARRIVALCALL_ACTION_REDIRECT

public static final int ARRIVALCALL_ACTION_REDIRECT

通話中の着信呼動作の一つとして、転送電話を表します。

関連項目:

getArrivalCallAction(), 定数フィールド値

ARRIVALCALL_ACTION_ANSWERING

public static final int ARRIVALCALL_ACTION_ANSWERING

通話中の着信呼動作の一つとして、留守番電話を表します。

関連項目:

getArrivalCallAction(), 定数フィールド値

ARRIVALCALL_ACTION_REJECT

public static final int ARRIVALCALL_ACTION_REJECT

通話中の着信呼動作の一つとして、着信拒否を表します。

関連項目:

getArrivalCallAction(), 定数フィールド値

ARRIVALCALL_ACTION_CALL_WAIT

public static final int ARRIVALCALL_ACTION_CALL_WAIT

通話中の着信呼動作の一つとして、通常着信を表します。

関連項目:

getArrivalCallAction(), 定数フィールド値

メソッドの詳細

getAvailableFunction

public int[] getAvailableFunction()

音声通話制御がサポートする機能を取得します。

戻り値:

サポートする機能の一覧を返します。サポートする機能がない場合は null を返します。

関連項目:

AVAILABLE_FUNCTION_TYPE_CALL_WAIT, AVAILABLE_FUNCTION_TYPE_DTMF, AVAILABLE_FUNCTION_TYPE_ECHO_CANCELLER, AVAILABLE_FUNCTION_TYPE_NOISE_CANCELLER, AVAILABLE_FUNCTION_TYPE_RECEIVER_VOLUME_CONTROL, AVAILABLE_FUNCTION_TYPE_SENDER_VOLUME_CONTROL

setReceiverVolume

public void setReceiverVolume(int rate)
                       throws SessionException,
                              DeviceException

受話音量を設定します。
受話音量がサポートされていない状態で、本メソッドを呼んだ場合は何もしません。

受話音量の設定は不揮発保存されます。

パラメータ:

rate - 0～100の範囲で指定します。

例外:

java.lang.IllegalArgumentException - rateに範囲外の値が指定された場合に発生します。

SessionException - 内部エラーにより処理が中断した場合に発生します。

DeviceException - デバイスの故障により、受話音量の設定に失敗した場合に発生します。

setSenderVolumeMute

public void setSenderVolumeMute(boolean enabled)
                         throws SessionException,
                                DeviceException

送話音量ミュートの有効/無効を設定します。 送話音量がサポートされていない状態で、本メソッドを呼んだ場合は何もしません。

送話音量ミュートの設定は不揮発保存されません。再起動した場合、設定は初期値（無効）になります。

パラメータ:

enabled - 送話音をミュートにする場合はtrueを、そうでない場合はfalseを指定します。

例外:

SessionException - 内部エラーにより処理が中断した場合に発生します。

DeviceException - デバイスの故障により、送話音量ミュートの設定に失敗した場合に発生します。

setEchoCanceller

public void setEchoCanceller(boolean enabled)
                      throws SessionException,
                             DeviceException

エコーキャンセラの有効/無効を設定します。 エコーキャンセラがサポートされていない状態で、本メソッドを呼んだ場合は何もしません。

エコーキャンセラの有効/無効設定は不揮発保存されます。

パラメータ:

enabled - エコーキャンセラを有効にする場合はtrueを、そうでない場合はfalseを指定します。

例外:

SessionException - 内部エラーにより処理が中断した場合に発生します。

DeviceException - デバイスの故障により、エコーキャンセラの設定に失敗した場合に発生します。

setNoiseCanceller

public void setNoiseCanceller(boolean enabled)
                       throws SessionException,
                              DeviceException

ノイズキャンセラの有効/無効を設定します。 ノイズキャンセラがサポートされていない状態で、本メソッドを呼んだ場合は何もしません。

ノイズキャンセラの有効/無効設定は不揮発保存されます。

パラメータ:

enabled - ノイズキャンセラを有効にする場合はtrueを、そうでない場合はfalseを指定します。

例外:

SessionException - 内部エラーにより処理が中断した場合に発生します。

DeviceException - デバイスの故障により、ノイズキャンセラの設定に失敗した場合に発生します。

setArrivalCallAction

public void setArrivalCallAction(int action)
                          throws SessionException,
                                 DeviceException

通話中の着信呼動作のサービスを設定します。(転送電話、留守番電話、着信拒否、通常着信)

本メソッドで通話中の着信呼動作を通常着信(ARRIVALCALL_ACTION_CALL_WAIT)に設定した場合は、 ModemControllerListener.onReceived(ModemController, Session)がコールバックされることで着信が通知されます。
通常着信（ARRIVALCALL_ACTION_CALL_WAIT）以外が設定された場合は着信されません。
ただし、次の状態において第2呼着信時があった場合は、通常着信(ARRIVALCALL_ACTION_CALL_WAIT)に設定したときと同様に着信されます。

• 本メソッドで転送電話を設定し、転送電話を未契約の状態
• 本メソッドで留守番電話を設定し、留守番電話を未契約の状態
• 本メソッドで転送電話を設定し、転送電話を契約しているが転送先電話番号が設定されていない状態

パラメータ:

action - 通話中の着信呼動作

例外:

java.lang.IllegalArgumentException - actionに通話中の着信呼動作で定義されていない値を設定した場合に発生します。

SessionException - 内部エラーにより処理が中断した場合に発生します。

DeviceException - デバイスの故障により、通話中の着信呼動作の設定に失敗した場合に発生します。

関連項目:

ARRIVALCALL_ACTION_ANSWERING, ARRIVALCALL_ACTION_REJECT, ARRIVALCALL_ACTION_CALL_WAIT, ARRIVALCALL_ACTION_REDIRECT, USSDServiceManager

setDriveMode

public void setDriveMode(boolean enable)
                  throws DeviceException,
                         SessionException

公共モード(ドライブモード)の有効／無効を設定します。 setArrivalCallAction(int)によって通話中の着信呼動作のサービスを設定している場合でも、着信呼動作はこのメソッドの設定が優先されます。

パラメータ:

enable - 公共モード(ドライブモード)を有効にする場合はtrueを、そうでない場合はfalseを指定します。

例外:

DeviceException - デバイスの故障により、公共モード(ドライブモード)の設定に失敗した場合に発生します。

SessionException - 内部エラーにより処理が中断した場合に発生します。

setCallWaiting

public void setCallWaiting(boolean enable)
                    throws SessionException,
                           RegulationException,
                           ExternalStatusException

キャッチホンサービスの有効／無効を設定します。 このメソッドが正常終了するとキャッチホンサービスが設定されます。

キャッチホンサービスが既に有効の状態で本メソッドの引数にtrueを指定した場合や、 キャッチホンサービスが既に無効の状態で本メソッドの引数にfalseを指定した場合でも、キャッチホンサービスの有効／無効を再設定します。

パラメータ:

enable - キャッチホンサービスを有効にする場合はtrueを、そうでない場合はfalseを指定します。

例外:

SessionException - キャッチホン未契約の場合など、正常に処理できなかった場合に発生します。

RegulationException - 規制による通信失敗の場合に発生します。

ExternalStatusException - UIMが挿入されていない場合など、キャッチホンサービスの設定に失敗した場合に発生します。

changeHoldStatus

public void changeHoldStatus()
                      throws SessionException,
                             CommunicationFailureException

保留呼を通話呼に変更します。
通話呼と、保留呼または着信呼がある状態で本メソッドをコールすると、通話呼を保留呼にし、着信呼または保留呼を通話呼へ変更します。 但し、着信呼のセッションにVoiceSession.MANNER_MODE_TYPE_DRIVEが設定されている場合、本メソッドをコールするとSessionExceptionが発生します。
保留呼のみがある状態で本メソッドをコールすると、保留呼を通話呼に変更します。
上記状態以外の状態で本メソッドをコールした場合、SessionExceptionが発生します。

例外:

SessionException - キャッチホン未契約の場合など、正常に処理できなかった場合に発生します。

CommunicationFailureException - 通信異常の場合に発生します。

関連項目:

getConnectedSession(), VoiceSession.receive()

getReceiverVolume

public int getReceiverVolume()
                      throws SessionException,
                             DeviceException

受話音量を取得します。

戻り値:

受話音量を返します。

例外:

SessionException - 内部エラーにより処理が中断した場合に発生します。

DeviceException - デバイスの故障により、受話音量の設定値取得に失敗した場合に発生します。

isSenderVolumeMute

public boolean isSenderVolumeMute()
                           throws SessionException

送話音量ミュートの有効/無効を取得します。

戻り値:

送話音量ミュートの有効/無効を返します。

例外:

SessionException - 内部エラーにより処理が中断した場合に発生します。

isEchoCanceller

public boolean isEchoCanceller()
                        throws SessionException,
                               DeviceException

エコーキャンセラの有効/無効を取得します。

戻り値:

エコーキャンセラの有効/無効を返します。

例外:

SessionException - 内部エラーにより処理が中断した場合に発生します。

DeviceException - デバイスの故障により、エコーキャンセラの設定値取得に失敗した場合に発生します。

isNoiseCanceller

public boolean isNoiseCanceller()
                         throws SessionException,
                                DeviceException

ノイズキャンセラの有効/無効を取得します。

戻り値:

ノイズキャンセラの有効/無効を返します。

例外:

SessionException - 内部エラーにより処理が中断した場合に発生します。

DeviceException - デバイスの故障により、ノイズキャンセラの設定値取得に失敗した場合に発生します。

getArrivalCallAction

public int getArrivalCallAction()
                         throws SessionException,
                                DeviceException

通話中の着信呼動作のサービスを取得します。

戻り値:

通話中の着信呼動作を返します。

例外:

SessionException - 内部エラーにより処理が中断した場合に発生します。

DeviceException - デバイスの故障により、通話中の着信呼動作の設定値取得に失敗した場合に発生します。

関連項目:

ARRIVALCALL_ACTION_ANSWERING, ARRIVALCALL_ACTION_REJECT, ARRIVALCALL_ACTION_CALL_WAIT, ARRIVALCALL_ACTION_REDIRECT

isDriveMode

public boolean isDriveMode()
                    throws SessionException,
                           DeviceException

公共モード(ドライブモード)の有効／無効を取得します。

戻り値:

公共モード(ドライブモード)の有効／無効を返します。

例外:

SessionException - 内部エラーにより処理が中断した場合に発生します。

DeviceException - デバイスの故障により、公共モード(ドライブモード)の設定値取得に失敗した場合に発生します。

createSession

public Session createSession(java.lang.String destination)
                      throws SessionException

音声通話の接続を表すインスタンスを生成します。

定義:

クラス ModemController 内の createSession

パラメータ:

destination - 通話先の電話番号を指定します。電話番号は"090********"のように、ハイフンなどは入れずに指定します。使用可能な文字は{0-9、#、*、+、A-C、a-c}です。

戻り値:

音声通話の接続を表すインスタンスを返します。

例外:

java.lang.NullPointerException - destinationにnullが指定された場合に発生します。

java.lang.IllegalArgumentException - 桁数の上限を超えるdestinationを指定した場合や、不正なフォーマット（電話番号にハイフンが入っているなど）のdestinationを指定した場合に発生します。

SessionException - destinationが電話発信対象外の番号の場合に発生します。

setModemControllerListener

public void setModemControllerListener(ModemControllerListener listener)

リスナを登録します。

音声通話制御の状態を通知するイベントを受けることができます。 音声専用の通知(ガイダンス通知等)を受け取りたい場合は、listenerに音声専用の情報通知リスナを指定してください。

このインスタンスに登録できるリスナは1つだけです。
このメソッドを複数回呼出した場合、最後に登録したリスナだけが有効です。
null を指定すると、リスナの登録を削除します。

定義:

クラス ModemController 内の setModemControllerListener

パラメータ:

listener - 登録するリスナを指定します。

getConnectedSession

public Session getConnectedSession()

現在音声通話が通話呼のSessionを取得します。

定義:

クラス ModemController 内の getConnectedSession

戻り値:

音声通話が通話中状態(通話呼)のSessionを返します。通話中状態(通話呼)のSessionが無い場合はnullを返します。