Appearance

mavsdk::Tune Class Reference ​

#include: tune.h

Enable creating and sending a tune to be played on the system.

Data Structures ​

struct TuneDescription

Public Types ​

TypeDescription
enum SongElementAn element of the tune.
enum ResultPossible results returned for tune requests.
std::function< void(Result)> ResultCallbackCallback type for asynchronous Tune calls.

Public Member Functions ​

TypeNameDescription
 Tune (System & system)Constructor. Creates the plugin for a specific System.
 Tune (std::shared_ptr< System > system)Constructor. Creates the plugin for a specific System.
 ~Tune () overrideDestructor (internal use only).
 Tune (const Tune & other)Copy constructor.
voidplay_tune_async (TuneDescription tune_description, const ResultCallback callback)Send a tune to be played by the system.
Resultplay_tune (TuneDescription tune_description)constSend a tune to be played by the system.
const Tune &operator= (const Tune &)=deleteEquality operator (object is not copyable).

Constructor & Destructor Documentation ​

Tune() ​

cpp
mavsdk::Tune::Tune(System &system)

Constructor. Creates the plugin for a specific System.

The plugin is typically created as shown below:

cpp
auto tune = Tune(system);

Parameters

  • System& system - The specific system associated with this plugin.

Tune() ​

cpp
mavsdk::Tune::Tune(std::shared_ptr< System > system)

Constructor. Creates the plugin for a specific System.

The plugin is typically created as shown below:

cpp
auto tune = Tune(system);

Parameters

  • std::shared_ptr< System > system - The specific system associated with this plugin.

~Tune() ​

cpp
mavsdk::Tune::~Tune() override

Destructor (internal use only).

Tune() ​

cpp
mavsdk::Tune::Tune(const Tune &other)

Copy constructor.

Parameters

Member Typdef Documentation ​

typedef ResultCallback ​

cpp
using mavsdk::Tune::ResultCallback =  std::function<void(Result)>

Callback type for asynchronous Tune calls.

Member Enumeration Documentation ​

enum SongElement ​

An element of the tune.

ValueDescription
StyleLegatoAfter this element, start playing legato.
StyleNormalAfter this element, start playing normal.
StyleStaccatoAfter this element, start playing staccato.
Duration1After this element, set the note duration to 1.
Duration2After this element, set the note duration to 2.
Duration4After this element, set the note duration to 4.
Duration8After this element, set the note duration to 8.
Duration16After this element, set the note duration to 16.
Duration32After this element, set the note duration to 32.
NoteAPlay note A.
NoteBPlay note B.
NoteCPlay note C.
NoteDPlay note D.
NoteEPlay note E.
NoteFPlay note F.
NoteGPlay note G.
NotePausePlay a rest.
SharpAfter this element, sharp the note (half a step up).
FlatAfter this element, flat the note (half a step down).
OctaveUpAfter this element, shift the note 1 octave up.
OctaveDownAfter this element, shift the note 1 octave down.

enum Result ​

Possible results returned for tune requests.

ValueDescription
UnknownUnknown result.
SuccessRequest succeeded.
InvalidTempoInvalid tempo (range: 32 - 255).
TuneTooLongInvalid tune: encoded string must be at most 247 chars.
ErrorFailed to send the request.
NoSystemNo system connected.

Member Function Documentation ​

play_tune_async() ​

cpp
void mavsdk::Tune::play_tune_async(TuneDescription tune_description, const ResultCallback callback)

Send a tune to be played by the system.

This function is non-blocking. See 'play_tune' for the blocking counterpart.

Parameters

play_tune() ​

cpp
Result mavsdk::Tune::play_tune(TuneDescription tune_description) const

Send a tune to be played by the system.

This function is blocking. See 'play_tune_async' for the non-blocking counterpart.

Parameters

Returns

 Result - Result of request.

operator=() ​

cpp
const Tune & mavsdk::Tune::operator=(const Tune &)=delete

Equality operator (object is not copyable).

Parameters

Returns

 const Tune & -