[Paul]

Jamroom paSCSeamless Module

Revision History

20120218 V1.0.0 Original Release

20120218 V1.0.2 Nova theme template bug fixes

20130423 V1.0.3 Hide track bug fix

20130908 V1.0.4 Try file_get_contents if CURL fails

Overview

The paSCSeamless module provides users with seamless integration of both their uploaded 'regular' songs, and embedded SoundCloud songs on both the user profile, and skin song pages
When users click on their 'Create Song' button, they get the choice of uploading either a regular song, or a SoundCloud song and are subsequently directed to the respective similar looking form page
After uploading an embedded SoundCloud song, it is treated as a regular song and can be modified, arranged and deleted in the same manner as, and alongside of regular songs
User access to this module is artist quota controlled

Module Installation

Copy the paSCSeamless.php and the 'modules' folder to your Jamroom directory
Log into Jamroom as admin, go to the Module Config page and enable the paSCSeamless module
Installation should now be complete, however, if not running Jamroom V4.1.5 or later, you may need to run the Integrity Check to install this module correctly

Skin and Theme Templates

In order to show SoundCloud songs in the skin and user profile pages, templates need to be modified
Included with this module are the modified template for the 'stock' Nova skin and theme
If you are running the above 'stock' skin and theme, just copy the templates from this package as appropriate
If you are running the above 'stock' skin and theme that have only had their CSS files changed as a colour scheme, say, it should be OK to copy these modified files, BUT BE SURE TO BACKUP FIRST
If you are not running stock skins and themes, or have modified your song templates in any way, check out the included templates to see what is required - basically, whenever the song image, or a link to a popup player, or an embedded player is required, the relevant template code is wrapped in the conditional statement {if is_numeric($SONG_SOUNDCLOUD_ID)}{else}{/if} and the appropriate Song code put in the 'if' section, and the original template code in the 'else' section - copy and paste the Song code from one of the supplied modified templates - BE SURE TO BACKUP FIRST
NOTE that the sample templates also include those modified for the paYTSeamless and paVimeoSeamless modules. It is OK to copy these over as well, even if you are not running these two modules.

Upgrading This Module

Overwrite all your previously uploaded module files with those in the latest release.
Log into your Jamroom site as 'Admin' and if prompted to do so, run the Integrity Check

Module Configuration

By default, all your artist quotas will be configured with this module disabled - the enable/disable option is in the quota Media Support section
By default, all your artist quotas will be configured to allow uploads of both SoundCloud and regular songs - the 'SoundCloud Songs Only' option is in the quota Media Support section and if set, only SoundCloud songs will be uploadable
Go to the Config Modules section and click on the module settings button. A page is displayed where you can configure all the module options - You should not need to change the SoundCloud Tracks URL settings at this time
In order to use this module, perform the following steps to register this application with SoundCloud

Goto http://soundcloud.com and create an account with SoundCloud
Confirm your registration email and log into SoundCloud
Goto http://soundcloud.com/you/apps and register a new application
Name the new application (your Jamroom site name, say) and enter your Jamroom site URL as the re-direct URL, then save the application
Make a note of your SoundCloud Client ID and Secret
In your Admin Control Panel, goto Admin Options => System Config => System Modules and click on the paSCSeamless Settings button
Enter the above Client ID and Secret codes into the relevent fields and click on 'Update Settings'

Questions?

Email any questions, comments or suggestions to paul@paulasher.com, or post on this Forum Thread

- Paul Asher


_________________
Paul Asher
Jamroom Network Team Member: http://www.jamroom.net
Priority Support: http://www.jamroom.net/Support_Center

Last edited by Paul on 09/08/13 03:48; edited 5 times in total

[Paul]

Demo site at http://paulasher.com - Login with demo/demo


_________________
Paul Asher
Jamroom Network Team Member: http://www.jamroom.net
Priority Support: http://www.jamroom.net/Support_Center

[Acidphantom]

Special tanks from Acidphantom...

[Acidphantom]

Hi PA,

Buyed the mod today, realy cool made btw.

I would like to know if you gonna make modified templates for n8flash designs too?


best regards,
Acidphantom

[Paul]

Thanks for buying AP.
If you look at any of the supplied Nova templates you'll see what is involved with modifications - its fairly straightforward.

Basically, whereever a song image or a song player occurs, wrap it with the following conditional statements -

Code

{***** paSCSeamless Module Addition *****} {if $SONG_SOUNDCLOUD_ID != '' && is_numeric($SONG_SOUNDCLOUD_ID)} {paSCSeamless_GetTrackData soundcloud_data=$SONG_SOUNDCLOUD_DATA assign="_scData"}   Soundcloud Code {else}   Original Code {/if}

The smarty function call paSCSeamless_GetTrackData returns additional track data supplied by the SC API as an array $_scData
So for a song image occurance, the template code might be something like -

Code

{***** paSCSeamless Module Addition *****} {if $SONG_SOUNDCLOUD_ID != '' && is_numeric($SONG_SOUNDCLOUD_ID)} {paSCSeamless_GetTrackData soundcloud_data=$SONG_SOUNDCLOUD_DATA assign="_scData"}       <img src="{$_scData.artwork_url}" width="96" height="72" alt="{$SONG_NAME}"> {else}       <img src="{$SONG_IMAGE_URL}" width="96" height="72" alt="{$SONG_NAME}"> {/if}

and for a player -

Code

{***** paSCSeamless Module Addition *****} {if $SONG_SOUNDCLOUD_ID != '' && is_numeric($SONG_SOUNDCLOUD_ID)} {paSCSeamless_GetTrackData soundcloud_data=$SONG_SOUNDCLOUD_DATA assign="_scData"}       <a href="{$JAMROOM_URL}/index.php?t=player_soundcloud&amp;soundcloud_id={$SONG_SOUNDCLOUD_ID}&amp;song_id={$SONG_ID}" onclick="popwin(this.href,'audio_player',600,220,'yes');return false"><img src="{$SKIN_URL}/images/hifi_stream.png" alt="Play Soundcloud Track" title="Play Soundcloud Track" class="m_outline" /></a> {else}     {jr_lang id="12" default="you must be logged in to stream this file" assign="str_notice"}     {jr_lang id="13" default="you must be logged in to download this file" assign="dld_notice"}     {jr_lang id="14" default="not available" assign="na_notice"}     {jr_lang id="15" default="HIFI Stream" assign="hifi_s"}     {jr_lang id="16" default="LOFI Stream" assign="lofi_s"}     {jr_lang id="17" default="HIFI Download" assign="hifi_d"}     {if $HIFI_EXTENSION == 'mp3'}       {assign var="media_play" value="`$JAMROOM_URL`/`$jamroom_index`?t=player_audio&amp;mode=song_hifi&amp;band_id=`$BAND_ID`&amp;song_id=`$SONG_ID`"}       {assign var="onclick" value="popwin(this.href,'audio_player',`$smarty.config.audio_popup_width`,`$smarty.config.audio_popup_height`,'yes');return false"}     {else}       {assign var="media_play" value=$HIFI_PLAY_URL}       {assign var="onclick" value=""}     {/if}     {assign var="hifi_size" value=$HIFI_SIZE|jr_format_size}     {jr_media_access type="image" class="m_outline" alt="`$hifi_s`: (`$HIFI_EXTENSION`, `$hifi_size`, `$HIFI_LENGTH`)" media="hifi_stream" media_url=$media_play skin="Nova" media_size=$HIFI_SIZE download=$HIFI_DOWNLOAD no_image="no.png" no_alt="`$hifi_s` `$na_notice`" login_image="perm.png" login_alt=$str_notice onclick=$onclick}&nbsp;     {jr_media_access type="image" class="m_outline" alt="`$hifi_d`: (`$HIFI_EXTENSION`, `$hifi_size`, `$HIFI_LENGTH`)" media="hifi_download" media_url=$SONG_HIFI_DOWNLOAD_URL skin="Nova" media_size=$HIFI_SIZE download=$HIFI_DOWNLOAD no_image="no.png" no_alt="`$hifi_d` `$na_notice`" login_image="perm.png" login_alt=$dld_notice}&nbsp;     {if $LOFI_EXTENSION == 'mp3'}       {assign var="media_play" value="`$JAMROOM_URL`/`$jamroom_index`?t=player_audio&amp;mode=song_lofi&amp;band_id=`$BAND_ID`&amp;song_id=`$SONG_ID`"}       {assign var="onclick" value="popwin(this.href,'audio_player',`$smarty.config.audio_popup_width`,`$smarty.config.audio_popup_height`,'yes');return false"}     {else}       {assign var="media_play" value=$LOFI_PLAY_URL}       {assign var="onclick" value=""}     {/if}     {assign var="lofi_size" value=$LOFI_SIZE|jr_format_size}     {jr_media_access type="image" class="m_outline" alt="`$lofi_s`: (`$LOFI_EXTENSION`, `$lofi_size`, `$LOFI_LENGTH`)" media="lofi_stream" media_url=$media_play skin="Nova" media_size=$LOFI_SIZE download=$LOFI_DOWNLOAD no_image="no.png" no_alt="`$lofi_s` `$na_notice`" login_image="perm.png" login_alt=$str_notice onclick=$onclick} {/if}

Note that you may want to put a {debug} in your code and take a look at the $_scData array - There may be stuff in there you can use!!

I'm hoping that most users will be able to do the mods themselves, but I will offer advice where necessary. Alternatively, I will do skin/theme templates on demand and put them in the Marketplace for a nominal charge. Hope that is acceptable to you all and that you appreciate that doing this does take time and effort.

Having said that, I do not have a copy of the n8flash skin so at the moment would not be able to do it.
Cheers
Pa


_________________
Paul Asher
Jamroom Network Team Member: http://www.jamroom.net
Priority Support: http://www.jamroom.net/Support_Center

[Acidphantom]

Hi PA,

Ty for the reply. I meant the skin maestro.

Like the module from paYTSeamless templates.

I will try do my best to configure everything out.


Best regards,
Acidphantom

[Acidphantom]

To difficult for me ...

[Paul]

Acidphantom:

To difficult for me ...

PM me your logins and I'll give you a start - I don't have a Maestro install to play with.

Pa


_________________
Paul Asher
Jamroom Network Team Member: http://www.jamroom.net
Priority Support: http://www.jamroom.net/Support_Center

[Acidphantom]

Hi PA,

soundcloud tracks shows up always as hidden tracks in the track list of the control panel. Also favorite a track of soundcloud not be listet in the favorites on profiles. Actions by create a soundcloud track also not programmed too yet. Just wanted tell you this issues.

It is an amazing feature for my site...


Best regards,
Acidphantom

[Paul]

Acidphantom:

Hi PA, soundcloud tracks shows up always as hidden tracks in the track list of the control panel. Also favorite a track of soundcloud not be listet in the favorites on profiles. Actions by create a soundcloud track also not programmed too yet. Just wanted tell you this issues. It is an amazing feature for my site... Best regards, Acidphantom

Actions and Favouriting SC tracks work OK on the demo site - http://paulasher.com
Also, SC tracks are not being created as 'hidden'.
Have you tried it there?
I still have the logins you sent me the other day so I'll check it out on your site.
Cheers
Pa


_________________
Paul Asher
Jamroom Network Team Member: http://www.jamroom.net
Priority Support: http://www.jamroom.net/Support_Center

[Acidphantom]

Hi PA,

Still same login ... the wierd thing is that on nachtkind profile track pictures disapearing. Tyvm for reply.


Actions yes it says "Created song" ok then the other action info is a n8flash thing.


Greetings,
Acidphantom

[Paul]

Acidphantom:

Hi PA, Still same login ... the wierd thing is that on nachtkind profile track pictures disapearing. Tyvm for reply. Actions yes it says "Created song" ok then the other action info is a n8flash thing. Greetings, Acidphantom

Just tried things on your site and its working the same as the demo site - SC tracks created ok, actions and fans working. Maybe I'm misunderstanding your issues?
As for Nachtkind, I looked at the SC data on your database for him and there are no images for most of his tracks. The SC API returns an array of SC track data which may, or may not contain an image url. I make all of that array available for use in your templates so if there was no image from SC when importing the track, there will be no image in your templates.
Cheers
Pa


_________________
Paul Asher
Jamroom Network Team Member: http://www.jamroom.net
Priority Support: http://www.jamroom.net/Support_Center

[Acidphantom]

HI PA,

Thanks for checking it... Just a question is it possible to make in the next soundcloud Module release an manager like you made with the youtube module? Just for future things.


Best regards,
Acidphantom

[Paul]

Acidphantom:

HI PA, Thanks for checking it... Just a question is it possible to make in the next soundcloud Module release an manager like you made with the youtube module? Just for future things. Best regards, Acidphantom

You mean to check that the SC tracks are still valid?
I'll look into it.
Cheers
Pa


_________________
Paul Asher
Jamroom Network Team Member: http://www.jamroom.net
Priority Support: http://www.jamroom.net/Support_Center

[Acidphantom]

Yes thats exactly what I meant