Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Player example

This player can be used to play any type of stream on Web Call Server

  • RTSP
  • WebRTC
  • RTMPRTMFP
  • SIP

On the screenshot below an RTSP stream is being playing in the web player.

Image RemovedImage Added

Code of the example

The path to the source code of the example on WCS server is:

/usr/local/FlashphonerWebCallServer/client2/examples/demo/streaming/player

player.css - file with styles
player.html - page of the player
player.js - script providing functionality for the player

This example can be tested using the following address:

https://host:8888/client2/examples/demo/streaming/player/player.html

Here host is the address of the WCS server.

...

Analyzing the code

To analyze the code, let's take the version of file player.js with hash cf0daabc6b86e21d5a2f9e4605366c8b7f0d27eb 7fff01f, which is available here and can be
downloaded with corresponding build 2.0.3.18.1894219.

1. Initialization of the API.

Flashphoner.init()   code

Code Block
languagejs
themeRDark
        Flashphoner.init({flashMediaProviderSwfLocation
            receiverLocation: '../../dependencies/websocket-player/WSReceiver2.js',
            decoderLocation: '../../media-provider.swf'/dependencies/websocket-player/video-worker2.js',
            preferredMediaProvider: mediaProvider
        });

2. Connection to server

Flashphoner.createSession()   code

Code Block
languagejs
themeRDark
    Flashphoner.createSession({urlServer: url}).on(SESSION_STATUS.ESTABLISHED, function(session){
        setStatus(session.status());
        //session connected, start playback...
        playStream(session);
    }).on(SESSION_STATUS.DISCONNECTED, function(){
        setStatus(SESSION_STATUS.DISCONNECTED);...
        onStopped();
    }).on(SESSION_STATUS.FAILED, function(){
        setStatus(SESSION_STATUS.FAILED);
        onStopped();...
    });

3. Receiving the event confirming successful connection

ConnectionStatusEvent ESTABLISHED SESSION_STATUS.ESTABLISHED code

Code Block
languagejs
themeRDark
    Flashphoner.createSession({urlServer: url}).on(SESSION_STATUS.ESTABLISHED, function(session){
        setStatus(session.status());
        //session connected, start playback
        playStream(session);
    }).on(SESSION_STATUS.DISCONNECTED, function(){
        ...
    }).on(SESSION_STATUS.FAILED, function(){
        ...
    });

4. Playback of video stream

Session.createStream(), Stream.play() code

Code Block
languagejs
themeRDark
    stream = session.createStream(options).on(STREAM_STATUS.PENDING, function (stream) {
        ...
    });
    stream.play()

...

;

When stream is created, the following parameters are passed

  • streamName - name of the stream (rtsp:// address in this case)
  • remoteVideo - <div> div element, in which the video will be displayed
  • picture resolution to transcode
  • unmutePlayOnStart: false - disables automatic audio unmuting for autoplay to conform browsers requirements

code

Code Block
languagejs
themeRDark
    session.createStream(var options = {
        name: streamName,
        display: remoteVideo,
        flashShowFullScreenButton: true
    };
    if (Flashphoner.getMediaProviders()[0] === "MSE" && mseCutByIFrameOnly) {
        options.mediaConnectionConstraints = {
            cutByIFrameOnly: mseCutByIFrameOnly
        }
    }
    if (resolution_for_wsplayer) {
        options.playWidth = resolution_for_wsplayer.playWidth;
        options.playHeight = resolution_for_wsplayer.playHeight;
    } else if (resolution).play(); {
        options.playWidth = resolution.split("x")[0];
        options.playHeight = resolution.split("x")[1];
    }
    if (autoplay) {
        options.unmutePlayOnStart = false;
    }

5. Receiving the event confirming successful stream playback

StreamStatusEvent PLAYING STREAM_STATUS.PLAYING code

Code Block
languagejs
themeRDark
    stream = session.createStream(options).on(STREAM_STATUS.PENDING, function (stream) {
        name: streamName,
 ...
    }).on(STREAM_STATUS.PLAYING, function (stream) {
        $("#preloader").hide();
        setStatus(stream.status());
       display: remoteVideo onStarted(stream);
    }).on(STREAM_STATUS.PLAYINGSTOPPED, function(stream) {
        ...
  document.getElementById(stream.id()).addEventListener('resize', function(event){
  }).on(STREAM_STATUS.FAILED, function() {
        ...
    });
    stream.play();

6. Handling the event about channel bandwith

STREAM_EVENT, STREAM_EVENT_TYPE.NOT_ENOUGH_BANDWIDTH code

Code Block
languagejs
themeRDark
    }).on(STREAM_EVENT, function(streamEvent){
        if (STREAM_EVENT_TYPE.NOT_ENOUGH_BANDWIDTH === streamEvent.type) {
            var info  resizeVideo(event.target);
= streamEvent.payload.info.split("/");
            var remoteBitrate = info[0];
           });
        setStatus(stream.status());
        onStarted(stream var networkBandwidth = info[1];
            console.log("Not enough bandwidth, consider using lower video resolution or bitrate. Bandwidth " + (Math.round(networkBandwidth / 1000)) + " bitrate " + (Math.round(remoteBitrate / 1000)));
    }).on    } else if (STREAM_STATUS.STOPPED, function(EVENT_TYPE.RESIZE === streamEvent.type) {
            ...
        }
    });

7. Handling the event about changing stream picture size

STREAM_EVENT, STREAM_EVENT_TYPE.RESIZE code

Code Block
languagejs
themeRDark
    }).on(STREAM_STATUS.FAILEDEVENT, function(streamEvent) {
            ...
        } else if (STREAM_EVENT_TYPE.RESIZE === streamEvent.type).play();

6. Stop of playback.

...

 {
            console.log("New video size: " + streamEvent.payload.streamerVideoWidth + "x" + streamEvent.payload.streamerVideoHeight);
        }
    });

8. Playback stop

Stream.stop()   code

Code Block
languagejs
themeRDark
function onStarted(stream) {
    $("#playBtn").text("Stop").off('click').click(function(){
        $(this).prop('disabled', true);
        stream.stop();
    }).prop('disabled', false);
    ...
}

79.  Receiving Receiving the event confirming successful stream playback stop

StreamStatusEvent STOPPED STREAM_STATUS.STOPPED code

Code Block
languagejs
themeRDark
    stream = session.createStream(options).on(STREAM_STATUS.PENDING, function (stream) {
        name: streamName,
 ...
    }).on(STREAM_STATUS.STOPPED, function () {
        $("#preloader").hide();
        setStatus(STREAM_STATUS.STOPPED);
       display: remoteVideo onStopped();
    }).on(STREAM_STATUS.PLAYINGFAILED, function(stream) {
        ...
    }).play();

10. Playback volume control

Stream.unmuteRemoteAudio()

...

, Stream.setVolume() code

Code Block
languagejs
themeRDark
    $("#volumeControl").slider({
        range: "min",
        min: 0,
        max: 100,
        value: currentVolumeValue,
        step: 10,
        animate: true,
        slide: function(event, ui) {
        setStatus(STREAM_STATUS.STOPPED)     //WCS-2375. fixed autoplay in ios safari
            if (stream.isRemoteAudioMuted()) {
                stream.unmuteRemoteAudio();
            }
            currentVolumeValue = ui.value;
        onStopped();    stream.setVolume(currentVolumeValue);
        }
    }).on(STREAM_STATUS.FAILED, function() {
        ...
    }).play();slider("disable");

11. Playback automatic start on page load

code

Code Block
languagejs
themeRDark
    if (autoplay) {
        // We can start autoplay with muted audio only, so set volume slider to 0 #WCS-2425
        $("#volumeControl").slider('value', 0);
        $("#playBtn").click();
    }