diff options
Diffstat (limited to 'docs/Classes/SDLMediaClockFormat.html')
| -rw-r--r-- | docs/Classes/SDLMediaClockFormat.html | 320 |
1 files changed, 0 insertions, 320 deletions
diff --git a/docs/Classes/SDLMediaClockFormat.html b/docs/Classes/SDLMediaClockFormat.html deleted file mode 100644 index 77de53323..000000000 --- a/docs/Classes/SDLMediaClockFormat.html +++ /dev/null @@ -1,320 +0,0 @@ -<h1>SDLMediaClockFormat Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-+valueOf:">+valueOf:</a></li> - <li><a href="#section-+values">+values</a></li> - <li><a href="#section-+CLOCK1">+CLOCK1</a></li> - <li><a href="#section-+CLOCK2">+CLOCK2</a></li> - <li><a href="#section-+CLOCK3">+CLOCK3</a></li> - <li><a href="#section-+CLOCKTEXT1">+CLOCKTEXT1</a></li> - <li><a href="#section-+CLOCKTEXT2">+CLOCKTEXT2</a></li> - <li><a href="#section-+CLOCKTEXT3">+CLOCKTEXT3</a></li> - <li><a href="#section-+CLOCKTEXT4">+CLOCKTEXT4</a></li> -</ul> - -<h3>Overview</h3> - -<p>Indicates the format of the time displayed on the connected SDL unit.</p> - -<p>Format description follows the following nomenclature: <br> - Sp = Space <br> - | = or <br> - c = character <br></p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Media Clock Format</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="nf">valueOf</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">value</span><span class="p">(</span><span class="n">of</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <h4>Parameters</h4> - <dl> - <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> - </dl> - <div> - <h4>Return Value</h4> - <p>SDLMediaClockFormat</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract declare an array that store all possible Media clock formats inside</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span> <span class="o">*</span><span class="p">)</span><span class="n">values</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">values</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">Any</span><span class="p">]</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>the array</p> - - </div> - - <h3 id="section-+CLOCK1"> - +CLOCK1 - </h3> - - <p>@abstract Media clock format: Clock1</p> - -<p>@discussion - <ul> - <li>maxHours = 19</li> - <li>maxMinutes = 59</li> - <li>maxSeconds = 59</li> - </ul></p> - -<ul> -<li>- returns: The SDLMediaClockFormat object with value <em>CLOCK1</em></li> -</ul> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="n">CLOCK1</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">clock1</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLMediaClockFormat object with value <em>CLOCK1</em></p> - - </div> - - <h3 id="section-+CLOCK2"> - +CLOCK2 - </h3> - - <p>@abstract Media clock format: Clock2</p> - -<p>@discussion - <ul> - <li>maxHours = 59</li> - <li>maxMinutes = 59</li> - <li>maxSeconds = 59</li> - </ul></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="n">CLOCK2</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">clock2</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLMediaClockFormat object with value <em>CLOCK2</em></p> - - </div> - - <h3 id="section-+CLOCK3"> - +CLOCK3 - </h3> - - <p>@abstract Media clock format: Clock3</p> - -<p>@discussion - <ul> - <li>maxHours = 9</li> - <li>maxMinutes = 59</li> - <li>maxSeconds = 59</li> - </ul></p> - -<p>@since SDL 2.0 - - returns: The SDLMediaClockFormat object with value <em>CLOCK3</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="n">CLOCK3</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">clock3</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLMediaClockFormat object with value <em>CLOCK3</em></p> - - </div> - - <h3 id="section-+CLOCKTEXT1"> - +CLOCKTEXT1 - </h3> - - <p>@abstract Media clock format: ClockText1</p> - -<p>@discussion - <ul> - <li>5 characters possible</li> - <li>Format: 1|sp c :|sp c c</li> - <li>1|sp : digit <q>1</q> or space</li> - <li>c : character out of following character set: sp|0-9|[letters, see - TypeII column in XLS.</li> - <li>:|sp : colon or space</li> - <li>used for Type II headunit</li> - </ul></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="n">CLOCKTEXT1</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">clocktext1</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLMediaClockFormat object with value <em>CLOCKTEXT1</em></p> - - </div> - - <h3 id="section-+CLOCKTEXT2"> - +CLOCKTEXT2 - </h3> - - <p>@abstract Media clock format: ClockText2</p> - -<p>@discussion - <ul> - <li>5 characters possible</li> - <li>Format: 1|sp c :|sp c c</li> - <li>1|sp : digit <q>1</q> or space</li> - <li>c : character out of following character set: sp|0-9|[letters, see - CID column in XLS.</li> - <li>:|sp : colon or space</li> - <li>used for CID headunit</li> - </ul> - difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported character - set</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="n">CLOCKTEXT2</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">clocktext2</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLMediaClockFormat object with value <em>CLOCKTEXT2</em></p> - - </div> - - <h3 id="section-+CLOCKTEXT3"> - +CLOCKTEXT3 - </h3> - - <p>@abstract Media clock format: ClockText3</p> - -<p>@discussion - <ul> - <li>6 chars possible</li> - <li>Format: 1|sp c c :|sp c c</li> - <li>1|sp : digit <q>1</q> or space</li> - <li>c : character out of following character set: sp|0-9|[letters, see - Type 5 column in XLS].</li> - <li>:|sp : colon or space</li> - <li>used for Type V headunit</li> - </ul> - difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported character - set</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="n">CLOCKTEXT3</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">clocktext3</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLMediaClockFormat object with value <em>CLOCKTEXT3</em></p> - - </div> - - <h3 id="section-+CLOCKTEXT4"> - +CLOCKTEXT4 - </h3> - - <p>@abstract Media clock format: ClockText4</p> - -<p>@discussion - <ul> - <li>6 chars possible</li> - <li>Format: c :|sp c c : c c</li> - <li>:|sp : colon or space</li> - <li>c : character out of following character set: sp|0-9|[letters]</li> - <li>used for MFD3/4/5 headunits</li> - </ul></p> - -<p>@since SDL 2.0 - - returns: The SDLMediaClockFormat object with value <em>CLOCKTEXT4</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="n">CLOCKTEXT4</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">clocktext4</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLMediaClockFormat object with value <em>CLOCKTEXT4</em></p> - - </div> - -</section> |