com.nttdocomo.device
クラス IrRemoteControlFrame

Object
  拡張com.nttdocomo.device.IrRemoteControlFrame

public class IrRemoteControlFrame
extends Object

IRリモートコントローラから送信されるデータフレーム定義します。

[DoJa-4.0 (901i) 以降]
アプリケーションプログラマは、 このデータフレームを送信する前に、

の全てのパラメータを、対応するメソッドを呼び出すことで、 明示的に設定しなければなりません。 明示的に設定していないパラメータが存在している場合、 送信時に「フレーム情報が不正」であるという理由で例外が発生します。

導入されたバージョン:
DoJa-3.0 (505i)
関連項目:
IrRemoteControl

フィールドの概要
static int COUNT_INFINITE
          送信単位のリピート回数無限を表します(=0)。
 
コンストラクタの概要
IrRemoteControlFrame()
          フレームデータオブジェクトのインスタンスを生成します。
 
メソッドの概要
 void setFrameData(byte[] data, int bitLength)
          フレームのデータ部を設定します。
 void setFrameData(long data1, int bitLength1, long data2, int bitLength2)
          フレームのデータ部を設定します。
 void setFrameDuration(int duration)
           フレームのリピート時間(0.1m sec)を設定します。
 void setRepeatCount(int count)
          フレームの繰り返し送信回数を設定します。
 void setStartHighDuration(int duration)
          フレームのスタート部のHigh時間(usec)を設定します。
 void setStartLowDuration(int duration)
          フレームのスタート部のLow時間(usec)を設定します。
 void setStopHighDuration(int duration)
          フレームのストップ部のHigh時間(usec)を設定します。
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

COUNT_INFINITE

public static final int COUNT_INFINITE
送信単位のリピート回数無限を表します(=0)。

関連項目:
定数フィールド値
コンストラクタの詳細

IrRemoteControlFrame

public IrRemoteControlFrame()
フレームデータオブジェクトのインスタンスを生成します。

メソッドの詳細

setFrameData

public void setFrameData(long data1,
                         int bitLength1,
                         long data2,
                         int bitLength2)
フレームのデータ部を設定します。

このメソッドを呼び出すと、 以前にsetFrameData(byte[], int) メソッドによって設定された内容は破棄されます。 data2 の有効ビット長が0の場合にはdata2部分は送信されません。 データは、data1 MSB -> LSB, data2 MSB -> LSB の順に送信されます。

 例) data1: MSB 1100 1111 0000 .... 0000 LSB, bitLength1 = 8
     data2: MSB 0011 1111 0000 .... 0000 LSB, bitLength2 = 4
     データは  1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 1, 1
     の順に送信されます。
 

[DoJa-4.0 (901i) 以降] data1 の有効ビット長が0の場合にはdata1部分は送信されません。 すなわち、data1、data2 の有効ビット長が0の場合には、データ部は送信されません。

このメソッドでは 128 bit までの送信のみサポートしていますので、 128 bit を超えるデータを送信する場合には setFrameData(byte[], int) を使用して下さい。

パラメータ:
data1 - 送信データの先頭から最大64bit分のデータを設定します。
bitLength1 - [DoJa-3.5 (900iC) まで] data1 のMSBからの有効ビット長(1-64)を設定します。
[DoJa-4.0 (901i) 以降] data1 のMSBからの有効ビット長(0-64)を設定します。
data2 - 送信データのdata1に続く最大64bit分のデータを設定します。
bitLength2 - data2 のMSBからの有効ビット長(0-64)を指定します。
例外:
IllegalArgumentException - bitLength1,2 の値が有効範囲外の時に発生します。

setFrameData

public void setFrameData(byte[] data,
                         int bitLength)
フレームのデータ部を設定します。

このメソッドを呼び出すと、 以前にsetFrameData(long, int, long, int) メソッドによって設定された内容は破棄されます。 データは、先頭バイトから順に MSB -> LSB の順に送信されます。

 例) data[0]:MSB  1100 1111 LSB,
     data[1]: MSB  0011 0000 LSB,  bitlength = 12
     データは、1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 1, 1 の順に送信されます。
 

[DoJa-4.0 (901i) 以降] data の有効ビット長が0の場合には データ部は送信されません。

パラメータ:
data - 送信データを格納した配列を設定します。
bitLength - 送信データの有効ビット長を指定します。
例外:
NullPointerException - dataがnullの場合に発生します。
IllegalArgumentException - [DoJa-3.5 (900iC) まで] bitLengthが0以下、 またはbitLengthがdata.length*8より大きい場合、 実装のサポートする範囲外の値を設定した場合に発生します。
[DoJa-4.0 (901i) 以降] bitLengthが0未満、 またはbitLengthがdata.length*8より大きい場合、 実装のサポートする範囲外の値を設定した場合に発生します。

setRepeatCount

public void setRepeatCount(int count)
フレームの繰り返し送信回数を設定します。 (COUNT_INFINITE = 0)の値を設定した場合には、フレームデータは 無限回(中断されるまで)送信されます。

パラメータ:
count - フレームの繰り返し送信回数を設定します。
例外:
IllegalArgumentException - count が負の場合に発生します。

setFrameDuration

public void setFrameDuration(int duration)

フレームのリピート時間(0.1m sec)を設定します。

[DoJa-3.0 (506i, 506iC)、DoJa-3.5 (900iC) 以外] 実際のフレームデータを送信するのに必要な時間を下回る値が設定された 場合に、実際に送信されるデータ部分については機種依存です。
[ DoJa-3.0 (506i) 以降 ただし、DoJa-3.5 (900i) を除く] 実際のフレームデータを送信するのに必要な時間を下回る値を設定すると、 送信 時に例外が発生します。

パラメータ:
duration - フレームのリピート時間を設定します。
例外:
IllegalArgumentException - duration が0以下の場合に発生します。

setStartHighDuration

public void setStartHighDuration(int duration)
フレームのスタート部のHigh時間(usec)を設定します。 High時間、Low時間の両方に0の値が設定された場合には、 スタート部は送信されません。

パラメータ:
duration - フレームのスタート部のHigh時間(usec)を設定します。
例外:
IllegalArgumentException - duration が負の場合に発生します。

setStartLowDuration

public void setStartLowDuration(int duration)
フレームのスタート部のLow時間(usec)を設定します。 High時間、Low時間の両方に0の値が設定された場合には、 スタート部は送信されません。

パラメータ:
duration - フレームのスタート部のLow時間(usec)を設定します。
例外:
IllegalArgumentException - duration が負の場合に発生します。

setStopHighDuration

public void setStopHighDuration(int duration)
フレームのストップ部のHigh時間(usec)を設定します。 0の値が設定された場合には、ストップ部は送信されません。

パラメータ:
duration - フレームのストップ部のHigh時間(usec)を設定します。
例外:
IllegalArgumentException - duration が負の場合に発生します。


NTT DOCOMO,INC.

本製品または文書は著作権法により保護されており、その使用、複製、再頒布および逆コンパイルを制限するライセンスのもとにおいて頒布されます。NTTドコモ(その他に許諾者がある場合は当該許諾者も含めて)の書面による事前の許可なく、本製品および関連する文書のいかなる部分も、いかなる方法によっても複製することが禁じられます。フォントを含む第三者のソフトウェアは、著作権法により保護されており、その提供者からライセンスを受けているものです。

Sun、Sun Microsystems、Java、J2MEおよびJ2SEは、米国およびその他の国における米国 Sun Microsystems,Inc.の商標または登録商標です。サンのロゴマークは、米国 Sun Microsystems, Inc.の登録商標です。

FeliCaは、ソニー株式会社が開発した非接触ICカードの技術方式です。FeliCaは、ソニー株式会社の登録商標です。

「iモード」、「iアプリ/アイアプリ」、「i-αppli」ロゴ、「DoJa」はNTTドコモの商標または登録商標です。

その他記載された会社名、製品名などは該当する各社の商標または登録商標です。