그룹 음성 통화

그룹 음성 통화를 구현하는 예제 코드입니다.

필수 조건

시작하기 전에 다음 작업을 수행해야 합니다.

• PlanetKit을 초기화하세요.
• 적절한 액세스 토큰을 획득하세요.
• 그룹 통화 흐름에서 전반적인 API 사용 과정을 확인하세요.

그룹 음성 통화 구현 시 고려 사항

joinConference()를 호출한 다음에는 반환된 PlanetKitJoinConferenceResult의 reason 속성을 확인해야 합니다.

• reason이 PlanetKitStartFailReason.NONE인 경우 성공을 의미합니다.
• 그렇지 않으면 실패를 의미하며 reason에 따라 적절한 조치를 취해야 합니다.

장치 권한 요청

Dart permission_handler 패키지를 사용하여 전화 및 마이크 권한을 요청하세요.

import 'package:permission_handler/permission_handler.dart';
final status = await [Permission.microphone, Permission.phone, Permission.bluetoothConnect].request();

변수 준비

주요 속성 및 이벤트 핸들러에 대한 변수를 준비합니다.

• PlanetKitConferenceEventHandler는 그룹 통화의 상태 변경 이벤트를 처리하는 데 사용됩니다. 자세한 내용은 그룹 통화 흐름을 참조하세요.
• PlanetKitMyMediaStatusHandler는 로컬 사용자의 미디어 상태 변경 이벤트를 처리하는 데 사용됩니다. 마이크가 음소거되거나 음소거 해제되는 경우, 또는 오디오 설명이 업데이트되는 경우 등 이벤트를 기반으로 로컬 사용자의 UI를 업데이트할 수 있습니다.

final String _myUserId = "test user id";
final String _serviceId = "test service id";
PlanetKitConference? _conference;
List<Peer> _peers = [];

final _eventHandler = PlanetKitConferenceEventHandler(
    onConnected: (conference) => print("connected"),
    onDisconnected: (conference, reason, source, byRemote) => print("disconnected $reason"),
    onPeerListUpdated: _onPeerListUpdated);

final _myMediaStatusHandler = PlanetKitMyMediaStatusHandler(
    onMicMute: (status) => print("mic muted"),
    onMicUnmute: (status) => print("mic unmuted"),
    onAudioDescriptionUpdate: (status, averageVolumeLevel) => print("audio description updated"));

그룹 통화 입장

그룹 통화에 입장하려면 PlanetKitJoinConferenceParamBuilder()를 사용해 PlanetKitJoinConferenceParam를 만들어 이를 인자로 PlanetKitManager.instance.joinConference()를 호출하세요.

Future<bool> joinConference(String roomId, String accessToken) async {
  var builder = PlanetKitJoinConferenceParamBuilder()
      .setMyUserId(_myUserId)
      .setMyServiceId(_serviceId)
      .setRoomServiceId(_serviceId)
      .setRoomId(roomId)
      .setAccessToken(accessToken);

  PlanetKitJoinConferenceParam? param;
  try {
    param = builder.build();
  } catch (error) {
    print("failed to build join conference param $error");
    return false;
  }
  final result =
      await PlanetKitManager.instance.joinConference(param, _eventHandler);

  if (result.reason != PlanetKitStartFailReason.none) {
    print("join conference result ${result.reason}");
    return false;
  }

  // Store conference instance and set MyMediaStatusHandler.
  _conference = result.conference;
  _conference?.myMediaStatus.setHandler(_myMediaStatusHandler);
  return true;
}

PlanetKitPeerControl을 사용하여 피어 관리

PlanetKitConferenceEventHandler.onPeerListUpdated() 및 PlanetKitPeerControl을 사용하여 그룹 통화에 참여한 피어를 관리하세요. 피어 목록이 업데이트되면 모니터링할 피어에 대한 PlanetKitPeerControl을 생성하세요.

class Peer {
  String userId;
  bool isMuted;
  bool isOnHold;
  bool isConnected = true;
  int volume = 0;
  PlanetKitPeerControl? _control;
  Peer({required this.userId, required this.isMuted, required this.isOnHold});

  Future<void> register(PlanetKitPeerControl control) async {
    _control = control;
    final _handler = PlanetKitPeerControlHandler(
      onMicMute: (control) => isMuted = true,
      onMicUnmute: (control) => isMuted = false,
      onHold: (control, reason) => isOnHold = true,
      onUnhold: (control) => isOnHold = false,
      onAudioDescriptionUpdate: (control, averageVolumeLevel) =>
          volume = averageVolumeLevel,
      onDisconnect: (control) => isConnected = false,
    );
    await _control?.register(_handler);
  }

  Future<void> unregister() async {
    await _control?.unregister();
  }
}

void _onPeerListUpdated(PlanetKitConference conference, PlanetKitConferencePeerListUpdateParam updateParam) async {

  // process added peers
  for (var addedPeer in updateParam.addedPeers) {
    final isMuted = await addedPeer.isMuted;
    final holdStatus = await addedPeer.holdStatus;

    final peer = Peer(
        userId: addedPeer.userId.userId,
        isMuted: isMuted,
        isOnHold: holdStatus.isOnHold);
    _peers.add(peer);

    // create peer control to monitor peer updates
    final peerControl = await _conference?.createPeerControl(addedPeer);
    if (peerControl == null) {
      print(
          "fail to create PlanetKitPeerControl for peer: ${addedPeer.userId.userId}");
      continue;
    }

    peer.register(peerControl);
  }

  // process removed peers
  for (var removedPeer in updateParam.removedPeers) {
    try {
      final removed = _peers.firstWhere((item) => item.userId == removedPeer.userId.userId);
      removed.unregister();
    } catch (e) {
      print("failed to remove peer: ${removedPeer.userId.userId}");
    }
  }
}

그룹 통화 퇴장

그룹 통화에서 퇴장하려면, leaveConference()를 호출하세요.

Future<bool> leaveConference() async {
  return await _conference?.leaveConference() ?? false;
}

CallKit 연동을 위한 추가 구현(선택 사항)

Note

이 단계는 iOS 애플리케이션에만 적용됩니다.

CallKit 프레임워크를 사용하는 경우 PlanetKitJoinConferenceParam에서 callKitType을 PlanetKitCallKitType.user로 설정해야 합니다.

그런 다음 CXProviderDelegate.provider(_ provider: CXProvider, didActivate audioSession: AVAudioSession)에서 PlanetKitConference.notifyCallKitAudioActivation()을 호출하여 PlanetKit에서 오디오가 활성화되도록 해야 합니다.

관련 예제 코드

• PlanetKit 초기화
• 그룹 영상 통화

관련 문서

• 액세스 토큰
• 그룹 통화 흐름