diff options
Diffstat (limited to 'docs/Classes/SDLSetMediaClockTimer.html')
-rw-r--r-- | docs/Classes/SDLSetMediaClockTimer.html | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/docs/Classes/SDLSetMediaClockTimer.html b/docs/Classes/SDLSetMediaClockTimer.html new file mode 100644 index 000000000..c7227f3f2 --- /dev/null +++ b/docs/Classes/SDLSetMediaClockTimer.html @@ -0,0 +1,145 @@ +<h1>SDLSetMediaClockTimer Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithDictionary:">-initWithDictionary:</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> + -init + </h3> + + <p>@abstract Constructs a new SDLSetMediaClockTimer object</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">()</span></code></pre> + + + + + <h3> + -initWithDictionary: + </h3> + + <p>@abstract Constructs a new SDLSetMediaClockTimer object indicated by the NSMutableDictionary +parameter +- parameter: dict The dictionary to use</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDictionary</span><span class="p">:(</span><span class="n">NSMutableDictionary</span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n">dictionary</span> <span class="nv">dict</span><span class="p">:</span> <span class="kt">NSMutableDictionary</span><span class="o">!</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>dict</dt> + <dd><p>The dictionary to use</p> +</dd> + </dl> + + <h3> + 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"><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">atomic</span><span class="p">)</span> <span class="n">SDLStartTime</span> <span class="o">*</span><span class="n">startTime</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">startTime</span><span class="p">:</span> <span class="kt">SDLStartTime</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3> + 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"><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">atomic</span><span class="p">)</span> <span class="n">SDLStartTime</span> <span class="o">*</span><span class="n">endTime</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">endTime</span><span class="p">:</span> <span class="kt">SDLStartTime</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3> + 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’s value when it was paused</li> + </ul></p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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">atomic</span><span class="p">)</span> <span class="n">SDLUpdateMode</span> <span class="o">*</span><span class="n">updateMode</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">updateMode</span><span class="p">:</span> <span class="kt">SDLUpdateMode</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> |