gpg::CaptureOverlayStateListenerHelper

#include <capture_overlay_state_listener_helper.h>

Defines a helper which can be used to provide ICaptureOverlayStateListener callbacks to the SDK without defining the full ICaptureOverlayStateListener interface.

Summary

Callbacks configured on this object will be invoked by the Video APIs as described in VideoManager. Callbacks not explicitly set will do nothing.

Constructors and Destructors

CaptureOverlayStateListenerHelper()
CaptureOverlayStateListenerHelper(std::shared_ptr< CaptureOverlayStateListenerHelperImpl > impl)
Constructs a CaptureOverlayStateListenerHelper from a shared_ptr to a CaptureOverlayStateListenerHelperImpl.

Public types

OnCaptureOverlayStateChangedCallback typedef
std::function< void(VideoCaptureOverlayState overlay_state)>
OnCaptureOverlayStateChangedCallback is called when the video capture overlay changes state.

Public functions

SetOnCaptureOverlayStateChangedCallback(OnCaptureOverlayStateChangedCallback callback)
Set the OnCaptureOverlayStateChangedCallback.

Public types

OnCaptureOverlayStateChangedCallback

std::function< void(VideoCaptureOverlayState overlay_state)> OnCaptureOverlayStateChangedCallback

OnCaptureOverlayStateChangedCallback is called when the video capture overlay changes state.

Public functions

CaptureOverlayStateListenerHelper

 CaptureOverlayStateListenerHelper()

CaptureOverlayStateListenerHelper

 CaptureOverlayStateListenerHelper(
  std::shared_ptr< CaptureOverlayStateListenerHelperImpl > impl
)

Constructs a CaptureOverlayStateListenerHelper from a shared_ptr to a CaptureOverlayStateListenerHelperImpl.

Intended for internal use by the API.

SetOnCaptureOverlayStateChangedCallback

CaptureOverlayStateListenerHelper & SetOnCaptureOverlayStateChangedCallback(
  OnCaptureOverlayStateChangedCallback callback
)

Set the OnCaptureOverlayStateChangedCallback.