IRSignal (irkit-android-sdk 1.3.1 API)

java.lang.Object
- com.getirkit.irkit.IRSignal

All Implemented Interfaces:

android.os.Parcelable, java.io.Serializable
```
public class IRSignal
extends java.lang.Object
implements java.io.Serializable, android.os.Parcelable
```
赤外線信号を表します。 An IR signal.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type Field and Description

static android.os.Parcelable.Creator<IRSignal> CREATOR

static java.lang.String TAG

static int VIEW_POSITION_INVALID
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Fields
Modifier and Type	Field and Description
`static android.os.Parcelable.Creator<IRSignal>`	`CREATOR`
`static java.lang.String`	`TAG`
`static int`	`VIEW_POSITION_INVALID`

Constructor Summary

Constructors
Constructor and Description

IRSignal()
コンストラクタ。 Constructor.

Constructors
Constructor and Description
`IRSignal()` コンストラクタ。 Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`copyFrom(IRSignal signal, android.content.Context context)` 引数のIRSignalの内容をこのインスタンスにコピーします。 Copy contents from the given IRSignal to this instance.
`int`	`describeContents()`
`void`	`export(java.util.HashMap<java.lang.String,java.lang.String> map)` 引数のHashMapにformatとfreqを追加します。 Export format and freq to the given HashMap.
`int[]`	`getData()` 赤外線信号のdataを返します。 Return the data array of this IR signal.
`java.lang.String`	`getDeviceId()` deviceidを返します。 Return the deviceid.
`java.lang.String`	`getFormat()` 赤外線信号のformatを返します。 Return the format of this IR signal.
`float`	`getFrequency()` 赤外線信号のfreq（キャリア周波数）を返します。 Return the carrier frequency of this IR signal.
`java.lang.String`	`getId()` 赤外線信号のidを返します。 Return the id of this IR signal.
`java.lang.String`	`getImageFilename()` アイコンのファイル名を返します。 Return the filename of the icon image.
`int`	`getImageResourceId()` アイコンのリソースIDを返します。 Returns the resource id of the icon image.
`java.lang.String`	`getImageResourceName()` アイコンのリソース名を返します。 Return the resource name of the icon image.
`java.lang.String`	`getName()` 赤外線信号の名前を返します。 Return the name of this IR signal.
`java.lang.String`	`getSuggestedImageFilename()` アイコン画像の保存場所として推奨されるファイル名を返します。 Return the suggested filename of the icon image.
`int`	`getViewPosition()` ビューに表示する際の位置を返します。 Return the position in view.
`boolean`	`hasBitmapImage()` ビットマップ画像を持っているかどうかを返します。 Returns whether a bitmap image is associated with this instance.
`void`	`onUpdateImageResourceId(android.content.res.Resources resources)` 現在のimageResourceIdを元にimageResourceNameを更新します。 Update imageResourceName based on current imageResourceId.
`void`	`removeBitmapImage()` アイコンのビットマップ画像を削除します。 Unset the bitmap icon image.
`void`	`removeBitmapImage(android.content.Context context)` アイコンのビットマップ画像とファイルを削除します。 Unset the bitmap icon image and delete the associated file.
`boolean`	`renameToSuggestedImageFilename(android.content.Context context)` ビットマップ画像のファイル名を推奨されたファイル名に変更します。 Rename the filename of the bitmap image to a suggested one.
`void`	`setData(int[] data)` 赤外線信号のdataをセットします。 Set the data array for this IR signal.
`void`	`setDeviceId(java.lang.String deviceId)` deviceidをセットします。 Set the deviceid.
`void`	`setFormat(java.lang.String format)` 赤外線信号のformatをセットします。 Set the format for this IR signal.
`void`	`setFrequency(float frequency)` 赤外線信号のfreq（キャリア周波数）をセットします。 Set the carrier frequency for this IR signal.
`void`	`setId(java.lang.String id)` 赤外線信号のidをセットします。 Set the id for this IR signal.
`void`	`setImageFilename(java.lang.String imageFilename)` アイコンの画像ファイル名をセットします。ビットマップ画像をアイコンとして使う際に用います。 Set the filename of the icon image.
`void`	`setImageResourceId(int imageResourceId)` リソースIDを使ってアイコンをセットします。imageResourceNameは更新されません。 Set the icon image using resource id.
`void`	`setImageResourceId(int imageResourceId, android.content.res.Resources res)` リソースIDを使ってアイコンをセットします。imageResourceNameも同時に更新されます。 Set the icon image using resource id.
`void`	`setImageResourceName(java.lang.String imageResourceName)` アイコンのリソース名をセットします。imageResourceIdは更新されません。 Set the resource name for the icon image.
`void`	`setName(java.lang.String name)` 赤外線信号の名前をセットします。 Set the name for this IR signal.
`void`	`setViewPosition(int viewPosition)` ビューに表示する際の位置をセットします。 Set the position in view.
`java.lang.String`	`toJson()` APIのリクエストパラメータに使用するためのJSON文字列を返します。 Returns JSON string which will be used for API parameters.
`java.lang.String`	`toString()`
`void`	`writeToParcel(android.os.Parcel out, int flags)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TAG
```
public static final java.lang.String TAG
```
  - VIEW_POSITION_INVALID
```
public static final int VIEW_POSITION_INVALID
```
    See Also:
    
    Constant Field Values
  - CREATOR
```
public static final android.os.Parcelable.Creator<IRSignal> CREATOR
```
- Constructor Detail
  - IRSignal
```
public IRSignal()
```
    コンストラクタ。 Constructor.
- Method Detail
  - getData
```
public int[] getData()
```
    赤外線信号のdataを返します。 Return the data array of this IR signal.
    
    Returns:
    
    赤外線信号データ。 IR signal data.
  - setData
```
public void setData(int[] data)
```
    赤外線信号のdataをセットします。 Set the data array for this IR signal.
    
    Parameters:
    
    data - 赤外線信号データ。 IR signal data.
  - getFormat
```
public java.lang.String getFormat()
```
    赤外線信号のformatを返します。 Return the format of this IR signal.
    
    Returns:
    
    赤外線信号フォーマット。 IR signal format.
  - setFormat
```
public void setFormat(java.lang.String format)
```
    赤外線信号のformatをセットします。 Set the format for this IR signal.
    
    Parameters:
    
    format - 赤外線信号フォーマット。 IR signal format.
  - getFrequency
```
public float getFrequency()
```
    赤外線信号のfreq（キャリア周波数）を返します。 Return the carrier frequency of this IR signal.
    
    Returns:
    
    キャリア周波数。 Carrier frequency.
  - setFrequency
```
public void setFrequency(float frequency)
```
    赤外線信号のfreq（キャリア周波数）をセットします。 Set the carrier frequency for this IR signal.
    
    Parameters:
    
    frequency - キャリア周波数。 Carrier frequency.
  - getName
```
public java.lang.String getName()
```
    赤外線信号の名前を返します。 Return the name of this IR signal.
    
    Returns:
    
    赤外線信号の名前。 IR signal name.
  - setName
```
public void setName(java.lang.String name)
```
    赤外線信号の名前をセットします。 Set the name for this IR signal.
    
    Parameters:
    
    name - 赤外線信号の名前。 IR signal name.
  - getImageResourceId
```
public int getImageResourceId()
```
    アイコンのリソースIDを返します。 Returns the resource id of the icon image.
    
    Returns:
    
    リソースID。 Resource id.
  - setImageResourceId
```
public void setImageResourceId(int imageResourceId)
```
    リソースIDを使ってアイコンをセットします。imageResourceNameは更新されません。 Set the icon image using resource id. imageResourceName will not be updated.
    
    Parameters:
    
    imageResourceId - リソースID。 Resource id.
  - setImageResourceId
```
public void setImageResourceId(int imageResourceId,
                               android.content.res.Resources res)
```
    リソースIDを使ってアイコンをセットします。imageResourceNameも同時に更新されます。 Set the icon image using resource id. imageResourceName will be updated as well.
    
    Parameters:
    
    imageResourceId - リソースID。 Resource id.
    
    res - Resources object
  - getImageResourceName
```
public java.lang.String getImageResourceName()
```
    アイコンのリソース名を返します。 Return the resource name of the icon image.
    
    Returns:
    
    リソース名。 Resource name.
  - setImageResourceName
```
public void setImageResourceName(java.lang.String imageResourceName)
```
    アイコンのリソース名をセットします。imageResourceIdは更新されません。 Set the resource name for the icon image. imageResourceId will not be updated.
    
    Parameters:
    
    imageResourceName - リソース名。 Resource name.
  - getImageFilename
```
public java.lang.String getImageFilename()
```
    アイコンのファイル名を返します。 Return the filename of the icon image.
    
    Returns:
    
    ファイル名。 Filename.
  - setImageFilename
```
public void setImageFilename(java.lang.String imageFilename)
```
    アイコンの画像ファイル名をセットします。ビットマップ画像をアイコンとして使う際に用います。 Set the filename of the icon image. Used for bitmap image.
    
    Parameters:
    
    imageFilename - 内部ストレージ上の画像ファイル名。 Filename of the image on internal storage.
  - getDeviceId
```
public java.lang.String getDeviceId()
```
    deviceidを返します。 Return the deviceid.
    
    Returns:
    
    deviceid
  - setDeviceId
```
public void setDeviceId(java.lang.String deviceId)
```
    deviceidをセットします。 Set the deviceid.
    
    Parameters:
    
    deviceId - deviceid
  - getViewPosition
```
public int getViewPosition()
```
    ビューに表示する際の位置を返します。 Return the position in view.
    
    Returns:
    
    ビュー内の位置。セットされていない場合はVIEW_POSITION_INVALID。 Position in view, or VIEW_POSITION_INVALID if position is not set.
  - setViewPosition
```
public void setViewPosition(int viewPosition)
```
    ビューに表示する際の位置をセットします。 Set the position in view.
    
    Parameters:
    
    viewPosition - ビュー内の位置。 Position in view.
  - getId
```
public java.lang.String getId()
```
    赤外線信号のidを返します。 Return the id of this IR signal.
    
    Returns:
    
    id
  - setId
```
public void setId(java.lang.String id)
```
    赤外線信号のidをセットします。 Set the id for this IR signal.
    
    Parameters:
    
    id - id
  - getSuggestedImageFilename
```
public java.lang.String getSuggestedImageFilename()
```
    アイコン画像の保存場所として推奨されるファイル名を返します。 Return the suggested filename of the icon image.
    
    Returns:
    
    ファイル名。 Filename.
  - copyFrom
```
public void copyFrom(IRSignal signal,
                     android.content.Context context)
```
    引数のIRSignalの内容をこのインスタンスにコピーします。 Copy contents from the given IRSignal to this instance.
    
    Parameters:
    
    signal - コピー元の信号。 Source.
    
    context - Context object
  - renameToSuggestedImageFilename
```
public boolean renameToSuggestedImageFilename(android.content.Context context)
```
    ビットマップ画像のファイル名を推奨されたファイル名に変更します。 Rename the filename of the bitmap image to a suggested one.
    
    Parameters:
    
    context - Context object
    
    Returns:
    
    ファイル名変更が成功した場合はtrue。 True if the renaming succeeded.
  - toJson
```
public java.lang.String toJson()
```
    APIのリクエストパラメータに使用するためのJSON文字列を返します。 Returns JSON string which will be used for API parameters.
    
    Returns:
    
    JSON string
  - export
```
public void export(java.util.HashMap<java.lang.String,java.lang.String> map)
```
    引数のHashMapにformatとfreqを追加します。 Export format and freq to the given HashMap.
    
    Parameters:
    
    map - HashMap object
  - hasBitmapImage
```
public boolean hasBitmapImage()
```
    ビットマップ画像を持っているかどうかを返します。 Returns whether a bitmap image is associated with this instance.
    
    Returns:
    
    ビットマップ画像がセットされている場合はtrue。 True if this instance has a bitmap.
  - removeBitmapImage
```
public void removeBitmapImage()
```
    アイコンのビットマップ画像を削除します。 Unset the bitmap icon image.
  - removeBitmapImage
```
public void removeBitmapImage(android.content.Context context)
```
    アイコンのビットマップ画像とファイルを削除します。 Unset the bitmap icon image and delete the associated file.
    
    Parameters:
    
    context - Context object
  - onUpdateImageResourceId
```
public void onUpdateImageResourceId(android.content.res.Resources resources)
```
    現在のimageResourceIdを元にimageResourceNameを更新します。 Update imageResourceName based on current imageResourceId.
    
    Parameters:
    
    resources - Resources object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - describeContents
```
public int describeContents()
```
    Specified by:
    
    describeContents in interface android.os.Parcelable
  - writeToParcel
```
public void writeToParcel(android.os.Parcel out,
                          int flags)
```
    Specified by:
    
    writeToParcel in interface android.os.Parcelable

Class IRSignal

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAG

VIEW_POSITION_INVALID

CREATOR

Constructor Detail

IRSignal

Method Detail

getData

setData

getFormat

setFormat

getFrequency

setFrequency

getName

setName

getImageResourceId

setImageResourceId

setImageResourceId

getImageResourceName

setImageResourceName

getImageFilename

setImageFilename

getDeviceId

setDeviceId

getViewPosition

setViewPosition

getId

setId

getSuggestedImageFilename

copyFrom

renameToSuggestedImageFilename

toJson

export

hasBitmapImage

removeBitmapImage

removeBitmapImage

onUpdateImageResourceId

toString

describeContents

writeToParcel