forked from alexa/alexa-auto-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassaace_1_1alexa_1_1_playback_controller.html
174 lines (164 loc) · 9.9 KB
/
classaace_1_1alexa_1_1_playback_controller.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Alexa Auto SDK: aace::alexa::PlaybackController Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="aace-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Alexa Auto SDK
 <span id="projectnumber">1.0.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>aace</b></li><li class="navelem"><b>alexa</b></li><li class="navelem"><a class="el" href="classaace_1_1alexa_1_1_playback_controller.html">PlaybackController</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classaace_1_1alexa_1_1_playback_controller-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">aace::alexa::PlaybackController Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a76438dda2f5eacefd9f9cf33392f6ecd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1alexa_1_1_playback_controller.html#a76438dda2f5eacefd9f9cf33392f6ecd">playButtonPressed</a> ()</td></tr>
<tr class="separator:a76438dda2f5eacefd9f9cf33392f6ecd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad324b0923fa23afc798195edb90a115"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1alexa_1_1_playback_controller.html#aad324b0923fa23afc798195edb90a115">pauseButtonPressed</a> ()</td></tr>
<tr class="separator:aad324b0923fa23afc798195edb90a115"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3d3dcfc62eb322ac1e9d797fcf06c39"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1alexa_1_1_playback_controller.html#ac3d3dcfc62eb322ac1e9d797fcf06c39">nextButtonPressed</a> ()</td></tr>
<tr class="separator:ac3d3dcfc62eb322ac1e9d797fcf06c39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac37b185415e146d1c114df09cdabd059"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1alexa_1_1_playback_controller.html#ac37b185415e146d1c114df09cdabd059">previousButtonPressed</a> ()</td></tr>
<tr class="separator:ac37b185415e146d1c114df09cdabd059"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classaace_1_1alexa_1_1_playback_controller.html">PlaybackController</a> should be extended to handle playback control operations such as on-platform button presses for the <code><a class="el" href="classaace_1_1alexa_1_1_audio_player.html">AudioPlayer</a></code>. The Engine will respond to <a class="el" href="classaace_1_1alexa_1_1_playback_controller.html">PlaybackController</a> events with playback control directives on the <code><a class="el" href="classaace_1_1alexa_1_1_audio_player.html">AudioPlayer</a></code> <code><a class="el" href="classaace_1_1alexa_1_1_media_player.html">MediaPlayer</a></code>.</p>
<dl class="section note"><dt>Note</dt><dd>The <a class="el" href="classaace_1_1alexa_1_1_template_runtime.html#a71852ea84caa81de6cd633006c76ad51">TemplateRuntime::renderPlayerInfo()</a> payload includes information about what playback control buttons should be enabled on screen with a player info display card.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classaace_1_1alexa_1_1_audio_player.html">AudioPlayer</a> </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a76438dda2f5eacefd9f9cf33392f6ecd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76438dda2f5eacefd9f9cf33392f6ecd">◆ </a></span>playButtonPressed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aace::alexa::PlaybackController::playButtonPressed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notifies the Engine of a platform request to begin audio playback, such as when a user presses a "play" button. The Engine will issue a playback directive to the <code><a class="el" href="classaace_1_1alexa_1_1_audio_player.html">AudioPlayer</a></code> <code><a class="el" href="classaace_1_1alexa_1_1_media_player.html">MediaPlayer</a></code> to initiate playback on the platform. </p>
</div>
</div>
<a id="aad324b0923fa23afc798195edb90a115"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad324b0923fa23afc798195edb90a115">◆ </a></span>pauseButtonPressed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aace::alexa::PlaybackController::pauseButtonPressed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notifies the Engine of a platform request to pause audio playback, such as when a user presses a "pause" button. The Engine will issue a playback directive to the <code><a class="el" href="classaace_1_1alexa_1_1_audio_player.html">AudioPlayer</a></code> <code><a class="el" href="classaace_1_1alexa_1_1_media_player.html">MediaPlayer</a></code> to stop playback on the platform. </p>
</div>
</div>
<a id="ac3d3dcfc62eb322ac1e9d797fcf06c39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3d3dcfc62eb322ac1e9d797fcf06c39">◆ </a></span>nextButtonPressed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aace::alexa::PlaybackController::nextButtonPressed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notifies the Engine of a platform request to skip forward in the playback queue, such as when a user presses a "next" button. The Engine will issue playback directives to the <code><a class="el" href="classaace_1_1alexa_1_1_audio_player.html">AudioPlayer</a></code> <code><a class="el" href="classaace_1_1alexa_1_1_media_player.html">MediaPlayer</a></code> to control playback on the platform. </p>
</div>
</div>
<a id="ac37b185415e146d1c114df09cdabd059"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac37b185415e146d1c114df09cdabd059">◆ </a></span>previousButtonPressed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void aace::alexa::PlaybackController::previousButtonPressed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notifies the Engine of a platform request to skip backward in the playback queue, such as when a user presses a "previous" button. The Engine will issue playback directives to the <code><a class="el" href="classaace_1_1alexa_1_1_audio_player.html">AudioPlayer</a></code> <code><a class="el" href="classaace_1_1alexa_1_1_media_player.html">MediaPlayer</a></code> to control playback on the platform. </p>
</div>
</div>
</div><!-- contents -->
<html>
<body>
<hr style="height:1px;border-width:0;color:gray;background-color:gray">
<p style="text-align:left;">
Alexa Auto SDK 1.0.2 - Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
<span style="float:right;">
Licensed under the <a HREF=http://aws.amazon.com/apache2.0/>Apache License, Version 2.0</a>
</span>
</p>
</body>
</html>