×
Namespaces

Variants
Actions
(Difference between revisions)

Nokia MixRadio app-to-app protocol for Windows Phone 8

From Nokia Developer Wiki
Jump to: navigation, search
chintandave_er (Talk | contribs)
(Chintandave er -)
jaaura (Talk | contribs)
m (Jaaura -)
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Draft]]
+
[[Category:Windows Phone]][[Category:Windows Phone 8]][[Category:Nokia Music API]][[Category:Code Snippet]]
{{Abstract|This article explains how to integrate our application with Nokia Music services and elements using Nokia Music API for Windows Phone. }}
+
{{Abstract|This article explains how to access Nokia Music services using the Nokia Music app's published app-to-app protocol.}}
 
+
 
{{ArticleMetaData <!-- v1.2 -->
 
{{ArticleMetaData <!-- v1.2 -->
 
|sourcecode= <!-- Link to example source code e.g. [[Media:The Code Example ZIP.zip]] -->
 
|sourcecode= <!-- Link to example source code e.g. [[Media:The Code Example ZIP.zip]] -->
 
|installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.sis]]) -->
 
|installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.sis]]) -->
|devices= <!-- Devices tested against - e.g. ''devices=Nokia 6131 NFC, Nokia C7-00'') -->
+
|devices= Nokia Lumia devices,
 
|sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Qt SDK 1.1.4]) -->
 
|sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Qt SDK 1.1.4]) -->
|platform= Windows Phone  
+
|platform= Windows Phone 8 only
 
|devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
 
|devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
|dependencies= <!-- Any other/external dependencies e.g.: Google Maps Api v1.0 -->
+
|dependencies= Nokia Lumia device only, Nokia Music
|signing=<!-- Signing requirements - empty or one of: Self-Signed, DevCert, Manufacturer -->
+
|signing= <!-- Signing requirements - empty or one of: Self-Signed, DevCert, Manufacturer -->
 
|capabilities= <!-- Capabilities required by the article/code example (e.g. Location, NetworkServices. -->
 
|capabilities= <!-- Capabilities required by the article/code example (e.g. Location, NetworkServices. -->
|keywords= <!-- APIs, classes and methods (e.g. QSystemScreenSaver, QList, CBase -->
+
|keywords= URI, Launcher, LaunchUriAsync
 
|language= <!-- Language category code for non-English topics - e.g. Lang-Chinese -->
 
|language= <!-- Language category code for non-English topics - e.g. Lang-Chinese -->
 
|translated-by= <!-- [[User:XXXX]] -->
 
|translated-by= <!-- [[User:XXXX]] -->
|translated-from-title= <!-- Title only -->  
+
|translated-from-title= <!-- Title only -->
 
|translated-from-id= <!-- Id of translated revision -->
 
|translated-from-id= <!-- Id of translated revision -->
|review-by=<!-- After re-review: [[User:username]] -->
+
|review-by= <!-- After re-review: [[User:username]] -->
 
|review-timestamp= <!-- After re-review: YYYYMMDD -->
 
|review-timestamp= <!-- After re-review: YYYYMMDD -->
 
|update-by= <!-- After significant update: [[User:username]]-->
 
|update-by= <!-- After significant update: [[User:username]]-->
 
|update-timestamp= <!-- After significant update: YYYYMMDD -->
 
|update-timestamp= <!-- After significant update: YYYYMMDD -->
|creationdate=20121115
+
|creationdate= 20121115
|author= [[User:chintandave_er]]
+
|author= [[User:Chintandave er]]
 +
}}
 +
 
 +
{{SeeAlso|
 +
* [http://bit.ly/ZS1w6p Nokia Music API]
 +
* [http://bit.ly/ZS2i3k Nokia Music App-to-app Protocol PPT]
 +
* [http://bit.ly/Wb7PTn URI Scheme of Built in app WP8]
 
}}
 
}}
  
 
== Introduction ==
 
== Introduction ==
Windows Phone 8 Supports app-to-app protocol even for 3rd party application. That means we can launch one app from other app by using Launching API for Windows Phone. Here We will show how to use Nokia Music app-to-app protocol for Windows Phone 8 in our application to get use of Nokia Music service. The Nokia Music Windows Phone API providers Launchers that allow integration with Nokia Music in the same easy manner.
+
[[:Category:Windows Phone 8|Windows Phone 8]] exposes an app-to-app protocol API for 3rd party applications. This can be used to launch the Nokia Music app with the Launching API for Windows Phone, search for an artist or an album, get details of a particular song or an album, get nearest gigs etc. This article describes how to use Nokia Music app-to-app protocol in an application to access the Nokia Music service.  
 +
 
 +
{{Tip|The protocol relies on the existence of the Nokia Music app, which will not be present on non-Nokia devices. If your code may run on other devices a good approach is to use the [http://www.developer.nokia.com/Resources/Library/Lumia/#!nokia-music-apis/nokia-music-launchers.html Nokia Music API Launchers] - not only do these provide the common "launcher" interface, but they also provide fallback-to-web behaviour if Nokia Music app is not present.}}
  
== What is app-to-app protocol ==
+
== What is app-to-app protocol ? ==
App-to-app protocols allow one app to launch another app with a specific URI Scheme. With Windows Phone 8, we can also register our app as 3rd party application to support app-to-app protocol and can allow other app to open our app and use elements of our app into their app.
+
App-to-app protocols allow one app to launch another app with a specific URI Scheme. With [[::Category:Windows Phone 8|Windows Phone 8]], we can also register our app as 3rd party application to support app-to-app protocol and can allow other app to open our app and use elements of our app into their app.
  
But here we will see how to use Nokia Music API Launchers for Windows Phone 8 to use various services of Nokia Music. To call app-to-app protocol, we need to use [http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh701480.aspx Launcher.LaunchUriAsync(Uri)] method and pass URI schema in it. For example, to launch Nokia Music app from other app call {{Icode|Launcher.LaunchUriAsync(Uri)}} with URI Schema {{Icode|nokia-music://}}
+
But here we will see how to use Nokia Music API Launchers for [[::Category:Windows Phone 8|Windows Phone 8]] to use various services of Nokia Music. To call app-to-app protocol, we need to use [http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh701480.aspx Launcher.LaunchUriAsync(Uri)] method and pass URI schema in it. For example, to launch Nokia Music app from other app, call {{Icode|Launcher.LaunchUriAsync(Uri)}} with URI Schema {{Icode|nokia-music://}}
  
 
<code csharp>
 
<code csharp>
Line 37: Line 44:
 
</code>
 
</code>
  
 
+
{{Note|This code cant be tested on [[::Category:Windows Phone 8|Windows Phone 8]] Emulator due to lack of Nokia Music app but can test only on Nokia Lumia [[::Category:Windows Phone 8|Windows Phone 8]] device. If you want to test this code in Emulator, You need .xap file of Nokia music to install Nokia Music app manually.}}
  
 
== Nokia Music app-to-app protocol ==  
 
== Nokia Music app-to-app protocol ==  
Line 55: Line 62:
 
</code>
 
</code>
  
=== Search Anything ===  
+
=== Search Artist===  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 88: Line 95:
 
! Task !! URI
 
! Task !! URI
 
|-  
 
|-  
|  Play Artist Mix || nokia-music://play/artist/?artist={name}
+
|  Play an Artist Mix || nokia-music://play/artist/?artist={name}
 
|}
 
|}
  
.
+
 
 
Example:
 
Example:
 
<code csharp>
 
<code csharp>
 
Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://play/artist/?artist=green day”));
 
Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://play/artist/?artist=green day”));
 
</code>
 
</code>
 +
 +
 +
=== Show Gigs Around You ===
 +
{| class="wikitable"
 +
|-
 +
! Task !! URI
 +
|-
 +
|  Show Gigs Around You || nokia-music://show/gigs
 +
|}
 +
 +
 +
Example:
 +
<code csharp>
 +
Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://show/gigs”));
 +
</code>
 +
 +
=== Search for Gigs ===
 +
{| class="wikitable"
 +
|-
 +
! Task !! URI
 +
|-
 +
|  Search for Gigs || nokia-music://search/gigs/?term={term}
 +
|}
 +
 +
 +
Example:
 +
<code csharp>
 +
Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://show/gigs”));
 +
</code>
 +
 +
=== Show Curated Mixes ===
 +
{| class="wikitable"
 +
|-
 +
! Task !! URI
 +
|-
 +
|  Show Curated Mixes || nokia-music://show/mixes
 +
|}
 +
 +
 +
Example:
 +
<code csharp>
 +
Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://show/mixes”));
 +
</code>
 +
 +
 +
=== Play a Curated Mix ===
 +
{| class="wikitable"
 +
|-
 +
! Task !! URI
 +
|-
 +
|  Play a Curated Mix || nokia-music://play/mix/?id={id}
 +
|}
 +
 +
 +
Example:
 +
<code csharp>
 +
Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://play/mix/?id=18523926”));
 +
</code>
 +
 +
 +
=== Show Product Details (e.g. Album) ===
 +
{| class="wikitable"
 +
|-
 +
! Task !! URI
 +
|-
 +
|  Show Product Details (e.g. Album) || nokia-music://show/product/?id={id}
 +
|}
 +
 +
 +
Example:
 +
<code csharp>
 +
Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://show/product/?id=36100035”));
 +
</code>
 +
 +
== See also ==
 +
* [http://www.developer.nokia.com/Resources/Library/Lumia/#!nokia-music-api.html Nokia Music API]
 +
* [http://www.developer.nokia.com/Resources/Library/Lumia/#!nokia-music-api/nokia-music-launchers.html Nokia Music Launchers]

Revision as of 16:59, 9 January 2013

This article explains how to access Nokia Music services using the Nokia Music app's published app-to-app protocol.

SignpostIcon XAML 40.png
WP Metro Icon WP8.png
Article Metadata
Tested with
Devices(s): Nokia Lumia devices,
Compatibility
Platform(s): Windows Phone 8 only
Windows Phone 8
Dependencies: Nokia Lumia device only, Nokia Music
Article
Keywords: URI, Launcher, LaunchUriAsync
Created: chintandave_er (15 Nov 2012)
Last edited: jaaura (09 Jan 2013)

Contents

Introduction

Windows Phone 8 exposes an app-to-app protocol API for 3rd party applications. This can be used to launch the Nokia Music app with the Launching API for Windows Phone, search for an artist or an album, get details of a particular song or an album, get nearest gigs etc. This article describes how to use Nokia Music app-to-app protocol in an application to access the Nokia Music service.

Tip.pngTip: The protocol relies on the existence of the Nokia Music app, which will not be present on non-Nokia devices. If your code may run on other devices a good approach is to use the Nokia Music API Launchers - not only do these provide the common "launcher" interface, but they also provide fallback-to-web behaviour if Nokia Music app is not present.

What is app-to-app protocol ?

App-to-app protocols allow one app to launch another app with a specific URI Scheme. With Windows Phone 8, we can also register our app as 3rd party application to support app-to-app protocol and can allow other app to open our app and use elements of our app into their app.

But here we will see how to use Nokia Music API Launchers for Windows Phone 8 to use various services of Nokia Music. To call app-to-app protocol, we need to use Launcher.LaunchUriAsync(Uri) method and pass URI schema in it. For example, to launch Nokia Music app from other app, call Launcher.LaunchUriAsync(Uri) with URI Schema nokia-music://

Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://”));

Note.pngNote: This code cant be tested on Windows Phone 8 Emulator due to lack of Nokia Music app but can test only on Nokia Lumia Windows Phone 8 device. If you want to test this code in Emulator, You need .xap file of Nokia music to install Nokia Music app manually.

Nokia Music app-to-app protocol

Here are the list of Nokia Music app-to-app protocol with example.

Launch App

Task URI
Launch App nokia-music://

Example:

Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://”));

Search Artist

Task URI
Search nokia-music://search/anything/?term={searchtext}

Example:

Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://search/anything/?term=green day”));

Show Artist Details

Task URI
Show Artist Details By Id nokia-music://show/artist/?id={id}
Show Artist Details By name nokia-music://show/artist/?name={name}

Example:

Windows.System.Launcher.LaunchUriAsync(new Uri(“ nokia-music://show/artist/?name=green day”));

Play Artist Mix

Task URI
Play an Artist Mix nokia-music://play/artist/?artist={name}


Example:

Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://play/artist/?artist=green day”));


Show Gigs Around You

Task URI
Show Gigs Around You nokia-music://show/gigs


Example:

Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://show/gigs”));

Search for Gigs

Task URI
Search for Gigs nokia-music://search/gigs/?term={term}


Example:

Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://show/gigs”));

Show Curated Mixes

Task URI
Show Curated Mixes nokia-music://show/mixes


Example:

Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://show/mixes”));


Play a Curated Mix

Task URI
Play a Curated Mix nokia-music://play/mix/?id={id}


Example:

Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://play/mix/?id=18523926”));


Show Product Details (e.g. Album)

Task URI
Show Product Details (e.g. Album) nokia-music://show/product/?id={id}


Example:

Windows.System.Launcher.LaunchUriAsync(new Uri(“nokia-music://show/product/?id=36100035”));

See also

236 page views in the last 30 days.

Was this page helpful?

Your feedback about this content is important. Let us know what you think.

 

Thank you!

We appreciate your feedback.

×