CoWatchingClient

@PublicApi
interface CoWatchingClient


מייצג סשן של צפייה משותפת.

מודיע ל-Meet על הפעולות שהמשתמשים ביצעו לאחרונה (למשל, הפעלה/השהיה/חיפוש) ועל גורמים סביבתיים, כמו עיכובים בגלל אגירת נתונים של המדיה.

סיכום

קבועים

const Double

קצב משחק מקסימלי מותר.

const Double

מספר הדילוגים המרבי המותר בשנייה.

תפקידים ציבוריים

Unit
notifyBuffering(mediaPlayoutPosition: Duration!)

מודיע ל-Meet שמדיה לא מוכנה להפעלה בגלל אגירת נתונים זמנית, בגלל מעבר קודם במדיה, חיפוש מדיה או עומס רגיל ברשת.

Unit
notifyEnded(mediaPlayoutPosition: Duration!)

מודיע ל-Meet שנגן המדיה הגיע לסופה של המדיה הנוכחית.

Unit
notifyPauseState(paused: Boolean, mediaPlayoutPosition: Duration!)

אפשר לשלוח ל-Meet התראה על כך שהמשתמש השהה או ביטל את ההשהיה של הפעלת המדיה, כדי שהמערכת של Meet תוכל לשקף את הפעולה הזו אצל משתמשים אחרים.

Unit
notifyPlayoutRate(rate: Double, mediaPlayoutPosition: Duration!)

מודיע ל-Meet שהמשתמש עדכן את שיעור ההפעלה של המדיה (למשל,

Unit

אפשר לעדכן את Meet שהתור השתנה, כדי שיהיה אפשר לסנכרן אותו ב-Meet אצל משתמשים אחרים.

Unit
notifyReady(mediaPlayoutPosition: Duration!)

מודיע ל-Meet שמאגר הנתונים הזמני הושלם ואפשר עכשיו להפעיל את המדיה, החל מחותמת הזמן שצוינה.

Unit
notifySeekToTimestamp(mediaPlayoutPosition: Duration!)

שליחת התראה ל-Meet על כך שהמשתמש חיפש את נקודת ההפעלה של המדיה, כדי ש-Meet יוכל לשקף את הפעולה הזו אצל משתמשים אחרים.

Unit
notifySwitchedToMedia(
    mediaTitle: String!,
    mediaId: String!,
    mediaPlayoutPosition: Duration!
)

אפשר לעדכן את Meet על כך שהמשתמש החליף מדיה, כדי שמערכת Meet תוכל להעביר את ההודעה הזו למשתמשים אחרים.

Unit
notifySwitchedToMedia(
    mediaTitle: String!,
    mediaId: String!,
    mediaPlayoutPosition: Duration!,
    queue: CoWatchingQueue!
)

אפשר לעדכן את Meet על כך שהמשתמש החליף מדיה בעזרת עדכון סימולציה שממחיש את התור, כדי שמערכת Meet תוכל להעביר את המידע הזה למשתמשים אחרים.

קבועים

MAX_PLAYOUT_RATE

const val MAX_PLAYOUT_RATE = 2.0: Double

קצב משחק מקסימלי מותר.

MAX_SEEKS_PER_SECOND

const val MAX_SEEKS_PER_SECOND = 0.9: Double

מספר הדילוגים המרבי המותר בשנייה.

תפקידים ציבוריים

notifyBuffering

fun notifyBuffering(mediaPlayoutPosition: Duration!): Unit

מודיע ל-Meet שמדיה לא מוכנה להפעלה בגלל אגירת נתונים זמנית, בגלל מעבר קודם במדיה, חיפוש מדיה או עומס רגיל ברשת.

פרמטרים
mediaPlayoutPosition: Duration!

המיקום שבו המדיה מושהית, בהמתנה לסיום תהליך אגירת הנתונים

קליעות
java.lang.NullPointerException

אם mediaPlayoutPosition הוא null

com.google.android.meet.addons.AddonException

אם אירעה שגיאה בלתי צפויה

java.lang.IllegalStateException

ייקראו אחרי שסשן הצפייה המשותפת הסתיים

notifyEnded

fun notifyEnded(mediaPlayoutPosition: Duration!): Unit

מודיע ל-Meet שנגן המדיה הגיע לסופה של המדיה הנוכחית.

הערה: אין צורך להפעיל את השיטה הזו (אבל היא לא מזיקה) אם ההודעה NotificationSwitchedToMedia מופעלת באמצעות מנגנון הפעלה אוטומטית ברגע שהמדיה מסתיימת.

פרמטרים
mediaPlayoutPosition: Duration!

המיקום הסופי של השחקן

קליעות
java.lang.NullPointerException

אם mediaPlayoutPosition הוא null

com.google.android.meet.addons.AddonException

אם אירעה שגיאה בלתי צפויה

java.lang.IllegalStateException

ייקראו אחרי שסשן הצפייה המשותפת הסתיים

notifyPauseState

fun notifyPauseState(paused: Boolean, mediaPlayoutPosition: Duration!): Unit

אפשר לשלוח ל-Meet התראה על כך שהמשתמש השהה או ביטל את ההשהיה של הפעלת המדיה, כדי שהמערכת של Meet תוכל לשקף את הפעולה הזו אצל משתמשים אחרים.

פרמטרים
paused: Boolean

true אם מושהית או false אם ההפעלה נמשכת

mediaPlayoutPosition: Duration!

המיקום שבו המדיה הושהתה או בוטלה

קליעות
java.lang.NullPointerException

אם mediaPlayoutPosition הוא null

com.google.android.meet.addons.AddonException

אם אירעה שגיאה בלתי צפויה

java.lang.IllegalStateException

ייקראו אחרי שסשן הצפייה המשותפת הסתיים

notifyPlayoutRate

fun notifyPlayoutRate(rate: Double, mediaPlayoutPosition: Duration!): Unit

מודיע ל-Meet שהמשתמש עדכן את שיעור ההפעלה של המדיה (למשל, 1.25x) לערך חדש.

פרמטרים
rate: Double

קצב ההצגה של המדיה

mediaPlayoutPosition: Duration!

המיקום הנוכחי של הנגן

קליעות
java.lang.IllegalStateException

אם rate אינו מספר חיובי

java.lang.IllegalStateException

אם rate גדול מהערך MAX_PLAYOUT_RATE

com.google.android.meet.addons.AddonException

אם אירעה שגיאה בלתי צפויה

java.lang.IllegalStateException

ייקראו אחרי שסשן הצפייה המשותפת הסתיים

notifyQueueUpdate

fun notifyQueueUpdate(queue: CoWatchingQueue!): Unit

אפשר לעדכן את Meet שהתור השתנה, כדי שיהיה אפשר לסנכרן אותו ב-Meet אצל משתמשים אחרים.

פרמטרים
queue: CoWatchingQueue!

מידע על התור של אפליקציית התוסף

קליעות
java.lang.NullPointerException

אם queue הוא null

com.google.android.meet.addons.AddonException

אם אירעה שגיאה בלתי צפויה

java.lang.IllegalStateException

ייקראו אחרי שסשן הצפייה המשותפת הסתיים

notifyReady

fun notifyReady(mediaPlayoutPosition: Duration!): Unit

מודיע ל-Meet שמאגר הנתונים הזמני הושלם ואפשר עכשיו להפעיל את המדיה, החל מחותמת הזמן שצוינה.

פרמטרים
mediaPlayoutPosition: Duration!

המיקום שבו המדיה בתהליך אגירת נתונים ומוכנה להפעלה.

קליעות
java.lang.NullPointerException

אם mediaPlayoutPosition הוא null

com.google.android.meet.addons.AddonException

אם אירעה שגיאה בלתי צפויה

java.lang.IllegalStateException

ייקראו אחרי שסשן הצפייה המשותפת הסתיים

notifySeekToTimestamp

fun notifySeekToTimestamp(mediaPlayoutPosition: Duration!): Unit

שליחת התראה ל-Meet על כך שהמשתמש חיפש את נקודת ההפעלה של המדיה, כדי ש-Meet יוכל לשקף את הפעולה הזו אצל משתמשים אחרים.

פרמטרים
mediaPlayoutPosition: Duration!

חותמת הזמן שאליה המשתמש חיפש

קליעות
java.lang.NullPointerException

אם mediaPlayoutPosition הוא null

com.google.android.meet.addons.AddonException

אם אירעה שגיאה בלתי צפויה

java.lang.IllegalStateException

ייקראו אחרי שסשן הצפייה המשותפת הסתיים

java.lang.IllegalStateException

אם מספר החיפושים לשנייה גדול מ-MAX_SEEKS_PER_SECOND

notifySwitchedToMedia

fun notifySwitchedToMedia(
    mediaTitle: String!,
    mediaId: String!,
    mediaPlayoutPosition: Duration!
): Unit

אפשר לעדכן את Meet על כך שהמשתמש החליף מדיה, כדי שמערכת Meet תוכל להעביר את ההודעה הזו למשתמשים אחרים.

פרמטרים
mediaTitle: String!

כותרת המדיה השתנתה. השם הזה יופיע בממשק המשתמש של Meet כשמשתמשים אחרים שוקלים להתחבר לסשן של צפייה משותפת.

mediaId: String!

ה-URI של המחרוזת של המדיה שהועבר אל

mediaPlayoutPosition: Duration!

המיקום שבו המדיה התחילה להופיע

קליעות
java.lang.NullPointerException

אם הערכים mediaId או mediaPlayoutPosition ריקים

com.google.android.meet.addons.AddonException

אם אירעה שגיאה בלתי צפויה

java.lang.IllegalStateException

ייקראו אחרי שסשן הצפייה המשותפת הסתיים

notifySwitchedToMedia

fun notifySwitchedToMedia(
    mediaTitle: String!,
    mediaId: String!,
    mediaPlayoutPosition: Duration!,
    queue: CoWatchingQueue!
): Unit

אפשר לעדכן את Meet על כך שהמשתמש החליף מדיה בעזרת עדכון סימולציה שממחיש את התור, כדי שמערכת Meet תוכל להעביר את המידע הזה למשתמשים אחרים.

פרמטרים
mediaTitle: String!

כותרת המדיה השתנתה. השם הזה יופיע בממשק המשתמש של Meet כשמשתמשים אחרים שוקלים להתחבר לסשן של צפייה משותפת.

mediaId: String!

ה-URI של המחרוזת של המדיה שהועבר אל

mediaPlayoutPosition: Duration!

המיקום שבו המדיה התחילה להופיע

queue: CoWatchingQueue!

מידע על התור של אפליקציית התוסף

קליעות
java.lang.NullPointerException

אם הערכים mediaId, mediaPlayoutPosition או queue ריקים

com.google.android.meet.addons.AddonException

אם אירעה שגיאה בלתי צפויה

java.lang.IllegalStateException

ייקראו אחרי שסשן הצפייה המשותפת הסתיים