AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
CaptionManagerInterface.h
Go to the documentation of this file.
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  * http://aws.amazon.com/apache2.0/
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 #ifndef ALEXA_CLIENT_SDK_CAPTIONS_INTERFACE_INCLUDE_CAPTIONS_CAPTIONMANAGERINTERFACE_H_
17 #define ALEXA_CLIENT_SDK_CAPTIONS_INTERFACE_INCLUDE_CAPTIONS_CAPTIONMANAGERINTERFACE_H_
18 
19 #include <memory>
20 
21 #include "CaptionData.h"
22 #include "CaptionFrame.h"
24 
25 namespace alexaClientSDK {
26 namespace captions {
27 
33 public:
37  virtual ~CaptionManagerInterface() = default;
38 
46  virtual void onCaption(CaptionFrame::MediaPlayerSourceId sourceId, const CaptionData& captionData) = 0;
47 
55  virtual void setCaptionPresenter(const std::shared_ptr<CaptionPresenterInterface>& presenter) = 0;
56 
63  virtual void setMediaPlayers(
64  const std::vector<std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface>>& mediaPlayers) = 0;
65 
72  virtual void addMediaPlayer(
73  const std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface>& mediaPlayer) = 0;
74 
81  virtual void removeMediaPlayer(
82  const std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface>& mediaPlayer) = 0;
83 
89  virtual bool isEnabled() const = 0;
90 };
91 
92 } // namespace captions
93 } // namespace alexaClientSDK
94 
95 #endif // ALEXA_CLIENT_SDK_CAPTIONS_INTERFACE_INCLUDE_CAPTIONS_CAPTIONMANAGERINTERFACE_H_
virtual void setCaptionPresenter(const std::shared_ptr< CaptionPresenterInterface > &presenter)=0
virtual void onCaption(CaptionFrame::MediaPlayerSourceId sourceId, const CaptionData &captionData)=0
Definition: CaptionManagerInterface.h:32
Definition: CaptionData.h:30
virtual void setMediaPlayers(const std::vector< std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >> &mediaPlayers)=0
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
virtual void addMediaPlayer(const std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface > &mediaPlayer)=0
avsCommon::utils::mediaPlayer::MediaPlayerInterface::SourceId MediaPlayerSourceId
Type alias to the media player source ID.
Definition: CaptionFrame.h:36
virtual void removeMediaPlayer(const std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface > &mediaPlayer)=0

AlexaClientSDK 1.26.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0