AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
CaptionLine.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_CAPTIONLINE_H_
17 #define ALEXA_CLIENT_SDK_CAPTIONS_INTERFACE_INCLUDE_CAPTIONS_CAPTIONLINE_H_
18 
19 #include <string>
20 #include <vector>
21 
22 #include "TextStyle.h"
23 
24 namespace alexaClientSDK {
25 namespace captions {
26 
30 struct CaptionLine {
37  CaptionLine(const std::string& text = "", const std::vector<TextStyle>& styles = {});
38 
47  std::vector<CaptionLine> splitAtTextIndex(size_t index);
48 
55  static CaptionLine merge(std::vector<CaptionLine> captionLines);
56 
63  bool operator==(const CaptionLine& rhs) const;
64 
71  bool operator!=(const CaptionLine& rhs) const;
72 
74  std::string text;
75 
77  std::vector<TextStyle> styles;
78 };
79 
87 std::ostream& operator<<(std::ostream& stream, const CaptionLine& line);
88 
89 } // namespace captions
90 } // namespace alexaClientSDK
91 
92 #endif // ALEXA_CLIENT_SDK_CAPTIONS_INTERFACE_INCLUDE_CAPTIONS_CAPTIONLINE_H_
static CaptionLine merge(std::vector< CaptionLine > captionLines)
Definition: CaptionLine.cpp:44
std::vector< TextStyle > styles
Zero or more TextStyles that relate to m_text.
Definition: CaptionLine.h:77
bool operator==(const CaptionLine &rhs) const
Definition: CaptionLine.cpp:146
std::ostream & operator<<(std::ostream &stream, const CaptionFormat &format)
Definition: CaptionFormat.h:59
static int index
Mock buffer index.
Definition: AndroidSLESMediaQueueTest.cpp:70
bool operator!=(const CaptionLine &rhs) const
Definition: CaptionLine.cpp:150
std::vector< CaptionLine > splitAtTextIndex(size_t index)
Definition: CaptionLine.cpp:71
Definition: CaptionLine.h:30
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
std::string text
The text content for this line of captions.
Definition: CaptionLine.h:74
CaptionLine(const std::string &text="", const std::vector< TextStyle > &styles={})
Definition: CaptionLine.cpp:41

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