שיעור GCKSession

הפניה לכיתה GCKSession

סקירה כללית

מחלקת בסיס מופשטת שמייצגת סשן עם מכשיר של המקבל.

מחלקות משנה חייבות ליישם את השיטות start (GCKSession(Protected)) ו-endWithAction: (GCKSession(Protected)), ועליהן להפעיל את שיטות שירות ההודעות המתאימות (לדוגמה, notifyDidStartWithSessionID: (GCKSession(Protected))) כדי לציין את השינויים התואמים במצב הפעילות באתר. מחלקות משנה עשויות גם להטמיע את setDeviceVolume: (GCKSession), setDeviceMuted: (GCKSession) ו-remoteMediaClient אם המכשיר תומך בפעולות כאלה.

סשן נוצר ומבוקר באמצעות שיטות הסשן ב-GCKSessionManager, שבו נעשה שימוש ב-GCKDeviceProvider המתאים כדי ליצור את הסשן, ואז יאציל בקשות סשן לאובייקט ה-GCKSession הזה.

מאז
3.0

יורש את NSObject.

הועברה בירושה על ידי GCKCastSession.

סיכום שיטות של מכונה

(instancetype) - initWithDevice:traits:sessionID:
 מפעיל אובייקט סשן חדש עבור המכשיר הנתון, עם אפשרויות ברירת מחדל. עוד...
 
(instancetype) - initWithDevice:traits:sessionID:sessionOptions:
 מפעיל אובייקט סשן חדש עבור המכשיר הנתון. עוד...
 
(GCKRequest *) - setDeviceVolume:
 מגדיר את עוצמת הקול של המכשיר. עוד...
 
(GCKRequest *) - setDeviceMuted:
 מגדיר את מצב ההשתקה של המכשיר. עוד...
 
(void) - start
 התחלת הסשן. עוד...
 
(void) - endWithAction:
 מסיים את הסשן עם הפעולה שצוינה. עוד...
 
(void) - notifyDidStartWithSessionID:
 מחלקות משנה קריאה למסגרת כדי ליידע את המסגרת שהסשן התחיל. עוד...
 
(void) - notifyDidFailToStartWithError:
 מחלקות משנה מוצגות קריאה למסגרת כדי ליידע את המערכת שהתחלת הסשן נכשלה. עוד...
 
(void) - notifyDidEndWithError:willTryToResume:
 כיתות משנה קריאה למסגרת כדי ליידע את המסגרת שהסשן הסתיים. עוד...
 
(void) - notifyDidReceiveDeviceVolume:muted:
 מוצגות קריאה למחלקות משנה כדי להודיע ל-framework לעדכון של עוצמת הקול במכשיר ולמצב ההשתקה התקבל מהמכשיר. עוד...
 
(void) - notifyDidReceiveDeviceStatus:
 מוצגות מחלקות משנה כדי להודיע למסגרת שהתקבל מהמכשיר סטטוס מעודכן. עוד...
 
(void) - notifyDidSuspendWithReason:
 הוצא משימוש, לא להשתמש – מיושם כ-no-op. עוד...
 
(void) - notifyDidResume
 הוצא משימוש, לא להשתמש – מיושם כ-no-op. עוד...
 

סיכום הנכס

GCKDevicedevice
 המכשיר שאליו משויך הסשן הזה. עוד...
 
NSString * sessionID
 מזהה הסשן הנוכחי, אם יש כזה. עוד...
 
GCKSessionOptions * sessionOptions
 אפשרויות הסשן, אם יש כאלה. עוד...
 
GCKConnectionState connectionState
 המצב הנוכחי של החיבור לסשן. עוד...
 
BOOL suspended
 סימון שמציין אם הסשן מושעה כרגע. עוד...
 
NSString * deviceStatusText
 הטקסט של סטטוס המכשיר הנוכחי. עוד...
 
GCKSessionTraitstraits
 תכונות הסשן. עוד...
 
float currentDeviceVolume
 עוצמת הקול הנוכחית של המכשיר, בטווח של [0.0, 1.0]. עוד...
 
BOOL currentDeviceMuted
 מצב ההשתקה הנוכחי של המכשיר. עוד...
 
GCKRemoteMediaClientremoteMediaClient
 האובייקט GCKRemoteMediaClient שיכול לשמש לשליטה בהפעלה של מדיה בסשן הזה. עוד...
 
GCKMediaMetadatamediaMetadata
 המטא-נתונים הנוכחיים של המדיה, אם יש. עוד...
 

פרטי השיטה

- (instancetype) initWithDevice: (GCKDevice *)  device
traits: (nullable GCKSessionTraits *)  traits
sessionID: (nullable NSString *)  sessionID 

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

Parameters
deviceThe device.
traitsThe session traits.
sessionIDThe session ID of an existing session, if this object will be used to resume a session; otherwise nil if it will be used to start a new session.
- (instancetype) initWithDevice: (GCKDevice *)  device
traits: (nullable GCKSessionTraits *)  traits
sessionID: (nullable NSString *)  sessionID
sessionOptions: (nullable GCKSessionOptions *)  sessionOptions 

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

Parameters
deviceThe device.
traitsThe session traits.
sessionIDThe session ID of an existing session, if this object will be used to resume a session; otherwise nil if it will be used to start a new session.
sessionOptionsThe session options, if any; otherwise nil.
מאז
4.0
- (GCKRequest *) setDeviceVolume: (float)  volume

מגדיר את עוצמת הקול של המכשיר.

זוהי פעולה אסינכרונית. הטמעת ברירת המחדל היא no-op שנכשלת הבקשה עם שגיאת GCKErrorCodesupportedFeature.

Parameters
volumeThe new volume.
החזרות
אובייקט GCKRequest למעקב אחר הבקשה.
מאז
3.4; בגרסאות קודמות של המסגרת, השיטה הזו החזירה void.
- (GCKRequest *) setDeviceMuted: (BOOL)  muted

מגדיר את מצב ההשתקה של המכשיר.

זוהי פעולה אסינכרונית. הטמעת ברירת המחדל היא no-op שנכשלת הבקשה עם שגיאת GCKErrorCodesupportedFeature.

Parameters
mutedThe new mute state.
החזרות
אובייקט GCKRequest למעקב אחר הבקשה.
מאז
3.4; בגרסאות קודמות של המסגרת, השיטה הזו החזירה void.
- (void) start

התחלת הסשן.

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

סופק לפי קטגוריה GCKSession(Protected).

- (void) endWithAction: (GCKSessionEndAction action

מסיים את הסשן עם הפעולה שצוינה.

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

Parameters
actionThe action to take when ending the session; see GCKSessionEndAction for more details.

סופק לפי קטגוריה GCKSession(Protected).

- (void) notifyDidStartWithSessionID: (NSString *)  sessionID

מחלקות משנה קריאה למסגרת כדי ליידע את המסגרת שהסשן התחיל.

Parameters
sessionIDThe session's unique ID.

סופק לפי קטגוריה GCKSession(Protected).

- (void) notifyDidFailToStartWithError: (GCKError *)  error

מחלקות משנה מוצגות קריאה למסגרת כדי ליידע את המערכת שהתחלת הסשן נכשלה.

Parameters
errorThe error that occurred.

סופק לפי קטגוריה GCKSession(Protected).

- (void) notifyDidEndWithError: (nullable NSError *)  error
willTryToResume: (BOOL)  willTryToResume 

כיתות משנה קריאה למסגרת כדי ליידע את המסגרת שהסשן הסתיים.

Parameters
errorThe error that caused the session to end, if any. Should be nil if the session was ended intentionally.
willTryToResumeWhether the session will try to resume itself automatically.

סופק לפי קטגוריה GCKSession(Protected).

- (void) notifyDidReceiveDeviceVolume: (float)  volume
muted: (BOOL)  muted 

מוצגות קריאה למחלקות משנה כדי להודיע ל-framework לעדכון של עוצמת הקול במכשיר ולמצב ההשתקה התקבל מהמכשיר.

Parameters
volumeThe device's current volume. Must be in the range [0, 1.0];
mutedThe device's current mute state.

סופק לפי קטגוריה GCKSession(Protected).

- (void) notifyDidReceiveDeviceStatus: (nullable NSString *)  statusText

מוצגות מחלקות משנה כדי להודיע למסגרת שהתקבל מהמכשיר סטטוס מעודכן.

Parameters
statusTextThe new status.

סופק לפי קטגוריה GCKSession(Protected).

- (void) notifyDidSuspendWithReason: (GCKConnectionSuspendReason reason

הוצא משימוש, לא לשימוש – מיושם כ-no-op.

Deprecated:
אין להתקשר.

סופק לפי קטגוריה GCKSession(Protected).

- (void) notifyDidResume

הוצא משימוש, לא לשימוש – מיושם כ-no-op.

Deprecated:
אין להתקשר.

סופק לפי קטגוריה GCKSession(Protected).

פרטי הנכס

- (GCKDevice*) device
readnonatomicstrong

המכשיר שאליו משויך הסשן הזה.

- (NSString*) sessionID
readnonatomiccopy

מזהה הסשן הנוכחי, אם יש כזה.

- (GCKSessionOptions*) sessionOptions
readnonatomicstrong

אפשרויות הסשן, אם יש כאלה.

מאז
4.0
- (GCKConnectionState) connectionState
readnonatomicassign

המצב הנוכחי של החיבור לסשן.

- (BOOL) suspended
readnonatomicassign

סימון שמציין אם הסשן מושעה כרגע.

Deprecated:
GCKSession לא תומך יותר במצב השעיה. במקרה הצורך, מעבירים את הפונקציונליות הזו למחלקה משנית.
- (NSString*) deviceStatusText
readnonatomiccopy

הטקסט של סטטוס המכשיר הנוכחי.

- (GCKSessionTraits*) traits
readnonatomiccopy

תכונות הסשן.

- (float) currentDeviceVolume
readnonatomicassign

עוצמת הקול הנוכחית של המכשיר, בטווח של [0.0, 1.0].

- (BOOL) currentDeviceMuted
readnonatomicassign

מצב ההשתקה הנוכחי של המכשיר.

- (GCKRemoteMediaClient*) remoteMediaClient
readnonatomicstrong

האובייקט GCKRemoteMediaClient שיכול לשמש לשליטה בהפעלה של מדיה בסשן הזה.

השעה nil לפני שהסשן התחילה, או אם הסשן לא תומך ב-API של GCKRemoteMediaClient. מחלקות משנה שמספקות ממשק GCKRemoteMediaClient חייבות לבטל את שיטת getter.

- (GCKMediaMetadata*) mediaMetadata
readnonatomicstrong

המטא-נתונים הנוכחיים של המדיה, אם יש.

הערך יהיה nil אם הסשן לא תומך במרחב השמות של המדיה, או אם לא נטענת מדיה כרגע על המקבל.