Discussion

If TVODefaultAudioDevice is enabled, the SDK executes this block and activates the audio session while connecting to a Call, otherwise it is the developer’s responsibility to execute the block. Please note that the getter of this property returns a wrapper block which internally executes the block you set. By default, the SDK returns a default wrapper block which executes kTVODefaultAVAudioSessionConfigurationBlock internally.

The following example demonstrates changing the audio route from speaker to receiver:

  TVODefaultAudioDevice *audioDevice = [TVODefaultAudioDevice audioDevice];

  TwilioVoiceSDK.audioDevice = audioDevice;

  //...connect to a Call with audioDevice. By default the audio route will be configured to receiver.

  audioDevice.block =  ^ {
      // We will execute `kTVODefaultAVAudioSessionConfigurationBlock` first.
      kTVODefaultAVAudioSessionConfigurationBlock();

      // Overwrite the audio route
      AVAudioSession *session = [AVAudioSession sharedInstance];
      NSError *error = nil;
      if (![session overrideOutputAudioPort:AVAudioSessionPortOverrideSpeaker error:&error]) {
          NSLog(@"AVAudiosession overrideOutputAudioPort %@",error);
      }
  };
  audioDevice.block();

Discussion

By default, the SDK initializes this property to YES. Setting it to NO forces the underlying CoreAudio graph to be stopped (if active), and prevents it from being started again. Setting the property to YES allows the audio graph to be started whenever there is audio to play or record in a Call.

Discussion

Use defaultAudioDeviceto create a TVODefaultAudioDevice.

Discussion

Use this factory method if you want to connect to a Call with your choice of audio session configuration.

The following example demonstrates connecting to a Call using the AVAudioSessionCategoryPlayback category:

  TwilioVoiceSDK.audioDevice = [TVODefaultAudioDevice audioDeviceWithBlock:^ {
      // We will execute `kTVODefaultAVAudioSessionConfigurationBlock` first.
      kTVODefaultAVAudioSessionConfigurationBlock();

      // Overwrite the category to `playback`
      AVAudioSession *session = [AVAudioSession sharedInstance];
      NSError *error = nil;
      if (![session setCategory:AVAudioSessionCategoryPlayback
                           mode:AVAudioSessionModeVoiceChat
                        options:AVAudioSessionCategoryOptionAllowBluetooth | AVAudioSessionCategoryOptionAllowBluetoothA2DP
                          error:&error]) {
          NSLog(@"AVAudioSession setCategory:options:mode:error: %@",error);
      }
  }];

  TVOConnectOptions *connectOptions = [TVOConnectOptions optionsWithToken:token
                                                                    block:^(TVOConnectOptionsBuilder *builder) {
      // configure builder attributes here
  }];

  TVOCall *call = [TwilioVoiceSDK connectWithOptions:connectOptions];