Property Objects

コンポーネント（通常はビデオキャプチャデバイス）のプロパティを表します。詳細...

モジュール

	Category Properties Category Propertyは、PropertyMap内のすべてのプロパティ間のツリー関係を定義します。
	Command Properties Command Propertyは、デバイスが実行できるアクションを表します。
	Integer Properties Integer Propertyは、値が整数となる機能を表します。
	Float Properties Float Propertyは、値が浮動小数点数となる機能を表します。
	Boolean Properties Boolean Propertyは、値が単純なオン/オフスイッチとなる機能を表します。
	String Properties String Propertyは、値がテキストとなる機能を表します。
	Enumeration Properties Enumeration Propertyは、名前付きエントリのリストから値を選択する機能を表します。
	Register Properties Register Propertyは、生のバイト列で表される値を持ちます。

データ構造体

struct

IC4_PROPERTY

コンポーネント（通常はビデオキャプチャデバイス）のプロパティを表します。詳細...

型定義

typedef void(*	ic4_prop_notification) (struct IC4_PROPERTY prop, void user_ptr) プロパティ通知ハンドラ関数ポインタです。
typedef void(*	ic4_prop_notification_deleter) (void *user_ptr) プロパティ通知デリータです。

列挙型

enum	IC4_PROPERTY_TYPE { IC4_PROPTYPE_INVALID , IC4_PROPTYPE_INTEGER , IC4_PROPTYPE_FLOAT , IC4_PROPTYPE_ENUMERATION , IC4_PROPTYPE_BOOLEAN , IC4_PROPTYPE_STRING , IC4_PROPTYPE_COMMAND , IC4_PROPTYPE_CATEGORY , IC4_PROPTYPE_REGISTER , IC4_PROPTYPE_PORT , IC4_PROPTYPE_ENUMENTRY } 指定可能なプロパティタイプを定義します。詳細...
enum	IC4_PROPERTY_VISIBILITY { IC4_PROPVIS_BEGINNER , IC4_PROPVIS_EXPERT , IC4_PROPVIS_GURU , IC4_PROPVIS_INVISIBLE } 指定可能なプロパティの可視性を定義します。詳細...
enum	IC4_PROPERTY_INCREMENT_MODE { IC4_PROPINCMODE_INCREMENT , IC4_PROPINCMODE_VALUESET , IC4_PROPINCMODE_NONE } Integer PropertyおよびFloat Propertyで指定可能なプロパティの刻みモードを定義します。詳細...

関数

struct IC4_PROPERTY *	ic4_prop_ref (struct IC4_PROPERTY *prop) プロパティの内部参照カウントを1つ増やします。
void	ic4_prop_unref (struct IC4_PROPERTY *prop) プロパティの内部参照カウントを1つ減らします。
enum IC4_PROPERTY_TYPE	ic4_prop_get_type (struct IC4_PROPERTY *prop) 渡されたプロパティのタイプを返します。
const char *	ic4_prop_get_name (struct IC4_PROPERTY *prop) 渡されたプロパティの名前を返します。
bool	ic4_prop_is_available (struct IC4_PROPERTY *prop) プロパティが現在利用可能かどうかを確認します。
bool	ic4_prop_is_locked (struct IC4_PROPERTY *prop) プロパティが現在ロックされているかどうかを確認します。
bool	ic4_prop_is_likely_locked_by_stream (struct IC4_PROPERTY *prop) データストリームがアクティブであることが原因でプロパティがロックされているかどうかを判定しようとします。
bool	ic4_prop_is_readonly (struct IC4_PROPERTY *prop) プロパティが読み取り専用かどうかを確認します。
enum IC4_PROPERTY_VISIBILITY	ic4_prop_get_visibility (struct IC4_PROPERTY *prop) プロパティの可視性ヒントを返します。
const char *	ic4_prop_get_display_name (struct IC4_PROPERTY *prop) 渡されたプロパティの表示名を返します。
const char *	ic4_prop_get_tooltip (struct IC4_PROPERTY *prop) 渡されたプロパティのツールチップを返します。
const char *	ic4_prop_get_description (struct IC4_PROPERTY *prop) 渡されたプロパティの説明テキストを返します。
bool	ic4_prop_event_add_notification (struct IC4_PROPERTY prop, ic4_prop_notification handler, void user_ptr, ic4_prop_notification_deleter deleter) プロパティ通知ハンドラを登録します。
bool	ic4_prop_event_remove_notification (struct IC4_PROPERTY prop, ic4_prop_notification handler, void user_ptr) 以前に登録した通知ハンドラを登録解除します。
bool	ic4_prop_is_selector (struct IC4_PROPERTY *prop) このプロパティの値が、他のプロパティの意味や値を変更するかどうかを示します。
bool	ic4_prop_get_selected_props (struct IC4_PROPERTY prop, struct IC4_PROPERTY_LIST *ppSelected) 値の意味がこのプロパティに依存するプロパティのリストを返します。

詳細説明

コンポーネント（通常はビデオキャプチャデバイス）のプロパティを表します。

型定義ドキュメント

◆ ic4_prop_notification

typedef void(* ic4_prop_notification) (struct IC4_PROPERTY *prop, void *user_ptr)

プロパティ通知ハンドラ関数ポインタです。

パラメータ

[in]	prop	変化したプロパティ
[in]	user_ptr	通知ハンドラの登録時に指定されたユーザーデータ

関連項目: ic4_prop_event_add_notification

◆ ic4_prop_notification_deleter

typedef void(* ic4_prop_notification_deleter) (void *user_ptr)

プロパティ通知デリータです。

パラメータ

[in] user_ptr 通知デリータの登録時に指定されたユーザーデータ

関連項目: ic4_prop_event_add_notification; ic4_prop_event_remove_notification

列挙型ドキュメント

◆ IC4_PROPERTY_INCREMENT_MODE

enum IC4_PROPERTY_INCREMENT_MODE

Integer PropertyおよびFloat Propertyで指定可能なプロパティの刻みモードを定義します。

列挙子

列挙子
IC4_PROPINCMODE_INCREMENT	このプロパティは有効な値の間で固定の刻み幅を使用します。プロパティの刻み幅を取得するには、ic4_prop_integer_get_inc() または ic4_prop_float_get_inc() を使用します。
IC4_PROPINCMODE_VALUESET	このプロパティは有効な値の集合を定義します。有効な値の集合を照会するには、ic4_prop_integer_get_valid_value_set() または ic4_prop_float_get_valid_value_set() を使用します。
IC4_PROPINCMODE_NONE	このプロパティは最小値と最大値の間のすべての値を設定できます。このモードはFloat Propertyでのみ有効です。 Integer Propertyは、最小値と最大値の間のすべての値を許可したい場合、刻み幅として1を報告します。

IC4_PROPINCMODE_INCREMENT

このプロパティは有効な値の間で固定の刻み幅を使用します。

プロパティの刻み幅を取得するには、ic4_prop_integer_get_inc() または ic4_prop_float_get_inc() を使用します。

IC4_PROPINCMODE_VALUESET

このプロパティは有効な値の集合を定義します。

有効な値の集合を照会するには、ic4_prop_integer_get_valid_value_set() または ic4_prop_float_get_valid_value_set() を使用します。

IC4_PROPINCMODE_NONE

このプロパティは最小値と最大値の間のすべての値を設定できます。

このモードはFloat Propertyでのみ有効です。

Integer Propertyは、最小値と最大値の間のすべての値を許可したい場合、刻み幅として1を報告します。

◆ IC4_PROPERTY_TYPE

enum IC4_PROPERTY_TYPE

指定可能なプロパティタイプを定義します。

プロパティタイプは、プロパティに対して実行可能な操作とそのデータ型を定義します。

列挙子
IC4_PROPTYPE_INVALID	有効なプロパティタイプではなく、エラーを示します。
IC4_PROPTYPE_INTEGER	Integer Propertyです。
IC4_PROPTYPE_FLOAT	Float Propertyです。
IC4_PROPTYPE_ENUMERATION	Enumeration Propertyです。
IC4_PROPTYPE_BOOLEAN	Boolean Propertyです。
IC4_PROPTYPE_STRING	String Propertyです。
IC4_PROPTYPE_COMMAND	Command Propertyです。
IC4_PROPTYPE_CATEGORY	Category Propertyです。
IC4_PROPTYPE_REGISTER	Register Propertyです。
IC4_PROPTYPE_PORT	Port Propertyです。
IC4_PROPTYPE_ENUMENTRY	Enumeration entry Propertyです。

◆ IC4_PROPERTY_VISIBILITY

enum IC4_PROPERTY_VISIBILITY

指定可能なプロパティの可視性を定義します。

各プロパティには、異なるユーザータイプ向けのユーザーインターフェイスを作成するために使用できる可視性ヒントがあります。

列挙子
IC4_PROPVIS_BEGINNER	初心者向けの可視性です。
IC4_PROPVIS_EXPERT	上級者向けの可視性です。
IC4_PROPVIS_GURU	エキスパート向けの可視性です。
IC4_PROPVIS_INVISIBLE	非表示です。

関数ドキュメント

◆ ic4_prop_event_add_notification()

bool ic4_prop_event_add_notification	(	struct IC4_PROPERTY *	prop,
		ic4_prop_notification	handler,
		void *	user_ptr,
		ic4_prop_notification_deleter	deleter
	)

プロパティ通知ハンドラを登録します。

プロパティ通知ハンドラは、値やロック状態など、プロパティの何らかの側面が変化するたびに呼び出されます。

パラメータ

[in]	prop	プロパティ
[in]	handler	prop が変化した場合に呼び出されるプロパティ通知ハンドラ
[in]	user_ptr	通知ハンドラに渡されるユーザーデータ
[in]	deleter	通知が削除されたとき、またはプロパティが破棄されたときに呼び出されるプロパティ通知デリータ

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。

備考: deleter コールバックは、呼び出し側が user_ptr に渡したリソースを解放するのに役立ちます。; 同じプロパティに対して、user_ptr パラメータが異なる限り、複数の通知ハンドラを登録できます。

関連項目: ic4_prop_event_remove_notification; ic4_prop_notification; ic4_prop_notification_deleter

◆ ic4_prop_event_remove_notification()

bool ic4_prop_event_remove_notification	(	struct IC4_PROPERTY *	prop,
		ic4_prop_notification	handler,
		void *	user_ptr
	)

Unregisters a previously registered notification handler.

パラメータ

[in]	prop	通知ハンドラが登録されたプロパティ
[in]	handler	削除するプロパティ通知ハンドラ
[in]	user_ptr	ハンドラの登録時に指定されたユーザーデータ

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。

備考: handler と user_ptr の値は、直前に成功した ic4_prop_event_add_notification() の呼び出しの引数と正確に一致している必要があります。

関連項目: ic4_prop_event_add_notification

◆ ic4_prop_get_description()

const char * ic4_prop_get_description ( struct IC4_PROPERTY * prop )

渡されたプロパティの説明テキストを返します。

パラメータ

[in] prop プロパティ

戻り値: 渡されたプロパティの説明、またはエラーの場合は NULL を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。
戻り値が指すメモリは、プロパティオブジェクトが存在する限り有効です。

備考: プロパティの説明は、そのプロパティを説明する短いテキストで、通常はツールチップよりも詳細です。

関連項目: ic4_prop_get_tooltip

◆ ic4_prop_get_display_name()

const char * ic4_prop_get_display_name ( struct IC4_PROPERTY * prop )

渡されたプロパティの表示名を返します。

パラメータ

[in] prop プロパティ

戻り値: 渡されたプロパティの表示名、またはエラーの場合は NULL を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。
戻り値が指すメモリは、プロパティオブジェクトが存在する限り有効です。

備考: プロパティの表示名は、ユーザーインターフェイスに表示することを目的としたプロパティのテキスト表現です。
たとえば、ExposureTime プロパティの表示名は通常 Exposure Time です。

関連項目: ic4_prop_get_name

◆ ic4_prop_get_name()

const char * ic4_prop_get_name ( struct IC4_PROPERTY * prop )

渡されたプロパティの名前を返します。

パラメータ

[in] prop プロパティ

戻り値: 渡されたプロパティの名前、またはエラーの場合は NULL を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。
戻り値が指すメモリは、プロパティオブジェクトが存在する限り有効です。

備考: プロパティの名前は、PropertyMap内でそのプロパティを見つけるための記号名です。たとえば ExposureTime や AcquisitionFrameRate などです。

関連項目: ic4_prop_get_display_name

◆ ic4_prop_get_selected_props()

bool ic4_prop_get_selected_props	(	struct IC4_PROPERTY *	prop,
		struct IC4_PROPERTY_LIST **	ppSelected
	)

値の意味がこのプロパティに依存するプロパティのリストを返します。

パラメータ

[in]	prop	セレクタであるプロパティ
[out]	ppSelected	`prop` によって選択されたプロパティのリストを受け取るPropertyListへのポインタです。PropertyListが不要になったら、ic4_proplist_unref() を使用してオブジェクト参照を解放してください。

戻り値: 成功した場合は true、それ以外の場合は false を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。

備考: prop がBoolean Propertyでない場合、この関数は失敗し、エラー値は IC4_ERROR_GENICAM_TYPE_MISMATCH に設定されます。

関連項目: ic4_prop_is_selector

◆ ic4_prop_get_tooltip()

const char * ic4_prop_get_tooltip ( struct IC4_PROPERTY * prop )

渡されたプロパティのツールチップを返します。

パラメータ

[in] prop プロパティ

戻り値: 渡されたプロパティのツールチップ、またはエラーの場合は NULL を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。
戻り値が指すメモリは、プロパティオブジェクトが存在する限り有効です。

備考: プロパティのツールチップは、ユーザーインターフェイスでツールチップが必要なときに使用できるテキストです。
通常、ツールチップはプロパティの短い説明です。

関連項目: ic4_prop_get_description

◆ ic4_prop_get_type()

enum IC4_PROPERTY_TYPE ic4_prop_get_type ( struct IC4_PROPERTY * prop )

渡されたプロパティのタイプを返します。

パラメータ

[in] prop プロパティ

戻り値: プロパティ prop のタイプ、またはエラーの場合は IC4_PROPTYPE_INVALID を返します。
エラー情報を取得するには ic4_get_last_error() を使用します。

関連項目: IC4_PROPERTY_TYPE

◆ ic4_prop_get_visibility()

enum IC4_PROPERTY_VISIBILITY ic4_prop_get_visibility ( struct IC4_PROPERTY * prop )

プロパティの可視性ヒントを返します。

可視性ヒントは、複雑さの異なるユーザーインターフェイスを作成するために使用できます。最もよく使用されるプロパティは初心者向けの可視性を持ち、まれにしか使用されない機能や診断用の機能はエキスパート向け、あるいは非表示としてタグ付けされる場合があります。

パラメータ

[in] prop プロパティ

戻り値: プロパティの可視性ヒントを返します。
エラーが発生した場合、この関数は IC4_PROPVIS_INVISIBLE を返します。エラー情報を取得するには ic4_get_last_error() を使用します。

◆ ic4_prop_is_available()

bool ic4_prop_is_available ( struct IC4_PROPERTY * prop )

プロパティが現在利用可能かどうかを確認します。

プロパティが利用不可の場合、その値の読み取りまたは書き込みの試みは失敗します。

プロパティは、その値がデバイスの現在の状態において意味を持たない場合、利用不可になることがあります。プロパティの利用可否状態は、別のプロパティへの書き込みによって変化する場合があります。

パラメータ

[in] prop プロパティ

戻り値: プロパティが現在利用可能な場合は true、それ以外の場合は false を返します。
エラーが発生した場合、この関数は false を返します。エラー情報を取得するには ic4_get_last_error() を使用します。

関連項目: ic4_prop_is_locked; ic4_prop_is_readonly

◆ ic4_prop_is_likely_locked_by_stream()

bool ic4_prop_is_likely_locked_by_stream ( struct IC4_PROPERTY * prop )

データストリームがアクティブであることが原因でプロパティがロックされているかどうかを判定しようとします。

パラメータ

[in] prop プロパティ

戻り値: プロパティが現在ロックされており、データストリームを停止すればロック解除される可能性が高い場合は true を返します。
プロパティが現在ロックされていない場合、またはデータストリームを停止してもプロパティがロック解除されない可能性が高い場合は false を返します。
エラーが発生した場合、この関数は false を返します。エラー情報を取得するには ic4_get_last_error() を使用します。

備考: 技術的な理由により、この関数は常に正確に将来を予測できるとは限りません。

関連項目: ic4_prop_is_locked

◆ ic4_prop_is_locked()

bool ic4_prop_is_locked ( struct IC4_PROPERTY * prop )

プロパティが現在ロックされているかどうかを確認します。

ロックされたプロパティは読み取れますが、その値の書き込みの試みは失敗します。

プロパティのロック状態は、別のプロパティへの書き込みによって変化する場合があります。

ロックされるプロパティの一般的な例としては、ExposureAuto または GainAuto が有効な場合の ExposureTime や Gain があります。

パラメータ

[in] prop プロパティ

戻り値: プロパティが現在ロックされている場合は true、それ以外の場合は false を返します。
エラーが発生した場合、この関数は false を返します。エラー情報を取得するには ic4_get_last_error() を使用します。

関連項目: ic4_prop_is_available; ic4_prop_is_readonly; ic4_prop_is_likely_locked_by_stream

◆ ic4_prop_is_readonly()

bool ic4_prop_is_readonly ( struct IC4_PROPERTY * prop )

プロパティが読み取り専用かどうかを確認します。

読み取り専用プロパティは書き込み可能になることはなく、読み取り専用状態が変化することもありません。

読み取り専用プロパティの一般的な例は DeviceTemperature です。

パラメータ

[in] prop プロパティ

戻り値: プロパティが読み取り専用の場合は true、それ以外の場合は false を返します。
エラーが発生した場合、この関数は false を返します。エラー情報を取得するには ic4_get_last_error() を使用します。

関連項目: ic4_prop_is_available; ic4_prop_is_locked

◆ ic4_prop_is_selector()

bool ic4_prop_is_selector ( struct IC4_PROPERTY * prop )

このプロパティの値が、他のプロパティの意味や値を変更するかどうかを示します。

パラメータ

[in] prop プロパティ

戻り値: prop がセレクタの場合は true、それ以外の場合は false を返します。
If an error occurs, the function returns false. エラー情報を取得するには ic4_get_last_error() を使用します。

関連項目: ic4_prop_get_selected

◆ ic4_prop_ref()

struct IC4_PROPERTY * ic4_prop_ref ( struct IC4_PROPERTY * prop )

プロパティの内部参照カウントを1つ増やします。

パラメータ

[in] prop プロパティ

戻り値: prop として渡されたポインタ

備考: prop が NULL の場合、この関数は NULL を返します。エラー値は設定されません。

関連項目: ic4_prop_unref

◆ ic4_prop_unref()

void ic4_prop_unref ( struct IC4_PROPERTY * prop )

プロパティの内部参照カウントを1つ減らします。

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

パラメータ

[in] prop プロパティ

備考: prop が NULL の場合、この関数は何も行いません。エラー値は設定されません。

関連項目: ic4_prop_ref