ios-musixmatch-app-extension

KO | EN

gitlite — search

#javascript #react #ai #typescript #golang #rust #deep-learning #linux #docker #nodejs #java #kubernetes #ios #mcp

ios-musixmatch-app-extension

(★ 23)

Musixmatch iOS extension SDK with samples

ios-musixmatch-app-extension Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Musixmatch iOS Lyrics Extension

With just a few lines of code your app can access the world's largest lyrics catalog to provide a better experience to your users.

With the Musixmatch extension you can:

1. See the synced lyrics for the now playing song in your app
 2. Read the lyrics for any song directly from your app.

Please refer to the official documentation on [Musixmatch.com](https://developer.musixmatch.com/documentation/ios-lyrics-extension)

## App Extension in Action

1. Open the Sample Player App

2. Tap the LYRICS button

3. Get the Lyrics

## Just Give Me the Code

Integrating the Musixmatch extension is very easy, just include the following files in your project.

* [MXMLyricsAction.h](https://github.com/Musixmatchdev/musixmatch-app-extension/blob/master/MXMLyricsAction/MXMLyricsAction.h)
* [MXMLyricsAction.m](https://github.com/Musixmatchdev/musixmatch-app-extension/blob/master/MXMLyricsAction/MXMLyricsAction.m)

## Running the Demo App

Adding Musixmatch support to your app is easy. To demonstrate how it works, we have demo sample app for iOS that showcase all of the Musixmatch features.

### Step 1: Download the Source Code and Demo Apps

To get started, download the Musixmatch Extension project from https://github.com/Musixmatchdev/musixmatch-app-extension/archive/master.zip, or [clone it from GitHub](https://github.com/Musixmatchdev/musixmatch-app-extension).

Inside the downloaded folder, you'll find the resources needed to integrate with Musixmatch.

### Step 2: Chose a song

Tap on 'Add Music' button to reproduce a song

### Step 3: Open Musixmatch Extension

Tap on 'Lyrics' button and choose Musixmatch (the fist time you ave to enable if from 'More').

## Integrating Musixmatch With Your App

You can open Musixmatch whenever you want to show lyrics on time for your nowplaying track.
Just give to Musixmatch extension these datas:

1. Title
2. Artist
3. Album
4. Artwork
5. Current seek time
6. Track duration

You can open Musixmatch Extension from your app without any specific UI, it could be standard "Lyircs button" or if you need a specific Musixmatch logo contact us, infos are below.

### Add Musixmatch Files to Your Project

Add the `MXMLyricsAction.h` and `MXMLyricsAction.m` to your project and import `MXMLyricsAction.h` in your view contoller that implements the action for the lyrics button.

### How to Open Musixmatch Extension

Add lyrics button on your view, you can enable it by check `isSystemAppExtensionAPIAvailable`,
Musixmatch Extension is available for every iOS8 devices.

Note that if users doesn't have Musixmatch installed or old version installed without **Lyrics Extension**
the Extension open the AppStore on Musixmatch app page to download/update.

Next we need to wire up the action for this button to this method in your UIViewController:

```objective-c
- (IBAction)lyrics:(id)sender {
 
    MPMediaItem *item = [[MPMusicPlayerController iPodMusicPlayer] nowPlayingItem];

if (item) {
        [[MXMLyricsAction sharedExtension] findLyricsForSongWithTitle:item.title
                                                               artist:item.artist
                                                                album:item.albumTitle
                                                              artWork:[item.artwork imageWithSize:artWork.frame.size]
                                                      currentProgress:[[MPMusicPlayerController iPodMusicPlayer] currentPlaybackTime]
                                                        trackDuration:item.playbackDuration
                                                    forViewController:self
                                                               sender:sender
                                                     competionHandler:^(NSError *error) {
                                                         
                                                     }];
    }
    
}

```

Data needed in deep:

1. Provide a `NSString` for song title.
2. Provide a `NSString` for song artist name.
3. Pass a `NSString` for song album name.
4. Pass an `UIImage` for the view's background (artwork).
5. Provide a `NSTimeInterval` for the current seek time.
6. Provide a `NSTimeInterval` for the song duration.
7. Provide a `UIViewController` from the Extesion can appear.
8. Provide a completion block that will be called when the user finishes their selection.

### Customize Extension

As the Extension can't change the **Status Bar**, there are two possible view styles

1. StatusBar White
2. StatusBar Black

You can try the two different style by change the 'UISwitch' in the Demo App.
Here an example:

**StatusBar White**

**StatusBar Black**

## References

If you open up MXMLyricsAction.m and start poking around, you'll be interested in these references.

* [Apple Extension Guide](https://developer.apple.com/library/prerelease/ios/documentation/General/Conceptual/ExtensibilityPG/index.html#//apple_ref/doc/uid/TP40014214)
* [NSItemProvider](https://developer.apple.com/library/prerelease/ios/documentation/Foundation/Reference/NSItemProvider_Class/index.html#//apple_ref/doc/uid/TP40014351), [NSExtensionItem](https://developer.apple.com/library/prerelease/ios/documentation/Foundation/Reference/NSExtensionItem_Class/index.html#//apple_ref/doc/uid/TP40014375), and [UIActivityViewController](https://developer.apple.com/library/prerelease/ios/documentation/UIKit/Reference/UIActivityViewController_Class/index.html#//apple_ref/doc/uid/TP40011976) class references.

## Contact Us

You can reach us at ios@musixmatch.com, or if you prefer, [@musixmatch_api](https://twitter.com/musixmatch_api) on Twitter.

ios-musixmatch-app-extension

ios-musixmatch-app-extension Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ios-musixmatch-app-extension

ios-musixmatch-app-extension Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README