นำ Co-Doing API ไปใช้

หน้านี้จะอธิบายวิธีใช้ API การทำงานร่วมกันเพื่อสนับสนุนสถานการณ์การทำงานร่วมกัน

การตั้งค่าเบื้องต้น

แอปพลิเคชันการแชร์สดควรเริ่มต้นออบเจ็กต์ CoDoingClient ซึ่งแสดงถึงเซสชันการทำงานร่วมกัน

หากต้องการใช้ SDK การแชร์สดของ Meet ให้เรียกใช้เมธอด AddonClientFactory.getClient การดำเนินการนี้จะแสดงผล AddonClient ที่ทำหน้าที่เป็นจุดแรกเข้าสำหรับเซสชันการทำงานร่วมกัน

หากต้องการใช้ไคลเอ็นต์ ให้เรียกใช้เมธอด newSessionBuilder จาก AddonClient เพื่อแสดงเครื่องมือสร้างสำหรับ AddonSession ใหม่ newSessionBuilder จะใช้อินเทอร์เฟซ AddonSessionHandler เพื่อจัดการ Callback ที่ส่วนเสริมมีให้สำหรับเซสชัน

หากต้องการเริ่มเซสชัน ให้เพิ่มเมธอด withCoDoing ลงในเครื่องมือสร้าง

ตัวอย่างโค้ดต่อไปนี้แสดงการเริ่มต้นพื้นฐานของออบเจ็กต์ไคลเอ็นต์ที่ทำร่วมกัน

class AwesomeVideoAddonSessionHandler implements AddonSessionHandler {}

//For sample implementation, see the "Handle incoming updates" section.
class AwesomeVideoCoDoingHandler implements CoDoingHandler {}

public ListenableFuture<AddonSession> initialSetup() {
  AddonClient meetClient = AddonClientFactory.getClient();
  return meetClient
      .newSessionBuilder(
          new AwesomeVideoAddonSessionHandler())
      .withCoDoing(new AwesomeVideoCoDoingHandler())
      .begin();
}

หยุดวิดีโอชั่วคราว

เมื่อเข้าร่วมประสบการณ์การแชร์สด หากผู้ใช้หยุดการเล่นชั่วคราวในแอปวิดีโอในเครื่อง คุณต้องตรวจสอบว่าผู้เข้าร่วมการแชร์สดทุกคนหยุดวิดีโอชั่วคราวด้วย

โดยสร้าง CoDoingState ข้อความที่แสดงภาพวิดีโอหยุดชั่วคราว แล้วบอกให้ Google Meet ประกาศไปยังผู้เข้าร่วมคนอื่นๆ โดยใช้เมธอด setGlobalState สถานะทั่วโลกที่แชร์จะกลายเป็นสถานะเริ่มต้นสำหรับผู้เข้าร่วมทั้งหมด ไม่ว่าจะเป็นสถานะเดิมหรือสถานะใหม่ จนกว่าจะมีการตั้งค่าสถานะใหม่

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีแจ้งให้ผู้ใช้ทราบสถานะหยุดชั่วคราว

public void onVideoPaused(String videoUrl, Instant currentTimestamp) {
  // Create an internal state object to share with other participants. Note: It's
  // good practice to encode all metadata—even seemingly irrelevant data—into
  // ActivityState updates to guard against race conditions and other subtle
  // failures.
  AwesomeVideoState videoState = AwesomeVideoState
    .builder()
    .videoUrl(videoUrl)
    .videoTimestamp(currentTimestamp)
    .isPaused(true)
    .build();

  // Create the CoDoingState object to wrap the internal state
  CoDoingState coDoingState = new CoDoingState();
  coDoingState.state = SerializationUtils.serialize(videoState);

  // Use Meet to broadcast internal state update to all other participants
  this.coDoingClient.setGlobalState(coDoingState);
};

ตัวอย่างโค้ดจะทริกเกอร์ออบเจ็กต์ videoState ที่ต่อเนื่องให้ประกาศไปยังอินสแตนซ์อื่นๆ ทั้งหมดของ Meet ที่เข้าร่วมประสบการณ์การแชร์สด ดูรายละเอียดเกี่ยวกับวิธีรับการอัปเดตการออกอากาศจากผู้เข้าร่วมคนอื่นๆ ได้ที่ส่วนจัดการการอัปเดตที่เข้ามาใหม่

แผนภาพต่อไปนี้อธิบายลำดับเหตุการณ์หลังจากทริกเกอร์การหยุดชั่วคราว

ยกเลิกการหยุดวิดีโอชั่วคราว

เช่นเดียวกับหยุดวิดีโอชั่วคราว หากผู้ใช้ยกเลิกการหยุดวิดีโอชั่วคราวในแอปในเครื่อง Meet จะต้องเผยแพร่การดำเนินการนี้แก่ผู้เข้าร่วมการแชร์สดคนอื่นๆ

ทางฝั่งผู้ส่ง (ผู้ใช้ที่ยกเลิกการหยุดวิดีโอชั่วคราว) ความแตกต่างเพียงอย่างเดียวจากตัวอย่างการหยุดชั่วคราวคือการอัปเดตสถานะ isPaused

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีแจ้งให้ผู้ใช้ทราบสถานะที่ไม่ได้หยุดชั่วคราวจากฝั่งผู้ส่ง

public void onVideoUnpaused(String videoUrl, Instant currentTimestamp) {
  AwesomeVideoState videoState = AwesomeVideoState
    .builder()
    .videoUrl(videoUrl)
    .videoTimestamp(currentTimestamp)
    .isPaused(false)
    .build();

  CoDoingState coDoingState = new CoDoingState();
  coDoingState.state = SerializationUtils.serialize(videoState);

  this.coDoingClient.setGlobalState(coDoingState);
}

กรอวิดีโอ

เช่นเดียวกับหยุดวิดีโอชั่วคราวและยกเลิกการหยุดวิดีโอชั่วคราว หากผู้ใช้ลากไทม์ไลน์ในแอปในเครื่องไปยังการประทับเวลาใหม่ Meet จะต้องประกาศการดำเนินการนี้ไปยังผู้เข้าร่วมทุกคน

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีแจ้งให้ผู้ใช้ทราบเกี่ยวกับการประทับเวลาที่อัปเดตแล้วจากฝั่งผู้ส่ง

public void onVideoSeeked(String videoUrl, Instant currentTimestamp, bool isPaused) {
  AwesomeVideoState videoState = AwesomeVideoState
    .builder()
    .videoUrl(videoUrl)
    .videoTimestamp(currentTimestamp)
    .isPaused(isPaused)
    .build();

  CoDoingState coDoingState = new CoDoingState();
  coDoingState.state = SerializationUtils.serialize(videoState);

  this.coDoingClient.setGlobalState(coDoingState);
}

เล่นวิดีโออื่น

หากผู้ใช้เปลี่ยนวิดีโอที่ดูอยู่โดยการเลือกวิดีโออื่นในแอปในเครื่องด้วย Meet จะต้องเล่นวิดีโอใหม่ให้กับผู้เข้าร่วมการแชร์สดทุกคน วิดีโอที่มีการเปลี่ยนแปลงจะเก็บอยู่ใน videoState.videoUrl

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีแจ้งให้ผู้ใช้ทราบเกี่ยวกับ URL ของวิดีโอที่อัปเดต

public void onVideoChanged(String videoUrl, Duration currentTimestamp, bool isPaused) {
  AwesomeVideoState videoState = AwesomeVideoState
    .builder()
    .videoUrl(videoUrl)
    .videoTimestamp(currentTimestamp)
    .isPaused(isPaused)
    .build();

  CoDoingState coDoingState = new CoDoingState();
  coDoingState.state = SerializationUtils.serialize(videoState);

  this.coDoingClient.setGlobalState(coDoingState);
}

สิ้นสุดการทำงานร่วมกัน

เมื่อผู้ใช้เลือกที่จะสิ้นสุดกิจกรรม วิธีการ endSession จะยกเลิกการเชื่อมต่อจากแอป Meet การดำเนินการนี้ไม่ได้เป็นการบังคับให้ Meet สิ้นสุดการประชุม และไม่ได้เป็นการทำให้ผู้ใช้ออกจากการประชุม

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีแจ้งให้ผู้ใช้ในเซสชันที่หยุดไป

public void endCoDoing() {
  this.session.endSession();
}

จัดการการอัปเดตที่เข้ามาใหม่

เมื่อแอป Meet ของผู้เข้าร่วมรายอื่นได้รับประกาศ ระบบจะเรียกใช้ Callback onGlobalStateChanged() ให้ โดยทั่วไปแล้ว ควรตัดสินใจอย่างรอบคอบเกี่ยวกับสิ่งที่ควรดำเนินการเพื่อตอบสนองต่อการอัปเดตที่เข้ามาใหม่ เช่น การจับคู่การประทับเวลาของวิดีโอขาเข้าในกรณีที่แตกต่างจากการประทับเวลาในเครื่องมากพอ

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีจัดการการอัปเดตต่างๆ ที่เข้ามาใหม่

class AwesomeVideoCoDoingHandler implements CoDoingHandler {
  public void onGlobalStateChanged(CoDoingState update) {
    AwesomeVideoState videoState = SerializationUtils.deserialize(update.state());

    // Handle transition to new video.
    if (!videoState.videoUrl.equals(this.videoPlayer.videoUrl)) {
      this.videoPlayer.loadVideo(videoState.videoUrl);
    }

    // If the timestamp in the arriving update has sufficiently diverged, adjust
    // the local video playout.
    if (videoState.videoTimestamp.minus(this.videoPlayer.videoTimestamp).abs() >
                                        Duration.ofSeconds(2)) {
      this.videoPlayer.seek(videoState.videoTimestamp);
    }

    // Update pause state, if necessary.
    if (!videoState.isPaused && this.videoPlayer.isPaused) {
      this.videoPlayer.unpause();
    } else if (videoState.isPaused && !this.videoPlayer.isPaused) {
      this.videoPlayer.pause();
    }
  }
}