![]()  | 
  
    AlexaClientSDK
    3.0.0
    
   A cross-platform, modular SDK for interacting with the Alexa Voice Service 
   | 
 
Classes | |
| class | AlexaPlaybackControllerCapabilityAgentTest | 
| class | MockAlexaPlaybackControllerInterface | 
Typedefs | |
| using | EndpointIdentifier = endpoints::EndpointIdentifier | 
Functions | |
| static std::chrono::milliseconds | TIMEOUT (1000) | 
| Timeout when waiting for futures to be set.  More... | |
| static const EndpointIdentifier | TEST_ENDPOINT_ID ("testEndpointId") | 
| The test EndpointId.  More... | |
| static const std::string | EVENT ("event") | 
| Event key.  More... | |
| static const std::string | MESSAGE_ID_TEST ("MessageId_Test") | 
| MessageId for testing.  More... | |
| static const std::string | DIALOG_REQUEST_ID_TEST ("DialogRequestId_Test") | 
| DialogRequestId for testing.  More... | |
| static const std::string | CORRELATION_TOKEN_TEST ("CorrelationToken_Test") | 
| Correlation token for testing.  More... | |
| std::shared_ptr< AVSDirective > | buildAVSDirective (std::string directiveName) | 
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_givenInvalidParameters_create_shouldFail) | |
| Test that calls create() returns a nullptr if called with invalid arguments.  More... | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_playDirective_successCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_playDirective_errorCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_pauseDirective_successCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_pauseDirective_errorCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_stopDirective_successCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_stopDirective_errorCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_startOverDirective_successCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_startOverDirective_errorCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_previousDirective_successCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_previousDirective_errorCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_nextDirective_successCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_nextDirective_errorCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_rewindDirective_successCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_rewindDirective_errorCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_fastForwardDirective_successCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_fastForwardDirective_errorCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_unknownDirective) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_reportStateChange_successCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_reportStateChange_errorCase) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_unknownDirectiveWithProactivelyReportedAndRetrievableTrue) | |
| TEST_F (AlexaPlaybackControllerCapabilityAgentTest, test_unknownDirectiveWithProactivelyReportedAndRetrievableFalse) | |
Variables | |
| static const std::string | NAMESPACE {"Alexa.PlaybackController"} | 
| The namespace for capability agent.  More... | |
| static const std::string | NAMESPACE_STATE_REPORT {"Alexa.PlaybackStateReporter"} | 
| The namespace for capability agent.  More... | |
| static const std::string | STATE_REPORTER_PROPERTY {"playbackState"} | 
| Property name for Alexa.PlaybackStateReporter.  More... | |
| static const std::string | INTERFACE_VERSION {"3"} | 
| The supported version.  More... | |
| static const std::string | NAME_PLAY {"Play"} | 
| The name for Play directive.  More... | |
| static const std::string | NAME_PAUSE {"Pause"} | 
| The name for Pause directive.  More... | |
| static const std::string | NAME_STOP {"Stop"} | 
| The name for Stop directive.  More... | |
| static const std::string | NAME_START_OVER {"StartOver"} | 
| The name for StartOver directive.  More... | |
| static const std::string | NAME_PREVIOUS {"Previous"} | 
| The name for Previous directive.  More... | |
| static const std::string | NAME_NEXT {"Next"} | 
| The name for Next directive.  More... | |
| static const std::string | NAME_REWIND {"Rewind"} | 
| The name for Rewind directive.  More... | |
| static const std::string | NAME_FAST_FORWARD {"FastForward"} | 
| The name for FastForward directive.  More... | |
| static const std::string | UNKNOWN_DIRECTIVE {"Unknown"} | 
| An unknown directive signature.  More... | |
| static const std::string | PLAYBACKSTATE_PROPERTY_NAME {"playbackState"} | 
| The name of playback state property.  More... | |
| using alexaClientSDK::acsdkAlexaPlaybackController::test::EndpointIdentifier = typedef endpoints::EndpointIdentifier | 
| std::shared_ptr<AVSDirective> alexaClientSDK::acsdkAlexaPlaybackController::test::buildAVSDirective | ( | std::string | directiveName | ) | 
      
  | 
  static | 
Correlation token for testing.
      
  | 
  static | 
DialogRequestId for testing.
      
  | 
  static | 
Event key.
      
  | 
  static | 
MessageId for testing.
      
  | 
  static | 
The test EndpointId.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_givenInvalidParameters_create_shouldFail | |||
| ) | 
Test that calls create() returns a nullptr if called with invalid arguments.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_playDirective_successCase | |||
| ) | 
Test successful handling of Play directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_playDirective_errorCase | |||
| ) | 
Test error path of Play directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_pauseDirective_successCase | |||
| ) | 
Test successful handling of Pause directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_pauseDirective_errorCase | |||
| ) | 
Test error path of Pause directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_stopDirective_successCase | |||
| ) | 
Test successful handling of Stop directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_stopDirective_errorCase | |||
| ) | 
Test error path of Stop directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_startOverDirective_successCase | |||
| ) | 
Test successful handling of StartOver directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_startOverDirective_errorCase | |||
| ) | 
Test error path of StartOver directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_previousDirective_successCase | |||
| ) | 
Test successful handling of Previous directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_previousDirective_errorCase | |||
| ) | 
Test error path of Previous directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_nextDirective_successCase | |||
| ) | 
Test successful handling of Next directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_nextDirective_errorCase | |||
| ) | 
Test error path of Next directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_rewindDirective_successCase | |||
| ) | 
Test successful handling of Rewind directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_rewindDirective_errorCase | |||
| ) | 
Test error path of Rewind directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_fastForwardDirective_successCase | |||
| ) | 
Test successful handling of FastForward directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_fastForwardDirective_errorCase | |||
| ) | 
Test error path of FastForward directive.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_unknownDirective | |||
| ) | 
Tests unknown Directive. Expect that the sendExceptionEncountered and setFailed will be called.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_reportStateChange_successCase | |||
| ) | 
Test triggering of reportStateChange and subsequent call to the ContextManager to build the context.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_reportStateChange_errorCase | |||
| ) | 
Test triggering of reportStateChange and subsequent call to get the getPlaybackState and call to the ContextManager to report the new playback state.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_unknownDirectiveWithProactivelyReportedAndRetrievableTrue | |||
| ) | 
Tests unknown Directive with both proactively reported and retrievable set. Expect that the sendExceptionEncountered and setFailed will be called.
| alexaClientSDK::acsdkAlexaPlaybackController::test::TEST_F | ( | AlexaPlaybackControllerCapabilityAgentTest | , | 
| test_unknownDirectiveWithProactivelyReportedAndRetrievableFalse | |||
| ) | 
Tests unknown Directive with both proactively reported and retrievable as false. Expect that the sendExceptionEncountered and setFailed will be called.
      
  | 
  static | 
Timeout when waiting for futures to be set.
      
  | 
  static | 
The supported version.
      
  | 
  static | 
The name for FastForward directive.
      
  | 
  static | 
The name for Next directive.
      
  | 
  static | 
The name for Pause directive.
      
  | 
  static | 
The name for Play directive.
      
  | 
  static | 
The name for Previous directive.
      
  | 
  static | 
The name for Rewind directive.
      
  | 
  static | 
The name for StartOver directive.
      
  | 
  static | 
The name for Stop directive.
      
  | 
  static | 
The namespace for capability agent.
      
  | 
  static | 
The namespace for capability agent.
      
  | 
  static | 
The name of playback state property.
      
  | 
  static | 
Property name for Alexa.PlaybackStateReporter.
      
  | 
  static | 
An unknown directive signature.
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0