AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
alexaClientSDK::captions::CaptionData Struct Reference

#include <CaptionData.h>

Public Member Functions

 CaptionData (const CaptionFormat format=CaptionFormat::UNKNOWN, const std::string &content="")
 
bool isValid () const
 
bool operator== (const CaptionData &rhs) const
 
bool operator!= (const CaptionData &rhs) const
 

Public Attributes

CaptionFormat format
 The format of the un-processed caption content. More...
 
std::string content
 The un-processed caption content. More...
 

Detailed Description

A container for un-processed caption content and metadata of a particular caption format.

Constructor & Destructor Documentation

◆ CaptionData()

alexaClientSDK::captions::CaptionData::CaptionData ( const CaptionFormat  format = CaptionFormat::UNKNOWN,
const std::string &  content = "" 
)
inline

Constructor.

Parameters
formatThe caption format enum value.
contentThe caption content.

Member Function Documentation

◆ isValid()

bool alexaClientSDK::captions::CaptionData::isValid ( ) const

Indicates if the data contained in this struct is valid caption data.

Returns
true if this object contains valid caption data.

◆ operator!=()

bool alexaClientSDK::captions::CaptionData::operator!= ( const CaptionData rhs) const
inline

Operator != for CaptionData.

Parameters
rhsThe right hand side of the != operation.
Returns
Whether or not this instance and rhs are not equivalent.

◆ operator==()

bool alexaClientSDK::captions::CaptionData::operator== ( const CaptionData rhs) const
inline

Operator == to compare CaptionData values.

Parameters
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are equivalent.

Member Data Documentation

◆ content

std::string alexaClientSDK::captions::CaptionData::content

The un-processed caption content.

◆ format

CaptionFormat alexaClientSDK::captions::CaptionData::format

The format of the un-processed caption content.


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

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