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

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