動画ファイル・画像シーケンス・カメラから動画をキャプチャするためのクラス。続き...

#include <opencv2/videoio.hpp>

Collaboration diagram for cv::VideoCapture:

公開メンバ関数
	VideoCapture ()
	デフォルトコンストラクタ。

	VideoCapture (const Ptr< IStreamReader > &source, int apiPreference, const std::vector< int > &params)
	データストリームを使って動画を開く。

	VideoCapture (const String &filename, int apiPreference, const std::vector< int > &params)
	API Preferenceとパラメータを指定して、動画ファイル・キャプチャデバイス・IP動画ストリームを動画キャプチャ用に開く。

	VideoCapture (const String &filename, int apiPreference=CAP_ANY)
	API Preferenceを指定して、動画ファイル・キャプチャデバイス・IP動画ストリームを動画キャプチャ用に開く。

	VideoCapture (int index, int apiPreference, const std::vector< int > &params)
	API Preferenceとパラメータを指定して、カメラを動画キャプチャ用に開く。

	VideoCapture (int index, int apiPreference=CAP_ANY)
	カメラを動画キャプチャ用に開く。

virtual	~VideoCapture ()
	デフォルトのデストラクタ。

virtual double	get (int propId) const
	指定した VideoCapture プロパティを返す。

String	getBackendName () const
	使用しているバックエンドAPI名を返す。

bool	getExceptionMode () const
	例外モードが有効かどうかを問い合わせる

virtual bool	grab ()
	動画ファイルまたはキャプチャデバイスから次のフレームを取得する。

virtual bool	isOpened () const
	動画キャプチャが既に初期化済みであれば true を返す。

virtual bool	open (const Ptr< IStreamReader > &source, int apiPreference, const std::vector< int > &params)
	データストリームを使って動画を開く。

virtual bool	open (const String &filename, int apiPreference, const std::vector< int > &params)
	API Preferenceとパラメータを指定して、動画ファイル・キャプチャデバイス・IP動画ストリームを動画キャプチャ用に開く。

virtual bool	open (const String &filename, int apiPreference=CAP_ANY)
	動画ファイル・キャプチャデバイス・IP動画ストリームを動画キャプチャ用に開く。

virtual bool	open (int index, int apiPreference, const std::vector< int > &params)
	API Preferenceとパラメータを指定して、カメラを動画キャプチャ用に開く。

virtual bool	open (int index, int apiPreference=CAP_ANY)
	カメラを動画キャプチャ用に開く。

virtual VideoCapture &	operator>> (Mat &image)
	次の動画フレームを読み込むためのストリーム演算子。

virtual VideoCapture &	operator>> (UMat &image)

virtual bool	read (OutputArray image)
	次の動画フレームを取得・デコードして返す。

virtual void	release ()
	動画ファイルまたはキャプチャデバイスを閉じる。

virtual bool	retrieve (OutputArray image, int flag=0)
	取得済みの動画フレームをデコードして返す。

virtual bool	set (int propId, double value)
	VideoCapture にプロパティを設定する。

void	setExceptionMode (bool enable)

静的公開メンバ関数
static bool	waitAny (const std::vector< VideoCapture > &streams, std::vector< int > &readyIndex, int64 timeoutNs=0)
	VideoCapture から準備の整ったフレームを待つ。

限定公開変数類
Ptr< CvCapture >	cap

Ptr< IVideoCapture >	icap

bool	throwOnFail

フレンド
class	internal::VideoCapturePrivateAccessor

詳細説明

動画ファイル・画像シーケンス・カメラから動画をキャプチャするためのクラス。

このクラスは、カメラから動画をキャプチャしたり、動画ファイルや画像シーケンスを読み込んだりするためのC++ APIを提供する。

このクラスは次のように使用できる:

 
#include <opencv2/core.hpp>
#include <opencv2/videoio.hpp>
#include <opencv2/highgui.hpp>
#include <iostream>
#include <stdio.h>
 
using namespace cv;
using namespace std;
 
int main(int, char**)
{
 Mat frame;
 //--- INITIALIZE VIDEOCAPTURE
 VideoCapture cap;
 // open the default camera using default API
 // cap.open(0);
 // OR advance usage: select any API backend
 int deviceID = 0;             // 0 = open default camera
 int apiID = cv::CAP_ANY;      // 0 = autodetect default API
 // open selected camera using selected API
    cap.open(deviceID, apiID);
 // check if we succeeded
 if (!cap.isOpened()) {
        cerr << "ERROR! Unable to open camera\n";
 return -1;
    }
 
 //--- GRAB AND WRITE LOOP
    cout << "Start grabbing" << endl
        << "Press any key to terminate" << endl;
 for (;;)
    {
 // wait for a new frame from camera and store it into 'frame'
        cap.read(frame);
 // check if we succeeded
 if (frame.empty()) {
            cerr << "ERROR! blank frame grabbed\n";
 break;
        }
 // show live and wait for a key with timeout long enough to show images
        imshow("Live", frame);
 if (waitKey(5) >= 0)
 break;
    }
 // the camera will be deinitialized automatically in VideoCapture destructor
 return 0;
}

覚え書き

C API では、VideoCapture の代わりにブラックボックス構造体 CvCapture が使用される。

(C++) VideoCapture インターフェースの使い方の基本的なサンプルは OPENCV_SOURCE_CODE/samples/cpp/videocapture_starter.cpp にある
(Python) VideoCapture インターフェースの使い方の基本的なサンプルは OPENCV_SOURCE_CODE/samples/python/video.py にある
(Python) マルチスレッドでの動画処理のサンプルは OPENCV_SOURCE_CODE/samples/python/video_threaded.py にある
(Python) Video4Linux2バックエンドのいくつかの機能を紹介するVideoCaptureのサンプル OPENCV_SOURCE_CODE/samples/python/video_v4l2.py

例: samples/cpp/camshiftdemo.cpp, samples/cpp/facedetect.cpp, samples/cpp/laplace.cpp, samples/cpp/lkdemo.cpp, samples/cpp/peopledetect.cpp, samples/cpp/polar_transforms.cpp, samples/cpp/segment_objects.cpp, samples/cpp/train_HOG.cpp, samples/cpp/tutorial_code/videoio/video-write/video-write.cpp, samples/cpp/videowriter_basic.cpp, samples/dnn/classification.cpp, samples/dnn/object_detection.cpp, samples/dnn/segmentation.cpp, samples/dnn/text_detection.cpp, samples/tapi/hog.cpp。

構築子と解体子の詳解

◆ VideoCapture() [1/6]

cv::VideoCapture::VideoCapture ( )


cv.VideoCapture(		) ->	<VideoCapture object>
cv.VideoCapture(	filename[, apiPreference]	) ->	<VideoCapture object>
cv.VideoCapture(	filename, apiPreference, params	) ->	<VideoCapture object>
cv.VideoCapture(	index[, apiPreference]	) ->	<VideoCapture object>
cv.VideoCapture(	index, apiPreference, params	) ->	<VideoCapture object>
cv.VideoCapture(	source, apiPreference, params	) ->	<VideoCapture object>

デフォルトコンストラクタ。

覚え書き: C API では、ビデオの処理が終わったら、cvReleaseCapture() でCvCapture構造体を解放するか、デストラクタで自動的に cvReleaseCapture() を呼び出す Ptr<CvCapture> を使用する。

◆ VideoCapture() [2/6]

cv::VideoCapture::VideoCapture	(	const String &	filename,
		int	apiPreference = CAP_ANY )

explicit


cv.VideoCapture(		) ->	<VideoCapture object>
cv.VideoCapture(	filename[, apiPreference]	) ->	<VideoCapture object>
cv.VideoCapture(	filename, apiPreference, params	) ->	<VideoCapture object>
cv.VideoCapture(	index[, apiPreference]	) ->	<VideoCapture object>
cv.VideoCapture(	index, apiPreference, params	) ->	<VideoCapture object>
cv.VideoCapture(	source, apiPreference, params	) ->	<VideoCapture object>

APIプリファレンスを指定して、ビデオ撮影用にビデオファイル、撮影デバイス、またはIPビデオストリームを開く。

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

引数

filename

次のいずれかを指定できる:

動画ファイル名（例: video.avi）
または画像シーケンス（例: img_%02d.jpg。これは img_00.jpg, img_01.jpg, img_02.jpg, ... のようなサンプルを読み込む）
または動画ストリームのURL（例: protocol://host:port/script_name?script_params|auth）
またはGStreamerをバックエンドとして使用する場合は gst-launch ツール形式のGStreamerパイプライン文字列。各動画ストリームやIPカメラのフィードはそれぞれ独自のURLスキームを持つことに注意。正しいURLを知るには、そのソースストリームのドキュメントを参照すること。

apiPreference 使用する優先的なCapture APIバックエンド。複数のリーダー実装が利用可能な場合に特定の実装を強制するために使用できる。例: cv::CAP_FFMPEG、cv::CAP_IMAGES、cv::CAP_DSHOW など。

参照: cv::VideoCaptureAPIs

◆ VideoCapture() [3/6]

cv::VideoCapture::VideoCapture	(	const String &	filename,
		int	apiPreference,
		const std::vector< int > &	params )

explicit


cv.VideoCapture(		) ->	<VideoCapture object>
cv.VideoCapture(	filename[, apiPreference]	) ->	<VideoCapture object>
cv.VideoCapture(	filename, apiPreference, params	) ->	<VideoCapture object>
cv.VideoCapture(	index[, apiPreference]	) ->	<VideoCapture object>
cv.VideoCapture(	index, apiPreference, params	) ->	<VideoCapture object>
cv.VideoCapture(	source, apiPreference, params	) ->	<VideoCapture object>

APIプリファレンスとパラメータを指定して、ビデオ撮影用にビデオファイル、撮影デバイス、またはIPビデオストリームを開く。

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

params パラメータでは、(paramId_1, paramValue_1, paramId_2, paramValue_2, ...) のペアとしてエンコードされた追加パラメータを指定できる。cv::VideoCaptureProperties を参照。

◆ VideoCapture() [4/6]

cv::VideoCapture::VideoCapture	(	int	index,
		int	apiPreference = CAP_ANY )

explicit


cv.VideoCapture(		) ->	<VideoCapture object>
cv.VideoCapture(	filename[, apiPreference]	) ->	<VideoCapture object>
cv.VideoCapture(	filename, apiPreference, params	) ->	<VideoCapture object>
cv.VideoCapture(	index[, apiPreference]	) ->	<VideoCapture object>
cv.VideoCapture(	index, apiPreference, params	) ->	<VideoCapture object>
cv.VideoCapture(	source, apiPreference, params	) ->	<VideoCapture object>

ビデオ撮影用にカメラを開く。

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

引数

index	開く動画キャプチャデバイスのID。デフォルトのバックエンドでデフォルトカメラを開くには、単に0を渡す。（後方互換のため、apiPreference が CAP_ANY の場合は camera_id + domain_offset (CAP_*) の指定も有効である）
apiPreference	使用する優先的なCapture APIバックエンド。複数のリーダー実装が利用可能な場合に特定の実装を強制するために使用できる。例: cv::CAP_DSHOW、cv::CAP_MSMF、cv::CAP_V4L など。

参照: cv::VideoCaptureAPIs

◆ VideoCapture() [5/6]

cv::VideoCapture::VideoCapture	(	int	index,
		int	apiPreference,
		const std::vector< int > &	params )

explicit


cv.VideoCapture(		) ->	<VideoCapture object>
cv.VideoCapture(	filename[, apiPreference]	) ->	<VideoCapture object>
cv.VideoCapture(	filename, apiPreference, params	) ->	<VideoCapture object>
cv.VideoCapture(	index[, apiPreference]	) ->	<VideoCapture object>
cv.VideoCapture(	index, apiPreference, params	) ->	<VideoCapture object>
cv.VideoCapture(	source, apiPreference, params	) ->	<VideoCapture object>

APIプリファレンスとパラメータを指定して、ビデオ撮影用にカメラを開く。

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

params パラメータでは、(paramId_1, paramValue_1, paramId_2, paramValue_2, ...) のペアとしてエンコードされた追加パラメータを指定できる。cv::VideoCaptureProperties を参照。

◆ VideoCapture() [6/6]

cv::VideoCapture::VideoCapture	(	const Ptr< IStreamReader > &	source,
		int	apiPreference,
		const std::vector< int > &	params )


cv.VideoCapture(		) ->	<VideoCapture object>
cv.VideoCapture(	filename[, apiPreference]	) ->	<VideoCapture object>
cv.VideoCapture(	filename, apiPreference, params	) ->	<VideoCapture object>
cv.VideoCapture(	index[, apiPreference]	) ->	<VideoCapture object>
cv.VideoCapture(	index, apiPreference, params	) ->	<VideoCapture object>
cv.VideoCapture(	source, apiPreference, params	) ->	<VideoCapture object>

データストリームを使用してビデオを開く。

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

params パラメータでは、(paramId_1, paramValue_1, paramId_2, paramValue_2, ...) のペアとしてエンコードされた追加パラメータを指定できる。cv::VideoCaptureProperties を参照。

◆ ~VideoCapture()

virtual cv::VideoCapture::~VideoCapture ( )

virtual

デフォルトのデストラクタ。

このメソッドは、まず VideoCapture::release を呼び出して、すでに開いているファイルまたはカメラを閉じる。

メンバ関数詳解

◆ get()

virtual double cv::VideoCapture::get ( int propId ) const

virtual

Python:
	cv.VideoCapture.get(	propId	) ->	retval

指定した VideoCapture プロパティを返す。

引数

propId cv::VideoCaptureProperties のプロパティ識別子（例: cv::CAP_PROP_POS_MSEC、cv::CAP_PROP_POS_FRAMES など）、または動画I/O APIバックエンド向けの追加フラグのいずれか

戻り値: 指定したプロパティの値。VideoCapture インスタンスが使用するバックエンドでサポートされていないプロパティを問い合わせた場合は、値 0 が返される。

覚え書き: プロパティの読み書きは多くの層を経由する。このチェーンに沿って予期しない結果が生じることがある。
VideoCapture -> API Backend -> Operating System -> Device Driver -> Device Hardware

返される値は、デバイスが実際に使用している値と異なる場合や、デバイス依存のルール（例: ステップやパーセンテージ）でエンコードされている場合がある。実際の挙動はデバイスドライバとAPIバックエンドに依存する。

例: samples/cpp/laplace.cpp.

◆ getBackendName()

String cv::VideoCapture::getBackendName ( ) const

Python:
	cv.VideoCapture.getBackendName(		) ->	retval

使用しているバックエンドAPI名を返す。

覚え書き: ストリームが開いている必要がある。

◆ getExceptionMode()

bool cv::VideoCapture::getExceptionMode ( ) const

inline

Python:
	cv.VideoCapture.getExceptionMode(		) ->	retval

例外モードが有効かどうかを問い合わせる

◆ grab()

virtual bool cv::VideoCapture::grab ( )

virtual

Python:
	cv.VideoCapture.grab(		) ->	retval

ビデオファイルまたは撮影デバイスから次のフレームを取得（grab）する。

戻り値: 成功した場合は true（非ゼロ）。

このメソッド/関数は、ビデオファイルまたはカメラから次のフレームを取得（grab）し、成功した場合は true（非ゼロ）を返す。

この関数の主な用途は、複数カメラ環境、特にカメラがハードウェア同期を持たない場合である。すなわち、各カメラに対して VideoCapture::grab() を呼び出し、その後でより遅いメソッド VideoCapture::retrieve() を呼び出して、各カメラからフレームをデコードして取得する。この方法により、デモザイクやモーションJPEG展開などのオーバーヘッドが排除され、異なるカメラから取得されるフレームの時刻がより近くなる。

また、接続されたカメラがマルチヘッド（例: ステレオカメラやKinectデバイス）の場合、そこからデータを取得する正しい方法は、まず VideoCapture::grab() を呼び出し、その後 channel パラメータの値を変えて VideoCapture::retrieve() を1回以上呼び出すことである。

Kinectおよびその他のOpenNI互換深度センサの利用

◆ isOpened()

virtual bool cv::VideoCapture::isOpened ( ) const

virtual

Python:
	cv.VideoCapture.isOpened(		) ->	retval

ビデオ撮影がすでに初期化されている場合は true を返す。

直前の VideoCapture コンストラクタまたは VideoCapture::open() の呼び出しが成功した場合、このメソッドは true を返す。

例: samples/cpp/camshiftdemo.cpp, samples/cpp/facedetect.cpp, samples/cpp/laplace.cpp, samples/cpp/lkdemo.cpp, samples/cpp/peopledetect.cpp, samples/cpp/polar_transforms.cpp, samples/cpp/segment_objects.cpp, samples/cpp/train_HOG.cpp, samples/cpp/videowriter_basic.cpp, samples/tapi/hog.cpp。

◆ open() [1/5]

virtual bool cv::VideoCapture::open	(	const Ptr< IStreamReader > &	source,
		int	apiPreference,
		const std::vector< int > &	params )

virtual


cv.VideoCapture.open(	filename[, apiPreference]	) ->	retval
cv.VideoCapture.open(	filename, apiPreference, params	) ->	retval
cv.VideoCapture.open(	index[, apiPreference]	) ->	retval
cv.VideoCapture.open(	index, apiPreference, params	) ->	retval
cv.VideoCapture.open(	source, apiPreference, params	) ->	retval

データストリームを使用してビデオを開く。

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

params パラメータでは、(paramId_1, paramValue_1, paramId_2, paramValue_2, ...) のペアとしてエンコードされた追加パラメータを指定できる。cv::VideoCaptureProperties を参照。

戻り値: ファイルが正常に開かれた場合は true

このメソッドは、まず VideoCapture::release を呼び出して、すでに開いているファイルまたはカメラを閉じる。

◆ open() [2/5]

virtual bool cv::VideoCapture::open	(	const String &	filename,
		int	apiPreference,
		const std::vector< int > &	params )

virtual


cv.VideoCapture.open(	filename[, apiPreference]	) ->	retval
cv.VideoCapture.open(	filename, apiPreference, params	) ->	retval
cv.VideoCapture.open(	index[, apiPreference]	) ->	retval
cv.VideoCapture.open(	index, apiPreference, params	) ->	retval
cv.VideoCapture.open(	source, apiPreference, params	) ->	retval

APIプリファレンスとパラメータを指定して、ビデオ撮影用にビデオファイル、撮影デバイス、またはIPビデオストリームを開く。

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

params パラメータでは、(paramId_1, paramValue_1, paramId_2, paramValue_2, ...) のペアとしてエンコードされた追加パラメータを指定できる。cv::VideoCaptureProperties を参照。

戻り値: ファイルが正常に開かれた場合は true

このメソッドは、まず VideoCapture::release を呼び出して、すでに開いているファイルまたはカメラを閉じる。

◆ open() [3/5]

virtual bool cv::VideoCapture::open	(	const String &	filename,
		int	apiPreference = CAP_ANY )

virtual


cv.VideoCapture.open(	filename[, apiPreference]	) ->	retval
cv.VideoCapture.open(	filename, apiPreference, params	) ->	retval
cv.VideoCapture.open(	index[, apiPreference]	) ->	retval
cv.VideoCapture.open(	index, apiPreference, params	) ->	retval
cv.VideoCapture.open(	source, apiPreference, params	) ->	retval

ビデオ撮影用にビデオファイル、撮影デバイス、またはIPビデオストリームを開く。

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

パラメータはコンストラクタ VideoCapture(const String& filename, int apiPreference = CAP_ANY) と同じ。

戻り値: ファイルが正常に開かれた場合は true

このメソッドは、まず VideoCapture::release を呼び出して、すでに開いているファイルまたはカメラを閉じる。

例: samples/cpp/camshiftdemo.cpp, samples/cpp/facedetect.cpp, samples/cpp/laplace.cpp, samples/cpp/lkdemo.cpp, samples/cpp/peopledetect.cpp, samples/cpp/polar_transforms.cpp, samples/cpp/segment_objects.cpp, samples/cpp/train_HOG.cpp, samples/dnn/classification.cpp, samples/dnn/object_detection.cpp, samples/dnn/segmentation.cpp, samples/dnn/text_detection.cpp, samples/tapi/hog.cpp。

◆ open() [4/5]

virtual bool cv::VideoCapture::open	(	int	index,
		int	apiPreference,
		const std::vector< int > &	params )

virtual


cv.VideoCapture.open(	filename[, apiPreference]	) ->	retval
cv.VideoCapture.open(	filename, apiPreference, params	) ->	retval
cv.VideoCapture.open(	index[, apiPreference]	) ->	retval
cv.VideoCapture.open(	index, apiPreference, params	) ->	retval
cv.VideoCapture.open(	source, apiPreference, params	) ->	retval

APIプリファレンスとパラメータを指定して、ビデオ撮影用にカメラを開く。

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

params パラメータでは、(paramId_1, paramValue_1, paramId_2, paramValue_2, ...) のペアとしてエンコードされた追加パラメータを指定できる。cv::VideoCaptureProperties を参照。

戻り値: カメラが正常に開かれた場合は true。

このメソッドは、まず VideoCapture::release を呼び出して、すでに開いているファイルまたはカメラを閉じる。

◆ open() [5/5]

virtual bool cv::VideoCapture::open	(	int	index,
		int	apiPreference = CAP_ANY )

virtual


cv.VideoCapture.open(	filename[, apiPreference]	) ->	retval
cv.VideoCapture.open(	filename, apiPreference, params	) ->	retval
cv.VideoCapture.open(	index[, apiPreference]	) ->	retval
cv.VideoCapture.open(	index, apiPreference, params	) ->	retval
cv.VideoCapture.open(	source, apiPreference, params	) ->	retval

ビデオ撮影用にカメラを開く。

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

パラメータはコンストラクタ VideoCapture(int index, int apiPreference = CAP_ANY) と同じ。

戻り値: カメラが正常に開かれた場合は true。

このメソッドは、まず VideoCapture::release を呼び出して、すでに開いているファイルまたはカメラを閉じる。

◆ operator>>() [1/2]

virtual VideoCapture & cv::VideoCapture::operator>> ( Mat & image )

virtual

次のビデオフレームを読み込むストリーム演算子。

参照: read()

◆ operator>>() [2/2]

virtual VideoCapture & cv::VideoCapture::operator>> ( UMat & image )

virtual

これは利便性のために提供されているオーバーロードされたメンバ関数である。上記の関数とは、受け取る引数のみが異なる。

参照: read()

◆ read()

virtual bool cv::VideoCapture::read ( OutputArray image )

virtual

Python:
	cv.VideoCapture.read(	[, image]	) ->	retval, image

次のビデオフレームを取得（grab）、デコードして返す。

引数

[out] image ここに動画フレームが返される。フレームが取得されていない場合、画像は空になる。

戻り値: フレームが取得されなかった場合は false

このメソッド/関数は、VideoCapture::grab() と VideoCapture::retrieve() を1回の呼び出しにまとめたものである。これはビデオファイルの読み込みやデータの撮影に最も便利なメソッドで、取得したばかりのフレームをデコードして返す。フレームが取得されなかった場合（カメラが切断された、またはビデオファイルにこれ以上フレームがない場合）、メソッドは false を返し、関数は空の画像を返す（cv::Mat の場合は Mat::empty() で確認できる）。

覚え書き: C API では、関数 cvRetrieveFrame() および cv.RetrieveFrame() は、ビデオ撮影構造体の内部に格納された画像を返す。この画像を変更したり解放したりすることは許可されていない。cvCloneImage を使ってフレームをコピーし、そのコピーに対して任意の操作を行うことができる。

例: samples/cpp/videowriter_basic.cpp.

◆ release()

virtual void cv::VideoCapture::release ( )

virtual

Python:
	cv.VideoCapture.release(		) ->	None

ビデオファイルまたは撮影デバイスを閉じる。

このメソッドは、後続の VideoCapture::open および VideoCapture のデストラクタによって自動的に呼び出される。

C関数は、メモリの解放と *capture ポインタのクリアも行う。

◆ retrieve()

virtual bool cv::VideoCapture::retrieve	(	OutputArray	image,
		int	flag = 0 )

virtual

Python:
	cv.VideoCapture.retrieve(	[, image[, flag]]	) ->	retval, image

取得（grab）したビデオフレームをデコードして返す。

引数

[out]	image	ここに動画フレームが返される。フレームが取得されていない場合、画像は空になる。
	flag	フレームインデックス、またはドライバ固有のフラグを指定できる

戻り値: フレームが取得されなかった場合は false

このメソッドは、取得したばかりのフレームをデコードして返す。フレームが取得されなかった場合（カメラが切断された、またはビデオファイルにこれ以上フレームがない場合）、メソッドは false を返し、関数は空の画像を返す（cv::Mat の場合は Mat::empty() で確認できる）。

参照: read()

覚え書き: C API では、関数 cvRetrieveFrame() および cv.RetrieveFrame() は、ビデオ撮影構造体の内部に格納された画像を返す。この画像を変更したり解放したりすることは許可されていない。cvCloneImage を使ってフレームをコピーし、そのコピーに対して任意の操作を行うことができる。

◆ set()

virtual bool cv::VideoCapture::set	(	int	propId,
		double	value )

virtual

Python:
	cv.VideoCapture.set(	propId, value	) ->	retval

VideoCapture にプロパティを設定する。

引数

propId	cv::VideoCaptureProperties のプロパティ識別子（例: cv::CAP_PROP_POS_MSEC、cv::CAP_PROP_POS_FRAMES など）、または動画I/O APIバックエンド向けの追加フラグのいずれか
value	プロパティの値。

戻り値: プロパティが VideoCapture インスタンスが使用するバックエンドでサポートされている場合は true。

覚え書き: true が返されても、プロパティ値が撮影デバイスに受け入れられたことを保証するものではない。VideoCapture::get() の注記を参照。

例: samples/cpp/laplace.cpp.

◆ setExceptionMode()

void cv::VideoCapture::setExceptionMode ( bool enable )

inline

Python:
	cv.VideoCapture.setExceptionMode(	enable	) ->	None

例外モードを切り替える

メソッドは、失敗時にエラーコードを返す代わりに例外を送出する

◆ waitAny()

static bool cv::VideoCapture::waitAny	(	const std::vector< VideoCapture > &	streams,
		std::vector< int > &	readyIndex,
		int64	timeoutNs = 0 )

static

Python:
	cv.VideoCapture.waitAny(	streams[, timeoutNs]	) ->	retval, readyIndex
	cv.VideoCapture_waitAny(	streams[, timeoutNs]	) ->	retval, readyIndex

VideoCapture から準備の整ったフレームを待機する。

引数

streams	入力動画ストリーム
readyIndex	フレームが取得されたストリームのインデックス（.retrieve() で実際のフレームを取得できる状態のもの）
timeoutNs	ナノ秒数（0 - 無限）

戻り値: streamReady が空でない場合は true

例外

Exception Exception on stream errors (check .isOpened() to filter out malformed streams) or VideoCapture type is not supported

この関数の主な用途は複数カメラ環境である。このメソッドは準備状態ベクトルを埋め、カメラが準備できていればビデオフレームを取得する。

この呼び出しの後、VideoCapture::retrieve() を使ってフレームデータをデコードし取得する。

Friends And Related Symbol Documentation

◆ internal::VideoCapturePrivateAccessor

friend class internal::VideoCapturePrivateAccessor

friend

メンバ変数詳解

◆ cap

Ptr<CvCapture> cv::VideoCapture::cap

protected

◆ icap

Ptr<IVideoCapture> cv::VideoCapture::icap

protected

◆ throwOnFail

bool cv::VideoCapture::throwOnFail

protected

このクラス詳解は次のファイルから抽出されました:

opencv2/videoio.hpp

公開メンバ関数

静的公開メンバ関数

限定公開変数類

フレンド

詳細説明

構築子と解体子の詳解

◆ VideoCapture() [1/6]

◆ VideoCapture() [2/6]

◆ VideoCapture() [3/6]

◆ VideoCapture() [4/6]

◆ VideoCapture() [5/6]

◆ VideoCapture() [6/6]

◆ ~VideoCapture()

メンバ関数詳解

◆ get()

◆ getBackendName()

◆ getExceptionMode()

◆ grab()

◆ isOpened()

◆ open() [1/5]

◆ open() [2/5]

◆ open() [3/5]

◆ open() [4/5]

◆ open() [5/5]

◆ operator>>() [1/2]

◆ operator>>() [2/2]

◆ read()

◆ release()

◆ retrieve()

◆ set()

◆ setExceptionMode()

◆ waitAny()

Friends And Related Symbol Documentation

◆ internal::VideoCapturePrivateAccessor

メンバ変数詳解

◆ cap

◆ icap

◆ throwOnFail