Stay organized with collections
Save and categorize content based on your preferences.
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.
Public types
OnCaptureOverlayStateChangedCallback
std::function< void(VideoCaptureOverlayState overlay_state)> OnCaptureOverlayStateChangedCallback
OnCaptureOverlayStateChangedCallback is called when the video capture overlay changes state.
Public functions
CaptureOverlayStateListenerHelper
CaptureOverlayStateListenerHelper()
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-10-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-28 UTC."],[],[],null,["# gpg::CaptureOverlayStateListenerHelper Class Reference\n\ngpg::CaptureOverlayStateListenerHelper\n======================================\n\n`#include \u003ccapture_overlay_state_listener_helper.h\u003e`\n\nDefines a helper which can be used to provide [ICaptureOverlayStateListener](/games/services/cpp/api/class/gpg/i-capture-overlay-state-listener#classgpg_1_1_i_capture_overlay_state_listener) callbacks to the SDK without defining the full [ICaptureOverlayStateListener](/games/services/cpp/api/class/gpg/i-capture-overlay-state-listener#classgpg_1_1_i_capture_overlay_state_listener) interface.\n\nSummary\n-------\n\nCallbacks configured on this object will be invoked by the Video APIs as described in [VideoManager](/games/services/cpp/api/class/gpg/video-manager#classgpg_1_1_video_manager). Callbacks not explicitly set will do nothing.\n\n| ### Constructors and Destructors ||\n|---|---|\n| [CaptureOverlayStateListenerHelper](#classgpg_1_1_capture_overlay_state_listener_helper_1aa26ee013824e0860204d116f6936ec00)`()` ||\n| [CaptureOverlayStateListenerHelper](#classgpg_1_1_capture_overlay_state_listener_helper_1aecaf9e0d1448e531b913d62bf0d0c743)`(std::shared_ptr\u003c `[CaptureOverlayStateListenerHelperImpl](/games/services/cpp/api/class/gpg/capture-overlay-state-listener-helper#classgpg_1_1_capture_overlay_state_listener_helper_1ada1a3968e0e8823a87dcc090e606722d)` \u003e impl)` Constructs a [CaptureOverlayStateListenerHelper](/games/services/cpp/api/class/gpg/capture-overlay-state-listener-helper#classgpg_1_1_capture_overlay_state_listener_helper) from a `shared_ptr` to a `CaptureOverlayStateListenerHelperImpl`. ||\n\n| ### Public types ||\n|--------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [OnCaptureOverlayStateChangedCallback](#classgpg_1_1_capture_overlay_state_listener_helper_1a8495775a99a242e17d467ed7ce626d44) | typedef `std::function\u003c void(`[VideoCaptureOverlayState](/games/services/cpp/api/namespace/gpg#namespacegpg_1ab33e17bd3d8f618360755e2c73a2b9b0)` overlay_state)\u003e` `OnCaptureOverlayStateChangedCallback` is called when the video capture overlay changes state. |\n\n| ### Public functions ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [SetOnCaptureOverlayStateChangedCallback](#classgpg_1_1_capture_overlay_state_listener_helper_1ab3a2ea2eb5abd24167f0b7f53bef96a4)`(`[OnCaptureOverlayStateChangedCallback](/games/services/cpp/api/class/gpg/capture-overlay-state-listener-helper#classgpg_1_1_capture_overlay_state_listener_helper_1a8495775a99a242e17d467ed7ce626d44)` callback)` | [CaptureOverlayStateListenerHelper](/games/services/cpp/api/class/gpg/capture-overlay-state-listener-helper#classgpg_1_1_capture_overlay_state_listener_helper)` &` Set the OnCaptureOverlayStateChangedCallback. |\n\nPublic types\n------------\n\n### OnCaptureOverlayStateChangedCallback\n\n```c++\nstd::function\u003c void(VideoCaptureOverlayState overlay_state)\u003e OnCaptureOverlayStateChangedCallback\n``` \n`OnCaptureOverlayStateChangedCallback` is called when the video capture overlay changes state.\n\nPublic functions\n----------------\n\n### CaptureOverlayStateListenerHelper\n\n```c++\n CaptureOverlayStateListenerHelper()\n``` \n\n### CaptureOverlayStateListenerHelper\n\n```c++\n CaptureOverlayStateListenerHelper(\n std::shared_ptr\u003c CaptureOverlayStateListenerHelperImpl \u003e impl\n)\n``` \nConstructs a [CaptureOverlayStateListenerHelper](/games/services/cpp/api/class/gpg/capture-overlay-state-listener-helper#classgpg_1_1_capture_overlay_state_listener_helper) from a `shared_ptr` to a `CaptureOverlayStateListenerHelperImpl`.\n\nIntended for internal use by the API. \n\n### SetOnCaptureOverlayStateChangedCallback\n\n```c++\nCaptureOverlayStateListenerHelper & SetOnCaptureOverlayStateChangedCallback(\n OnCaptureOverlayStateChangedCallback callback\n)\n``` \nSet the OnCaptureOverlayStateChangedCallback."]]
