diff options
Diffstat (limited to 'docs/Classes/SDLArtwork.html')
| -rw-r--r-- | docs/Classes/SDLArtwork.html | 43 |
1 files changed, 11 insertions, 32 deletions
diff --git a/docs/Classes/SDLArtwork.html b/docs/Classes/SDLArtwork.html index c461ff991..b7e0fbb40 100644 --- a/docs/Classes/SDLArtwork.html +++ b/docs/Classes/SDLArtwork.html @@ -23,7 +23,6 @@ <p>This is an ephemeral file, it will not be persisted through sessions / ignition cycles. Any files that you do not <em>know</em> you will use in future sessions should be created through this method. For example, album / artist artwork should be ephemeral.</p> <p>Persistent files should be created using <code>persistentArtworkWithImage:name:asImageFormat:</code></p> - <div class="aside aside-warning"> <p class="aside-title">Warning</p> <p>It is strongly recommended to pass the file url using an SDLFile initializer instead of the image. If you pass the UIImage, it is loaded into memory, and will be dumped to a temporary file. This will create a duplicate file. <em>Only pass a UIImage if the image is not stored on disk</em>.</p> @@ -38,27 +37,20 @@ <span class="nf">asImageFormat</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLArtworkImageFormat.html">SDLArtworkImageFormat</a></span><span class="p">)</span><span class="nv">imageFormat</span><span class="p">;</span></code></pre> - <h4>Swift</h4> - <pre class="highlight"><code><span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">image</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="k">as</span> <span class="nv">imageFormat</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLArtworkImageFormat.html">SDLArtworkImageFormat</a></span><span class="p">)</span></code></pre> - <h4>Parameters</h4> <dl> <dt>image</dt> - <dd><p>The UIImage to be sent to the remote head unit</p> -</dd> + <dd><p>The UIImage to be sent to the remote head unit</p></dd> <dt>name</dt> - <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system).</p> -</dd> + <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote file system limitations.</p></dd> <dt>imageFormat</dt> - <dd><p>Whether the image should be converted to a PNG or JPG before transmission. Images with transparency or few colors should be PNGs. Images with many colors should be JPGs.</p> -</dd> + <dd><p>Whether the image should be converted to a PNG or JPG before transmission. Images with transparency or few colors should be PNGs. Images with many colors should be JPGs.</p></dd> </dl> <div> <h4>Return Value</h4> <p>An instance of this class to be passed to the file manager.</p> - </div> <h3 id="section-+persistentArtworkWithImage:name:asImageFormat:"> @@ -70,7 +62,6 @@ <p>This is a persistent file, it will be persisted through sessions / ignition cycles. You will only have a limited space for all files, so be sure to only persist files that are required for all or most sessions. For example, menu artwork should be persistent.</p> <p>Ephemeral files should be created using <code>ephemeralArtworkWithImage:name:asImageFormat:</code></p> - <div class="aside aside-warning"> <p class="aside-title">Warning</p> <p>It is strongly recommended to pass the file url using an SDLFile initializer instead of the image. If you pass the UIImage, it is loaded into memory, and will be dumped to a temporary file. This will create a duplicate file. <em>Only pass a UIImage if the image is not stored on disk</em>.</p> @@ -86,27 +77,20 @@ <span class="p">(</span><span class="n"><a href="../Enums/SDLArtworkImageFormat.html">SDLArtworkImageFormat</a></span><span class="p">)</span><span class="nv">imageFormat</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">persistentArtwork</span><span class="p">(</span><span class="n">withImage</span> <span class="nv">image</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="k">as</span> <span class="nv">imageFormat</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLArtworkImageFormat.html">SDLArtworkImageFormat</a></span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre> - <h4>Parameters</h4> <dl> <dt>image</dt> - <dd><p>The UIImage to be sent to the remote head unit</p> -</dd> + <dd><p>The UIImage to be sent to the remote head unit</p></dd> <dt>name</dt> - <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system).</p> -</dd> + <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote file system limitations.</p></dd> <dt>imageFormat</dt> - <dd><p>Whether the image should be converted to a PNG or JPG before transmission. Images with transparency or few colors should be PNGs. Images with many colors should be JPGs.</p> -</dd> + <dd><p>Whether the image should be converted to a PNG or JPG before transmission. Images with transparency or few colors should be PNGs. Images with many colors should be JPGs.</p></dd> </dl> <div> <h4>Return Value</h4> <p>An instance of this class to be passed to the file manager.</p> - </div> <h3 id="section--initWithImage:name:persistent:asImageFormat:"> @@ -125,29 +109,24 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="nv">image</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">persistent</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="k">as</span> <span class="nv">imageFormat</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLArtworkImageFormat.html">SDLArtworkImageFormat</a></span><span class="p">)</span></code></pre> + <pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="nv">image</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">persistent</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="k">as</span> <span class="nv">imageFormat</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLArtworkImageFormat.html">SDLArtworkImageFormat</a></span><span class="p">)</span></code></pre> <h4>Parameters</h4> <dl> <dt>image</dt> - <dd><p>The UIImage to be sent to the remote head unit</p> -</dd> + <dd><p>The UIImage to be sent to the remote head unit</p></dd> <dt>name</dt> - <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system).</p> -</dd> + <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote file system limitations.</p></dd> <dt>persistent</dt> - <dd><p>Whether or not the artwork should be persistent.</p> -</dd> + <dd><p>Whether or not the artwork should be persistent.</p></dd> <dt>imageFormat</dt> - <dd><p>Whether the image should be converted to a PNG or JPG before transmission. Images with transparency or few colors should be PNGs. Images with many colors should be JPGs.</p> -</dd> + <dd><p>Whether the image should be converted to a PNG or JPG before transmission. Images with transparency or few colors should be PNGs. Images with many colors should be JPGs.</p></dd> </dl> <div> <h4>Return Value</h4> <p>An instance of this class to be passed to the file manager.</p> - </div> </section> |