summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLSetMediaClockTimer.html
blob: c2d891d2cffe8296e315881050e5d1396e6e6acf (plain)
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
<h1>SDLSetMediaClockTimer Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithUpdateMode:hours:minutes:seconds:">-initWithUpdateMode:hours:minutes:seconds:</a></li>
  <li><a href="#section--initWithUpdateMode:">-initWithUpdateMode:</a></li>
  <li><a href="#section-startTime">startTime</a></li>
  <li><a href="#section-endTime">endTime</a></li>
  <li><a href="#section-updateMode">updateMode</a></li>
</ul>

<h3>Overview</h3>

<p>Sets the media clock/timer value and the update method (e.g.count-up,
 count-down, etc.)
 <p>
 Function Group: Base <p>
 <b>HMILevel needs to be FULL, LIMITIED or BACKGROUND</b>
 </p></p>

<p>Since SmartDeviceLink 1.0</p>


<section class="section task-group-section">
  <h3 id="section--initWithUpdateMode:hours:minutes:seconds:">
      -initWithUpdateMode:hours:minutes:seconds:
  </h3>
  
  <p>Undocumented</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithUpdateMode</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLUpdateMode.h@T@SDLUpdateMode">SDLUpdateMode</a></span><span class="p">)</span><span class="nv">updateMode</span> <span class="nf">hours</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">hours</span> <span class="nf">minutes</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">minutes</span> <span class="nf">seconds</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">seconds</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">updateMode</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLUpdateMode.h@T@SDLUpdateMode">SDLUpdateMode</a></span><span class="p">,</span> <span class="nv">hours</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">,</span> <span class="nv">minutes</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">,</span> <span class="nv">seconds</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">)</span></code></pre>

  
  
  
  <h3 id="section--initWithUpdateMode:">
      -initWithUpdateMode:
  </h3>
  
  <p>Undocumented</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithUpdateMode</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLUpdateMode.h@T@SDLUpdateMode">SDLUpdateMode</a></span><span class="p">)</span><span class="nv">updateMode</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">updateMode</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLUpdateMode.h@T@SDLUpdateMode">SDLUpdateMode</a></span><span class="p">)</span></code></pre>

  
  
  
  <h3 id="section-startTime">
      startTime
  </h3>
  
  <p>@abstract A Start Time with specifying hour, minute, second values</p>

<p>@discussion A startTime object with specifying hour, minute, second values
            <p>
            <b>Notes: </b>
            <ul>
            <li>If <q>updateMode</q> is COUNTUP or COUNTDOWN, this parameter
            must be provided</li>
            <li>Will be ignored for PAUSE/RESUME and CLEAR</li>
            </ul></p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLStartTime.html">SDLStartTime</a></span> <span class="o">*</span><span class="n">startTime</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">startTime</span><span class="p">:</span> <span class="nf">SDLStartTime</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-endTime">
      endTime
  </h3>
  
  <p>@abstract An END time of type SDLStartTime, specifying hour, minute, second values</p>

<p>@discussion An SDLStartTime object with specifying hour, minute, second values</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLStartTime.html">SDLStartTime</a></span> <span class="o">*</span><span class="n">endTime</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">endTime</span><span class="p">:</span> <span class="nf">SDLStartTime</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-updateMode">
      updateMode
  </h3>
  
  <p>@abstract The media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME)</p>

<p>@discussion a Enumeration value (COUNTUP/COUNTDOWN/PAUSE/RESUME)
            <p>
            <b>Notes: </b>
            <ul>
            <li>When updateMode is PAUSE, RESUME or CLEAR, the start time value
            is ignored</li>
            <li>When updateMode is RESUME, the timer resumes counting from
            the timer&rsquo;s value when it was paused</li>
            </ul></p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLUpdateMode.h@T@SDLUpdateMode">SDLUpdateMode</a></span> <span class="n">_Nonnull</span> <span class="n">updateMode</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">updateMode</span><span class="p">:</span> <span class="nf">SDLUpdateMode</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
</section>