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 启动的叠加层状态的变化。

请注意，一次只能有一个叠加层状态监听器处于活动状态。如果在之前已注册另一个叠加层状态监听器的情况下调用此方法，则原始监听器将被新监听器替换。

RegisterCaptureOverlayStateChangedListener

void RegisterCaptureOverlayStateChangedListener(
  CaptureOverlayStateListenerHelper helper
)

注册一个监听器以监听由 ShowCaptureOverlay 启动的叠加层状态的变化。

使用 CaptureOverlayStateListenerHelper 创建监听器。

请注意，一次只能有一个叠加层状态监听器处于活动状态。如果在之前已注册另一个叠加层状态监听器的情况下调用此方法，则原始监听器将被新监听器替换。

ShowCaptureOverlay

void ShowCaptureOverlay()

启动视频捕获叠加层。

UnregisterCaptureOverlayStateChangedListener

void UnregisterCaptureOverlayStateChangedListener()

注销此客户端的叠加层状态更新监听器（如果有）。