Device Enumeration

このセクションでは、接続されているビデオキャプチャデバイスの列挙と情報の取得方法について説明します。 詳細...

Data Structures

struct   IC4_DEVICE_ENUM

デバイスエニュメレータ型です。 詳細...

struct  IC4_DEVICE_INFO

デバイス情報型です。 詳細...

struct  IC4_INTERFACE

デバイスインターフェイス型です。 詳細...

Typedefs

typedef void(*  ic4_devenum_device_list_change_handler) (struct IC4_DEVICE_ENUM *pDevEnum, void *user_ptr)

デバイスリスト変更ハンドラの関数ポインタです。
typedef void(*  ic4_devenum_device_list_change_deleter) (void *user_ptr)

デバイスリスト変更のユーザーデータをクリーンアップするための関数ポインタです。

列挙

enum   IC4_TL_TYPE { IC4_TLTYPE_UNKNOWN , IC4_TLTYPE_GIGEVISION , IC4_TLTYPE_USB3VISION }

利用可能なトランスポートレイヤーの種類を表します。 詳細...

関数

bool  ic4_devenum_create (struct IC4_DEVICE_ENUM **ppEnumerator)

新しいデバイスエニュメレータを作成します。

struct IC4_DEVICE_ENUM * ic4_devenum_ref (struct IC4_DEVICE_ENUM *pEnumerator)

デバイスエニュメレータの内部参照カウントを1つ増やします。

void ic4_devenum_unref (struct IC4_DEVICE_ENUM *pEnumerator

デバイスエニュメレータの内部参照カウントを1つ減らします。
bool ic4_devenum_update_device_list (struct IC4_DEVICE_ENUM *pEnumerator)

ビデオキャプチャデバイスを検索し、エニュメレータの内部デバイスリストを設定します。

int ic4_devenum_get_device_count (const struct IC4_DEVICE_ENUM *pEnumerator)

前回の ic4_devenum_update_device_list() の呼び出しで検出されたデバイスの数を返します。

bool  ic4_devenum_get_devinfo (const struct IC4_DEVICE_ENUM *pEnumerator, int index, struct IC4_DEVICE_INFO **ppInfo)

検出されたビデオキャプチャデバイスの1つを表す IC4_DEVICE_INFO オブジェクトを返します。
bool ic4_devenum_update_interface_list (struct IC4_DEVICE_ENUM *pEnumerator)

インターフェイスを検索し、エニュメレータの内部インターフェイスリストを設定します。

int ic4_devenum_get_interface_count (const struct IC4_DEVICE_ENUM *pEnumerator)

前回の ic4_devenum_update_interface_list() の呼び出しで検出されたインターフェイスの数を返します。

bool ic4_devenum_get_devitf (const struct IC4_DEVICE_ENUM *pEnumerator, int index, struct IC4_INTERFACE **ppInterface)

検出されたインターフェイスの1つを表す IC4_INTERFACE オブジェクトを返します。

bool ic4_devenum_event_add_device_list_changed (struct IC4_DEVICE_ENUM *pEnumerator, ic4_devenum_device_list_change_handler handler, void *user_ptr, ic4_devenum_device_list_change_deleter deleter)

利用可能なビデオキャプチャデバイスのリストが（潜在的に）変更されたときに呼び出される関数を登録します。

bool  ic4_devenum_event_remove_device_list_changed (struct IC4_DEVICE_ENUM *pEnumerator, ic4_devenum_device_list_change_handler handler, void *user_ptr)

以前に ic4_devenum_event_add_device_list_changed() で登録されたデバイスリスト変更ハンドラの登録を解除します。

struct IC4_INTERFACE * ic4_devitf_ref (struct IC4_INTERFACE *pInterface)

デバイスインターフェイスの内部参照カウントを1つ増やします。

void ic4_devitf_unref (struct IC4_INTERFACE *pInterface)

デバイスインターフェイスの内部参照カウントを1つ減らします。

const char * ic4_devitf_get_display_name (const struct IC4_INTERFACE *pInterface)

デバイスインターフェイスの名前を返します。

const char * ic4_devitf_get_tl_name (const struct IC4_INTERFACE *pInterface)

このインターフェイスオブジェクトを提供するトランスポートレイヤーの名前を返します。

const char * ic4_devitf_get_tl_version (const struct IC4_INTERFACE *pInterface)

このインターフェイスオブジェクトを提供するトランスポートレイヤーのバージョンを返します。

enum IC4_TL_TYPE ic4_devitf_get_tl_type (const struct IC4_INTERFACE *pInterface)

このインターフェイスが使用するトランスポートレイヤーの種類を返します。

bool ic4_devitf_get_property_map (const struct IC4_INTERFACE *pInterface, struct IC4_PROPERTY_MAP **ppMap)

指定したデバイスインターフェイスのPropertyMapを開きます。
bool ic4_devitf_update_device_list (struct IC4_INTERFACE *pInterface)

ビデオキャプチャデバイスを検索し、デバイスインターフェイスの内部デバイスリストを設定します。

int ic4_devitf_get_device_count (const struct IC4_INTERFACE *pInterface)

前回の ic4_devitf_update_device_list() の呼び出しで検出されたデバイスの数を返します。

bool  ic4_devitf_get_devinfo (const struct IC4_INTERFACE *pInterface, int index, struct IC4_DEVICE_INFO **ppInfo)

検出されたビデオキャプチャデバイスの1つを表す IC4_DEVICE_INFO オブジェクトを返します。

bool  ic4_devitf_equals (const struct IC4_INTERFACE *pInterface1, const struct IC4_INTERFACE *pInterface2)

2つのデバイスインターフェイスオブジェクトが同じインターフェイスを参照しているかどうかを確認します。
struct IC4_DEVICE_INFO *  ic4_devinfo_ref (struct IC4_DEVICE_INFO *pInfo)

デバイス情報の内部参照カウントを1つ増やします。
void  ic4_devinfo_unref (struct IC4_DEVICE_INFO *pInfo)

デバイス情報の内部参照カウントを1つ減らします。
const char *  ic4_devinfo_get_model_name (const struct IC4_DEVICE_INFO *pInfo)

デバイス情報オブジェクトからモデル名を取得します。

const char * ic4_devinfo_get_serial (const struct IC4_DEVICE_INFO *pInfo)

デバイス情報オブジェクトからシリアル番号の文字列表現を取得します。
const char * ic4_devinfo_get_version (const struct IC4_DEVICE_INFO *pInfo)

デバイス情報オブジェクトからデバイスバージョンを取得します。

const char * ic4_devinfo_get_user_id (const struct IC4_DEVICE_INFO *pInfo)

デバイス情報オブジェクトからデバイスのユーザー定義識別子を取得します。

const char * ic4_devinfo_get_unique_name (const struct IC4_DEVICE_INFO *pInfo)

デバイス情報オブジェクトからデバイスの一意な名前を取得します。

bool ic4_devinfo_equals (const struct IC4_DEVICE_INFO *pInfo1, const struct IC4_DEVICE_INFO *pInfo2)

2つのデバイス情報オブジェクトが同じビデオキャプチャデバイスを参照しているかどうかを確認します。

bool ic4_devinfo_get_devitf (const struct IC4_DEVICE_INFO *pInfo, struct IC4_INTERFACE **ppInterface)

デバイス情報オブジェクトが表すデバイスが接続されているインターフェイスを返します。

詳細説明

このセクションでは、接続されているビデオキャプチャデバイスの列挙と情報の取得方法について説明します。

Device Enumerator オブジェクト（IC4_DEVICE_ENUM）を作成するには、ic4_devenum_create() を呼び出します。

Device Enumerator は、システムに存在するビデオキャプチャデバイスを表す IC4_DEVICE_INFO オブジェクトのリストへのアクセスを提供します。

IC4_DEVICE_INFO オブジェクトを使用すると、デバイスのモデル名やシリアル番号などのデバイス情報を照会できます。

型定義ドキュメント

◆ ic4_devenum_device_list_change_deleter

typedef void(* ic4_devenum_device_list_change_deleter) (void *user_ptr)

デバイスリスト変更のユーザーデータをクリーンアップするための関数ポインタです。

パラメータ
[in]user_ptric4_devenum_event_add_device_list_changed() の呼び出し時に指定されたユーザーデータです

◆ ic4_devenum_device_list_change_handler

typedef void(* ic4_devenum_device_list_change_handler) (struct IC4_DEVICE_ENUM *pDevEnum, void *user_ptr)

デバイスリスト変更ハンドラの関数ポインタです。

パラメータ
[in]pDevEnumコールバックが登録されたデバイスエニュメレータへのポインタです
[in]user_ptric4_devenum_event_add_device_list_changed() の呼び出し時に指定されたユーザーデータです

列挙型ドキュメント

◆ IC4_TL_TYPE

enum IC4_TL_TYPE

利用可能なトランスポートレイヤーの種類を表します。

Enumerator
IC4_TLTYPE_UNKNOWN 

その他または不明なトランスポートレイヤーの種類です。

IC4_TLTYPE_GIGEVISION 

トランスポートレイヤーはGigE Vision規格を使用します。

IC4_TLTYPE_USB3VISION 

トランスポートレイヤーはUSB3 Vision規格を使用します。

関数ドキュメント

◆ ic4_devenum_create()

bool ic4_devenum_create ( struct IC4_DEVICE_ENUM **  ppEnumerator)

新しいデバイスエニュメレータを作成します。

パラメータ
[out]ppEnumerator新しいデバイスエニュメレータへのポインタを受け取るポインタです。
エニュメレータが不要になったら、次の関数を使用してオブジェクト参照を解放してください: ic4_devenum_unref().
戻り値
成功した場合は true、それ以外の場合は false を返します。 エラー情報の取得には ic4_get_last_error() を使用してください。
関連項目
ic4_devenum_unref

◆ ic4_devenum_event_add_device_list_changed()

bool ic4_devenum_event_add_device_list_changed ( struct IC4_DEVICE_ENUM *  pEnumerator,
ic4_devenum_device_list_change_handler  handler,
void *  user_ptr,
ic4_devenum_device_list_change_deleter  deleter 
)

利用可能なビデオキャプチャデバイスのリストが（潜在的に）変更されたときに呼び出される関数を登録します。

パラメータ
[in]pEnumeratorコールバックが登録されるデバイスエニュメレータです
[in]handler利用可能なビデオキャプチャデバイスのリストが変更されたときに呼び出される関数です
[in]user_ptrhandler の呼び出し時に渡されるユーザーデータです。
[in]deleterハンドラの登録が解除され、user_ptr が不要になったときに呼び出される関数です。
deleter 関数は、user_ptr に関連付けられたデータを解放するために使用できます。
deleter 関数は、デバイスリスト変更ハンドラの登録が解除されたとき、またはデバイスエニュメレータオブジェクト自体が破棄されたときに呼び出されます。
注意
To unregister a device-list-changed handler, call ic4_devenum_event_remove_device_list_changed().
handler の呼び出しが必ずしもデバイスリストの実際の変更に対応しているとは限りません。
戻り値
成功した場合は true、それ以外の場合は false を返します。
エラー情報の取得には ic4_get_last_error() を使用してください。

◆ ic4_devenum_event_remove_device_list_changed()

bool ic4_devenum_event_remove_device_list_changed ( struct IC4_DEVICE_ENUM *  pEnumerator,
ic4_devenum_device_list_change_handler  handler,
void *  user_ptr 
)

以前に ic4_devenum_event_add_device_list_changed() で登録されたデバイスリスト変更ハンドラの登録を解除します。

パラメータ
[in]pEnumeratorコールバックが現在登録されているデバイスエニュメレータです
[in]handler登録を解除する関数へのポインタです
[in]user_ptr関数が以前に登録されたときのユーザーデータです
注意
handler と user_ptr の組み合わせは、ic4_devenum_event_add_device_list_changed() の呼び出しで使用したパラメータと完全に一致している必要があります。
戻り値
成功した場合は true、それ以外の場合は false を返します。
エラー情報の取得には ic4_get_last_error() を使用してください。

◆ ic4_devenum_get_device_count()

int ic4_devenum_get_device_count ( const struct IC4_DEVICE_ENUM *  pEnumerator)

前回の ic4_devenum_update_device_list() の呼び出しで検出されたデバイスの数を返します。

パラメータ
[in]pEnumeratorデバイスエニュメレータへのポインタです
戻り値
Device Enumerator の内部デバイスリスト内のデバイス数です。
エラーが発生した場合、関数は 0 を返します。ic4_get_last_error() でエラー情報を取得できます。
関連項目
ic4_devenum_get_devinfo

◆ ic4_devenum_get_devinfo()

bool ic4_devenum_get_devinfo ( const struct IC4_DEVICE_ENUM *  pEnumerator,
int  index,
struct IC4_DEVICE_INFO **  ppInfo 
)

検出されたビデオキャプチャデバイスの1つを表す IC4_DEVICE_INFO オブジェクトを返します。

パラメータ
[in]pEnumeratorデバイスエニュメレータへのポインタです
[in]index情報を取得するデバイスのリスト内の位置です
[out]ppInfoIC4_DEVICE_INFO オブジェクトへのポインタを受け取るポインタです。
デバイス情報オブジェクトが不要になったら、次の関数を使用して参照を解放してください: ic4_devenum_unref().
戻り値
成功した場合は true、それ以外の場合は false を返します。
備考
このメソッドが有用な値を返すには、事前に ic4_devenum_update_device_list() を呼び出す必要があります。index の有効な最大値を確認するには、ic4_devenum_get_device_count() を使用してください。
関連項目
ic4_devinfo_unref

◆ ic4_devenum_get_devitf()

bool ic4_devenum_get_devitf ( const struct IC4_DEVICE_ENUM *  pEnumerator,
int  index,
struct IC4_INTERFACE **  ppInterface 
)

検出されたインターフェイスの1つを表す IC4_INTERFACE オブジェクトを返します。

パラメータ
[in]pEnumeratorデバイスエニュメレータへのポインタです
[in]index開くインターフェイスのリスト内の位置です
[out]ppInterfaceIC4_INTERFACE オブジェクトへのポインタを受け取るポインタです。
インターフェイスオブジェクトが不要になったら、次の関数を使用して参照を解放してください: ic4_devitf_unref().
戻り値
成功した場合は true、それ以外の場合は false を返します。
備考
このメソッドが有用な値を返すには、事前に ic4_devenum_update_interface_list() を呼び出す必要があります。index の有効な最大値を確認するには、ic4_devenum_get_interface_count() を使用してください。
関連項目
ic4_devinfo_unref

◆ ic4_devenum_get_interface_count()

int ic4_devenum_get_interface_count ( const struct IC4_DEVICE_ENUM *  pEnumerator)

前回の ic4_devenum_update_interface_list() の呼び出しで検出されたインターフェイスの数を返します。

パラメータ
[in]pEnumeratorデバイスエニュメレータへのポインタです
戻り値
Device Enumerator の内部インターフェースリスト内のインターフェース数です。
エラーが発生した場合、関数は 0 を返します。ic4_get_last_error() でエラー情報を取得できます。
関連項目
ic4_devenum_get_devitf

◆ ic4_devenum_ref()

struct IC4_DEVICE_ENUM * ic4_devenum_ref ( struct IC4_DEVICE_ENUM *  pEnumerator)

デバイスエニュメレータの内部参照カウントを1つ増やします。

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

◆ ic4_devenum_unref()

void ic4_devenum_unref ( struct IC4_DEVICE_ENUM *  pEnumerator)

デバイスエニュメレータの内部参照カウントを1つ減らします。

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

パラメータ
[in]pEnumeratorデバイスエニュメレータへのポインタです
備考
pEnumerator が NULL の場合、関数は何も行いません。エラー値は設定されません。
関連項目
ic4_devenum_ref

◆ ic4_devenum_update_device_list()

bool ic4_devenum_update_device_list ( struct IC4_DEVICE_ENUM *  pEnumerator)

ビデオキャプチャデバイスを検索し、エニュメレータの内部デバイスリストを設定します。

パラメータ
[in]pEnumeratorデバイスエニュメレータへのポインタです
戻り値
成功した場合は true、それ以外の場合は false を返します。 エラー情報の取得には ic4_get_last_error() を使用してください。
関連項目
ic4_devenum_get_device_count
ic4_devenum_get_devinfo

◆ ic4_devenum_update_interface_list()

bool ic4_devenum_update_interface_list ( struct IC4_DEVICE_ENUM *  pEnumerator)

インターフェイスを検索し、エニュメレータの内部インターフェイスリストを設定します。

パラメータ
[in]pEnumeratorデバイスエニュメレータへのポインタです
戻り値
成功した場合は true、それ以外の場合は false を返します。 エラー情報の取得には ic4_get_last_error() を使用してください。
備考
インターフェイスの列挙の使用は完全に任意です。多くのユースケースでは、ic4_devenum_update_device_list() によるデバイスの検索で十分です。
関連項目
ic4_devenum_get_interface_count
ic4_devenum_get_devitf

◆ ic4_devinfo_equals()

bool ic4_devinfo_equals ( const struct IC4_DEVICE_INFO *  pInfo1,
const struct IC4_DEVICE_INFO *  pInfo2 
)

2つのデバイス情報オブジェクトが同じビデオキャプチャデバイスを参照しているかどうかを確認します。

パラメータ
[in]pInfo11つ目のデバイス情報です
[in]pInfo22つ目のデバイス情報です
戻り値
デバイス情報オブジェクトが同じビデオキャプチャデバイスを参照している場合は true、それ以外の場合は false です。
両方のポインタが NULL の場合、関数は true を返します。

◆ ic4_devinfo_get_devitf()

bool ic4_devinfo_get_devitf ( const struct IC4_DEVICE_INFO *  pInfo,
struct IC4_INTERFACE **  ppInterface 
)

デバイス情報オブジェクトが表すデバイスが接続されているインターフェイスを返します。

パラメータ
[in]pInfoデバイス情報オブジェクトです
[out]ppInterfaceIC4_INTERFACE オブジェクトへのポインタを受け取るポインタです。
インターフェイスオブジェクトが不要になったら、次の関数を使用して参照を解放してください: ic4_devitf_unref().
戻り値
成功した場合は true、それ以外の場合は false を返します。 エラー情報の取得には ic4_get_last_error() を使用してください。

◆ ic4_devinfo_get_model_name()

const char * ic4_devinfo_get_model_name ( const struct IC4_DEVICE_INFO *  pInfo)

デバイス情報オブジェクトからモデル名を取得します。

パラメータ
[in]pInfoデバイス情報オブジェクトへのポインタです
戻り値
デバイスのモデル名を含む null 終端文字列へのポインタです。エラーが発生した場合は NULL です。
エラー情報の取得には ic4_get_last_error() を使用してください。
戻り値が指すメモリは、デバイス情報オブジェクトが存在する限り有効です。

◆ ic4_devinfo_get_serial()

const char * ic4_devinfo_get_serial ( const struct IC4_DEVICE_INFO *  pInfo)

デバイス情報オブジェクトからシリアル番号の文字列表現を取得します。

パラメータ
[in]pInfoデバイス情報オブジェクトへのポインタです
戻り値
デバイスのシリアル番号を含む null 終端文字列へのポインタです。エラーが発生した場合は NULL です。
エラー情報の取得には ic4_get_last_error() を使用してください。
戻り値が指すメモリは、デバイス情報オブジェクトが存在する限り有効です。
シリアル番号文字列の形式はデバイス固有です。

◆ ic4_devinfo_get_unique_name()

const char * ic4_devinfo_get_unique_name ( const struct IC4_DEVICE_INFO *  pInfo)

デバイス情報オブジェクトからデバイスの一意な名前を取得します。

パラメータ
[in]pInfoデバイス情報オブジェクトへのポインタです
戻り値
デバイスの一意の名前を含む null 終端文字列へのポインタです。エラーが発生した場合は NULL です。
エラー情報の取得には ic4_get_last_error() を使用してください。
戻り値が指すメモリは、デバイス情報オブジェクトが存在する限り有効です。
一意な名前は、デバイスドライバの識別子とデバイスのシリアル番号で構成され、デバイスを単一の文字列で一意に識別できます。

◆ ic4_devinfo_get_user_id()

const char * ic4_devinfo_get_user_id ( const struct IC4_DEVICE_INFO *  pInfo)

デバイス情報オブジェクトからデバイスのユーザー定義識別子を取得します。

パラメータ
[in]pInfoデバイス情報オブジェクトへのポインタです
戻り値
デバイスのユーザー定義の識別子を含む null 終端文字列へのポインタです。エラーが発生した場合は NULL です。
エラー情報の取得には ic4_get_last_error() を使用してください。
戻り値が指すメモリは、デバイス情報オブジェクトが存在する限り有効です。
備考
デバイスがサポートしている場合、デバイスのユーザー定義識別子は、デバイスのPropertyMapにある DeviceUserID 機能を通じて構成できます。

◆ ic4_devinfo_get_version()

const char * ic4_devinfo_get_version ( const struct IC4_DEVICE_INFO *  pInfo)

デバイス情報オブジェクトからデバイスバージョンを取得します。

パラメータ
[in]pInfoデバイス情報オブジェクトへのポインタです
戻り値
デバイスのバージョン情報を含む null 終端文字列へのポインタです。エラーが発生した場合は NULL です。
エラー情報の取得には ic4_get_last_error() を使用してください。
戻り値が指すメモリは、デバイス情報オブジェクトが存在する限り有効です。
デバイスバージョンの形式はデバイス固有です。

◆ ic4_devinfo_ref()

struct IC4_DEVICE_INFO * ic4_devinfo_ref ( struct IC4_DEVICE_INFO *  pInfo)

デバイス情報の内部参照カウントを1つ増やします。

パラメータ
[in]pInfoデバイス情報オブジェクトへのポインタです
戻り値
pInfo で渡されたポインタです
備考
pInfo が NULL の場合、関数は NULL を返します。エラー値は設定されません。
関連項目
ic4_devinfo_unref

◆ ic4_devinfo_unref()

void ic4_devinfo_unref ( struct IC4_DEVICE_INFO *  pInfo)

デバイス情報の内部参照カウントを1つ減らします。

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

パラメータ
[in]pInfoデバイス情報オブジェクトへのポインタです
備考
pInfo が NULL の場合、関数は何も行いません。エラー値は設定されません。
関連項目
ic4_devenum_ref

◆ ic4_devitf_equals()

bool ic4_devitf_equals ( const struct IC4_INTERFACE *  pInterface1,
const struct IC4_INTERFACE *  pInterface2 
)

2つのデバイスインターフェイスオブジェクトが同じインターフェイスを参照しているかどうかを確認します。

パラメータ
[in]pInterface11つ目のインターフェイスオブジェクトです
[in]pInterface22つ目のインターフェイスオブジェクトです
戻り値
デバイスインターフェースオブジェクトが同じインターフェースを参照している場合は true、それ以外の場合は false です。
両方のポインタが NULL の場合、関数は true を返します。

◆ ic4_devitf_get_device_count()

int ic4_devitf_get_device_count ( const struct IC4_INTERFACE *  pInterface)

前回の ic4_devitf_update_device_list() の呼び出しで検出されたデバイスの数を返します。

パラメータ
[in]pInterfaceデバイスインターフェイスへのポインタです
戻り値
インターフェースの内部デバイスリスト内のデバイス数です。
エラーが発生した場合、関数は 0 を返します。ic4_get_last_error() でエラー情報を取得できます。
関連項目
ic4_devitf_get_devinfo

◆ ic4_devitf_get_devinfo()

bool ic4_devitf_get_devinfo ( const struct IC4_INTERFACE *  pInterface,
int  index,
struct IC4_DEVICE_INFO **  ppInfo 
)

検出されたビデオキャプチャデバイスの1つを表す IC4_DEVICE_INFO オブジェクトを返します。

パラメータ
[in]pInterfaceデバイスインターフェイスへのポインタです
[in]index情報を取得するデバイスのリスト内の位置です
[out]ppInfoIC4_DEVICE_INFO オブジェクトへのポインタを受け取るポインタです。
デバイス情報オブジェクトが不要になったら、次の関数を使用して参照を解放してください: ic4_devenum_unref().
戻り値
成功した場合は true、それ以外の場合は false を返します。
備考
このメソッドが有用な値を返すには、事前に ic4_devitf_update_device_list() を呼び出す必要があります。index の有効な最大値を確認するには、ic4_devitf_get_device_count() を使用してください。
関連項目
ic4_devinfo_unref

◆ ic4_devitf_get_display_name()

const char * ic4_devitf_get_display_name ( const struct IC4_INTERFACE *  pInterface)

デバイスインターフェイスの名前を返します。

パラメータ
[in]pInterfaceデバイスインターフェイスへのポインタです
戻り値
デバイスインターフェースの名前を含む、null 終端された文字列です。
返されたポインタが指すメモリは、インターフェイスオブジェクトが存在する限り有効です。
If an error occurs, the function returns NULL. エラー情報の取得には ic4_get_last_error() を使用してください。

◆ ic4_devitf_get_property_map()

bool ic4_devitf_get_property_map ( const struct IC4_INTERFACE *  pInterface,
struct IC4_PROPERTY_MAP **  ppMap 
)

指定したデバイスインターフェイスのPropertyMapを開きます。

PropertyMapを使用して、インターフェイスの詳細情報を取得したり、インターフェイスや接続されたデバイスを構成したりできます。

パラメータ
[in]pInterfaceデバイスインターフェイスへのポインタです
[out]ppMap次のオブジェクトへのポインタへのポインタです: IC4_PROPERTY_MAP object.
PropertyMapが不要になったら、次の関数を使用して参照を解放してください: ic4_propmap_unref().
戻り値
成功した場合は true、それ以外の場合は false を返します。 エラー情報の取得には ic4_get_last_error() を使用してください。

◆ ic4_devitf_get_tl_name()

const char * ic4_devitf_get_tl_name ( const struct IC4_INTERFACE *  pInterface)

このインターフェイスオブジェクトを提供するトランスポートレイヤーの名前を返します。

この文字列は、インターフェイス上のデバイスへのアクセスを提供するドライバの名前として解釈できます。

パラメータ
[in]pInterfaceデバイスインターフェイスへのポインタです
戻り値
トランスポート層の名前を含む、null 終端された文字列です。
返されたポインタが指すメモリは、インターフェイスオブジェクトが存在する限り有効です。
If an error occurs, the function returns NULL. エラー情報の取得には ic4_get_last_error() を使用してください。

◆ ic4_devitf_get_tl_type()

enum IC4_TL_TYPE ic4_devitf_get_tl_type ( const struct IC4_INTERFACE *  pInterface)

このインターフェイスが使用するトランスポートレイヤーの種類を返します。

パラメータ
[in]pInterfaceデバイスインターフェイスへのポインタです
戻り値
A IC4_TL_TYPE 値です。トランスポート層の種類を表します。

◆ ic4_devitf_get_tl_version()

const char * ic4_devitf_get_tl_version ( const struct IC4_INTERFACE *  pInterface)

このインターフェイスオブジェクトを提供するトランスポートレイヤーのバージョンを返します。

この文字列は、インターフェイス上のデバイスへのアクセスを提供するドライバのドライババージョンとして解釈できます。

パラメータ
[in]pInterfaceデバイスインターフェイスへのポインタです
戻り値
トランスポート層のバージョンを含む、null 終端された文字列です。
返されたポインタが指すメモリは、インターフェイスオブジェクトが存在する限り有効です。
If an error occurs, the function returns NULL. エラー情報の取得には ic4_get_last_error() を使用してください。

◆ ic4_devitf_ref()

struct IC4_INTERFACE * ic4_devitf_ref ( struct IC4_INTERFACE *  pInterface)

デバイスインターフェイスの内部参照カウントを1つ増やします。

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

◆ ic4_devitf_unref()

void ic4_devitf_unref ( struct IC4_INTERFACE *  pInterface)

デバイスインターフェイスの内部参照カウントを1つ減らします。

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

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

◆ ic4_devitf_update_device_list()

bool ic4_devitf_update_device_list ( struct IC4_INTERFACE *  pInterface)

ビデオキャプチャデバイスを検索し、デバイスインターフェイスの内部デバイスリストを設定します。

パラメータ
[in]pInterfaceデバイスインターフェイスへのポインタです
戻り値
成功した場合は true、それ以外の場合は false を返します。 エラー情報の取得には ic4_get_last_error() を使用してください。
関連項目
ic4_devitf_get_device_count
ic4_devitf_get_devinfo