فئة 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:
 تطلب الفئات الفرعية من هذه الفئات إشعار إطار العمل الذي يفيد بتلقّي الجهاز المحدَّث لمستوى صوت الجهاز وحالة كتم الصوت فيه. المزيد...
 
(void) - notifyDidReceiveDeviceStatus:
 تطلب الفئات الفرعية من هذه الفئات إشعار إطار العمل بأنّ الحالة المعدّلة قد تم تلقّيها من الجهاز. المزيد...
 
(void) - notifyDidSuspendWithReason:
 تم إيقاف العمل به، يُرجى عدم استخدامه. يتم تنفيذه كميزة مستقلة. المزيد...
 
(void) - notifyDidResume
 تم إيقاف العمل به، يُرجى عدم استخدامه. يتم تنفيذه كميزة مستقلة. المزيد...
 

ملخّص الموقع

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

لضبط مستوى صوت الجهاز.

هذه عملية غير متزامنة. والتنفيذ التلقائي هو إجراء بيئة مستقلة يفشل في الطلب مع ظهور الخطأ GCKErrorCodeSupportedFeature.

Parameters
volumeThe new volume.
المرتجعات
عنصر GCKRequest لتتبع الطلب.
منذ
3.4؛ في إصدارات إطار العمل السابقة، عرضت هذه الطريقة void.
- (GCKRequest *) setDeviceMuted: (BOOL)  muted

لضبط حالة كتم صوت الجهاز.

هذه عملية غير متزامنة. والتنفيذ التلقائي هو إجراء بيئة مستقلة يفشل في الطلب مع ظهور الخطأ 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 

تطلب الفئات الفرعية من هذه الفئات إشعار إطار العمل الذي يفيد بتلقّي الجهاز المحدَّث لمستوى صوت الجهاز وحالة كتم الصوت فيه.

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

تم إيقاف العمل بها، يُرجى عدم استخدامها - يتم تنفيذها كميزة مستقلة.

Deprecated:
عدم الاتصال.

متوفرة حسب الفئة "GCKSession(Protected)"

- (void) notifyDidResume

تم إيقاف العمل بها، يُرجى عدم استخدامها - يتم تنفيذها كميزة مستقلة.

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 قبل بدء الجلسة، أو إذا كانت الجلسة لا تتوافق مع GCKRemoteMediaClient API. يجب أن تلغي الفئات الفرعية التي توفّر واجهة GCKRemoteMediaClient طريقة getter.

- (GCKMediaMetadata*) mediaMetadata
readnonatomicstrong

البيانات الوصفية الحالية للوسائط، إن توفّرت

سيصبح nil إذا كانت الجلسة لا تتيح مساحة اسم الوسائط أو إذا لم يتم تحميل أي وسائط حاليًا على جهاز الاستقبال.