Page History

...

1. Sign in to Chrome Developer Dashboard
2. In the dashboard, click ‘Add new item’ button

Image Added

3. Accept the developer agreement

Image Added

4. On the ‘Upload’ page, choose the chrome-extension.zip file and click ‘Upload’ button

Image Added

5. When the extension is uploaded, the page for editing the extension draft will be opened
Edit the extension as required and click ‘Save draft and return to dashboard’ button at the bottom of the page.

Image Added

6. The extension will appear in the developer dashboard
Click ‘Publish’ link to publish the extension.

Image Added

A published extension will have status ‘Published’ as on the image below.

Image Added

For more information, see Chrome Web Store Publishing Tutorial.

Extension Inline Installation

Extension installation can be initiated by clicking a link on the Screen Sharing client page.
Note that the extension to be installed should be customized, published and approved before inline installation can be used.

Follow the procedures described below to use the client with your extensions.

1. When publishing, select ‘Inline Install’ option

Image Added

2. Verify and add website with your domain to the extension
- Click ‘Add a New Site’

Image Added

- Google Search Console page will open in a new tab
Enter URL with your domain.

Image Added

- A page with the instruction for the site verification will open
Follow the procedure steps and click ‘Verify’ button.

Image Added

- If the verification is passed, a page confirming successful verification will be opened

Image Added

- The website will appear in the list in the extension options and the extension can be associated with the site

Image Added

Extension for Firefox with publication in Mozilla Add-ons

Go to accounts.firefox.com and create a Firefox account for your email address (e.g. a Gmail address).

Sign in to Mozilla Add-ons

1. Go to Mozilla Add-ons ons and click ‘Log in’ link

Image Added

2. Enter the email address used to create the Firefox account and click ‘Continue’ button

Image Added

3. ‘Sign in’ page will be opened
Enter the Firefox account password and sign in.

Customization for your domain

Edit the extension manifest file package.json and index.js of the Firefox add-on.
In package.json change:

title
name
id
description
author
homepage

In index.js replace flashphoner.com with your domain.

Packaging and publication in Mozilla Add-ons

To package Firefox add-on, you will need to install additional tools-

NPM

...

JPM

Install prerequisites

The steps below describe how to install the prerequisites on Windows.
(For more information, see the guide from Mozilla.)

1. Install Node.js
- Download the installer from nodejs.org
- Run the downloaded installer
- Follow thru the installation wizard: accept the license agreement and the default installation settings

Image Added

- Restart the computer

2. Make sure that NPM is installed: run command npm -v in command line

Image Added

3. Install JPM: run npm install jpm –global or npm install jpm command in command line

Image Added

4. Make sure that JPM is installed: run command jpm in command line

Image Added

Package the add-on

1. Open command line and navigate to firefox-extension directory
2. Execute jpm xpi command to create XPI file

Image Added

Submit the add-on at Mozilla portal

1. Sign in to Mozilla Add-ons
2. Go to ‘Tools’ | ‘Submit a New Add-on’

Image Added

3. Select the created XPI

Image Added

4. When the file is uploaded, click ‘Continue’ to follow the submission steps

Image Added

After the submission, the add-on will appear in the submissions list (‘Tools’ | ‘Manage My Submissions’).

Image Added

See more on publishing add-on to Mozilla here.

Code of the example for Chrome and Firefox

This example uses Flashphoner extensions for work with domain *.flashphoner.com. For work with your domain, build up and publish your extensions as described above.

As temporary solution, IP address of your WCS server can be added to file C:\Windows\System32\drivers\etc\hosts (on Windows OS) as test.flashphoner.com. That way, you will be able to test your WCS server with domain test.flashphoner.com till the extensions for your domain are built up.

...

For Chrome, link to the extension is specified directly in file screen-sharing.html line 17

Code Block

language	js
theme	RDark

<link rel="chrome-webstore-item" href="https://chrome.google.com/webstore/detail/nlbaajplpmleofphigmgaifhoikjmbkg">

Customization of the example script for Chrome

Edit screen-sharing.html line 17 and screen-sharing.js line 6

in screen-sharing.html, chrome-webstore-item should point to your extension in Chrome Web Store
in screen-sharing.js, change value of chromeScreenSharingExtensionId variable to your extension ID

To get extension ID, click ‘More info’ for the extension in Chrome Developer Dashboard.

Image Added

Customization of the example script for Firefox

Edit params object in installExtension()method in screen-sharing.js. line 179

Code Block

language	js
theme	RDark

var params = {
"Flashphoner Screen Sharing": { URL: "../../../dependencies/screen-sharing/firefox-extension/flashphoner_screen_sharing-0.0.4-fx+an.xpi",
              IconURL: "../../../dependencies/screen-sharing/firefox-extension/icon.png",
              Hash: "sha1:e9f7df0e73ddb61b362eb63a6d7d1be2f3a5c262",
              toString: function () { return this.URL; }
            }
        };

Change

"Flashphoner Screen Sharing" to the name of the add-on (will be used in the install confirmation dialog)
flashphoner_screen_sharing-0.0.4-fx+an.xpi to the name of the add-on XPI
Hash value to hash generated for the XPI file

(See params object description here. You can easily get sha1 sum on Linux by using sha1sum <XPI file> command.)

...

To analyze the code, let's take the version of file screen-sharing.js with hash cf0daabc6b86e21d5a2f9e4605366c8b7f0d27eb, which is available here and can be downloaded with corresponding build 0.3.18.1894.

1. Initialization of the API. line 11

API is initialized after loading the page. Chrome extension ID is passed to the init() method.

Code Block

language	js
theme	RDark

Flashphoner.init({screenSharingExtensionId: extensionId});

2. Path to the Firefox add-on. line 178

Code Block

language	js
theme	RDark

var params = {
            "Flashphoner Screen Sharing": { URL: "../../dependencies/screen-sharing/firefox-extension/flashphoner_screen_sharing-0.0.4-fx+an.xpi",
                IconURL: "../../dependencies/screen-sharing/firefox-extension/icon.png",
                Hash: "sha1:9c2bd6b0a22473cc721d7b3d3ecc72707b507f75",
                toString: function () { return this.URL; }
            }
        };

3. Connection to WCS server. line 91

Code Block

language	js
theme	RDark

Flashphoner.createSession({urlServer: url}).on(SESSION_STATUS.ESTABLISHED, function(session){
        //session connected, start streaming
        startStreaming(session);
    }).on(SESSION_STATUS.DISCONNECTED, function(){
        setStatus(SESSION_STATUS.DISCONNECTED);
        onStopped();
    }).on(SESSION_STATUS.FAILED, function(){
        setStatus(SESSION_STATUS.FAILED);
        onStopped();
    });

4. Video constraints. line 106

Type 'screen' is specified in the constraint for video stream.

Code Block

language	js
theme	RDark

var constraints = {
        video: {
            width: parseInt($('#width').val()),
            height: parseInt($('#height').val()),
            frameRate: parseInt($('#fps').val()),
            type: "screen"
        }
    };

5. Video streaming. line 114

After establishing connection to the server, new video stream is created with method session.createStream(), and function publish() is called to publish the stream.

Code Block

language	js
theme	RDark

 session.createStream({
        name: streamName,
        display: localVideo,
        constraints: constraints
    })...publish();

6. Playback of preview video stream. line 131

When the screen sharing stream is published, preview video stream is created with method session.createStream(), and function play() is called to start playback of the stream in <div> element remoteVideo.

Code Block

language	js
theme	RDark

session.createStream({
            name: streamName,
            display: remoteVideo
        }).on(STREAM_STATUS.PLAYING, function(previewStream){
            document.getElementById(previewStream.id()).addEventListener('resize', function(event){
                resizeVideo(event.target);
            });
            //enable stop button
            onStarted(publishStream, previewStream);
        }).on(STREAM_STATUS.STOPPED, function(){
            publishStream.stop();
        }).on(STREAM_STATUS.FAILED, function(){
            //preview failed, stop publishStream
            if (publishStream.status() == STREAM_STATUS.PUBLISHING) {
                setStatus(STREAM_STATUS.FAILED);
                publishStream.stop();
            }
        }).play();

As the result, screen sharing video is sent to the server and played from the server in different <div> element.
To play the same video on different page, use the example Player.

Space shortcuts

Page tree

Versions Compared

Old Version 2

New Version 3

Key

Extension Inline Installation

Extension for Firefox with publication in Mozilla Add-ons

Sign in to Mozilla Add-ons

Customization for your domain

Packaging and publication in Mozilla Add-ons

Install prerequisites

Package the add-on

Submit the add-on at Mozilla portal

Code of the example for Chrome and Firefox

Customization of the example script for Chrome

Customization of the example script for Firefox