AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Attributes | List of all members
alexaClientSDK::bluetoothImplementations::blueZ::MediaContext Class Reference

#include <MediaContext.h>

Public Member Functions

 ~MediaContext ()
 
 MediaContext ()
 
void setStreamFD (int streamFD)
 
int getStreamFD ()
 
void setReadMTU (int readMTU)
 
int getReadMTU ()
 
void setWriteMTU (int writeMTU)
 
int getWriteMTU ()
 
sbc_t * getSBCContextPtr ()
 
bool isSBCInitialized ()
 
void setSBCInitialized (bool initialized)
 

Static Public Attributes

static constexpr int INVALID_FD = -1
 Invalid file descriptor. More...
 

Detailed Description

Media streaming context. Contains the data configured during the arbitrary invocation of BlueZ MediaEndpoint1::SetConfiguration callback.

Constructor & Destructor Documentation

◆ ~MediaContext()

alexaClientSDK::bluetoothImplementations::blueZ::MediaContext::~MediaContext ( )

Destructor

◆ MediaContext()

alexaClientSDK::bluetoothImplementations::blueZ::MediaContext::MediaContext ( )

Constructor

Member Function Documentation

◆ getReadMTU()

int alexaClientSDK::bluetoothImplementations::blueZ::MediaContext::getReadMTU ( )

Get Maximum Transfer Unit for read operations

Returns
Maximum Transfer Unit for read operations

◆ getSBCContextPtr()

sbc_t* alexaClientSDK::bluetoothImplementations::blueZ::MediaContext::getSBCContextPtr ( )

Get pointer to SBC decoder context object

Returns
The pointer to SBC decoder context object

◆ getStreamFD()

int alexaClientSDK::bluetoothImplementations::blueZ::MediaContext::getStreamFD ( )

Get linux file descriptor that should be used for read/write operations.

Returns
linux file descriptor that should be used for read/write operations.

◆ getWriteMTU()

int alexaClientSDK::bluetoothImplementations::blueZ::MediaContext::getWriteMTU ( )

Get Maximum Transfer Unit for write operations.

Returns
Maximum Transfer Unit for write operations.

◆ isSBCInitialized()

bool alexaClientSDK::bluetoothImplementations::blueZ::MediaContext::isSBCInitialized ( )

Method to check if SBC decoder context has been successfully initialized.

Returns
true if if SBC decoder context has been successfully initialized, false otherwise.

◆ setReadMTU()

void alexaClientSDK::bluetoothImplementations::blueZ::MediaContext::setReadMTU ( int  readMTU)

Set Maximum Transfer Unit for read operations.

Parameters
readMTUMaximum Transfer Unit for read operations.

◆ setSBCInitialized()

void alexaClientSDK::bluetoothImplementations::blueZ::MediaContext::setSBCInitialized ( bool  initialized)

Marks the SBC decoder context as successfully initialized.

Parameters
initializedtrue if SBC decoder context has been successfully initialized, false otherwise.

◆ setStreamFD()

void alexaClientSDK::bluetoothImplementations::blueZ::MediaContext::setStreamFD ( int  streamFD)

Sets a linux file descriptor that should be used for read/write operations.

Parameters
streamFDlinux file descriptor that should be used for read/write operations.

◆ setWriteMTU()

void alexaClientSDK::bluetoothImplementations::blueZ::MediaContext::setWriteMTU ( int  writeMTU)

Set Maximum Transfer Unit for write operations.

Parameters
writeMTUMaximum Transfer Unit for write operations.

Member Data Documentation

◆ INVALID_FD

constexpr int alexaClientSDK::bluetoothImplementations::blueZ::MediaContext::INVALID_FD = -1
static

Invalid file descriptor.


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

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