Versions Compared

Key

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

Table of Contents

Описание

Пример

...

Работа с кодом примера

Для разбора кода возьмем версию примера PhoneMin, которая доступена для скачивания в сборке 2.5.2.

Класс для основного вида приложения: ViewController (заголовочный файл ViewController.h; файл имплементации ViewController.m).

1. Импорт API. код

Code Block
languagebash
themeRDark
#import <FPWCSApi2/FPWCSApi2.h>

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

FPWCSApi2 createSession, FPWCSApi2Session connect код
В параметрах сессии указываются:

  • URL WCS-сервера
  • параметры SIP-аккаунта для совершения исходящих и приема входящих звонков
  • имя серверного приложения defaultApp
Code Block
languagebash
themeRDark
FPWCSApi2SessionOptions *options = [[FPWCSApi2SessionOptions alloc] init];
options.urlServer = _connectUrl.text;
options.sipRegisterRequired = _sipRegRequired.control.isOn;
options.sipLogin = _sipLogin.input.text;
options.sipAuthenticationName = _sipAuthName.input.text;
options.sipPassword = _sipPassword.input.text;
options.sipDomain = _sipDomain.input.text;
options.sipOutboundProxy = _sipOutboundProxy.input.text;
options.sipPort = [NSNumber numberWithInteger: [_sipPort.input.text integerValue]];
options.appKey = @"defaultApp";
NSError *error;
if (!options.sipLogin.length || !options.sipAuthenticationName.length || !options.sipPassword.length ||
     !options.sipDomain.length || !options.sipOutboundProxy.length || options.sipPort.integerValue == 0) {
    UIAlertController * alert = [UIAlertController
                                 alertControllerWithTitle:@"All Sip Credentials is required"
                                 message:error.localizedDescription
                                 preferredStyle:UIAlertControllerStyleAlert];
        
    UIAlertAction* okButton = [UIAlertAction
                               actionWithTitle:@"Ok"
                               style:UIAlertActionStyleDefault
                               handler:^(UIAlertAction * action) {
                                   [self onDisconnected];
                               }];
        
    [alert addAction:okButton];
    [self presentViewController:alert animated:YES completion:nil];
    return nil;
}
session = [FPWCSApi2 createSession:options error:&error];
if (error) {
    UIAlertController * alert = [UIAlertController
                                 alertControllerWithTitle:@"Failed to connect"
                                 message:error.localizedDescription
                                 preferredStyle:UIAlertControllerStyleAlert];
        
    UIAlertAction* okButton = [UIAlertAction
                               actionWithTitle:@"Ok"
                               style:UIAlertActionStyleDefault
                               handler:^(UIAlertAction * action) {
                                   [self onDisconnected];
                               }];
        
    [alert addAction:okButton];
    [self presentViewController:alert animated:YES completion:nil];
    return nil;
}
...
[session connect];

...

FPWCSApi2Session createCall, FPWCSApi2Call call код

При создании звонка в метод createCall передаются параметры:

  • имя вызываемого SIP-аккаунта
  • дополнительные параметры SIP INVITE запроса, введенные пользователем
Code Block
languagebash
themeRDark
- (FPWCSApi2Call *)call {
    FPWCSApi2Session *session = [FPWCSApi2 getSessions][0];
    FPWCSApi2CallOptions *options = [[FPWCSApi2CallOptions alloc] init];
    NSString *parameters = _inviteParameters.input.text;
    if (parameters && [parameters length] > 0) {
        NSError* err = nil;
        parameters = [parameters stringByReplacingOccurrencesOfString:@""" withString:@"\""];
        NSMutableDictionary *dictionary = [NSJSONSerialization JSONObjectWithData:[parameters dataUsingEncoding:NSUTF8StringEncoding] options:0 error:&err];
        if (err) {
            NSLog(@"Error converting JSON Invite parameters to dictionary %@, JSON %@", err, parameters);
        } else {
            options.inviteParameters = dictionary;
        }
    }
    options.callee = _callee.input.text;
    //used for only recv audio
//    options.localConstraints = [[FPWCSApi2MediaConstraints alloc] initWithAudio:NO video:NO];
//    options.remoteConstraints = [[FPWCSApi2MediaConstraints alloc] initWithAudio:YES video:NO];
    NSError *error;
    call = [session createCall:options error:&error];
    if (!call) {
        UIAlertController * alert = [UIAlertController
                                     alertControllerWithTitle:@"Failed to create call"
                                     message:error.localizedDescription
                                     preferredStyle:UIAlertControllerStyleAlert];
        
        UIAlertAction* okButton = [UIAlertAction
                                   actionWithTitle:@"Ok"
                                   style:UIAlertActionStyleDefault
                                   handler:^(UIAlertAction * action) {
                                       [self toCallState];
                                   }];
        
        [alert addAction:okButton];
        [self presentViewController:alert animated:YES completion:nil];
        return nil;
    }

    [call on:kFPWCSCallStatusBusy callback:^(FPWCSApi2Call *call){
        [self changeCallStatus:call];
        [self toCallState];
    }];
    
    [call on:kFPWCSCallStatusFailed callback:^(FPWCSApi2Call *call){
        [self changeCallStatus:call];
        [self toCallState];
    }];
    
    [call on:kFPWCSCallStatusRing callback:^(FPWCSApi2Call *call){
        [self changeCallStatus:call];
        [self toHangupState];
    }];
    
    [call on:kFPWCSCallStatusHold callback:^(FPWCSApi2Call *call){
        [self changeCallStatus:call];
        [self changeViewState:_holdButton enabled:YES];
    }];
    
    [call on:kFPWCSCallStatusEstablished callback:^(FPWCSApi2Call *call){
        [self changeCallStatus:call];
        [self toHangupState];
        [self changeViewState:_holdButton enabled:YES];
    }];
    
    [call on:kFPWCSCallStatusFinish callback:^(FPWCSApi2Call *call){
        [self changeCallStatus:call];
        [self toCallState];
    }];
    
    [call call];
    return call;
}

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

FPWCSApi2Session onIncomingCallCallback код

...

languagebash
themeRDark

...

демонстрирует возможности совершения SIP аудио звонков при помощи iOS SDK

На скриншотах, приведенных ниже, отображается интерфейс приложения перед совершением звонка.

В поле ввода 'WCS URL' указан адрес демонстрационного WCS-сервера wcs5-eu.flashphoner.com

В полях ввода 'SIP...' указываются параметры регистрации на SIP-сервере.
В поле 'Callee', указано имя вызываемого абонента.

Поле 'Invite parameters' предназначено для ввода дополнительных параметров сообщения SIP INVITE.

Соединение с сервером устанавливается при нажатии на кнопку 'Connect'. Звонок устанавливается/завершается по нажатию Call/Hangup, вводится в режим удержания либо выводится из него кнопкой Hold/Unhold.

Image Added

Image Added

Работа с кодом примера

Для разбора кода возьмем версию примера PhoneMin, которая доступна на GitHub.

Класс для основного вида приложения: ViewController (заголовочный файл ViewController.h; файл имплементации ViewController.m).

1. Импорт API code

Code Block
languagecpp
themeRDark
#import <FPWCSApi2/FPWCSApi2.h>

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

FPWCSApi2.createSession, FPWCSApi2Session.connect code
В параметрах сессии указываются:

  • URL WCS-сервера
  • параметры SIP-аккаунта для совершения исходящих и приема входящих звонков
  • имя серверного приложения defaultApp
Code Block
languagecpp
themeRDark
FPWCSApi2SessionOptions *options = [[FPWCSApi2SessionOptions alloc] init];
options.urlServer = _connectUrl.text;
options.sipRegisterRequired = _sipRegRequired.control.isOn;
options.sipLogin = _sipLogin.input.text;
options.sipAuthenticationName = _sipAuthName.input.text;
options.sipPassword = _sipPassword.input.text;
options.sipDomain = _sipDomain.input.text;
options.sipOutboundProxy = _sipOutboundProxy.input.text;
options.sipPort = [NSNumber numberWithInteger: [_sipPort.input.text integerValue]];
options.appKey = @"defaultApp";
NSError *error;
...
session = [FPWCSApi2 createSession:options error:&error];
...
[session connect];

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

FPWCSApi2Session.createCall, FPWCSApi2Call.call code

При создании звонка в метод createCall передаются параметры:

  • имя вызываемого SIP-аккаунта
  • дополнительные параметры SIP INVITE запроса, введенные пользователем
Code Block
languagecpp
themeRDark
- (FPWCSApi2Call *)call {
    FPWCSApi2Session *session = [FPWCSApi2 getSessions][0];
    FPWCSApi2CallOptions *options = [[FPWCSApi2CallOptions alloc] init];
    NSString *parameters = _inviteParameters.input.text;
    if (parameters && [parameters length] > 0) {
        NSError* err = nil;
        parameters = [parameters stringByReplacingOccurrencesOfString:@""" withString:@"\""];
        NSMutableDictionary *dictionary = [NSJSONSerialization JSONObjectWithData:[parameters dataUsingEncoding:NSUTF8StringEncoding] options:0 error:&err];
        if (err) {
            NSLog(@"Error converting JSON Invite parameters to dictionary %@, JSON %@", err, parameters);
        } else {
            options.inviteParameters = dictionary;
        }
    }
    options.callee = _callee.input.text;
    ...
    NSError *error;
    call = [session createCall:options error:&error];
    ...
    [call call];
    return call;
}

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

FPWCSApi2Session.onIncomingCallCallback code

Code Block
languagecpp
themeRDark
[session onIncomingCallCallback:^(FPWCSApi2Call *rCall) {
    call = rCall;
        
    [call on:kFPWCSCallStatusRingkFPWCSCallStatusBusy callback:^(FPWCSApi2Call *call){
        [self changeCallStatus:call];
        [self toHangupStatetoCallState];
    }];
        
    [call on:kFPWCSCallStatusHoldkFPWCSCallStatusFailed callback:^(FPWCSApi2Call *call){
        [self changeCallStatus:call];
        [self changeViewState:_holdButton enabled:YES toCallState];
    }];
        
    [call on:kFPWCSCallStatusEstablishedkFPWCSCallStatusRing callback:^(FPWCSApi2Call *call){
        [self changeCallStatus:call];
        [self toHangupState];
        [self changeViewState:_holdButton enabled:YES];
    }];
        
    [call on:kFPWCSCallStatusFinishkFPWCSCallStatusHold callback:^(FPWCSApi2Call *call){
        [self changeCallStatus:call];
        [self toCallState];
        [self dismissViewControllerAnimated:YES completion:nil];
        [self  }changeViewState:_holdButton enabled:YES];
    ...
}];

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

FPWCSApi2Call answer код

Code Block
languagebash
themeRDark
alert = [UIAlertController
        
    [call on:kFPWCSCallStatusEstablished callback:^(FPWCSApi2Call *call){
           [self changeCallStatus:call];
   alertControllerWithTitle:[NSString stringWithFormat:@"Incoming call from '%@'", [rCallself getCalleetoHangupState]];
        [self changeViewState:_holdButton enabled:YES];
    }];
        
    [call on:kFPWCSCallStatusFinish  message:error.localizedDescriptioncallback:^(FPWCSApi2Call *call){
        [self changeCallStatus:call];
        [self toCallState];
        [self dismissViewControllerAnimated:YES  preferredStylecompletion:UIAlertControllerStyleAlertnil];
    }];
    
UIAlertAction* answerButton...
}];

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

FPWCSApi2Call.answer code

Code Block
languagecpp
themeRDark
alert = [UIAlertActionUIAlertController
                               actionWithTitlealertControllerWithTitle:[NSString stringWithFormat:@"Answer"
  Incoming call from '%@'", [rCall getCallee]]
                             stylemessage:UIAlertActionStyleDefault
                   error.localizedDescription
            handler:^(UIAlertAction * action) {
              preferredStyle:UIAlertControllerStyleAlert];
        
UIAlertAction* answerButton = [UIAlertAction
          [call answer];
                    actionWithTitle:@"Answer"
           }];
        
[alert addAction:answerButton];
UIAlertAction* hangupButton = [UIAlertAction
        style:UIAlertActionStyleDefault
                       actionWithTitle:@"Hangup"
        handler:^(UIAlertAction * action) {
                    style:UIAlertActionStyleDefault
               [call answer];
               handler:^(UIAlertAction * action) {
             }];
        
[alert addAction:answerButton];
UIAlertAction* hangupButton =  [UIAlertAction
         [call hangup];
                     actionWithTitle:@"Hangup"
          }];
        
[alert addAction:hangupButton];
[self presentViewController:alert animated:YES completion:nil];

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

FPWCSApi2Call hold, unhold код

Code Block
languagebash
themeRDark
- (void)holdButton:(UIButton *)button {
    [self changeViewState:button enabledstyle:NO];UIAlertActionStyleDefault
      if ([button.titleLabel.text isEqualToString:@"UNHOLD"]) {
        if (call) {
            [call unhold];
  handler:^(UIAlertAction * action) {
          [_holdButton setTitle:@"HOLD" forState:UIControlStateNormal];
        }
    } else {
        if ([call) {
hangup];
                [call hold];
            [_holdButton setTitle:@"UNHOLD" forState:UIControlStateNormal }];
        }
[alert addAction:hangupButton];
[self presentViewController:alert  }
}

7. Отправка тонального сигнала

...

animated:YES completion:nil];

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

FPWCSApi2Call.hold, unhold code

Code Block
languagebashcpp
themeRDark
- (void)dtmfButtonholdButton:(UIButton *)button {
)button {
    [self changeViewState:button enabled:NO];
    if ([button.titleLabel.text isEqualToString:@"UNHOLD"]) {
        if (call) {
            [call sendDTMF:_dtmf.input.text type:kFPWCSCallDTMFRFC2833];
    }
}

...

FPWCSApi2Call hangup код

Code Block
languagebash
themeRDark
- (void)callButton:(UIButton *)button {
unhold];
     [self changeViewState:button enabled:NO];
    if ([button.titleLabel.text isEqualToString[_holdButton setTitle:@"HANGUPHOLD"]) {
 forState:UIControlStateNormal];
        }
   if ([FPWCSApi2 getSessions].count)} else {
        if (call) {
  [call hangup];
        } else {[call hold];
            [self toCallState_holdButton setTitle:@"UNHOLD" forState:UIControlStateNormal];
        }
    }
} else

7. Отправка тонального сигнала

FPWCSApi2Call.sendDTMF code

Code Block
languagecpp
themeRDark
- (void)dtmfButton:(UIButton *)button {
        if ([FPWCSApi2 getSessions].count (call) {
        [call sendDTMF:_dtmf.input.text type:kFPWCSCallDTMFRFC2833];
     [self call];}
}

8. Переключение с голосового динамика на динамик громкой связи

FPWCSApi2Call.setLoudspeakerStatus code

Code Block
languagecpp
themeRDark
- (void)useLoudSpeakerValueChanged:(id)sender {
        } elseif (call) {
        [call    [self toCallState];
        }setLoudspeakerStatus:_useLoudSpeaker.control.isOn withError:nil];
    }
}

9. Завершение входящего исходящего звонка.

FPWCSApi2Call.hangup код code

Code Block
languagebashcpp
themeRDark
UIAlertAction* hangupButton = [UIAlertAction
   - (void)callButton:(UIButton *)button {
    [self changeViewState:button enabled:NO];
    if ([button.titleLabel.text isEqualToString:@"HANGUP"]) {
        if       actionWithTitle:@"Hangup"
   ([FPWCSApi2 getSessions].count) {
            [call hangup];
        } else {
     style:UIAlertActionStyleDefault
       [self toCallState];
        }
        ...
       handler:^(UIAlertAction * action) {
}
}

10. Завершение входящего звонка.

FPWCSApi2Call.hangup code

Code Block
languagecpp
themeRDark
UIAlertAction* hangupButton = [UIAlertAction
                               actionWithTitle:@"Hangup"
     [call hangup];
                         style:UIAlertActionStyleDefault
      }];
        
[alert addAction:hangupButton];

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

FPWCSApi2Session disconnect код

Code Block
languagebash
themeRDark
- (void)connectButton:(UIButton *)button {
         [self changeViewState:button enabled:NO];
    if ([button.titleLabel.text isEqualToString:@"DISCONNECT"]handler:^(UIAlertAction * action) {
                 if ([FPWCSApi2 getSessions].count) {
            FPWCSApi2Session *session = [FPWCSApi2 getSessions][0call hangup];
            NSLog(@"Disconnect session with server %@", [session getServerUrl]);
            [session disconnect}];
        
[alert addAction:hangupButton];

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

FPWCSApi2Session.disconnect code

Code Block
languagecpp
themeRDark
-  } else(void)connectButton:(UIButton *)button {
    [self changeViewState:button enabled:NO];
    if  NSLog(@"Nothing to disconnect");
            [self onDisconnected];
 ([button.titleLabel.text isEqualToString:@"DISCONNECT"]) {
       }
 if   } else([FPWCSApi2 getSessions].count) {
        //todo check url is notFPWCSApi2Session empty
*session =       [self changeViewState:_connectUrl enabled:NO[FPWCSApi2 getSessions][0];
        [self changeViewState:_sipLogin.input enabled:NO];
     NSLog(@"Disconnect session with server %@", [self changeViewState:_sipAuthName.input enabled:NO];
session getServerUrl]);
            [self changeViewState:_sipPassword.input enabled:NOsession disconnect];
        } else {
 [self changeViewState:_sipDomain.input enabled:NO];
          [self changeViewState:_sipOutboundProxy.input enabled:NO];
NSLog(@"Nothing to disconnect");
            [self changeViewState:_sipRegRequired.control enabled:NOonDisconnected];
        [self changeViewState:_sipPort.input enabled:NO];}
        [self connect];...
    }
}