~ubuntu-branches/ubuntu/wily/grilo/wily

« back to all changes in this revision

Viewing changes to doc/grilo/html/GrlSource.html

  • Committer: Package Import Robot
  • Author(s): Alberto Garcia
  • Date: 2014-03-19 16:12:33 UTC
  • mfrom: (1.2.5)
  • Revision ID: package-import@ubuntu.com-20140319161233-03kxmz2x6btjv2tg
Tags: 0.2.10-1
* New upstream release.
* debian/control: update build dependency on libglib2.0-dev to 2.34.
* debian/libgrilo-0.2-1.symbols: update.

Show diffs side-by-side

added added

removed removed

Lines of Context:
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16
16
<td width="100%" align="left" class="shortcuts">
17
 
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
18
 
                  <a href="#GrlSource.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
19
 
                  <a href="#GrlSource.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 
20
 
                  <a href="#GrlSource.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> 
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
 
18
                  <a href="#GrlSource.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
 
19
                  <a href="#GrlSource.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
 
20
                  <a href="#GrlSource.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
21
21
                  <a href="#GrlSource.signals" class="shortcut">Signals</a></span>
22
22
</td>
23
23
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
409
409
<td class="property_flags">Read / Write / Construct</td>
410
410
</tr>
411
411
<tr>
 
412
<td class="property_type"><span class="type">GStrv</span></td>
 
413
<td class="property_name"><a class="link" href="GrlSource.html#GrlSource--source-tags" title="The “source-tags” property">source-tags</a></td>
 
414
<td class="property_flags">Read / Write / Construct</td>
 
415
</tr>
 
416
<tr>
412
417
<td class="property_type"><a class="link" href="GrlMedia.html#GrlMediaType" title="enum GrlMediaType"><span class="type">GrlMediaType</span></a></td>
413
418
<td class="property_name"><a class="link" href="GrlSource.html#GrlSource--supported-media" title="The “supported-media” property">supported-media</a></td>
414
419
<td class="property_flags">Read / Write / Construct</td>
3318
3323
</div>
3319
3324
<hr>
3320
3325
<div class="refsect2">
 
3326
<a name="GrlSource--source-tags"></a><h3>The <code class="literal">“source-tags”</code> property</h3>
 
3327
<pre class="programlisting">  “source-tags”              <span class="type">GStrv</span></pre>
 
3328
<p>A string array of tags relevant this source.</p>
 
3329
<p>The tags are arbitrary, and applications should just pass over the tags
 
3330
it does not understand. Applications would usually use this to either
 
3331
group sources together, or hide certain sources: a radio application
 
3332
would filter for <a class="link" href="GrlMedia.html#GRL-MEDIA-TYPE-AUDIO:CAPS"><code class="literal">GRL_MEDIA_TYPE_AUDIO</code></a> in GrlSource::supported-media as
 
3333
well as "radio" being listed in the tags.</p>
 
3334
<p>To avoid irrelevant content being listed in applications, sources
 
3335
such as generic video sites should not be tagged as "cinema" or
 
3336
"tv" as they contain a lot of content that's not either of those.</p>
 
3337
<p>This is a list of commonly used values:</p>
 
3338
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 
3339
<li class="listitem"><p>"cinema", or "tv"
 
3340
The content served is from cinema or TV sources. For example, a
 
3341
source for movie trailers would select the former, a source for
 
3342
streaming live TV would select the latter.</p></li>
 
3343
<li class="listitem"><p>"radio"
 
3344
The content served is from streaming radios.</p></li>
 
3345
<li class="listitem"><p>"music"
 
3346
The content served is music, for example, music stores such as
 
3347
Jamendo or Magnatune.</p></li>
 
3348
<li class="listitem"><p>"country:country-code"
 
3349
The content is mostly relevant to users from a particular country,
 
3350
such as a national broadcaster. For example, BBC content would be
 
3351
tagged as "country:uk". Country codes should be an ISO-639-1 or
 
3352
ISO-639-2 code.</p></li>
 
3353
<li class="listitem"><p>"protocol:protocol-name"
 
3354
The content browsing or searching uses a particular protocol, such
 
3355
as DLNA/UPnP or DMAP/DAAP. This makes it easier to whitelist or
 
3356
blacklist sources rather than matching the implementation specific
 
3357
source ID. Examples are "protocol:dlna" and "protocol:dmap".</p></li>
 
3358
<li class="listitem"><p>"localhost", or "localuser"
 
3359
The content is served from the machine the application is running on,
 
3360
or by an application the user is running. Applications might choose to
 
3361
avoid showing the user's own data in their interfaces, or integrate it
 
3362
in the user's local collection.</p></li>
 
3363
</ul></div>
 
3364
<p>Flags: Read / Write / Construct</p>
 
3365
<p class="since">Since 0.2.10</p>
 
3366
</div>
 
3367
<hr>
 
3368
<div class="refsect2">
3321
3369
<a name="GrlSource--supported-media"></a><h3>The <code class="literal">“supported-media”</code> property</h3>
3322
3370
<pre class="programlisting">  “supported-media”          <a class="link" href="GrlMedia.html#GrlMediaType" title="enum GrlMediaType"><span class="type">GrlMediaType</span></a></pre>
3323
3371
<p>List of supported media types by this source.</p>