Versions Compared

Key

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

Пример вебфона с интерфейсом телефона

На скриншоте скриншотах ниже (слева направо)

  • параметры для SIP- соединения введены в login- форме входа

Image Added

  • введено SIP имя вызываемого пользователя вызываемого

Image Added

  • установлен видеозвонок

Image RemovedImage Added

Видео или аудиозвонок инициируется при нажатии на соответствующую кнопку и завершается при нажатии на кнопку Hangup.
Для удержания (hold) звонка используется иконка 'пауза'.
Для регулировки громкости используется ползунок, который появляется при клике на иконке 'динамик' в левом верхнем углу.

...

Для разбора кода возьмем версию файла Phone.js с хешем bb13dd898ed9ef182abcf44dd7fdc159e8d66f4a ecbadc3, которая находится здесь и доступна для скачивания в соответствующей сборке  2.0.5212.8.1894.

В этом скрипте методы Flashphoner API вызываются из соответствующих методов объекта Phone.

Например, метод для установления соединения с сервером createSession() вызывается из метода connect(). код

code

Code Block
languagejs
themeRDark
Phone.prototype.connect = function () {
   var me = this;
   .....
   Flashphoner.createSession(connectionOptions).on(SESSION_STATUS.ESTABLISHED, function(session){
   .....
}

Объект Phone создается и инициализируется после инициализации API. код

code

Code Block
languagejs
themeRDark
var phone = new Phone();

phone.init();

Кроме методов, необходимых для звонков, объект предоставляет методы для изменения контролов элементов интерфейса в зависимости от статуса соединения и звонка (line 194 - line 416).

1. Инициализация API.

Flashphoner.init() код code

Code Block
languagejs
themeRDark
Flashphoner.init({flashMediaProviderSwfLocation: '../../../../media-provider.swf',
            mediaProvidersReadyCallback: function(mediaProviders) {
Flashphoner.init();

2. Подключение к серверу.

Flashphoner.createSession() code

Методу createSession() передается объект с параметрами для подключения

  • urlServer - URL для WebSocket-соединения с WCS-сервером
  • sipOptions - объект с параметрами для SIP-соединения
Code Block
languagejs
themeRDark
    var url = setURL();

    this.sipOptions = {};
   //hide remote video if current media provider is Flash this.sipOptions.login = $('#sipLogin').val();
    this.sipOptions.password   = $('#sipPassword').val();
    this.sipOptions.authenticationName = $('#sipAuthenticationName').val();
   if (mediaProviders[0] this.sipOptions.domain == "Flash") { $('#sipDomain').val();
    this.sipOptions.outboundProxy = $('#sipOutboundProxy').val();
              $("#remoteVideoWrapper").removeClass().hidethis.sipOptions.port = $('#sipPort').val();
    this.sipOptions.useProxy = true;
    this.sipOptions.registerRequired = true;

    var connectionOptions =  $("#localVideoWrapper").attr('class', 'b-video__video ui-widget-content');
{
        urlServer: url,
          }sipOptions: this.sipOptions
    };

        }}Flashphoner.createSession(connectionOptions).on(SESSION_STATUS.ESTABLISHED, function(session){
        ...
    });

2. Подключение к серверу.

Flashphoner.createSession() код

Методу createSession() передается объект с параметрами для подключения

  • urlServer - URL для WebSocket-соединения с WCS-сервером
  • sipOptions - объект с параметрами для SIP-соединения

3. Получение от сервера события, подтверждающего успешное соединение.

ConnectionStatusEvent ESTABLISHED code

Code Block
languagejs
themeRDark
var  url = setURLFlashphoner.createSession();

    this.sipOptions = {};
connectionOptions).on(SESSION_STATUS.ESTABLISHED, function(session){
     this.sipOptions.login   me.session = $('#sipLogin').val()session;
     this.sipOptions.password  = $('#sipPassword').val(me.connectionStatusListener(SESSION_STATUS.ESTABLISHED);
    this.sipOptions.authenticationName = $('#sipAuthenticationName').val();
}).on(SESSION_STATUS.REGISTERED, function(session){
       this ..sipOptions.domain
   = $('#sipDomain').val();}).on(SESSION_STATUS.DISCONNECTED, function(){
    this.sipOptions.outboundProxy = $('#sipOutboundProxy').val();    ...
    this.sipOptions.port = $('#sipPort').val();
}).on(SESSION_STATUS.FAILED, function(){
        this..sipOptions.useProxy = true;
    this.sipOptions.registerRequired = true;

    var connectionOptions = }).on(SESSION_STATUS.INCOMING_CALL, function(call){
        urlServer: url,
        sipOptions: this.sipOptions...
    };

);

4. Получение от сервера события, подтверждающего успешную регистрацию на SIP-сервере.

ConnectionStatusEvent REGISTERED code

Code Block
languagejs
themeRDark
    Flashphoner.createSession(connectionOptions).on(SESSION_STATUS.ESTABLISHED, function(session){
        me.session = session;
        me.connectionStatusListener(SESSION_STATUS.ESTABLISHED);
    }).on(SESSION_STATUS.REGISTERED, function(session){
           me.registrationStatusListener(SESSION_STATUS.REGISTERED);
     }).on(SESSION_STATUS.DISCONNECTED, function(){
        me..connectionStatusListener(SESSION_STATUS.DISCONNECTED);
    }).on(SESSION_STATUS.FAILED, function(){
        me..connectionStatusListener(SESSION_STATUS.FAILED);
    }).on(SESSION_STATUS.INCOMING_CALL, function(call){
        call..on(CALL_STATUS.RING, function(){
            me.callStatusListener(call);
        }});

5. Получение от сервера события, сигнализирующего о входящем звонке.

ConnectionStatusEvent INCOMING_CALL code

Code Block
languagejs
themeRDark
    Flashphoner.createSession(connectionOptions).on(CALLSESSION_STATUS.ESTABLISHED, function(session){
            me.callStatusListener(call);
 ...
       }).on(CALLSESSION_STATUS.HOLDREGISTERED, function(session) {
            me.callStatusListener(call);
 ...
       }).on(CALLSESSION_STATUS.FINISHDISCONNECTED, function(){
        ...
    me.callStatusListener(call);}).on(SESSION_STATUS.FAILED, function(){
        ...
    me.incomingCall = false;}).on(SESSION_STATUS.INCOMING_CALL, function(call){
        })call.on(CALL_STATUS.FAILEDRING, function(){
            me.callStatusListener(call);
            me.incomingCall = false;...
        });
        me.onCallListener(call);
    });

3. Получение от сервера события, подтверждающего успешное соединение.

ConnectionStatusEvent ESTABLISHED код

...

languagejs
themeRDark

...

6. Исходящий звонок.

session.createCall(), call.call() code

При создании звонка в метод передаются следующие параметры

  • callee - SIP имя пользователя вызываемого
  • visibleName - отображаемое имя
  • localVideoDisplay - div-элемент, в котором будет отображаться видео с камеры
  • remoteVideoDisplay - div-элемент, в котором будет отображаться видео другой стороны
  • constraints - объект с параметрами, указывающими на наличие аудио и видео
Code Block
languagejs
themeRDark
    var constraints = {
        audio: true,
         me.connectionStatusListener(SESSION_STATUS.ESTABLISHED);video: hasVideo
    }).on(SESSION_STATUS.REGISTERED, function(session){;

    var outCall =  me.registrationStatusListener(SESSION_STATUS.REGISTERED);
    }).on(SESSION_STATUS.DISCONNECTED, function(){
this.session.createCall({
        callee: callee,
        visibleName: me.connectionStatusListener(SESSION_STATUS.DISCONNECTED);
this.sipOptions.login,
        }).on(SESSION_STATUS.FAILED, function(){
localVideoDisplay: this.localVideo,
        remoteVideoDisplay: me.connectionStatusListener(SESSION_STATUS.FAILED);
this.remoteVideo,
     }).on(SESSION_STATUS.INCOMING_CALL, function(call){   constraints: constraints
        call.on(CALL_STATUS.RING, function(){..
    });

        me.callStatusListener(call);
        }).on(CALL_STATUS.ESTABLISHED, function(){
            me.callStatusListener(call);
        }).on(CALL_STATUS.HOLD, function() {
            me.callStatusListener(call);
        }).on(CALL_STATUS.FINISH, function(){
            me.callStatusListener(call);
            me.incomingCall = false;
        }).on(CALL_STATUS.FAILED, function(){
            me.callStatusListener(call);
            me.incomingCall = false;
        });
        me.onCallListener(call);
    });

4. Получение от сервера события, подтверждающего успешную регистрацию на SIP-сервере.

ConnectionStatusEvent REGISTERED код

Code Block
languagejs
themeRDark
    Flashphoner.createSession(connectionOptions).on(SESSION_STATUS.ESTABLISHED, function(session){
        me.session = session;
        me.connectionStatusListener(SESSION_STATUS.ESTABLISHED);
    }).on(SESSION_STATUS.REGISTERED, function(session){
        me.registrationStatusListener(SESSION_STATUS.REGISTERED);
    }).on(SESSION_STATUS.DISCONNECTED, function(){
        me.connectionStatusListener(SESSION_STATUS.DISCONNECTED);
    }).on(SESSION_STATUS.FAILED, function(){
        me.connectionStatusListener(SESSION_STATUS.FAILED);
    }).on(SESSION_STATUS.INCOMING_CALL, function(call){
        call.on(CALL_STATUS.RING, function(){
            me.callStatusListener(call);
        }).on(CALL_STATUS.ESTABLISHED, function(){
            me.callStatusListener(call);
        }).on(CALL_STATUS.HOLD, function() {
            me.callStatusListener(call);
        }).on(CALL_STATUS.FINISH, function(){
            me.callStatusListener(call);
            me.incomingCall = false;
        }).on(CALL_STATUS.FAILED, function(){
            me.callStatusListener(call);
            me.incomingCall = false;
        });
        me.onCallListener(call);
    });

5. Получение от сервера события, сигнализирующего о входящем звонке.

ConnectionStatusEvent INCOMING_CALL код

Code Block
languagejs
themeRDark
 Flashphoner.createSession(connectionOptions).on(SESSION_STATUS.ESTABLISHED, function(session){
        me.session = session;
        me.connectionStatusListener(SESSION_STATUS.ESTABLISHED);
    }).on(SESSION_STATUS.REGISTERED, function(session){
        me.registrationStatusListener(SESSION_STATUS.REGISTERED);
    }).on(SESSION_STATUS.DISCONNECTED, function(){
        me.connectionStatusListener(SESSION_STATUS.DISCONNECTED);
    }).on(SESSION_STATUS.FAILED, function(){
        me.connectionStatusListener(SESSION_STATUS.FAILED);
    }).on(SESSION_STATUS.INCOMING_CALL, function(call){
        call.on(CALL_STATUS.RING, function(){
            me.callStatusListener(call);
        }).on(CALL_STATUS.ESTABLISHED, function(){
            me.callStatusListener(call);
        }).on(CALL_STATUS.HOLD, function() {
            me.callStatusListener(call);
        }).on(CALL_STATUS.FINISH, function(){
            me.callStatusListener(call);
            me.incomingCall = false;
        }).on(CALL_STATUS.FAILED, function(){
            me.callStatusListener(call);
            me.incomingCall = false;
        });
        me.onCallListener(call);
    });

6. Исходящий звонок.

session.createCall(), call() код

При создании звонка в метод передаются следующие параметры

  • callee - SIP имя пользователя вызываемого
  • visibleName - отображаемое имя
  • localVideoDisplay - div-элемент, в котором будет отображаться видео с камеры
  • remoteVideoDisplay - div-элемент, в котором будет отображаться видео другой стороны
  • constraints - объект с параметрами, указывающими на наличие аудио и видео
Code Block
languagejs
themeRDark
var constraints = {
        audio: true,
        video: hasVideo
    };

    var outCall = this.session.createCall({
        callee: callee,
        visibleName: this.sipOptions.login,
        localVideoDisplay: this.localVideo,
        remoteVideoDisplay: this.remoteVideo,
        constraints: constraints
    }).on(CALL_STATUS.RING, function(call){
        me.callStatusListener(call);
    }).on(CALL_STATUS.ESTABLISHED, function(call){
        me.callStatusListener(call);
    }).on(CALL_STATUS.HOLD, function(call){
        me.callStatusListener(call);
    }).on(CALL_STATUS.FINISH, function(call){
        me.callStatusListener(call);
    }).on(CALL_STATUS.FAILED, function(call){
        me.callStatusListener(call);
    });

    outCall.call();

7. Ответ на входящий звонок.

call.answer() код

Методу передается объект с опциями для ответа

  • localVideoDisplay - div-элемент, в котором будет отображаться видео с камеры
  • remoteVideoDisplay - div-элемент, в котором будет отображаться видео другой стороны
Code Block
languagejs
themeRDark
outCall.call();

7. Ответ на входящий звонок.

call.answer() code

Методу передается объект с опциями для ответа

  • localVideoDisplay - div-элемент, в котором будет отображаться видео с камеры
  • remoteVideoDisplay - div-элемент, в котором будет отображаться видео другой стороны
Code Block
languagejs
themeRDark
Phone.prototype.answer = function () {
    trace("Phone - answer " + this.currentCall.id());
    this.flashphonerListener.onAnswer(this.currentCall.id());
    this.currentCall.answer({
        localVideoDisplay: this.localVideo,
        remoteVideoDisplay: this.remoteVideo
    });
};

8. Удержание звонка.

- удержание: сall.hold() код code

Code Block
languagejs
themeRDark
Phone.prototype.hold = function () {
    trace("Phone - hold callId: " + this.currentCall.id());
    this.currentCall.hold();
};

- возобновление: call.unhold() код code

Code Block
languagejs
themeRDark
Phone.prototype.unhold = function () {
    trace("Phone - hold callId: " + this.currentCall.id());
    this.currentCall.unhold();
};

9. Завершение звонка.

сall.hangup() код code

Code Block
languagejs
themeRDark
Phone.prototype.hangup = function () {
    trace("Phone - hangup " + this.currentCall.id() + " status " + this.currentCall.status());
    this.hideFlashAccess();
    if (this.currentCall.status() == CALL_STATUS.PENDING) {
        this.callStatusListener(this.currentCall);
    } else {
        this.currentCall.hangup();
    }
    this.flashphonerListener.onHangup();
};

10. Закрытие соединения.

session.disconnect() . код code

Code Block
languagejs
themeRDark
Phone.prototype.disconnect = function () {
    trace("Phone - disconnect");
    this.session.disconnect();
};