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,则可以安全地开始捕获。

请勿使用此调用来检查是否支持捕获,而应使用 IsCaptureSupportedGetCaptureCapabilities

IsCaptureAvailableBlocking

IsCaptureAvailableResponse IsCaptureAvailableBlocking(
  VideoCaptureMode capture_mode
)

如果拍摄服务已在使用中,则同步提取。

使用此调用来检查开始拍摄 API 调用是否会返回 ResponseStatus::ERROR_VIDEO_ALREADY_CAPTURING。如果返回 true,则可以安全地开始捕获。超时默认指定为 10 年。

请勿使用此调用来检查是否支持捕获,而应使用 IsCaptureSupportedGetCaptureCapabilities

IsCaptureAvailableBlocking

IsCaptureAvailableResponse IsCaptureAvailableBlocking(
  Timeout timeout,
  VideoCaptureMode capture_mode
)

如果拍摄服务已在使用中,则同步提取。

使用此调用来检查开始拍摄 API 调用是否会返回 ResponseStatus::ERROR_VIDEO_ALREADY_CAPTURING。如果返回 true,则可以安全地开始捕获。将 timeout 指定为任意毫秒数。

请勿使用此调用来检查是否支持捕获,而应使用 IsCaptureSupportedGetCaptureCapabilities

IsCaptureSupported

bool IsCaptureSupported()

用于确定设备是否支持捕获的同步简单检查。

RegisterCaptureOverlayStateChangedListener

void RegisterCaptureOverlayStateChangedListener(
  ICaptureOverlayStateListener *listener
)

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

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

RegisterCaptureOverlayStateChangedListener

void RegisterCaptureOverlayStateChangedListener(
  CaptureOverlayStateListenerHelper helper
)

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

通过 CaptureOverlayStateListenerHelper 创建监听器。

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

ShowCaptureOverlay

void ShowCaptureOverlay()

启动视频拍摄叠加层。

UnregisterCaptureOverlayStateChangedListener

void UnregisterCaptureOverlayStateChangedListener()

取消注册此客户端的叠加层状态更新监听器(如果有)。