Packagesora.graybox
Classpublic class ProcessData
InheritanceProcessData Inheritance Object

ProcessDataクラスは、GrayBoxの音源システムを構成する基本的な要素です。 ProcessDataオブジェクトは音声処理に必要な情報を持ちます.

ProcessDataオブジェクトは毎回の音声処理に必要なオーディオバッファの参照などの情報を持ち、 IGrayBoxModule.process()メソッド通じて、ホストからモジュールへ渡されます。 モジュールはこのオブジェクトのプロパティを参照して音声処理、イベント処理等を行います。

See also

sora.graybox.GrayBox
sora.graybox.GrayBox.process()
sora.graybox.MidiEvent


Public Properties
 PropertyDefined By
  audioChannels : int = 2
ホストのオーディオチャンネルの数.
ProcessData
  audioLatency : Number = 0.0
オーディオ出力の待ち時間(ミリ秒).
ProcessData
  audioOut : Vector.<Vector.<Number>> = null
出力オーディオバッファへの参照.
ProcessData
  blockSize : int = 2048
ホストのプロセスブロックサイズ
ProcessData
  midiEventList : MidiEvent = null
MIDIイベントリスト(イベントバスのように機能)の管理用ダミーオブジェクトです.
ProcessData
  offsetFrames : int = 0
プロセスブロック先頭からのフレーム単位オフセット量.
ProcessData
  sampleFrames : int = 0
offsetFramesからの処理フレーム数.
ProcessData
  sampleRate : Number = 44100.0
ホストのサンプリングレートの値(Hz).
ProcessData
Public Methods
 MethodDefined By
  
ProcessDataオブジェクトをオブジェクトを構築します.
ProcessData
  
addToMidiEventList(event:MidiEvent, check:Boolean = false):void
パラメーターで指定した要素をMIDIイベントリストへ追加します.
ProcessData
  
MIDIイベントリストの、管理用ダミーオブジェクトを除いた先頭要素を取得します.
ProcessData
Property Detail
audioChannelsproperty
public var audioChannels:int = 2

ホストのオーディオチャンネルの数.

audioLatencyproperty 
public var audioLatency:Number = 0.0

オーディオ出力の待ち時間(ミリ秒). GrayBox.setDefaultAudioLatency()で設定した値、 またはGrayBox.audioLatency()で設定した値です。

See also

audioOutproperty 
public var audioOut:Vector.<Vector.<Number>> = null

出力オーディオバッファへの参照. このオーディオバッファはGrayBox.process()実行時にパラメーターとして指定したオーディオバッファです。

See also

blockSizeproperty 
public var blockSize:int = 2048

ホストのプロセスブロックサイズ

midiEventListproperty 
public var midiEventList:MidiEvent = null

MIDIイベントリスト(イベントバスのように機能)の管理用ダミーオブジェクトです.

このリストは片方向連結リストで、、offsetFramesの昇順に要素が並びます。

各モジュールはこのリストを参照することでMIDIイベントの処理が行えます。 この要素自体はダミー要素です。MIDIイベントの処理を行う場合はこの要素の後から処理してください。 同様に要素を追加、挿入する際はこの要素より後に追加してください。 この要素は先頭から移動しなでください。 ダミーを除いたリストを取得する場合はgetMidiEvents()メソッドが便利です。 安全にリストへ要素を登録する場合はaddToMidiEventList()が有効です。

See also

offsetFramesproperty 
public var offsetFrames:int = 0

プロセスブロック先頭からのフレーム単位オフセット量. GrayBox.process()実行時にパラメーターとして指定した値です。

See also

sampleFramesproperty 
public var sampleFrames:int = 0

offsetFramesからの処理フレーム数. GrayBox.process()実行時にパラメーターとして指定した値です。

See also

sampleRateproperty 
public var sampleRate:Number = 44100.0

ホストのサンプリングレートの値(Hz).

Constructor Detail
ProcessData()Constructor
public function ProcessData()

ProcessDataオブジェクトをオブジェクトを構築します. ProcessDataオブジェクトは単体では使用されません。

Method Detail
addToMidiEventList()method
public function addToMidiEventList(event:MidiEvent, check:Boolean = false):void

パラメーターで指定した要素をMIDIイベントリストへ追加します.

Parameters

event:MidiEvent — リストへ追加するオブジェクト。
 
check:Boolean (default = false) — trueにすることで要素のリストへの2重登録を回避します。 先頭要素から順に検索するため、リストが長くなるほど処理が重くなります。

See also

getMidiEvents()method 
public function getMidiEvents():MidiEvent

MIDIイベントリストの、管理用ダミーオブジェクトを除いた先頭要素を取得します.

Returns
MidiEvent — MIDIイベントリスト(MidiEventオブジェクトの連結リスト)。 リストに何も登録されいない場合はnullを返します。

See also