FrameSnapSink::snapSingle Method

デバイスから次に取得する1枚の画像をFrameQueueBufferにコピーします。

構文

tFrameQueueBuffer snapSingle( int64_t timeout_in_ms = -1 );
Error snapSingle( tFrameQueueBuffer& rval, int64_t timeout_in_ms = -1 );
パラメータ 説明
count 要求するイメージの数
timeout_in_ms タイムアウトエラー発生までの時間をミリ秒単位で指定します。
rval このパラメータは取得される画像バッファへのポインタを受け取ります。または、予めコールされた allocAndQueueBufferCacheクラスライブラリリファレンス>クラス>FrameSnapSink>FrameSnapSink::allocAndQueueBufferCache Methodで 割り当てられたバッファが使用されます。

戻り値

取得された画像バッファへのポインタを返します。タイムアウトが発生した場合、ポインタは nullptrとなるでしょう。
2度目以降の実行では、関数コールが成功したかどうかを示すエラー値を返します。

備考

バッファはallocAndQueueBufferCacheクラスライブラリリファレンス>クラス>FrameSnapSink>FrameSnapSink::allocAndQueueBufferCache Methodを使用して予め割り当てるか、rvalの入出力として供給されます。
このメソッドは画像が取得されるか、タイムアウト時間が経過するまで処理をブロックします。
この関数はGrabber::startLiveクラスライブラリリファレンス>クラス>Grabber>Grabber::startLive Methodをコールしてデバイスを起動している間に使用できます。