AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
MediaPlayerFactoryInterface.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_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_MEDIAPLAYERFACTORYINTERFACE_H_
17 #define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_MEDIAPLAYERFACTORYINTERFACE_H_
18 
19 #include <memory>
20 #include <string>
21 
23 
24 namespace alexaClientSDK {
25 namespace avsCommon {
26 namespace utils {
27 namespace mediaPlayer {
28 
29 // Forward-declare the MediaPlayerInterface class
31 
38 struct Fingerprint {
40  std::string package;
41 
43  std::string buildType;
44 
46  std::string versionNumber;
47 };
48 
58 public:
62  virtual ~MediaPlayerFactoryInterface() = default;
63 
69  virtual Fingerprint getFingerprint() = 0;
70 
76  virtual std::shared_ptr<MediaPlayerInterface> acquireMediaPlayer() = 0;
77 
86  virtual bool releaseMediaPlayer(std::shared_ptr<MediaPlayerInterface> mediaPlayer) = 0;
87 
95  virtual bool isMediaPlayerAvailable() = 0;
96 
102  virtual void addObserver(std::shared_ptr<MediaPlayerFactoryObserverInterface> observer) = 0;
103 
109  virtual void removeObserver(std::shared_ptr<MediaPlayerFactoryObserverInterface> observer) = 0;
110 };
111 
112 } // namespace mediaPlayer
113 } // namespace utils
114 } // namespace avsCommon
115 } // namespace alexaClientSDK
116 
117 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_MEDIAPLAYERFACTORYINTERFACE_H_
std::string buildType
Build type of media player.
Definition: MediaPlayerFactoryInterface.h:43
std::string package
Package name of media player.
Definition: MediaPlayerFactoryInterface.h:40
Definition: MediaPlayerFactoryInterface.h:38
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerInterface MediaPlayerInterface
Definition: PreviewAlexaClient.cpp:148
std::string versionNumber
Version number of media player.
Definition: MediaPlayerFactoryInterface.h:46

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