کلاس GCKCastSession

مرجع کلاس GCKCastSession

بررسی اجمالی

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

جلسات به طور خودکار توسط GCKSessionManager ایجاد و مدیریت می شوند. برنامه نباید مستقیماً متدهای چرخه حیات جلسه مانند start (GCKSession(Protected)) یا endAndStopCasting: (GCKSession(Protected)) فراخوانی کند.

از آنجا که
3.0

GCKSession به ارث می برد.

خلاصه روش نمونه

(instancetype) - initWithDevice:sessionID:castOptions:
مقداردهی اولیه تعیین شده بیشتر...
(BOOL) - addChannel:
یک کانال با جلسه ثبت می کند. بیشتر...
(BOOL) - removeChannel:
کانالی که قبلا ثبت نام کرده اید را از جلسه حذف می کند. بیشتر...
(void) - addDeviceStatusListener:
یک GCKCastDeviceStatusListener را به لیست شنوندگان این شی اضافه می کند. بیشتر...
(void) - removeDeviceStatusListener:
یک GCKCastDeviceStatusListener را از لیست شنوندگان این شی حذف می کند. بیشتر...
( GCKRequest *) - setDeviceVolume:forMultizoneDevice:
میزان صدای هر دستگاه را در یک گروه چند منطقه ای تنظیم می کند. بیشتر...
( GCKRequest *) - setDeviceMuted:forMultizoneDevice:
حالت بی‌صدا دستگاه را در یک گروه چند منطقه‌ای تنظیم می‌کند. بیشتر...
( GCKRequest *) - requestMultizoneStatus
درخواست وضعیت چند منطقه ای از یک گروه چند منطقه ای. بیشتر...
(instancetype) - initWithDevice:traits:sessionID:
یک شی جلسه جدید را برای دستگاه داده شده راه اندازی می کند. بیشتر...
( GCKRequest *) - setDeviceVolume:
میزان صدای دستگاه را تنظیم می کند. بیشتر...
( GCKRequest *) - setDeviceMuted:
وضعیت بی صدا دستگاه را تنظیم می کند. بیشتر...
(void) - start
جلسه را شروع می کند. بیشتر...
(void) - endAndStopCasting:
جلسه را به پایان می رساند. بیشتر...
(void) - suspendWithReason:
به دلیل معین جلسه را به حالت تعلیق در می آورد. بیشتر...
(void) - resume
جلسه را از سر می گیرد. بیشتر...
(void) - notifyDidStartWithSessionID:
توسط زیر کلاس ها فراخوانی می شود تا به فریم ورک اطلاع دهد که جلسه شروع شده است. بیشتر...
(void) - notifyDidFailToStartWithError:
توسط زیر کلاس‌ها فراخوانی می‌شود تا به چارچوب اطلاع دهد که جلسه شروع نشده است. بیشتر...
(void) - notifyDidResume
توسط کلاس های فرعی فراخوانی می شود تا به فریم ورک اطلاع دهد که جلسه از سر گرفته شده است. بیشتر...
(void) - notifyDidSuspendWithReason:
توسط کلاس های فرعی فراخوانی می شود تا به فریم ورک اطلاع دهد که جلسه به حالت تعلیق درآمده است. بیشتر...
(void) - notifyDidEndWithError:
توسط زیر کلاس ها فراخوانی می شود تا به فریم ورک اطلاع دهد که جلسه به پایان رسیده است. بیشتر...
(void) - notifyDidReceiveDeviceVolume:muted:
توسط کلاس‌های فرعی فراخوانی می‌شود تا به فریم‌ورک اطلاع دهد که حجم دستگاه به‌روز شده و وضعیت بی‌صدا از دستگاه دریافت شده است. بیشتر...
(void) - notifyDidReceiveDeviceStatus:
توسط زیر کلاس‌ها فراخوانی می‌شود تا به چارچوب اطلاع دهد که وضعیت به‌روزرسانی شده از دستگاه دریافت شده است. بیشتر...

خلاصه اموال

GCKActiveInputStatus   activeInputStatus
وضعیت فعلی «ورودی فعال» دستگاه. بیشتر...
GCKStandbyStatus   standbyStatus
وضعیت فعلی «آماده به کار» دستگاه. بیشتر...
GCKApplicationMetadata applicationMetadata
ابرداده برای برنامه گیرنده که در حال حاضر روی دستگاه گیرنده اجرا می شود، در صورت وجود؛ در غیر این صورت nil . بیشتر...
GCKDevice device
دستگاهی که این جلسه با آن مرتبط است. بیشتر...
NSString *  sessionID
شناسه جلسه فعلی، در صورت وجود. بیشتر...
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
sessionID: (NSString *__nullable)  sessionID
castOptions: ( GCKCastOptions *)  castOptions  

مقداردهی اولیه تعیین شده

یک جلسه Cast جدید با گزینه‌های Cast می‌سازد.

Parameters
deviceThe receiver device.
sessionIDThe session ID, if resuming; otherwise nil .
castOptionsThe Cast options.
- (BOOL) addChannel: ( GCKCastChannel *)  channel

یک کانال با جلسه ثبت می کند.

اگر جلسه متصل باشد و برنامه گیرنده از فضای نام کانال پشتیبانی کند، کانال به طور خودکار متصل می شود. اگر جلسه وصل نباشد، کانال تا شروع جلسه در حالت قطع می ماند.

Parameters
channelThe channel to register.
برمی گرداند
YES اگر کانال با موفقیت ثبت شد خیر، در غیر این صورت NO .
- (BOOL) removeChannel: ( GCKCastChannel *)  channel

کانالی که قبلا ثبت نام کرده اید را از جلسه حذف می کند.

Parameters
channelThe channel to unregister.
برمی گرداند
YES اگر کانال با موفقیت لغو شد، NO در غیر این صورت.
- (void) addDeviceStatusListener: (id< GCKCastDeviceStatusListener >)  listener

یک GCKCastDeviceStatusListener را به لیست شنوندگان این شی اضافه می کند.

Parameters
listenerThe listener to add.
- (void) removeDeviceStatusListener: (id< GCKCastDeviceStatusListener >)  listener

یک GCKCastDeviceStatusListener را از لیست شنوندگان این شی حذف می کند.

Parameters
listenerThe listener to remove.
- ( GCKRequest *) setDeviceVolume: (float)  volume
forMultizoneDevice: ( GCKMultizoneDevice *)  device  

میزان صدای هر دستگاه را در یک گروه چند منطقه ای تنظیم می کند.

این یک عملیات ناهمزمان است.

Parameters
volumeThe new volume, in the range [0.0, 1.0].
deviceThe multizone device.
برمی گرداند
یک شیء GCKRequest برای ردیابی درخواست.
- ( GCKRequest *) setDeviceMuted: (BOOL)  muted
forMultizoneDevice: ( GCKMultizoneDevice *)  device  

حالت بی‌صدا دستگاه را در یک گروه چند منطقه‌ای تنظیم می‌کند.

این یک عملیات ناهمزمان است.

Parameters
mutedThe new muted state.
deviceThe multizone device.
برمی گرداند
یک شیء GCKRequest برای ردیابی درخواست.
- ( GCKRequest *) requestMultizoneStatus

درخواست وضعیت چند منطقه ای از یک گروه چند منطقه ای.

این یک عملیات ناهمزمان است. هنگامی که وضعیت چند منطقه ای دریافت می شود، روش نمایندگی castSession:didReceiveMultizoneStatus: (GCKCastDeviceStatusListener-p) پیام داده می شود.

برمی گرداند
یک شیء GCKRequest برای ردیابی درخواست.
- (instancetype) initWithDevice: ( GCKDevice *)  device
traits: ( GCKSessionTraits *)  traits
sessionID: (NSString *__nullable)  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.
- ( 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) endAndStopCasting: (BOOL)  stopCasting

جلسه را به پایان می رساند.

این یک عملیات ناهمزمان است. باید توسط زیر کلاس ها لغو شود.

Parameters
stopCastingWhether to stop casting content to the receiver.

ارائه شده توسط دسته GCKSession(Protected) .

- (void) suspendWithReason: ( GCKConnectionSuspendReason reason

به دلیل معین جلسه را به حالت تعلیق در می آورد.

این یک عملیات ناهمزمان است. باید توسط زیر کلاس ها لغو شود.

ارائه شده توسط دسته GCKSession(Protected) .

- (void) resume

جلسه را از سر می گیرد.

این یک عملیات ناهمزمان است. باید توسط زیر کلاس ها لغو شود.

ارائه شده توسط دسته GCKSession(Protected) .

- (void) notifyDidStartWithSessionID: (NSString *)  sessionID

توسط زیر کلاس ها فراخوانی می شود تا به فریم ورک اطلاع دهد که جلسه شروع شده است.

Parameters
sessionIDThe session's unique ID.

ارائه شده توسط دسته GCKSession(Protected) .

- (void) notifyDidFailToStartWithError: (NSError *)  error

توسط زیر کلاس‌ها فراخوانی می‌شود تا به چارچوب اطلاع دهد که جلسه شروع نشده است.

Parameters
errorThe error that occurred.

ارائه شده توسط دسته GCKSession(Protected) .

- (void) notifyDidResume

توسط کلاس های فرعی فراخوانی می شود تا به فریم ورک اطلاع دهد که جلسه از سر گرفته شده است.

ارائه شده توسط دسته GCKSession(Protected) .

- (void) notifyDidSuspendWithReason: ( GCKConnectionSuspendReason reason

توسط کلاس های فرعی فراخوانی می شود تا به فریم ورک اطلاع دهد که جلسه به حالت تعلیق درآمده است.

Parameters
reasonThe reason for the suspension.

ارائه شده توسط دسته GCKSession(Protected) .

- (void) notifyDidEndWithError: (NSError *__nullable)  error

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

Parameters
errorThe error that caused the session to end, if any. Should be nil if the session was ended intentionally.

ارائه شده توسط دسته 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: (NSString *__nullable)  statusText

توسط زیر کلاس‌ها فراخوانی می‌شود تا به چارچوب اطلاع دهد که وضعیت به‌روزرسانی شده از دستگاه دریافت شده است.

Parameters
statusTextThe new status.

ارائه شده توسط دسته GCKSession(Protected) .

جزئیات ملک

- ( GCKActiveInputStatus ) activeInputStatus
read nonatomic assign

وضعیت فعلی «ورودی فعال» دستگاه.

- ( GCKStandbyStatus ) standbyStatus
read nonatomic assign

وضعیت فعلی "آماده به کار" دستگاه.

- ( GCKApplicationMetadata *) applicationMetadata
read nonatomic copy

ابرداده برای برنامه گیرنده که در حال حاضر روی دستگاه گیرنده اجرا می شود، در صورت وجود؛ در غیر این صورت nil .

- ( GCKDevice *) device
read nonatomic strong inherited

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

- (NSString*) sessionID
read nonatomic copy inherited

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

- ( GCKConnectionState ) connectionState
read nonatomic assign inherited

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

- (BOOL) suspended
read nonatomic assign inherited

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

- (NSString*) deviceStatusText
read nonatomic copy inherited

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

- ( GCKSessionTraits *) traits
read nonatomic copy inherited

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

- (float) currentDeviceVolume
read nonatomic assign inherited

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

- (BOOL) currentDeviceMuted
read nonatomic assign inherited

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

- ( GCKRemoteMediaClient *) remoteMediaClient
read nonatomic strong inherited

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

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

- ( GCKMediaMetadata *) mediaMetadata
read nonatomic strong inherited

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

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