Sink

Sinkオブジェクトは、ビデオキャプチャデバイスから取得した画像データへのプログラムからのアクセスを提供します。 詳細...

モジュール

 Queue Sink

Queue Sinkは、ビデオキャプチャデバイスから受信したすべての画像をプログラムで処理できるようにするSinkの実装です。

 Snap Sink

Snap Sinkは、すべての画像を表示するDisplayを維持したまま、必要に応じて単一の画像または連続した画像をプログラムでキャプチャできるようにするSinkの実装です。

データ構造

struct  IC4_SINK

Sinkを表し、画像データへのプログラムからのアクセスを可能にします。 詳細...

列挙

enum  IC4_SINK_TYPE { IC4_SINK_TYPE_QUEUESINK = 4 , IC4_SINK_TYPE_SNAPSINK = 5 , IC4_SINK_TYPE_INVALID = -1 }

Sinkの種類を識別します。 詳細...

enum  IC4_SINK_MODE { IC4_SINK_MODE_RUN , IC4_SINK_MODE_PAUSE , IC4_SINK_MODE_INVALID = -1 }

利用可能なSinkモードを定義します。 詳細...

Functions

width="15%"struct IC4_SINK * ic4_sink_ref (struct IC4_SINK *pSink)

Sinkの内部参照カウントを1つ増やします。

void ic4_sink_unref (struct IC4_SINK *pSink)

Sinkの内部参照カウントを1つ減らします。

bool ic4_sink_set_mode (struct IC4_SINK *pSink, enum IC4_SINK_MODE mode)

SinkのSinkモードを設定します。

enum IC4_SINK_MODE ic4_sink_get_mode (struct IC4_SINK *pSink)

Sinkの現在のSinkモードを取得します。

bool ic4_sink_is_attached (struct IC4_SINK *pSink)

Sinkが現在 Grabber にアタッチされているかどうかを確認します。

enum IC4_SINK_TYPE ic4_sink_get_type (struct IC4_SINK *pSink)

Sinkの実際の種類を返します。

詳細説明

Sinkオブジェクトは、ビデオキャプチャデバイスから取得した画像データへのプログラムからのアクセスを提供します。

複数のSinkの種類が利用可能です:

  • デバイスから受信したすべて、またはほとんどの画像をプログラムで処理する必要がある場合は、Queue Sink が推奨されます。
  • Snap Sinkは、必要に応じて画像または短い画像シーケンスをキャプチャするために使用できます。

Sinkオブジェクトを作成するには、その作成関数（例: ic4_queuesink_create() または ic4_snapsink_create()）を使用します。

Sinkは、ic4_grabber_stream_setup() 関数を使用してビデオキャプチャデバイスに接続されます。

すべての Sink オブジェクトは、IC4_SINK 型へのポインタによって参照されます。

列挙型ドキュメント

◆ IC4_SINK_MODE

enum IC4_SINK_MODE

利用可能なSinkモードを定義します。

Enumerator
IC4_SINK_MODE_RUN 

Sinkは動作中です。

IC4_SINK_MODE_PAUSE 

Sinkは一時停止しており、受信したすべてのImageBufferをただちにデバイスドライバに返します。

IC4_SINK_MODE_INVALID 

無効なSinkモードで、エラーを示すために使用されます。

◆ IC4_SINK_TYPE

enum IC4_SINK_TYPE

Sinkの種類を識別します。

Enumerator
IC4_SINK_TYPE_QUEUESINK 

Queue Sinkです。

IC4_SINK_TYPE_SNAPSINK 

Snap Sinkです。

IC4_SINK_TYPE_INVALID 

Sinkの種類ではありません。

関数ドキュメント

◆ ic4_sink_get_mode()

enum IC4_SINK_MODE ic4_sink_get_mode ( struct IC4_SINK *  pSink)

Sinkの現在のSinkモードを取得します。

パラメータ
[in]pSinkSinkです
戻り値
現在のSinkモードを表す IC4_SINK_MODE 値です。
エラーが発生した場合、戻り値は IC4_SINK_MODE_INVALID になります。 エラー情報の取得には ic4_get_last_error() を使用してください。

◆ ic4_sink_get_type()

enum IC4_SINK_TYPE ic4_sink_get_type ( struct IC4_SINK *  pSink)

Sinkの実際の種類を返します。

パラメータ
[in]pSinkSinkです
戻り値
Sinkの種類、またはエラーの場合は IC4_SINK_TYPE_INVALID です。
エラー情報の取得には ic4_get_last_error() を使用してください。

◆ ic4_sink_is_attached()

bool ic4_sink_is_attached ( struct IC4_SINK *  pSink)

Sinkが現在 Grabber にアタッチされているかどうかを確認します。

パラメータ
[in]pSink
戻り値
Sinkがアタッチされている場合は true、それ以外の場合は false を返します。

◆ ic4_sink_ref()

struct IC4_SINK * ic4_sink_ref ( struct IC4_SINK *  pSink)

Sinkの内部参照カウントを1つ増やします。

パラメータ
[in]pSinkSinkへのポインタです
戻り値
pSink で渡されたポインタです
備考
pSink が NULL の場合、関数は NULL を返します。エラー値は設定されません。
関連項目
ic4_sink_unref

◆ ic4_sink_set_mode()

bool ic4_sink_set_mode ( struct IC4_SINK *  pSink,
enum IC4_SINK_MODE  mode 
)

SinkのSinkモードを設定します。

パラメータ
[in]pSinkSinkです
[in]mode新しいSinkモードです
戻り値
成功した場合は true、それ以外の場合は false を返します。
エラー情報の取得には ic4_get_last_error() を使用してください。

◆ ic4_sink_unref()

void ic4_sink_unref ( struct IC4_SINK *  pSink)

Sinkの内部参照カウントを1つ減らします。

参照カウントがゼロに達すると、オブジェクトは破棄されます。

パラメータ
[in]pSinkSinkへのポインタです
備考
pSink が NULL の場合、関数は何も行いません。エラー値は設定されません。
関連項目
ic4_sink_ref