کلاس 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
منسوخ شده، استفاده نکنید - به عنوان بدون عملیات پیاده سازی شده است. بیشتر...

خلاصه اموال

GCKDevice device
دستگاهی که این جلسه با آن مرتبط است. بیشتر...
NSString *  sessionID
شناسه جلسه فعلی، در صورت وجود. بیشتر...
GCKSessionOptions *  sessionOptions
گزینه های جلسه، در صورت وجود. بیشتر...
GCKConnectionState  connectionState
وضعیت اتصال جلسه فعلی. بیشتر...
BOOL  suspended
پرچمی که نشان می دهد آیا جلسه در حال حاضر به حالت تعلیق درآمده است یا خیر. بیشتر...
NSString *  deviceStatusText
متن وضعیت فعلی دستگاه. بیشتر...
GCKSessionTraits traits
ویژگی های جلسه بیشتر...
float  currentDeviceVolume
حجم فعلی دستگاه، در محدوده [0.0، 1.0]. بیشتر...
BOOL  currentDeviceMuted
وضعیت قطعی دستگاه فعلی. بیشتر...
GCKRemoteMediaClient remoteMediaClient
شی GCKRemoteMediaClient که می تواند برای کنترل پخش رسانه در این جلسه استفاده شود. بیشتر...
GCKMediaMetadata mediaMetadata
فراداده رسانه فعلی، در صورت وجود. بیشتر...

جزئیات روش

- (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 است که با یک خطای GCKErrorCodeUnsupportedFeature، درخواست را با شکست مواجه می‌کند.

Parameters
volumeThe new volume.
برمی گرداند
یک شی GCKRequest برای ردیابی درخواست.
از آنجا که
3.4; در نسخه های فریمورک قبلی، این روش void برگرداند.
- ( GCKRequest *) setDeviceMuted: (BOOL)  muted

وضعیت بی صدا دستگاه را تنظیم می کند.

این یک عملیات ناهمزمان است. اجرای پیش‌فرض یک No-op است که با یک خطای GCKErrorCodeUnsupportedFeature، درخواست را با شکست مواجه می‌کند.

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
read nonatomic strong

دستگاهی که این جلسه با آن مرتبط است.

- (NSString*) sessionID
read nonatomic copy

شناسه جلسه فعلی، در صورت وجود.

- (GCKSessionOptions*) sessionOptions
read nonatomic strong

گزینه های جلسه، در صورت وجود.

از آنجا که
4.0
- (GCKConnectionState) connectionState
read nonatomic assign

وضعیت اتصال جلسه فعلی.

- (BOOL) suspended
read nonatomic assign

پرچمی که نشان می دهد آیا جلسه در حال حاضر به حالت تعلیق درآمده است یا خیر.

Deprecated:
GCKSession دیگر از حالت تعلیق پشتیبانی نمی‌کند. در صورت نیاز، این قابلیت را به یک زیر کلاس منتقل کنید.
- (NSString*) deviceStatusText
read nonatomic copy

متن وضعیت فعلی دستگاه.

- ( GCKSessionTraits *) traits
read nonatomic copy

ویژگی های جلسه

- (float) currentDeviceVolume
read nonatomic assign

حجم فعلی دستگاه، در محدوده [0.0، 1.0].

- (BOOL) currentDeviceMuted
read nonatomic assign

وضعیت قطعی دستگاه فعلی.

- ( GCKRemoteMediaClient *) remoteMediaClient
read nonatomic strong

شی GCKRemoteMediaClient که می تواند برای کنترل پخش رسانه در این جلسه استفاده شود.

قبل از شروع جلسه nil است، یا اگر جلسه از GCKRemoteMediaClient API پشتیبانی نمی کند. کلاس‌های فرعی که یک رابط GCKRemoteMediaClient ارائه می‌کنند باید روش گیرنده را لغو کنند.

- ( GCKMediaMetadata *) mediaMetadata
read nonatomic strong

فراداده رسانه فعلی، در صورت وجود.

اگر جلسه از فضای نام رسانه پشتیبانی نکند یا در حال حاضر هیچ رسانه ای روی گیرنده بارگذاری نشده باشد، nil خواهد بود.