AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Attributes | List of all members
alexaClientSDK::alexaLiveViewControllerInterfaces::DisplayProperties Struct Reference

#include <LiveViewControllerTypes.h>

Collaboration diagram for alexaClientSDK::alexaLiveViewControllerInterfaces::DisplayProperties:
Collaboration graph

Public Attributes

DisplayMode displayMode
 Display mode in which to render the live stream. More...
avsCommon::utils::Optional< OverlayTypeoverlayType
avsCommon::utils::Optional< OverlayPositionoverlayPosition

Detailed Description

DisplayProperties object. Defines details of the requested display experience on the viewing device.

Member Data Documentation

◆ displayMode

DisplayMode alexaClientSDK::alexaLiveViewControllerInterfaces::DisplayProperties::displayMode

Display mode in which to render the live stream.

◆ overlayPosition

avsCommon::utils::Optional<OverlayPosition> alexaClientSDK::alexaLiveViewControllerInterfaces::DisplayProperties::overlayPosition

(Optional) If displayMode is OVERLAY, overlayPosition indicates the position on the screen to display the overlay.

◆ overlayType

avsCommon::utils::Optional<OverlayType> alexaClientSDK::alexaLiveViewControllerInterfaces::DisplayProperties::overlayType

(Optional) If displayMode is OVERLAY, the type of overlay to use to render the live stream. If set to NONE, the displayMode defaults to FULL_SCREEN.

The documentation for this struct was generated from the following file:

AlexaClientSDK 3.0.0 - Copyright 2016-2022, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0