Interface Builder

出力構築用のビルダーインターフェース

interface Builder {
    addBlock(): void;
    closeBlock(id: number): void;
    dispose(): Promise<void>;
    finish(): Promise<void>;
    insertBlockBefore(anchorId: number): void;
    serialWrite(data: Buffer): Promise<void>;
    write(id: number, data: Buffer): Promise<void>;
}

Implemented by

Index

Methods

addBlock closeBlock dispose finish insertBlockBefore serialWrite write

Methods

addBlock

addBlock(): void
出力チェーンの末尾に新しいブロックを追加する。ブロックはサーバーから受信したチャンクデータを保持するコンテナであり、 write() で書き込み、finish() 時にストリームへ順番に出力される。

Returns void
- Defined in src/builder.ts:162

closeBlock

closeBlock(id: number): void
指定ブロックを閉じる。実装によっては何も行わない場合がある。
Parameters
- id: number
  閉じるブロックの ID
Returns void
- Defined in src/builder.ts:184

dispose

dispose(): Promise<void>
バッファや一時ファイルを含む全リソースを解放する。 finish() 後、またはエラー発生時に必ず呼び出すこと。

Returns Promise<void>
- Defined in src/builder.ts:204

finish

finish(): Promise<void>
すべてのフラグメントを出力ストリームへ順番にフラッシュし、トランスコードの完了を確定させる。呼び出し後はリソースを解放するため dispose() も呼ぶこと。

Returns Promise<void>
- Defined in src/builder.ts:198

insertBlockBefore

insertBlockBefore(anchorId: number): void
指定したブロックの直前に新しいブロックを挿入する。サーバーが RES_INSERT_BLOCK を送信した場合に呼び出される。
Parameters
- anchorId: number
  挿入基準となる既存ブロックの ID
Returns void
- Defined in src/builder.ts:169

serialWrite

serialWrite(data: Buffer): Promise<void>
データをフラグメント管理を介さず出力ストリームに直接シリアルに書き込む。 RES_DATA パケット (フラグメント外データ) の処理に使用される。
Parameters
- data: Buffer
  書き込むバイナリデータ
Returns Promise<void>
- Defined in src/builder.ts:191

write

write(id: number, data: Buffer): Promise<void>
指定ブロックにデータを書き込む。メモリもしくは一時ファイルへの書き込みを透過的に処理する。
Parameters
- id: number
  書き込み先ブロックの ID
- data: Buffer
  書き込むバイナリデータ
Returns Promise<void>
- Defined in src/builder.ts:177