Get current url to Flash swf using an External Interface call

Google Buzz

Overview:

Many have struggled with the task of getting you swf to read or get the current url showing in the browser, the html page the browser is at which has the swf embedded. Not to be confused with the _root._url which returns the path of the swf file. This would be helpful to know if someone is embedding your swfs on their site, or even customize your swf depending on which page it resides on. There is a pretty simple, yet virtually undocumented way to do this. We have to use javascript by calling External Interface and get the url from the DOM. Window.location.href. Then we must call the toString() function only because ExternalInterface.call requires a function rather than only reading a static property.

Steps:

  1. Import external interface into your file: import flash.external.ExternalInterface;

  2. Initialize a variable to store the url path: var urlPath;

  3. Create a function to call external interface and assign the html page path to your variable: urlPath = ExternalInterface.call(“window.location.href.toString”);

  4. Call the function when/if needed.

Example:

With javascript: window.location.href or window.location.href.toString();
With actionscript: ExternalInterface.call(“window.location.href.toString”);
External Interface html Example

Get Adobe Flash player


Actionscript:

1
2
3
4
5
6
7
8
9
import flash.external.*;
var urlPath;

function geturlhttp() {
urlPath = ExternalInterface.call("window.location.href.toString");
}
geturlhttp();
//Here I assign the url to a text box on the stage
_root.urlText.text = urlPath;

Download:

ExternalInterface.zip

  • del.icio.us
  • Digg
  • email
  • Facebook
  • FriendFeed
  • Google Bookmarks
  • Hexosearch
  • LinkedIn
  • Mixx
  • Print
  • PDF
  • StumbleUpon
  • Technorati
  • Twitter
  • RSS
This entry was posted in tutorial and tagged , , , , , , , . Bookmark the permalink. Post a comment or leave a trackback: Trackback URL.

24 Comments

  1. Jason
    Posted 17 January 2008 at 5:27 pm | Permalink

    Great but you can\’t get URLs from Myspace/Facebook because of Javascript is not allowed. Please vote to fix the bug below so we have this information everywhere.

    The browser URL information is actually available in the Error Code returned from a call to ExternalInterface (when Javascript is not allowed). This information is not available in the standard player (but is in the debug), ARGH…. We all want to track our Flash widgets so please vote to fix this bug. You would then be able to get the browser URL from the Error code returned on the API call from Myspace page (a bit of a hack but the information would be available).

    http://bugs.adobe.com/jira/browse/ASC-3095

  2. DB
    Posted 24 January 2008 at 8:30 pm | Permalink

    this doesn’t work in IE… alot of people having trouble with this :/

  3. Posted 25 January 2008 at 11:12 am | Permalink

    It is interesting, it seems to have a lot to do with the Microsoft’s dealings with Active content. Clicking on the “External Interface html Example” link does work in IE. I have struggled at getting this to work in IE scenarios also. Any suggestions?

  4. Posted 27 January 2008 at 3:24 am | Permalink

    You can also use location.href and pass it through SWFObject to get the current url of a page like:

    so.addVariable(“urlPageName”, location.href);

    I used it a couple of times across projects that needed to work locally and on the server. This worked fine for me across IE and Firefox.

  5. Posted 1 February 2008 at 11:54 am | Permalink

    @Evan – Thanks for this, learnt something new – just a shame it doesn’t play ball in IE.

    @agi – Good suggestion, I think that’ll work…

  6. Ed McManus
    Posted 8 February 2008 at 10:41 pm | Permalink

    Hi Guys,

    Just thought you might like to know there’s a solution to this problem. The following snippit works across all browsers I’ve tested (tho clearly it requires JS access):

    var result:String = ExternalInterface.call(‘eval’, ‘window.location.href’);

    Hope it helps!

  7. Posted 4 March 2008 at 10:16 am | Permalink

    I developed a new simple web tool that uses FScommand from flash and SWFObjecy implementation from the Javascript side. The two pair up nicely to make a functional addressing system in flash.

    Check it out => http://flashURL.net

  8. Posted 20 March 2008 at 11:30 pm | Permalink

    I’ve written an updated post on this subject see Get Current URL and Query String Parameters

  9. John T. Bailey
    Posted 20 May 2008 at 10:36 am | Permalink

    What is the advantage of using the ExternalInterface technique as you’ve described over the following:

    [actionscript]
    import flash.net.LocalConnection;
    var lc:LocalConnection = new LocalConnection();
    var domain:String = lc.domain;
    trace(domain);
    [/actionscript]

  10. Sander van den Berg
    Posted 29 May 2008 at 9:55 am | Permalink

    Hello all!

    @John: Think this will only give the URL of the location of the SWF, it won’t give you the URL of the screen in which you are viewing the SWF.

    for example:
    domain 1: contains SWF
    domain 2: contains html file with embed sourcecode.

    You want the URL of domain 2, so you can track ur SWF.

    This is my issue aswell. Since im gonna work with paying clients, having their own layout. I want to dynamicly get their XML file containing layout info (which is on my server) based on a URL or Domainname send by them automaticly when viewing my SWF.

  11. nick
    Posted 29 May 2008 at 9:29 pm | Permalink

    I’m trying to use this function to insert the current url when people submit a form, the code is below but the import flash.external.*; is created an endless loop how can I fix it, and is the way im getting the url ok or should i just put it into a variable instead of using the function? I appreciate any help

    thanks

    stop();
    System.useCodepage = true;
    send_btn.onRelease = function() {

    import flash.external.*;

    function geturlhttp() {
    _root.urlPath = ExternalInterface.call(“window.location.href.toString”);
    }

    my_vars = new LoadVars();
    my_vars.url = geturlhttp();
    my_vars.email = email_box.text;
    my_vars.name = name_box.text;
    if (my_vars.name != “” and my_vars.email != “” and my_vars.url != “”) {

    my_vars.sendAndLoad(“mailer.php”, my_vars, “POST”);
    gotoAndStop(2);
    } else {
    error_clip.gotoAndPlay(2);
    }
    my_vars.onLoad = function() {
    gotoAndStop(3);
    };
    };
    email_box.onSetFocus = subject_box.onSetFocus=message_box.onSetFocus=function () {
    if (error_clip._currentframe != 1) {
    error_clip.gotoAndPlay(6);
    }
    };

  12. Posted 18 November 2008 at 2:48 am | Permalink

    Hi,all
    ExternalInterface.call(’eval’, ‘window.location.href’);
    this can get url,but i have a problem,my flash is a widget and when it insert into a page,this widget has not a id(<object classid=…. id=…) and not work.
    how can i do ?

  13. Posted 18 November 2008 at 8:29 am | Permalink

    @Kavin – your flash does not need an id or class to use ExternalInterface. Although sites lie MySpace don’t allow the use of javascript, so we can’t use ExternalInterface there. Good luck!

  14. kallal
    Posted 26 November 2008 at 6:02 pm | Permalink

    This used to work fine in older versions during the AS1 days. What broke?

  15. Adrian
    Posted 24 April 2009 at 3:34 am | Permalink

    I tried to use your code below but it is not working in my end.

    The return value is “undefined”.

    I am currently experimenting on how can I get the querystring of the current URL and append it in the url in of my getURL function.

    Below is a sample of my code.

    *********************************************
    import flash.external.*;

    function geturlhttp()
    {
    //will contain the Current URL
    var urlPath = ExternalInterface.call(“window.location.href.tostring”);

    //trace (urlpath)
    // result is undefined
    //get current URL of the site
    var QStr:String;
    Qstr = “”;
    if (urlPath.indexOf(“?”) -1)
    {
    Qstr = urlPath.substr(urlPath.indexOf(“?”), urlPath.length );
    }

    getURL(“http://www.adrian.com/adrian.html” + Qstr , “_self”);

    }

    _root.LearnD.onRealease = function()

    {
    geturlhttp();
    };

    *********************************************
    Whenever I click the LearnD button , I am redirected to this page.

    http://www.adrian.com/adrian.htmlundefined

  16. Posted 24 April 2009 at 9:46 am | Permalink

    @Adrian – this line is most likely giving you trouble:
    if (urlPath.indexOf(”?”) -1)
    should it read:
    if (urlPath.indexOf(”?”) == -1) ?
    let me know if that does it. happy scripting.

  17. Adrian
    Posted 26 April 2009 at 12:34 am | Permalink

    I correct the codes aand the issue is still existing.

    I am still getting “undefined”. I also noticed that the code is working if I will assign a fixed URL value for the UrlPath variable.

  18. Posted 27 April 2009 at 11:56 am | Permalink

    Actually, it should be != rather than ==, and remember that variable names are caSe seNseTive, so your QStr and Qstr are not the same things.

    this worked for me:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    function geturlhttp() {
      //var urlPath = ExternalInterface.call("window.location.href.tostring");
      urlPath = "http://www.adrian.com/adrian.html?test=qs";
      //trace (urlpath)

      var QStr:String = "";
      if (urlPath.indexOf("?") != -1) {
        QStr = urlPath.substr(urlPath.indexOf("?"), urlPath.length );
        trace(QStr);
      }

      getURL("http://www.adrian.com/adrian.html" + QStr , "_self");

    }
  19. Keith
    Posted 13 May 2009 at 11:57 am | Permalink

    This page claims to provide the URL to the SWF but it does not. The example provided, and all of the alternative examples in the comments, provide the URL to the PAGE containing the SWF.

  20. Posted 8 June 2009 at 9:05 am | Permalink

    Thanks for the solution, that’s what I was looking for.

  21. Posted 22 June 2009 at 2:39 am | Permalink

    Hi,

    I don't really like to require users of my swf's to have to add and javascript, so instead I do this entirely in actionscript:

    ExternalInterface.call(“eval”,”document.location.href”);

    You have to use “eval” (evaluate) to work across all browsers (and “document.location” is safer than “window.location” in case you're in a frameset).

    HTH,

    MicroAngelo

  22. Posted 25 February 2010 at 5:43 am | Permalink

    You are perfect!

    I am too many time finding it, very nice and wonderful working.

    Thanks again!

  23. Hieu
    Posted 4 March 2010 at 4:41 am | Permalink

    Thanks a lot for sharing.

One Trackback

  1. [...] browsers and without having to rely on flashvars or javascript, but to just have it work. I wrote a post on it earlier, although it seemed it wouldn’t play nice with Internet Explorer IE, I later [...]

Post a Comment

Your email is never published nor shared. Required fields are marked *

*
*

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>