alexaClientSDK::acsdkAudioPlayer::AudioItem::Stream Struct Reference

Contains the parameters of the stream. More...

#include <AudioItem.h>

Collaboration diagram for alexaClientSDK::acsdkAudioPlayer::AudioItem::Stream:

Classes
struct	ProgressReport
	Contains values for progress reports. More...

Public Attributes
std::string	url
std::shared_ptr< avsCommon::avs::attachment::AttachmentReader >	reader
StreamFormat	format
std::chrono::milliseconds	offset
std::chrono::milliseconds	endOffset
std::chrono::steady_clock::time_point	expiryTime
	The date and time in ISO 8601 format for when the stream becomes invalid. More...
struct alexaClientSDK::acsdkAudioPlayer::AudioItem::Stream::ProgressReport	progressReport
std::string	token
	An opaque token that represents the current stream. More...
std::string	expectedPreviousToken
	An opaque token that represents the expected previous stream. More...

Detailed Description

Contains the parameters of the stream.

Member Data Documentation

endOffset

std::chrono::milliseconds alexaClientSDK::acsdkAudioPlayer::AudioItem::Stream::endOffset

A timestamp indicating where the stream plaback must end. The value 0 is used as a default value for when the field does not exist. A non-zero value is where the playback must end. The value if it exists must not be greater than the value of offset.

expectedPreviousToken

std::string alexaClientSDK::acsdkAudioPlayer::AudioItem::Stream::expectedPreviousToken

An opaque token that represents the expected previous stream.

expiryTime

std::chrono::steady_clock::time_point alexaClientSDK::acsdkAudioPlayer::AudioItem::Stream::expiryTime

The date and time in ISO 8601 format for when the stream becomes invalid.

format

StreamFormat alexaClientSDK::acsdkAudioPlayer::AudioItem::Stream::format

This field is defined when the AudioItem has an associated binary audio attachment. This parameter is ignored if the associated audio is a stream.

offset

std::chrono::milliseconds alexaClientSDK::acsdkAudioPlayer::AudioItem::Stream::offset

A timestamp indicating where in the stream the client must start playback. For example, when offset is set to 0, this indicates playback of the stream must start at 0, or the start of the stream. Any other value indicates that playback must start from the provided offset.

progressReport

struct alexaClientSDK::acsdkAudioPlayer::AudioItem::Stream::ProgressReport alexaClientSDK::acsdkAudioPlayer::AudioItem::Stream::progressReport

reader

std::shared_ptr<avsCommon::avs::attachment::AttachmentReader> alexaClientSDK::acsdkAudioPlayer::AudioItem::Stream::reader

The attachment reader for url if the audio content is a binary audio attachment. For http/https attachments, this field is set to nullptr and unused.

token

std::string alexaClientSDK::acsdkAudioPlayer::AudioItem::Stream::token

An opaque token that represents the current stream.

url

std::string alexaClientSDK::acsdkAudioPlayer::AudioItem::Stream::url

Identifies the location of audio content. If the audio content is a binary audio attachment, the value will be a unique identifier for the content, which is formatted as follows: "cid:". Otherwise the value will be a remote http/https location.

---

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

• /workplace/avs-device-sdk/capabilities/AudioPlayer/acsdkAudioPlayer/include/acsdkAudioPlayer/AudioItem.h