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()

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