gpg::VideoManager

#include <video_manager.h>

動画関連のさまざまなデータを取得して設定します。

概要

公開タイプ
CaptureCapabilitiesCallback typedef
std::function< void(const GetCaptureCapabilitiesResponse &)>
GetCaptureCapabilitiesResponse を受け取るコールバック タイプを定義します。
CaptureStateCallback typedef
std::function< void(const GetCaptureStateResponse &)>
GetCaptureStateResponse を受け取るコールバック タイプを定義します。
IsCaptureAvailableCallback typedef
std::function< void(const IsCaptureAvailableResponse &)>
IsCaptureAvailableResponse を受け取るコールバック タイプを定義します。

パブリック関数
GetCaptureCapabilities(CaptureCapabilitiesCallback callback)
void
マイクまたは前面カメラがサポートされているかどうか、サービスが外部ストレージに書き込むことができるかどうか、利用可能なキャプチャ モードと画質レベルなど、サービスのビデオ機能を非同期で取得します。
GetCaptureCapabilitiesBlocking()
マイクまたは前面カメラがサポートされているかどうか、外部ストレージに書き込むことができるかどうか、利用可能なキャプチャ モードと画質レベルなど、サービスの動画機能を同期的に取得します。
GetCaptureCapabilitiesBlocking(Timeout timeout)
マイクまたは前面カメラがサポートされているかどうか、外部ストレージに書き込むことができるかどうか、利用可能なキャプチャ モードと画質レベルなど、サービスの動画機能を同期的に取得します。
GetCaptureState(CaptureStateCallback callback)
void
キャプチャ サービスの現在の状態を非同期的に取得します。
GetCaptureStateBlocking()
キャプチャ サービスの現在の状態を同期的に取得します。
GetCaptureStateBlocking(Timeout timeout)
キャプチャ サービスの現在の状態を同期的に取得します。
IsCaptureAvailable(VideoCaptureMode capture_mode, IsCaptureAvailableCallback callback)
void
キャプチャ サービスがすでに使用されているかどうかを非同期で取得します。
IsCaptureAvailableBlocking(VideoCaptureMode capture_mode)
キャプチャ サービスがすでに使用中かどうかを同期的に取得します。
IsCaptureAvailableBlocking(Timeout timeout, VideoCaptureMode capture_mode)
キャプチャ サービスがすでに使用中かどうかを同期的に取得します。
IsCaptureSupported()
bool
デバイスがキャプチャをサポートしているかどうかを判断するための同期簡易チェック。
RegisterCaptureOverlayStateChangedListener(ICaptureOverlayStateListener *listener)
void
ShowCaptureOverlay によって開始されたオーバーレイ状態の変化をリッスンするリスナーを登録します。
RegisterCaptureOverlayStateChangedListener(CaptureOverlayStateListenerHelper helper)
void
ShowCaptureOverlay によって開始されたオーバーレイ状態の変化をリッスンするリスナーを登録します。
ShowCaptureOverlay()
void
動画キャプチャ オーバーレイを起動します。
UnregisterCaptureOverlayStateChangedListener()
void
このクライアントのオーバーレイ状態更新リスナー（ある場合）の登録を解除します。

構造体
gpg::VideoManager::GetCaptureCapabilitiesResponse

動画機能のデータとレスポンス ステータスを保持します。
gpg::VideoManager::GetCaptureStateResponse

動画キャプチャ状態とレスポンス ステータスのデータを保持します。
gpg::VideoManager::IsCaptureAvailableResponse

IsCaptureAvailable で指定されるキャプチャ モードが使用可能かどうかをレスポンスのステータスとともに保持します。

公開タイプ

CaptureCapabilitiesCallback

std::function< void(const GetCaptureCapabilitiesResponse &)> CaptureCapabilitiesCallback

GetCaptureCapabilitiesResponse を受け取るコールバック タイプを定義します。

このコールバックの型は、以下の GetCaptureCapabilities(*) 関数に提供されます。

CaptureStateCallback

std::function< void(const GetCaptureStateResponse &)> CaptureStateCallback

GetCaptureStateResponse を受け取るコールバック タイプを定義します。

このコールバックの型は、以下の GetCaptureState(*) 関数に提供されます。

IsCaptureAvailableCallback

std::function< void(const IsCaptureAvailableResponse &)> IsCaptureAvailableCallback

IsCaptureAvailableResponse を受け取るコールバック タイプを定義します。

このコールバックの型は、以下の IsCaptureAvailable(*) 関数に提供されます。

パブリック関数

GetCaptureCapabilities

void GetCaptureCapabilities(
  CaptureCapabilitiesCallback callback
)

マイクまたは前面カメラがサポートされているかどうか、サービスが外部ストレージに書き込むことができるかどうか、利用可能なキャプチャ モードと画質レベルなど、サービスのビデオ機能を非同期で取得します。

GetCaptureCapabilitiesBlocking

GetCaptureCapabilitiesResponse GetCaptureCapabilitiesBlocking()

マイクまたは前面カメラがサポートされているかどうか、外部ストレージに書き込むことができるかどうか、利用可能なキャプチャ モードと画質レベルなど、サービスの動画機能を同期的に取得します。

タイムアウトはデフォルトで 10 年に設定されています。

GetCaptureCapabilitiesBlocking

GetCaptureCapabilitiesResponse GetCaptureCapabilitiesBlocking(
  Timeout timeout
)

マイクまたは前面カメラがサポートされているかどうか、外部ストレージに書き込むことができるかどうか、利用可能なキャプチャ モードと画質レベルなど、サービスの動画機能を同期的に取得します。

timeout を任意のミリ秒数として指定します。

GetCaptureState

void GetCaptureState(
  CaptureStateCallback callback
)

キャプチャ サービスの現在の状態を非同期的に取得します。

これにより、キャプチャ オーバーレイが表示されているかどうかや、オーバーレイがアクティブにキャプチャに使用されているかどうかなどが通知されます。詳しくは、VideoCaptureState をご覧ください。

GetCaptureStateBlocking

GetCaptureStateResponse GetCaptureStateBlocking()

キャプチャ サービスの現在の状態を同期的に取得します。

これにより、キャプチャ オーバーレイが表示されているかどうかや、オーバーレイがアクティブにキャプチャに使用されているかどうかなどが通知されます。詳しくは、VideoCaptureState をご覧ください。タイムアウトはデフォルトで 10 年に設定されています。

GetCaptureStateBlocking

GetCaptureStateResponse GetCaptureStateBlocking(
  Timeout timeout
)

キャプチャ サービスの現在の状態を同期的に取得します。

これにより、キャプチャ オーバーレイが表示されているかどうか、オーバーレイがアクティブにキャプチャに使用されているかどうかなどが通知されます。詳しくは、VideoCaptureState をご覧ください。timeout を任意のミリ秒数として指定します。

IsCaptureAvailable

void IsCaptureAvailable(
  VideoCaptureMode capture_mode,
  IsCaptureAvailableCallback callback
)

キャプチャ サービスがすでに使用されているかどうかを非同期で取得します。

この呼び出しを使用して、キャプチャ開始 API 呼び出しが ResponseStatus::ERROR_VIDEO_ALREADY_CAPTURING を返すかどうかを確認します。true が返された場合は、安全にキャプチャを開始できます。

キャプチャがサポートされているかどうかを確認する場合は、この呼び出しではなく、IsCaptureSupported または GetCaptureCapabilities を使用してください。

IsCaptureAvailableBlocking

IsCaptureAvailableResponse IsCaptureAvailableBlocking(
  VideoCaptureMode capture_mode
)

キャプチャ サービスがすでに使用中かどうかを同期的に取得します。

この呼び出しを使用して、キャプチャ開始 API 呼び出しが ResponseStatus::ERROR_VIDEO_ALREADY_CAPTURING を返すかどうかを確認します。true が返された場合は、安全にキャプチャを開始できます。タイムアウトはデフォルトで 10 年に設定されています。

キャプチャがサポートされているかどうかを確認する場合は、この呼び出しではなく、IsCaptureSupported または GetCaptureCapabilities を使用してください。

IsCaptureAvailableBlocking

IsCaptureAvailableResponse IsCaptureAvailableBlocking(
  Timeout timeout,
  VideoCaptureMode capture_mode
)

キャプチャ サービスがすでに使用中かどうかを同期的に取得します。

この呼び出しを使用して、キャプチャ開始 API 呼び出しが ResponseStatus::ERROR_VIDEO_ALREADY_CAPTURING を返すかどうかを確認します。true が返された場合は、安全にキャプチャを開始できます。timeout を任意のミリ秒数として指定します。

キャプチャがサポートされているかどうかを確認する場合は、この呼び出しではなく、IsCaptureSupported または GetCaptureCapabilities を使用してください。

IsCaptureSupported

bool IsCaptureSupported()

デバイスがキャプチャをサポートしているかどうかを判断するための同期簡易チェック。

RegisterCaptureOverlayStateChangedListener

void RegisterCaptureOverlayStateChangedListener(
  ICaptureOverlayStateListener *listener
)

ShowCaptureOverlay によって開始されたオーバーレイ状態の変化をリッスンするリスナーを登録します。

同時にアクティブにできるオーバーレイ状態リスナーは 1 つだけです。別のオーバーレイ状態リスナーが登録されている間にこのメソッドを呼び出すと、元のリスナーが新しいリスナーに置き換えられます。

RegisterCaptureOverlayStateChangedListener

void RegisterCaptureOverlayStateChangedListener(
  CaptureOverlayStateListenerHelper helper
)

ShowCaptureOverlay によって開始されたオーバーレイ状態の変化をリッスンするリスナーを登録します。

CaptureOverlayStateListenerHelper を受け取ってリスナーを作成します。

同時にアクティブにできるオーバーレイ状態リスナーは 1 つだけです。別のオーバーレイ状態リスナーが登録されている間にこのメソッドを呼び出すと、元のリスナーが新しいリスナーに置き換えられます。

ShowCaptureOverlay

void ShowCaptureOverlay()

動画キャプチャ オーバーレイを起動します。

UnregisterCaptureOverlayStateChangedListener

void UnregisterCaptureOverlayStateChangedListener()

このクライアントのオーバーレイ状態更新リスナー（ある場合）の登録を解除します。